Doxygen:分组模块和页面?

时间:2013-02-06 10:18:29

标签: documentation markdown doxygen

我对doxygen中的页面和组有疑问。 我有一个项目,我用 @defgroup @ingroup cmds将类分组等。到目前为止,这个工作正常。

现在,我想通过markdown页面向项目添加特殊文档。这些页面应出现在专用模块(组)中。我尝试使用 @page @subpage cmds创建页面。这样可以正常工作,但页面显示在菜单中。

所以我尝试使用 @ingroup 将它们添加到组中。但这并不像我猜测的那样有用。 是否可以将页面添加到模块(组)?

结果应如下所示:

项目
   | - 模块
   | | - “Module1”
   | | | - documentation page1(来自* .md文件)
   | | | - 类文档
   | | - “Module2”
   | | | - documentation page2
   | | | - 类文档

我希望你能帮助我!

1 个答案:

答案 0 :(得分:0)

要对页面进行分组,您需要使用子页面功能,而不是组。

因此,为每个引用子页面和模块组的组创建一个页面。

/*! \page group1page A documentation page for my group
This page contains the info about group 1 \ref group1_label
\subpage group1page2
\subpage group1page3
*/

this Firebase documentation

http://www.doxygen.nl/manual/grouping.html#subpaging