无法使用Doxygen的“其他地方的文档”来记录多个标题中的宏

时间:2010-06-28 22:39:39

标签: c doxygen

我正在编写一个大型代码库(ANSI C,而不是C ++),并为每个目标设备(各种嵌入式设备和Win32)提供特定于平台的标头。

我想记录那些标题需要定义的typedef和宏,我认为在阅读Doxygen手册的Documentation at other places部分后它会正常工作。我将文档添加到#include目标平台标题的公共platform.h文件中。

我的目标平台标头(例如platform_win32.h)包含@file标记,并在文件列表中按预期显示。当我单击该文件时,它会显示typedef和宏的列表,但它仅显示对该标题唯一的的描述。任何出现在多个标题中的宏/类型都没有记录。

关于我能做些什么的任何想法?我真的很喜欢这些描述出现在多个文件中。这是某种命名空间问题吗?

编辑(Jens的信息):
这是疯狂的事情 - 我在platform.h中并排记录了两个宏。 platform_foo.h中显示的那个显示在全局变量列表中,但platform_win32.hplatform_bar.h中显示的那个不显示在列表中。

platform.h文件视图中没有出现任何宏文档,这是有道理的,因为宏文件和typedef没有在该文件中使用 - 它只包含文档。

有趣的是:我刚刚使用了HTML帮助,它列在globals_0x78.html中(0x78 ='x',宏名称的第一个字母)。我现在认为它可能与名称空间有关。查看文件的HTML源代码,我将其列为group_name::MACRO_NAME

稍后将探讨另一次会议的时间。

1 个答案:

答案 0 :(得分:0)

您是否尝试过使用doxygen preprocessor功能?