从doxygen中删除功能列表

时间:2013-01-24 17:20:46

标签: c++ doxygen

我遇到了doxygen文档的问题。 在“文件”部分中,是否可以使用doxyfile中的标志删除页面顶部的函数列表? 如果没有,有没有办法在这个“功能”列表之前插入一个部分(在cpp的源代码中使用doxygen命令)。

2 个答案:

答案 0 :(得分:2)

EXTRACT_ALL设为NO

HIDE_UNDOC_MEMBERS设为YES

不要记录您想隐藏的成员。

您还可以使用EXCLUDE_SYMBOLS排除某些记录的项目: EXCLUDE_SYMBOLS标记可用于指定应从输出中排除的一个或多个符号名称(名称空间,类,函数等)。符号名称可以是完全限定名称,单词,或者如果使用通配符*,则为子字符串。示例:ANamespace,AClass,AClass :: ANamespace,ANamespace :: * Test

答案 1 :(得分:0)

请参考此文档页面: http://www.doxygen.nl/manual/customize.html

“更改页面的布局”一章说明了如何包括/排除以及更一般地组织生成的文档。如果我正确理解的话,我就会遇到与您一样的问题,并按照上述文档中指示的步骤进行操作:

1)通过使用命令“ doxygen -l”,我获得了标准的“ DoxygenLayout.xml”布局文件

2)通过修改标准文件,注释掉整个 ... XML部分

,准备了一个自定义布局文件。

3)在我的Doxyfile中,将自定义布局文件指定为选项“ LAYOUT_FILE”的值

注意路径,以便doxygen知道在哪里可以找到Doxyfile和自定义布局文件。