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

时间:2012-08-09 17:09:50

标签: c++ documentation comments doxygen

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

/// @copyright Copyright © 2012

在这种情况下,我更喜欢这样打字:

/// @copyright Copyright (c) 2012

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

1 个答案:

答案 0 :(得分:4)

一般来说,我认为输入过滤器可以更好地处理这种替换。 这是一个简单的过滤器,它会替换(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 hex)