问题标签 [doxygen-wizard]

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 投票
0 回答
55 浏览

doxygen - 如何在 doxygen 的示例页面下显示源代码

我正在使用 doxygen 为我的个人项目编写和生成文档。该项目包括一些示例。因此,我在 index.html 下配置了示例页面。但是,示例源没有像附件那样显示源代码。我想用解释和完整的源代码来配置页面。为了解释,我在源代码中写了@example,特殊命令(参考https://www.doxygen.nl/manual/commands.html#cmdexample中的 \example )。如何在页面中显示完整的源代码?谢谢和问候,张。

在此处输入图像描述

0 投票
1 回答
184 浏览

c - __inline__ 和 __attribute__ 混淆 Doxygen

(已解决,请参阅最后的解决方案)

我在一个嵌入式 C 项目中,并编写了一个仅包含静态强制内联函数的 .h 文件。我已经这样记录了它们:

FORCE_INLINE定义为

问题线将扩展为:

__attribute__已添加到该EXCLUDE_SYSMBOLS部分,因此它们不会被记录为函数。

问题是 Doxygen 似乎被这条线弄糊涂了FORCE_INLINE __attribute__((unused))。似乎它不同步并跳过了文件中间除了一个之外的几乎所有功能。该函数的格式与其他所有人完全相同。

Doxygen 还将某些函数的部分参数和代码片段记录为全局变量。

我也尝试打开MACRO_EXPANSIONEXPAND_ONLY_PREDEF并添加FORCE_INLINE到该EXPAND_AS_DEFINED部分。没有不同。

我也尝试将它们添加到EXCLUDE_SYSMBOLS

作为测试,我将@fn命令添加到 Doxygen 看不到的功能之一,并生成了该功能的所有文档。但是我不能添加@fn到每个函数中,也不能将代码片段记录为全局变量。

有谁知道如何让 Doxygen 忽略FORCE_INLINE __attribute__((unused))每个函数前面的?

解决方案
@KamilCuk 给了我一个想法,所以我将它添加到我的头文件中:

然后替换FORCE_INLINE __attribute__((unused))FORCE_INLINE_SILENT. FORCE_INLINE在另一个头文件中定义。

0 投票
0 回答
20 浏览

c++ - 如何忽略 Doxygen 中的某些目录?

我尝试使用 Doxygen 来查看它是如何记录代码的。
我遇到的最大问题是它扫描所有子目录,但是我需要避免其中一些,因为最终文档中不需要(它们也不合适,因为不是我工作的直接部分)。
我认为可以从 Doxygen 向导的专家选项卡中进行,但我是新手,我不明白如何设置它们。
最后,对排除的目录的引用(即对函数、变量等的引用)会发生什么?

0 投票
1 回答
10 浏览

documentation - 使用 Doxywizard 时防止未处理的 DOT 文件被删除

我正在使用 Doxygen 向导为大型嵌入式 C 项目生成文档。我能够使用 Dot 和 Graphviz 生成图形和类图。但是,我想手动编辑一些依赖图——有些信息并不是一直都需要的,例如图深度太多。

我在运行 Doxywizard 时注意到,在生成图表文件并将其保存为 PNG 文件之前,会创建“原始文件”,因为缺少更好的词,其中包含使用 Graphviz 生成图表的代码。这些是可以在文本编辑器中打开的 DOT 文件。一旦生成图表图像,这些文件就会被删除。

在它们被删除之前,我可以通过停止 Doxywizard 中间进程来访问它们。有什么办法可以防止这些 DOT 文件被删除?