问题标签 [doxygen]

是否可以记录 configure.ac 以便 doxygen 可以在生成的手册中获取嵌入式注释并为选项、变量等生成文档？

谢谢

我有以下代码：

一切似乎都工作正常（枚举最终在文件范围内，但我有一个 \file，所以它与描述一起出现，格式正确。

我想要（并且没有发生）是我希望 Tick_Data_Row::m_cols 文档中对 Tick_Column_Type 的引用链接回该文档页面。Doxygen 通常似乎很聪明地弄清楚“啊哈，这是我知道的名字，我会热链接它”，但在这种情况下它没有这样做。

如果我将枚举移动到结构中并不重要。

有什么线索吗？

我有几个 html 页面解释了我的代码的不同部分，我最近也在上面运行了 Doxygen。我想在 Doxygen 的“相关页面”页面下添加指向我当前 html 页面的链接。

除了手动插入它们之外，还有其他方法吗？

我正在使用 Doxygen 为我的代码生成文档。我需要制作一个 PDF 版本并使用 Doxygen 的 LaTeX 输出似乎是这样做的方法。

但是，我遇到了许多烦人的问题，并且以前对 LaTeX 一无所知，对如何处理它们并没有真正的了解，并且对 LaTeX 相关事物的无数参考资料并没有太大帮助......

我研究了如何在 sty 文件中创建自定义样式以及如何让 Doxygen 使用它。经过大量搜索后，我发现如何通过此设置页边距等，我猜这也许是我想要做其他事情的文件，但我似乎找不到任何命令 doign我想要的是 ：（

1. 文档开头的目录包含很多项目 Id 而不是因为它使内容很长。有没有办法将这些内容限制为只说前两个级别，而不是为每个单独的函数、变量等提供条目？不过，我很想保留所有的书签。我确实尝试了“COMPACT_LATEX”选项，但除了删除内容页面上的项目外，它还删除了每个部分开头的书签和成员列表，我真的想保留这些。

2. 有没有办法改变事情的顺序，比如把完整的类描述放在部分的开头，而不是放在所有成员和属性之后？

是否可以在 Doxygen 中记录预处理器定义？我希望能够像变量或函数一样执行此操作，但是 Doxygen 输出似乎“丢失”了定义的文档，并且也不包含定义本身。

我尝试了以下

和

我还尝试将它们放在一个组中（尝试了 defgroup、addtogroup 和 ingroup），而不仅仅是在“文件范围”中，但这也没有任何效果（尽管该组中的其他项目已按预期记录）。

我查看了各种 Doxygen 选项，但看不到任何可以启用（或阻止）定义文档的东西。

我已经做了足够的谷歌搜索知道如果我有类似的东西

如果我有一个像这样的虚拟声明，我可以让 Doxygen 创建“正确”的协作图

在我的头文件中。

我的问题是：我如何让它适用于我的所有项目和所有标题，而不必在每个文件中实际包含该行？

我想从 doxygen 生成的文档中显示给定目录（及其子目录）中的所有类。

我可以使用 doxygen /addtogroup 和其他组命令，但我想这样做而不必为给定目录中的每个类添加组标签。

SHOW_DIRECTORIES 选项确实会生成一个“目录”选项卡/面板，但它会显示给定目录的所有文件，而不是类。

我怎样才能做到这一点 ？

谢谢！

有人知道解析 doxygen 风格的 C++ 注释字符串的 python 模块吗？我的意思是这样的字符串（简单示例）：

我想提取简短的、详细的描述、参数、返回值等。我目前正在使用字符串方法和正则表达式来执行此操作，但我的解决方案不是很健壮。或者，有人可以推荐一个我可以快速设置的易于使用的 python 解析器库吗？

提前致谢

我使用 Doxygen 为我的目标 c 代码生成文档。到目前为止，我还没有找到任何关于如何正确记录属性的指南。我看过的例子是尽一切可能做到的。有些人自己记录变量，有些人记录@property 声明。一些使用 //，而另一些使用完整的 /** */ 块。

谁能指出我的最佳实践参考？或者也许是一些关于未来与 Doxygen 兼容性的信息？我想坚持一个模式，至少，一旦他们开发出官方模式，就很容易适应 Doxygen。

有什么方法可以配置 Doxygen 以将来自 SVN 的日志作为输出的一部分包含在文件中？基本上，当我们提交时，我们会在 SVN 中输入非常严格的日志消息，我希望这些消息在 Doxygen 输出中有一个部分。