Doxygen:编译OpenFOAM 1.7.1文档时出错

时间:2012-01-05 16:48:08

标签: doxygen

我正在尝试使用doxygen 1.6.3和OpenFOAM源附带的Doxyfile生成OpenFOAM 1.7.1源文档。不幸的是,在编译过程中显然出现了一些问题:

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

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

  • 类,运算符和函数没有匹配的文件成员,没有匹配的类成员,没有唯一匹配的类成员,
  • 记录但未声明或未定义的功能,
  • 不支持的xml / html代码<cloudname>
  • 许多街区:
    不匹配</li>的{​​{1}}代码 不匹配<li>的{​​{1}}代码 在</ul>区块
  • 内意外结束评论

这些可能会破坏搜索吗?我无法编辑所有文件来摆脱警告,其中有太多。

我修改了OpenFOAM附带的Doxyfile,方法是将输出文件扩展名设置为<ul>(之前为<ul>)并添加行html,但这并未改变任何内容。我这样做是因为OpenFOAM开发人员使用的Doxyfile模板是针对doxygen 1.5.3(这就是它在第一行中所说的),据我所知,附加的搜索选项来自1.6.2。

这里可能出了什么问题? OpenFOAM开发人员似乎早先成功生成了文档,他们不再在线了。

如果有人链接到OF-1.7.1的已编译在线文档的链接,我会很乐意使用它们 - 除了最新版本之外我什么都没找到。


我找到了使用OF-2.0.0的doxygen相关文件(config,header,...)创建OF-1.7.1文档的指南,在这里使用doxygen 1.7.5.1:{{3 }}

我使用了doxygen 1.7.6.1(下载了错误的版本,只是尝试了它),并在doxyfile中:
php
SERVER_BASED_SEARCH = NO
INPUT_FILTER = doxyFilt

我现在有所有标签和Javascript搜索工作,所有图表似乎都已完成。

1 个答案:

答案 0 :(得分:2)

我对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的实用程序脚本,因为它们似乎与识别问题和修复生成的文档有关。