问题标签 [doxygen-addtogroup]

我在使用 Doxygen 识别名称空间和模块时遇到问题。我相信问题围绕着是将 放在\addtogroup命名空间内还是命名空间外。

示例 1，在命名空间之外：

示例 2 - 在命名空间内

我希望namespace Records出现在 Doxygen命名空间选项卡下，并间接出现在模块选项卡下。单击Namespaces页面中的项目应生成一个包含Records::Interface. 单击“模块”选项卡中的项目也应生成一个包含Records::Interface.

在我的 Doxygen 文档中，我在模块中的命名空间选项卡中缺少项目，反之亦然，这是由于这种困境导致我的不一致。

那么哪个是正确的方法，示例 1 或示例 2？{Doxygen 手册对此主题并不清楚。}
Doxygen：\addtogroup
Doxygen：记录命名空间

我正在为我的项目创建一个 Doxygen 文档。最近，我使用\addtogroup标签对相关类进行了分组。在此之后，我的文档中有一个模块选项卡。它显示所有模块。我想在同一页面上模块名称下方的模块名称下方添加一些描述。我怎样才能使用 Doxygen 呢？

这是我的标签

我需要一些在 C 代码上使用 Doxygen 的基本帮助。所有基本文档都很好，我需要帮助构建长长的文件和函数列表。

我有一个 C 源代码树，如下所示：

很标准。目前 doxygen 生成所有文件的平面文件列表。我们将 src/ 的每个 dub-dir 称为“模块”，因此记录这似乎非常适合 Doxygen 模块/组。

我应该如何使用分组命令来镜像上面的目录结构？我想在生成的文档中有一个模块 util 链接到 file1 和 file2 文档。就像 JavaDoc 对待一个包一样。

将 /addtogroup util & @{ 标记添加到每个头文件会生成一个迷你站点，其中包含所有头文件中所有数据结构等的扁平列表，这不是我所期望或想要的。也许这就是 doxygen 组应该做的事情，即当代码跨多个文件实现时统一记录 API？

我有一个包含一些常量的 C++ 类实现文件。常量出现在类方法实现之前。我想将常量组合在一起。我的组和描述显示在模块选项卡中，但组都是空的。存在详细描述，但没有组成员。组是这样的：

我还尝试使用@addtogroup 或@ingroup 显式添加组成员，但似乎都不起作用。

关于为什么这不起作用以及我需要做什么才能使它起作用的任何想法？

克里斯指出的编辑错字

解决方案

为了完成这项工作，我需要在我的 doxygen 配置中设置 EXTRACT_STATIC=YES。

在我的 C++ 应用程序中，我有大约 10 个不同的类来定义某些“行为”（我们称它们为 A、B、C、...）。代码中的其他地方（方法）可能会以任意组合使用这些行为。例如，方法 M1 使用行为 A 和 B，方法 M2 使用行为 A、C 和 D，...

在实践中，代码类似于这样：

我想清楚地概述哪种方法使用了一种行为，最好是在特定行为的文档中，以便每个行为的类文档都包含如下列表：

我可以对这个列表进行硬编码，但一段时间后它会变得过时，因为添加了新方法，方法开始使用额外的行为，或者方法停止使用行为。因此，为了使其可维护，我更喜欢在使用行为的方法中添加一些内容，告诉 Doxygen“这段代码正在使用这些行为，所以在该行为的文档中添加一些内容”。

“Visual AssistX”或“了解 C/C++”之类的工具允许我执行查找，但每次您想要执行查找时它们仍然需要一些手动操作。因此，我想在我的文档生成系统中自动执行此操作。

我正在考虑使用 defgroup 和 ingroup，但我不确定这是否适用于代码片段。最好的使用方法是什么？

我正在尝试使用 Doxygen GUI 为我的 iPhone 项目生成文档。其中有一个选项为“选择编程语言以优化结果”。在这个选项中，我找不到 Objective C 选项。当我运行氧气时，它只显示空的 HTML 文件。

请说清楚..！下面是屏幕截图...

设置 SOURCE_BROWSER = TRUE 显示所有文件的源代码。

是否可以显示特定文件的来源？
或使用 SOURCE_BROWSER = FALSE 启用 \ref 或等效项
如果 SOURCE_BROWSER = TRUE
或等效项，则删除特定文件的源代码

我在 doxygen 的组中包含降价文件，如下所示：

它们会按要求显示在模块文档中。但无论如何，它们显示为普通的顶级页面，如下所示：

如果已包含在模块文档组中，如何删除顶级降价页面？

我希望我的解释很清楚。

我正在用 doxygen 记录我的 C 代码。为了更好的可读性，我将每个 .c/.h 文件对（有时还有更多文件）的文档用defgroupand分组addtogroup（参见doxygen in c: grouping of defined）。文件页面看起来不错，但在组/模块页面上，所有变量文档都翻了一番。在头文件中声明（使用 extern）并在 .c 文件中（在摘要和描述部分中）定义的每个变量都有 2 个条目。函数和其他所有内容只列出一次......

如何摆脱组/模块页面上的重复变量文档？

我的源文件如下所示： .h 文件：

.c 文件：

我正在使用 Doxygen 来记录一个项目。在一个文件中，我有一堆我想放在一个组中的公共函数。我这样做如下：

问题是 LaTeX 输出包含两次此处的所有文档；一次在“模块文档”部分，再次在“文件文档”部分。这相当于我的最终 PDF 文件（从 LaTeX 生成）中可能有 25 页纯粹重复的内容。

一个理想的解决方法是让 myFile.c 的文件文档说“请参阅 @ref my_group”或类似的内容。有没有办法在 Doxygen 中实现这一点？