我正在使用一些遗留代码,我正在使用doxygen生成XML文档。我对这种代码有两个问题。首先它包含无效的评论。例如:
///@struct E
enum E
{
E1, E2, E3;
};
这会导致doxygen为名称为E
的struct生成输出,该输出不在代码中。我的第二个问题是HTML链接。例如,对于以下输入:
///@brief For info about this struct see: <a href="http://www.foo.com/bar&bar"\>
struct S
{
int i;
}
doxygen生成的输出不是有效的XML,因为链接中的&
未正确转义。
由于上述原因,我想doxygen忽略一些评论。这可能吗?
答案 0 :(得分:5)
我认为doxygen没有一个简单的开关,但是,你可以在doxygen运行之前编写自己的INPUT_FILTER程序来清理文件(例如通过删除注释)。 p>
答案 1 :(得分:1)
我注意到并测试了doxygen评论中的html注释将被忽略:
///@brief some comment here <--! ignored here --> also continues over.
至于&amp;没有逃脱,你注意到了吗?会逃脱吗?也许这是该部分的解决方案。