Doxygen:创建专门的页面

时间:2011-07-29 13:10:09

标签: doxygen deprecated

我终于想出了如何使用deprecated将函数标记为消失。我想要生成的是“相关页面”上列出的附加页面(很像GENERATE_DEPRECATED),它允许我列出已更改的API。

如果我们拉一个函数说 doFoo(INT,SomeClass的)

代替 doFoo(uInt_64,SOMECLASS,& errInstance)

我想要的是一种可以放置页面的方法

更改:

doFoo(int, SOMECLASS) removed: Use doFoo(uInt, SOMECLASS, &errInstance)

更糟糕的事情;我不确定如何在没有实际重新启用标题中的旧调用的情况下执行此操作,尽管它现在已被删除。

建议欢迎。

2 个答案:

答案 0 :(得分:1)

如果要定义自己的行为类似于已弃用的命令(例如\ change),请查看\ xrefitem命令以及ALIAS定义。

有关详细信息,请参阅http://www.doxygen.nl/manual/commands.html#cmdxrefitem

答案 1 :(得分:0)

对于这样的东西,我创建了一个文件,这是一个带有文本和代码块的大评论:

/*! 
\page changed Changed

<b>Changed:</b>

/code
doFoo(int, SOMECLASS) removed: Use doFoo(uInt, SOMECLASS, &errInstance)
/endcode

*/