【问题标题】:Documenting classes with doxygen用 doxygen 记录类
【发布时间】:2017-08-25 00:00:43
【问题描述】:

我正在尝试关注these doxygen examples,但没有任何显示。我跑 doxygen Doxyfile,然后检查 index.html 文件,但那里什么都没有。只有我的mainpage.dox 文件中的东西,与任何类无关。理想情况下,我会有一个班级列表,我在其中记录了这个特定的班级。

也许这是我的文件结构。 Doxygen 只是递归搜索根目录,还是查找带有特殊标签的文件?

【问题讨论】:

  • 你必须告诉它哪些文件包含在你的 Doxyfile 中。查看文档以了解它是哪个配置选项。检查此链接:stack.nl/~dimitri/doxygen/manual/starting.html#step1
  • @AnonMail 玩弄 INPUT 和 FILE_PATTERNS 标记名没有任何作用。不过,它们的默认值应该可以工作。使它起作用的是设置RECURSIVE = YES感谢您的帮助
  • 您是否提供了完整的路径名?或者在代码所在的目录中运行 doxygen?为什么不发布你的 Doxyfile?

标签: c++ doxygen


【解决方案1】:

我发现我必须同时使用@class 参数以及对该类的简要描述,然后才能将该类列在我生成的文档的“类”部分中。

【讨论】:

  • 还要检查 Doxyfile 设置 HIDE_UNDOC_CLASSESEXTRACT_ALL
  • 这些都是解决问题的蛮力方法,尤其是 EXTRACT_ALL 设置。
猜你喜欢
  • 2012-06-02
  • 2014-10-07
  • 2017-08-14
  • 2011-06-27
  • 2017-07-07
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多