【问题标题】:Doxygen: errors during compilation of OpenFOAM 1.7.1 documentationDoxygen:编译 OpenFOAM 1.7.1 文档时出错
【发布时间】:2012-02-03 12:01:47
【问题描述】:

我正在尝试使用 doxygen 1.6.3 和 OpenFOAM 源附带的 Doxyfile 生成 OpenFOAM 1.7.1 源文档。不幸的是,在编译过程中有些事情明显出错了:

  • 应该在主页上显示的AllClassesNamespaces 等链接不起作用。当我点击它们时没有任何反应。
  • 当我使用选项卡导航到一个类时,继承图和协作图都只显示类本身,没有其他内容 - 即使在我知道这些图很大的情况下也是如此。
  • 搜索不起作用。当我在搜索框中输入内容并按 Enter 时,没有任何反应。

我查看了 doxygen 运行的输出,虽然它引发了很多警告,但我没有收到任何错误消息。它抱怨:

  • 类、运算符和函数没有匹配的文件成员,没有匹配的类成员,没有唯一匹配的类成员,
  • 已记录但未声明或未定义的函数,
  • 不支持的xml/html标签<cloudname>
  • 很多块:
    </li>标签不匹配<li>
    </ul>标签不匹配<ul>
    <ul> 块内的评论意外结束

这些可能会破坏搜索吗?我无法编辑所有文件以消除警告,它们太多了。

我通过将输出文件扩展名设置为html(之前是php)并添加SERVER_BASED_SEARCH = NO 行来修改OpenFOAM 附带的Doxyfile,但这并没有改变任何东西。我这样做是因为 OpenFOAM 开发人员使用的 Doxyfile 模板适用于 doxygen 1.5.3(这就是它在第一行中所说的),而且据我所知,1.6.2 附带了额外的搜索选项。

这里可能出了什么问题? OpenFOAM 的开发者似乎早先已经成功地生成了文档,只是他们不再在线了。

如果有人有针对 OF-1.7.1 编译的在线文档的链接,我会很乐意使用这些链接 - 除了最新版本,我什么也没找到。


我在这里找到了使用 doxygen 1.7.5.1 的 OF-2.0.0 的 doxygen 相关文件(配置、标题、...)创建 OF-1.7.1 文档的指南:http://www.cfd-online.com/Forums/openfoam/78529-building-openfoam1-7-0-source-2.html

我使用 doxygen 1.7.6.1 代替(下载了错误的版本并尝试了它),并在 doxyfile 中:
INPUT_FILTER = doxyFilt
FILTER_SOURCE_FILES = YES
SHORT_NAMES = NO

我现在所有选项卡和 Javascript 搜索工作正常,所有图表似乎都已完成。

【问题讨论】:

    标签: doxygen


    【解决方案1】:

    我对 OpenFOAM 不太熟悉,但您可能想尝试一下:

    • 使用 Doxygen 1.5.3 代替 Doxygen 1.6.3。由于他们的文件中引用了 1.5.3,因此它可能与他们的源代码(和实用程序脚本)更加兼容。
    • 验证doxyFilt 是否在您的路径中:$WM_PROJECT_DIR/bin。该脚本由 doxygen 调用,并将在源文件被 Doxygen 使用之前对其进行预处理。

    通过以上内容,我能够验证ClassesNamespace 和相关选项卡是否正常工作。

    您可能还需要查看位于 $WM_PROJECT_DIR/doc/Doxygen/tools 的实用程序脚本,因为它们似乎与识别问题和修复生成的文档有关。

    【讨论】:

    • 我已经下载了 doxygen 1.5.3 并用它来构建文档,但没有运气。 doxyFilt 在路径中。正如你所说,选项卡没问题 - 但搜索仍然中断,继承和协作图仍然只显示它们创建的类。
    • 我刚刚发现 doxygen 1.6.0 引入了基于 Javascript 的搜索,所以当我使用 doxygen 1.5.3 生成文档时,我无法在本地运行搜索。
    • 过去我在使用 Doxygen 时遇到过问题,因为它的扫描仪/解析器无法胜任这项工作。因此,不同的版本在相同的源代码上表现不同,有时甚至在没有明显问题时抱怨。所以切换 Doxygen 版本可能是要走的路。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2019-05-17
    • 2011-03-27
    • 2022-01-19
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多