问题标签 [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 回答
188 浏览

eclipse-plugin - 如何从 DSL 语言生成 Doxygen 文档

我想为我的 DSL(域特定语言)生成 Doxygen 文档。因为我的 DSL 语言与 C、C++、Java 语言完全不同。

基本上我的是 eclipse 插件项目,我们正在为 DSL 语言开发 IDE,因为我想从 DSL 项目中生成 Doxygen。

我对 Doxygen 话题很陌生。请让我知道一些想法继续。

注意:我添加了依赖项,因此我可以为 Java 生成 Doxygen 文档。我不知道如何为我的 DSL 语言做这件事。

0 投票
0 回答
545 浏览

enums - 在组中时,doxygen 枚举在索引中显示两次

有一个包含 typedef 枚举的头文件。我无法修改此标题。枚举在我的项目中使用,我需要记录枚举。我通过将 @enum doxygen 命令添加到 .dox 文件来做到这一点:

这会在 INT_VALS 文档的模块部分中创建一个条目,其中每个枚举值都列为子条目。每个枚举值也在模块中作为单独的条目列出。枚举表在文档中正确创建。

我只想在模块索引中包含 INT_VALS 条目及其子条目,而不是额外的单个重复条目。

输出是html。

链接到示例输出的图像

0 投票
1 回答
167 浏览

enums - 有没有办法如何使用 doxygen 区分枚举中的组?

我想评论大枚举并将一些枚举元素分组(彼此跟随)

想象这样的枚举:

而且我要:

  1. 结果是一张桌子。
  2. 还有组名
  3. 直观地显示组内有哪些枚举元素

例如结果可能如下所示:

我不希望有任何特定的观点。以上只是说明我想要的。你知道在 doxygen 中是否有可能发生这样的事情?如果是,那怎么办?

0 投票
1 回答
366 浏览

documentation - 如何在 doxygen 文档上隐藏私有类声明

//我的 doxygen 文件:

EXTRACT_ALL = 是

EXTRACT_PRIVATE = 否

EXTRACT_PACKAGE = 否

EXTRACT_STATIC = 否

EXTRACT_LOCAL_CLASSES = 是

EXTRACT_LOCAL_METHODS = 否

HIDE_UNDOC_MEMBERS = 是

HIDE_UNDOC_CLASSES = 否

0 投票
0 回答
1320 浏览

javascript - doxygen 有更好的 JavaScript 过滤器吗?

我知道 Doxygen 不支持 JavaScript 文件。我还查看了 js2doxy.pl 脚本和这个:

使用 Doxygen 记录 JavaScript

第一个选项(js2doxy.pl)没有生成相关的 C++ 代码,它也跳过了所有原型方法并将它们留空。第二个选项有效,但不适用于基于原型的编程。我正在寻找一个可以支持基于原型(OOP)的 JavaScript 文件的过滤器。我对此进行了很多研究,但未能找到更好的过滤器。

提前致谢!

0 投票
1 回答
588 浏览

c - Doxygen:在数组创建的组内时警告文件结束

这个问题是由于 doxygen 解析约束造成的。我在 Kinetis Design Studio 中使用 doxygen 1.8.11 和 Eclox(eclipse 插件)进行嵌入式 C 开发。

几乎所有的 doxygen 编译工作,除了我需要有一些非常大的静态数组。我不想弄乱主要代码,所以我使用了在这些论坛上找到的 hack ( https://stackoverflow.com/a/4645515/6776259 ):

不幸的是,该 hack 导致我的 main.c main_module组的编译失败。出现以下错误:

警告:在组内时文件结束

我尝试使用以下内容从我的main_module组中排除这些常量:

这消除了 doxygen 编译错误,但编译后的 doxygen 文档在 Large_Array 声明之后不包含任何内容。所以似乎第二个@addtogroup语句不起作用。

我错过了一些简单的东西吗?任何帮助表示赞赏。谢谢你。

0 投票
1 回答
478 浏览

doxygen - 在 Doxygen 上并排放置图像

我试图在 Doxygen 文件的主页上放几张图片,但没有运气在网上找到答案,Doxygen 将两张图片放在一起。

有没有办法让它并排?

0 投票
1 回答
272 浏览

doxygen - 如何将 \addtogroup 与 ALIASES 命令一起使用?

我正在尝试创建一个自定义命令以便于组处理。这个想法一般...

...在代码文件中用作...

...获得 doxygen 结果评论:

我尝试使用 Doxygen 1.8.14。不幸的是,这不起作用。有任何想法吗?

编辑: 我认为根本问题是 \addtogroup 命令及其语法。我希望通过插入“^^”来强制换行来清除这一点,但在我看来,doxygen 是在一行中解析命令,而不是在前一步中解析“^^”新行...

0 投票
1 回答
414 浏览

c - Doxygen 没有收集全局待办事项列表中的所有 \todo

我对 doxygen 有疑问。并非我所有的 \todo 都收集在全局待办事项列表中,但其中大部分都收集了。我用一个源文件和头文件以及一个配置文件制作了一个简单的 C 示例,我在其中放置了待办事项,我希望 doxygen 将它们收集到全局待办事项列表中。

我的全局待办事项列表缺少以下代码片段中显示的待办事项,这意味着我的公共函数体内的待办事项(myFunc 中的 test_todo12)以及 cfg 文件中的待办事项(test_todo16 和 test_todo17),两者都按所示实现以下。

测试.h:

测试.c:

测试.cfg:

我正在使用 doxygen 1.8.14 版

与默认设置相比,我的 doxygen 配置文件的差异如下(在尝试了很多不同的组合之后):

链接到完整的可编译代码和 doxygen 配置(显示此问题的最小示例):链接到代码

当我导航到公共功能“myFunc”时,我看到了待办事项,它只是在全局待办事项列表中丢失了。

cfg 文件似乎根本不包含在 doxygen 文档中,尽管它包含在 C 文件中,但应该将其视为该文件的一部分?或者是否真的有必要为包含这些 cfg 文件做一些额外/特殊的事情?如果是这样,有人知道我错过了什么吗?

我希望有人能帮我解决我的问题,也许公共函数体中的 todo 甚至是一个错误?

问候杰斯珀

0 投票
1 回答
120 浏览

tabs - 如何在 doxygen 文档中添加我们自己定义的选项卡

代码的输出

FPGA_BOARD 内容

嗨,我想在页面上再添加一个选项卡,即我想在主页和相关页面之间添加“Lokesh”选项卡,我已附上屏幕截图以供参考。 图片供参考

在此处输入图像描述

详细的选项卡视图