如何订购Doxygen组

时间:2014-11-26 12:17:06

标签: pdf-generation doxygen

是否可以订购Doxygen PDF输出中列出的组(即模块)? 例如,如果我构建当前的C项目,commands的组将在status之前的结果PDF中列出,因为它默认按字母顺序排序,而我希望列出statuscommands之前。

我尝试更改组名,并为模块标题保留相同的标签名称,但这似乎没有任何影响,例如。

/** @defgroup g1 Status */   =   /** @defgroup status Status */

由于

3 个答案:

答案 0 :(得分:1)

您可以在代码页的第一个位置设置@defgroup块中的组顺序,也可以设置第一个组定义。您不需要defgroup部分的组范围。

/**
* @defgroup A_group Group of Macro A
* @defgroup B_group Group of Macro B
* @defgroup C_group Group of Functions
*/

然后使用@ingroup定义每个组,以便您需要代码。

/**
* @ingoup b_group
* @{
*/
... 
/** @} */
...
/**
* @ingroup a_group
* @{
*/
...
/** @} */
...
/**
* @ingroup c_group
* @{
*/
...
/** @} */

答案 1 :(得分:0)

我在这里使用@ Cheeseminer的建议并摆弄设置,以便只显示组文档,然后仅通过INPUT命令单独添加文件,按照我想要的顺序列出它们。

缺点是我每次向代码库添加新文件时都要记得将其添加到INPUT命令中:\

答案 2 :(得分:0)

创建一个按所需顺序包含组的文件,然后将其放在输入行中。这样:

文件index.c:

/** @addtogroup status
    @addtogroup commands
*/

和INPUT var in .doxygen

INPUT = index.c .

这会根据需要对项目进行排序,但不会添加任何新符号,您仍然可以使用源文件的默认收集而不必担心订单。