【问题标题】:User manual with DoxygenDoxygen 用户手册
【发布时间】:2015-12-22 08:35:33
【问题描述】:

我正在尝试使用 doxygen 为我的库编写用户手册/教程(类似于 doxygen 本身的用户手册!-link

我使用来自mainpage子页面 .md 文件来创建我的文档层次结构。我最终得到了类似于 OpenCV (link) 的东西,看起来相当不错,但它仍然没有 doxygen 用户手册的许多功能。例如,左侧的页面/部分索引和右侧的分页目录。

是否有任何方法可以生成可扩展的索引/目录并使用 doxygen 将其附加到每个页面中(如link)?这样做有没有更好的办法?还有其他提示吗?

【问题讨论】:

  • 我想你可能想学习使用 emacs org 模式。它确实拥有您所希望的一切以及更多。将它与 draw.io 结合用于图表,将 org 导出为 html,将 wkhtmltopdf 导出为 pdf,然后就可以了。 youtu.be/VjMp_B1V4bI

标签: documentation doxygen user-guide user-manual


【解决方案1】:

在 Doxyfile 中将 GENERATE_TREEVIEW 标志设置为 YES 将导致 Doxygen 创建侧面板。

例子:

GENERATE_TREEVIEW = YES

此功能要求浏览器支持 JavaScript、DHTML、CSS 和框架。

【讨论】:

  • 哦,它是如此简单,如此精确......谢谢,我正在为幸福而哭泣!
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 2011-03-13
  • 2012-02-27
  • 2016-06-15
  • 1970-01-01
  • 2016-01-09
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多