使用 Doxygen 的自定义 XML 标签

Custom XML Tags with Doxygen

提问人:Bojan Hrnkas 提问时间:8/14/2012 最后编辑:CommunityBojan Hrnkas 更新时间:12/22/2018 访问量:1887

问:

参考此解决方案:使用 Doxygen 的自定义标签

如果我使用 XML (c#) 样式进行记录,这似乎不起作用。 我试图添加一个“更改”标签:

ALIASES = "change=\xrefitem change \"Change\" \"Changes\""

但是,当我在文档中使用它时:

<change>Bojan Hrnkas, 14.08.2012: Optimized performance.</change>

HTML 输出如下所示:

<change>Bojan Hrnkas, 14.08.2012: Optimized performance.</change>

有没有办法实现 xml 标记的别名?

视窗 Doxygen

评论

0赞 Chris 8/28/2012
+1 问得好。这将是一个非常好的功能。

答:

0赞 Bojan Hrnkas 8/28/2012 #1

我可以确认在使用 XML 样式文档时不支持自定义标签。我的解决方案是混合两种样式,所以现在我有<summary>和@change{}。不是很好,但它有效。

2赞 Chris 8/28/2012 #2

实现此目的的一种方法是使用 INPUT_FILTER 配置文件选项将自定义 XML 命令替换为别名。例如,定义

ALIASES = "change=\xrefitem change \"Change\" \"Changes\""

我们可以用来查找和替换INPUT_FILTER

<change>Text</change>

\change Text

这个 SO 问题中,可以使用 sed 来执行此转换,使用类似于

sed 's/<change>\(.*\)<\/change>/\1/'

评论

0赞 Bojan Hrnkas 9/10/2012
我假设“sed”是 linux 的“Stream EDitor”。这听起来像是一个可能的解决方案。但是,我的开发环境是 Windows 上的 Visual Studio,因此“sed”不是一个选项。Visual Studio 是我坚持使用 xml 样式注释的原因。无论如何,谢谢!
2赞 Chris 9/10/2012
然后,您应该将 Windows 标记添加到您的问题中。无论如何,sed 可用于 Windows。或者,可以使用 Powershell 来实现相同的结果
0赞 user877329 10/4/2013
@BojanHrnkas 从 GNUWin32、MinGW 或 Cygwin 安装一个 sed。