Question

我用doxygen记录C代码。为了使文档更具可读性，我想至少使用@defgroup和@ingroup将每个.c / .h文件对中的代码添加到一个组中。在这些组中，我想使用@name块将一些定义组合在一起。

＆＃34;文件中的结果＆＃34;页面看起来与我的预期非常接近：文件中记录的所有内容都列在那里，或多或少地很好地分组。在＆＃34;模块＆＃34;另一方面，页面只列出函数和变量，第一个@name块之前的定义列在＆＃34;变量＆＃34;下。缺少所有其他定义和枚举。删除@name块列出＆＃34;变量＆＃34;下的所有定义/ typedefs / enums。没有自己的宏或枚举部分，也没有在这些页面上进一步分组。

如何在模块/组页面上列出的组中获取所有定义和枚举，例如记录定义/功能等的文件页面？

我使用doxygen 1.8.9.1 windows binarires。

我的代码看起来与此类似： .h文件：

/** @file
*   blabla
*   @author bla
*/
/// @ingroup MY_GRP
/// @{
#define SOMEDEF1 1
/// @name Special defs
/// @{
#define SOMEDEF2 2
/// @}
enum someenum {
foo,
bar
};

extern int some_variables;

extern void some_proc(int baz);

/// @}

.c文件如下所示：

/** @file
 *  blabla
 *  @author bla
 */
/** @defgroup MY_GRP A test group.
  * Description
  */
/// @{
#include "my.h"

/// Important variable.
int some_variable;

/** Important proc
 *  Description
 *  @param baz need this
 */
void some_proc(int baz) {
// code
}

/// @}

我让doxygen wizzard生成一个doxyfile并生成一个DoxygenLayout.xml文件。当与布局文件一起玩时，我发现＆＃34;定义＆＃34;组页面上的标签是空的（它们显然什么也不做），而＃34;定义了＃34;在变量部分中由＆＃34;成员组生成＆＃34;标签......不知道该怎么做。

非常感谢任何帮助。如果您需要doxyfile或其他任何内容，请告诉我。

Answer 1

Adding all members of a file to a group can be accomplished using the @addtogroup tag.

这里已经回答了同样的问题： Doxygen: Can file members inherit a module grouping if they are in a file that is grouped?

c中的doxygen：定义的分组

1 个答案: