用户手册与Doxygen

时间:2015-09-24 16:28:45

标签: documentation doxygen user-guide user-manual

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

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

有没有办法生成可扩展的索引/内容表并使用doxygen将其附加到每个页面中(如link中所述)?这样做有好处吗?还有其他提示吗?

1 个答案:

答案 0 :(得分:1)

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

示例:

GENERATE_TREEVIEW = YES

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