gpt4 book ai didi

c - 使用 Doxygen 的 "documentation at other places"在多个 header 中记录宏时出现问题

转载 作者:行者123 更新时间:2023-11-30 18:08:41 25 4
gpt4 key购买 nike

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

我想记录这些 header 需要定义的 typedef 和宏,并且我认为在阅读 Documentation at other places 后它会很好地工作。 Doxygen 手册的部分。我将文档添加到了一个常见的 platform.h 文件中,该文件 #includes 目标的平台 header 。

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

对此我能做些什么有什么想法吗?我真的希望描述出现在多个文件中。这是某种命名空间问题吗?

编辑(Jens 的信息):
这是一件疯狂的事情——我在 platform.h 中并排记录了两个宏。出现在 platform_foo.h 中的出现在全局变量列表中,而出现在 platform_win32.hplatform_bar.h 中的则出现在全局变量列表中未出现在列表中。

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

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

稍后再探讨——下次 session 的时间到了。

最佳答案

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

关于c - 使用 Doxygen 的 "documentation at other places"在多个 header 中记录宏时出现问题,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/3136661/

25 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com