问题标签 [doxygen]

问题：如何使用 Doxygen 记录 Ruby 代码？

免责声明：我知道 ruby​​ 已经内置了一个文档系统，并且可能还有其他方法可以做到这一点，但我正在操作的具体限制是如何让 Doxygen 完成这项工作（假设它是可能的）。

我按照Apple 的这个指南创建了 doxygen 文档。我确实需要修改脚本以将变量放在引号中，因此当它解析带有空格的目录时，它不会将其视为两个单独的参数。

也就是说，我最近转而在 XCODE 中使用 subversion，而不是使用 Snapshot 的东西，它有一个臭名昭著的历史，会破坏自己并丢失你的历史。我这样做的过程是为我的项目创建一个类似颠覆的目录结构，将其签入 SVN，然后从主干中签出。

我的问题是，当我创建文档时，无论我如何修改我的 doxygen 配置文件（exclude_parameters 等），它第一次为文档创建文档集都很好。第二次通过时，尝试使用 cp 命令复制到我的库文档目录时遇到问题，该目录安装它以供 XCODE 参考。

我尝试添加到 exclude_parameters .svn *.svn* */.svn* */.svn/* 但似乎没有任何帮助或影响文档。安装后我在我的 docset 上做了一个chmod，这解决了这个问题，但它实际上只是掩盖了 .svn 目录仍然存在于文档中的事实。

我想也许创建一个文件夹操作可以解决问题，但我并没有真正搞砸苹果脚本。这将是一个黑客，但肯定会完成工作。

但是，要正确地做到这一点，有没有人知道如何优雅地做到这一点（正确的方式）？

谢谢！

我目前工作的软件组最近决定开始记录我们的代码库。他们最初采用的方法是使用内置的三斜杠 /// 记录方法。

我们开始发现的一个新问题是，通过 doxygen 运行它的结果是代码库的一个非常好的表示，但供程序员使用，我们原本打算让我们的系统工程师阅读这个文档，他们经常会来我们问一个任务到底在做什么。

有没有一种简单的方法来使用 /// 方法和 doxygen 来记录我们的代码，如果我们以某种方式运行它，我们可以生成一个文档，该文档只包含系统工程版本的文档，而不需要所有额外的绒毛标准程序员文档会吓跑系统人员，例如方法和成员变量等？也欢迎任何替代解决方案建议。

很抱歉，如果这对我们要完成的工作有点混乱，我可以在收到回复时进行调整。谢谢。

我是doxygen的忠实粉丝，多年来我一直使用各种语言。特别是，我很欣赏它类似于 wiki 的能力，可以包含图像并运行 Graphviz 点生成器，以从内联 DOT 代码或外部文件中获得任意内联图。

RDoc具有使用 Graphviz 生成类图的图表支持，但我看不到任何包含任意图像或图表的方法。它似乎也不支持建立像氧气这样的任意页面。

是否有任何工具可以为 Ruby 提供这些 Doxygen 风格的功能？

我浏览了 Ruby Toolbox工具列表，它们似乎都是 RDoc 的变体。

目前对我来说最可能的解决方案似乎是扩展 Yard。

我正在使用 doxygen 从源代码生成 API 引用，旨在将其转换为 CHM 帮助文件并最终转换为 Eclipse 插件。不幸的是，目录中类、命名空间等的默认排序和嵌套并不完全理想，如果可能的话，我更愿意对其进行自定义。

默认情况下，doxygen 创建两个索引/菜单来导航生成的文档。一个是左侧框架上的通用目录，另一个是每个 HTML 页面顶部的按钮行。后者可以通过编辑doxygen 手册中描述的布局 xml 文件轻松自定义（请参阅“更改页面布局”部分），但到目前为止，我还没有看到对目录进行类似修改的方法。

举一个精确的例子，我正在寻找一种方法将三个标准主题Class List、Class Hierarchy和Class Members作为子主题嵌套在 TOC 的父主题中，默认情况下在位于每页的顶部。

我想这不是最不寻常的问题，并且可能有一个已知的解决方案可用。

感谢你的协助！

准确地说：我知道如何在声明时对枚举进行 dox 处理，我想将它们进行脱机处理。

我想保持头文件没有 doxygen 注释；它们都在 .cpp 文件中。这对于函数、类、typedef 等来说不是问题。我也可以enum像这样记录自己：

但我如何记录那里的价值观enum？

谢谢！

现在我收到一条错误消息：

我已经尝试在代码中查找和单个@f$标签，但到目前为止我还没有成功找到罪魁祸首。我该如何解决这个特定问题？

另外，在 doxygen 中调试 latex 错误的一些通用技巧是什么？某处有日志文件吗？

寻找类似于用于 Delphi 的 Modelmaker 的东西。显示模块的依赖关系。任何帮助表示赞赏。

到目前为止，Doxygen 一直很棒。如果有人知道 Doxygen 是否可以实现我想要的，请告诉我:)

我想为我的 API 创建一个 docset，它看起来和工作起来都像 Apple Core Library docset。例如，查看 NSString 的页面。

我试过 Doxygen，也试过 headerdoc2html。两者都没有非常接近我想要的。

headerdoc 生成的文件没有 Apple 文件的大部分高级结构，图形设计也不同。在更详细的层面上，例如查看特定方法时，事情更接近，但没有所有详细的结构。

Doxygen 生成的文件具有非常不同的高级结构，更不用说具有非常不同的图形设计了。

我还应该尝试什么？或者这些工具中的任何一个是否有参数可以让我更接近？

谢谢，帕特

公共 c++ 头文件必须提供大量注释。doxygen 注释很难格式化和包装。是否存在一些格式化工具？

具有第 80 个字符自动换行等功能，易于视觉功能分组。理想情况下，文档编写者单独准备文档，然后将其注入或使用带有代码的 doxytags 链接。

此时我们正在使用记事本/IDE 来记录代码。