将文本映射到 Doxygen 中的 HTML 实体

Mapping text to HTML entity in Doxygen

本文关键字:中的 HTML 实体 Doxygen 文本 映射      更新时间:2023-10-16

在Doxygen中,要获得HTML输出中的版权符号,文档必须使用©,如:

/// @copyright Copyright © 2012

在这种情况下,我更愿意像这样键入它:

/// @copyright Copyright (c) 2012

在后一个例子中,它看起来更好一点,并且可能也会更好地转换为纯文本和RTF输出。是否可以在 Doxygen 中创建文本到实体的映射?例如,(c)映射到©,而doxygen将简单地将所有(c)事件替换为©

一般来说,

我认为这种替换最好由输入过滤器处理。下面是一个简单的过滤器,它将替换一个(c)后跟一些数字,然后是 © 位数字,然后是相同的数字:

#!/bin/perl
open(F,"<$ARGV[0]") || die("Failed to open file $ARGV[0]: $!");
while (<F>)
{
  s/([cC])(s*d+)/&copy;1/g;
  print $_;
}
close(F);

要使用此过滤器,请将以下内容放入配置文件中:

INPUT_FILTER = "perl filter.pl"

注 1 过滤器将处理整个文件。允许仅应用于注释的筛选器可能是一个有用的功能。

注2 如果使用支持 UTF-8 的编辑器和相应的编码 (INPUT_ENCODING),您也可以直接插入版权字符(代码 C2 A9 十六进制)