问题标签 [doxygen-addtogroup]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
218 浏览

doxygen - 如何在 doxygen 配置文件(例如 iostream 库)中添加不带扩展名的文件?

在 INPUT 标记的配置文件中,我添加了一个目录。里面iostream没有任何扩展。运行配置文件后,我没有得到与iostream. 我想知道如何在 doxygen 配置文件中添加不带扩展名的文件。

0 投票
0 回答
90 浏览

doxygen - 如何使用 Doxygen 生成用户手册?

我有一些带有 .docx 扩展名的用户手册。我可以将我的手册转换为类似于 doxygen 手册(带有带有标题的侧面导航栏)

0 投票
0 回答
74 浏览

doxygen - Doxygen:组子项目

我想生成一个应该包含子项目文档的全局文档,但是我无法按子项目对其进行分组。项目结构如下所示:

顶级项目a

  • 页面
    • *.md
  • 子项目
    • 项目b
      • 文档
      • 页面
        • *.md
      • 源代码
    • 子项目c
      • 文档
      • 页面
        • *.md
      • 源代码

如果我只是让文档使用标准设置生成,那么所有降价文件都在同一级别。因此,我想按子项目对文档进行分组。我知道如果您添加\addtogroup [b,c]到所有文件中,您可以实现这一点,但我不想调整所有文件。在最好的情况下,我希望在顶级项目中写入一个文件,该文件将输入文件分组,如下所示

问题是,如果我是正确的,您只能指定一个文件而不是目录。我必须为子项目目录生成一个额外的标签来复制所有文件。我也试过\includeand \ref,但我真的无法让它工作。

我的另一个想法是为每个子项目生成一个“元”文档,然后我可以使用\addtogroup参数进行调整。我尝试了包含一个子项目的 refman.tex ,但我并没有真正看起来像它以这种方式工作。但最后我只需要一个 pdf,所以可以切换到任何工作。

0 投票
1 回答
113 浏览

documentation - 如何配置 doxyfile 并获取 .doc 文件的文档作为输入以在 Doxygen 中生成 html 输出?

我的任务是使用 doxygen 工具记录扩展名为 .doc 的文件。我能够为 .cpp 文件生成 html 输出,但坚持设置 doxyfile 的正确配置,以便为具有 .doc 扩展名的文件生成 html 输出作为输入文件。请帮我解决这个问题。

0 投票
1 回答
28 浏览

doxygen - 使用 Doxygen 生成 PDF

我正在使用带有 Doxygen 1.8.17 的 Ubuntu 20.04.1。我也安装了乳胶。

我可以很好地获取 .html 文件,并且它包含所有文档,但是通过两个命令转换输出的乳胶文件:latex refman pdflatex refman

结果“找不到文件'float.sty'”。我追溯到它应该在的文件位置,但那里的文件不存在。“xcolor.sty”似乎也不见了,可能还有其他。

提前致谢!

0 投票
0 回答
50 浏览

c - Doxygen 被多个 C 头文件中定义的符号扰乱

使用 Doxygen 1.8.7,即将升级到 1.8.17。

我正在编辑 C 库中的文档,该库在三个不同的标头中声明了相同的符号。这三个声明具有文档注释,将符号放在具有不同描述的三个不同组中。只要三个标题中没有两个一起使用,C 就可以了。Doxygen 认为它是一个多重声明,发出三个警告,并忽略其中两个定义。

处理这个问题的最佳方法是什么?

我发现的唯一解决方案是https://www.doxygen.nl/manual/faq.html#faq_code中描述的#ifndef/#endif 技巧。这将让我将所有三个符号描述填充到一个符号声明的 Doxygen 注释中,并告诉 Doxygen 忽略另外两个。但是描述只会出现在一组中,这将是三个声明中的一个的正确组。

为了说明这个问题,头文件 aaa.h 有一个这样的声明:

头文件 bbb.h 有这个:

头文件 ccc.h 有这个:

有没有更好的办法?

告诉工程师清理代码不是解决方案。我处于一种工作文化中,工程师不太可能根据编辑的要求更改代码。我们在发布周期中为时已晚,即使他们同意,他们也无法这样做。