我使用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_do_magic(foo_t *foo, int a, int b);
int foo_do_other_magic(foo_t *foo, int a);
在这种情况下,我希望在页面底部有一个foo_create
,foo_free
,foo_do_magic
和foo_do_other_magic
函数的列表,其中包含{的详细信息{1}}结构。我怎么能这样做?
编辑:foo_t
命令正是我想要的,但不幸的是我需要将此命令附加到每个函数。目前,我正在使用\related
,它会创建一个包含结构和相关函数的单独页面。