2011-03-22 101 views
3

我正在使用一些遗留代码,为此我使用doxygen生成XML文档。这种代码有两个问题。首先它包含无效的评论。例如:忽略一些注释

///@struct E 
enum E 
{ 
E1, E2, E3; 
}; 

这导致的doxygen以产生用于输出结构与名称E,这是不在代码中。我的第二个问题是HTML链接。例如,对于下面的输入:

///@brief For info about this struct see: <a href="http://www.foo.com/bar&bar"\> 
struct S 
{ 
    int i; 
} 

doxygen的产生的输出不是一个有效的XML,因为在链接&不正确地转义。

由于上述原因,我希望doxygen忽略一些评论。这可能吗?

回答

5

我不认为Doxygen有这个简单的开关,但是,您可以在Doxygen运行之前编写自己的INPUT_FILTER程序来清理文件(例如通过删除注释)。

1

我注意到并测试一个doxygen的注释中的HTML注释将被忽略:

///@brief some comment here <--! ignored here --> also continues over. 

至于&不被转义,你注意到\ &会逃呢?也许这是该部分的解决方案。

+0

听起来像一个有前途的想法,但不能在python中工作。 – Zane 2014-07-01 12:21:10

+0

如果将其更改为:## @这里有一些评论< - !在这里忽略 - >也继续。 – 2014-07-02 13:24:11