C Doxygen中结构的相关函数列表
我使用Doxygen为我的一个C项目生成API文档。对于项目中的每个数据结构,有一堆函数,它们在某种程度上与结构一起工作(比如C++类及其方法)。 我希望Doxygen在页面上生成这些函数的列表,其中包含结构的详细信息。可能吗 仅举一个例子,我的大多数结构和相关功能如下所示:C Doxygen中结构的相关函数列表,c,doxygen,C,Doxygen,我使用Doxygen为我的一个C项目生成API文档。对于项目中的每个数据结构,有一堆函数,它们在某种程度上与结构一起工作(比如C++类及其方法)。 我希望Doxygen在页面上生成这些函数的列表,其中包含结构的详细信息。可能吗 仅举一个例子,我的大多数结构和相关功能如下所示: typedef struct foo { /* anything */ } foo_t; foo_t *foo_create(int a); void foo_free(foo_t *foo); int foo_
typedef struct foo {
/* anything */
} foo_t;
foo_t *foo_create(int a);
void foo_free(foo_t *foo);
int foo_do_magic(foo_t *foo, int a, int b);
int foo_do_other_magic(foo_t *foo, int a);
在本例中,我希望在页面底部有一个foo\u create
、foo\u free
、foo\u do\u magic
和foo\u do\u other\u magic
函数列表,其中包含foo\u t
结构的详细信息。我该怎么做
Edit:与
\related
命令完全符合我的要求,但不幸的是,我需要将此命令附加到每个函数。现在,我使用的是\defgroup
,它创建了一个包含结构和相关函数的单独页面。试试看:可能看一下手册中的分组段落和命令\addtogroup and friends。@francis遗憾的是,必须将related添加到每个函数中,这是我不想做的事情。否则,它会按我所希望的那样完成任务。@albert将模块分组工作得很好。我可能会坚持这样做,因为这似乎是最简单的解决方案。谢谢