问题标签 [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.

0 投票
1 回答
1143 浏览

editor - Kate 中的 Doxygen 风格评论

Kate 有一个非常方便的快捷键 (Ctrl+D),可以将单行和多行注释应用到选定的文本区域。如何配置 Kate 以在 C/C++ 源文件中应用 doxygen 样式注释?

0 投票
1 回答
4874 浏览

doxygen - Doxygen 可以纯粹按照声明的顺序输出成员吗?

哪个 Doxygen 选项可以完全禁用按类型(私有/公共/方法/变量)排序成员,并完全根据声明的顺序输出成员?

0 投票
1 回答
1200 浏览

c++ - 在类中的私有块之后,Doxygen 无法在公共块上工作

如何告诉 Doxygen 在(C++)类中的私有部分之后记录公共部分?

例如

即使没有第一个公共部分,第二个公共部分仍然没有记录。

doxylog.txt 报告:

警告:未声明或定义记录的函数“Brg::undocumentedFunction1”

0 投票
3 回答
23415 浏览

doxygen - 从 doxygen 文档中排除一些类

我正在构建一个基于 Qt 的项目,并且在目标文档中可以找到许多 Qt 类。

如何告诉 Doxygen 禁用某些类的文档生成?Q.*?

0 投票
2 回答
2559 浏览

visual-studio - 让 Doxygen 和 MSVC TODO 标签一起工作

在 doxygen 中,标准的“/// \todo stuff”用于标记待办事项。我的大部分编码都是在 MSVC 中完成的,因此能够方便地查看任务列表中的 TODO。MSVC 使用“//TODO stuff”作为他们的标签。有什么办法可以让它们一起工作吗?我找到了任务列表的属性窗格并尝试将“\todo”添加到列表中,但它不喜欢“\”字符。我可以让这两个一起工作吗?

编辑:我特别有兴趣了解如何在 Visual Studio 10 中执行此操作。

0 投票
6 回答
9784 浏览

c# - 将 TEX 文件转换为 PDF 或 DOCX?

我正在使用 Doxygen 从 C# 源代码构建 API 库。Doxygen 生成一个 TEX 文件库。

我的客户要求提供此 API 库的 PDF 版本,因此我需要将 TEX 文件库转换为单个 PDF 或 DOCX。

我一直在研究 LyX、OpenOffice 和 ProText 等工具,但仍未找到解决方案。

欢迎所有建议。

0 投票
2 回答
1063 浏览

documentation - 从其他页面的部分生成 Doxygen 页面

我有一个带有 doxygen 注释的文件(比如 file1.doxy):

我想创建文件 file2.doxy ,其输出与以下内容相同:

实际上,我想从文件 file2.doxy 中引用文件 file1.doxy,而不是从 file1.doxy 中复制粘贴信息,但我可以将所需的标记标签插入到 file1.doxy 中。

doxygen有可能这样做吗?

0 投票
3 回答
2666 浏览

c++ - 如何在 Doxygen 注释中包含 .cpp 文件的子集?

我正在尝试编写一些 Doxygen 注释块,并且我想包含示例代码片段。当然,我希望这些示例能够实际编译,这样它们就不会过时。

我的 example.cpp(我在 .h 文件中包含)如下所示:

我的头文件(我正在运行 Doxygen)看起来像这样:

而且我想让 doxygen 只包含从“void demo”开始到文件末尾的东西(但没有 // endcode)。

我尝试过使用 \dontinclude 和 \skip、\skipline 和 \until 进行试验,但我无法完全弄清楚正确的咒语。

编辑:包括我的 .h 文件,现在我几乎得到了正确的咒语。这几乎完全符合我的要求,是否有某种方法可以在没有标签的情况下使用 \until,并从 example.cpp 中删除最后的 // endcode 行?

0 投票
2 回答
3556 浏览

documentation - 如何生成 rdoc 风格的可折叠代码段?

我正在使用 Doxygen 为 C++ 项目创建内部文档。我让 Doxygen 包含方法等的来源,但这使得页面难以扫描。我希望它表现得像 rdoc 并将源隐藏在默认折叠的块中。

我认为这HTML_DYNAMIC_SECTIONS可能会让我这样做,但可惜的是,变更日志说该选项只影响图表和图表。

也许我可以通过编辑来做到这一点LAYOUT_FILE

无论如何,聪明的人,我怎样才能强制 Doxygen 生成可折叠的代码段?

0 投票
3 回答
10620 浏览

c++ - Doxygen 如何排除 C++ 类?

我想从 Doxygen 的文档中排除一个类。通常这些类位于同名文件中,但很多时候它们包含在其他类定义中。这主要用于以“_”或“Private”开头的类。

如何告诉 Doxygen 排除 C++ 类?

提前致谢。