问题标签 [doxygen]
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.
c - 为 doxygen 选择 C 结构名称?
我如何告诉 Doxygen 使用此代码中的第一个声明:
干杯,克里斯
documentation - 在 doxygen 中添加自定义命令
我想在我的 doxygen 文档中添加一个自定义命令。基本上,对于我正在为其编写文档的每个 C 函数,我需要编写在读取模式或写入模式下“触及”哪些全局变量。这就像“另请参阅”列表,只是带有不同的标题。
在我的文件中,我想写这样的东西:
我尝试使用这样的别名:
它可以工作,但我担心它与样式表无关:如果明天我想更改 css,那么这个自定义命令将生成看起来与 seealso、作者和所有其他部分不同的输出。
基本上我只想从其他标准命令中复制格式。
另一种选择是使用 \xrefitem 命令,它也可以,但它需要引入一个部分作为第二个参数,这在我的情况下完全没用(也许它可以以某种方式隐藏?)。
有没有“正确的方法”来实现我的目标?
c++ - 如何将非成员函数与 Doxygen 中的类相关联?
我确信有一些方法可以使用 \defgroup、\addgroup 和 \@{ \@} 标签来做到这一点,但是经过几个小时的试验和(显然)错误,我问 SO.....
我有:
我有一些辅助非成员函数,它们确实是 C 接口的一部分,但不在类中:
我希望格式函数与类函数出现在同一页面上。那是不可能的吗?我能做的最好的就是一个“模块”页面,它将 C 列为一个类(带有指向 C 注释的超链接,并将格式设置为函数?
delphi - 德尔福和多氧
我想使用 doxygen + pas2dox 记录我的源代码。当我设置好所有东西时,包括过滤器和提取选项(提取所有东西),doxygen 运行良好。但是生成的文档仅包含源文件作为链接,并且没有提取任何类型/方法。过滤后的源看起来不错。
任何提示如何定位错误?
c - 如何防止 doxygen 在 C 文件中记录 #defines?
我#define
在头文件中有我当然希望 Doxygen 记录的值,但我在C文件中有其他值,我将它们视为静态常量,我不希望 Doxygen 记录它们。简单而愚蠢的事情
如何防止 Doxygen 将这些#define
s 放入它创建的文档中?我试过用它做标记,@internal
但这似乎没有帮助。
关于 Doxygen 的一个有点相关的问题#define
,我怎样才能得到:
在输出中放置“SOME_CONSTANT”和“An explain”而不是“1234”?
svn - 如何使用新的 doxygen 输出最小化修订之间的更改数量?
subversion 存储库包含 doxygen 从源代码生成的 html、latex 和 man 目录。即使对于小的源代码更改,也会生成具有随机名称的新文件,这会导致版本控制系统发生较大的变化。
有办法解决这个问题吗?如何在仍然包含 doxygen 生成的文档的同时最小化修订之间的变更集?或者,我怎样才能找到哪些 doxygen 生成的文件不再被使用并且应该被删除?
documentation - 问题让 Doxygen 记录 C 中的枚举
我对 Doxygen(Mac OS X Snow Leopard 上的 1.6.1)有一个相当奇怪的问题,因为无论我做什么,它似乎都没有记录我的枚举。我正在用 C 语言编程,并按照手册中的说明进行操作。这是我的代码:
它应该根据 doxygen 手册产生正确记录的输出,但它什么也没产生。我很可能错过了一些简单的东西,如果有人能指出我正确的方向,我将不胜感激。
c++ - 未记录的功能不应在列表中查看/显示 - 仅针对已记录的实体发布文档
我只检查了记录在案的实体。我有 func1 和 func3 的文档,但没有 func2 的文档。我有
但是在生成文档后,我仍然看到没有超链接的 func2 的签名。
有谁知道只显示那些明确记录的功能的方法?
c++ - c++:生成函数调用树
我想解析项目中的当前 c++ 文件并列出其中的所有方法/函数,然后生成函数调用和调用者树。Fg 你可以参考 doxygen 如何生成调用树。
我检查了 gccxml 但它没有列出从另一个函数调用的函数。
请向我推荐一些我可以使用的轻量级工具(开源)。
谢谢!
c# - 带有 C# 内部访问修饰符的 Doxygen
我正在使用 Doxygen 为我正在处理的 C# 项目生成一些 API 文档。我在这个项目中有相当多的“内部”功能,并且不希望 Doxygen 在它生成的生成的 html 中生成这些签名。
我已经尝试启用 HIDE_FRIEND_COMPOUNDS 但这仍然会导致我的内部类暴露在生成的文档中。
有谁知道如何做到这一点?