有没有办法定义模块html页面中列出函数的顺序?

时间:2014-11-17 12:42:34

标签: doxygen

我在头文件.h中声明了几个函数,并在.c文件(C,而不是C ++)中实现。

在标头文件中,我包含“@defgroup Gr1”,并在.c文件中包含“@addtogroup Gr1”,这使得两个文件内容属于组Gr1 }。

我观察到(我不知道是否总是如此),在Doxygen生成的html Gr1模块页面中,函数按照{{1}中实现的顺序列出文件。我需要将它们列在一个不同的,由我定义的顺序中(在这种情况下,将它们列在.h文件声明顺序中就足够了。)

所以,我有两个问题:

1.-有没有办法定义列出顺序的功能?

2.-有没有办法让他们的列表顺序成为.c文件声明顺序?

(如果可能的话,我宁愿不编辑布局xml文件,因为我想在每次对代码进行一些更改时直接使用Doxygen生成的文档。)

1 个答案:

答案 0 :(得分:1)

据我所知,您对列表订单的唯一控制 - 不更改源代码 - 是在字母顺序和声明顺序之间切换。 (配置文件中的各种SORT_*选项控制它。)

如果您将字母排序关闭,则可以通过将@addtogroup移动到头文件中来生成遵循头文件中给出的顺序的文档。这不一定非常具有侵略性:您可以使用花括号一次添加整个声明序列。

/**
 * @addtogroup my_group
 * @{
 */

...declarations here...

/** }@ */

另外,您提到不想编辑layout.xml文件,因为它会为您的工作流程添加额外的步骤。我已经将修改后的布局放在我DoxygenLayout.xml配置旁边的Doxyfile文件中了,祝你好运。 doxygen将自动选择并使用它。也就是说,我不相信编辑布局文件会对你有帮助。