简体   繁体   English

Doxygen用户手册

[英]User manual with Doxygen

I am trying to write user-manual/tutorial for my library using doxygen (something similar to the user-manual of the doxygen itself! - link ) 我想写使用的doxygen我的图书馆用户手动/教程(类似的doxygen本身的用户手册东西- 链接

I used .md files subpage ed from the mainpage to create my document hierarchy. 我用.MD文件子页面编辑从mainpage创建我的文档层次。 I ended up something similar to that of OpenCV ( link ), which looks quite nice, but it still does not have many features of that of doxygen user manual. 我最终得到了与OpenCV( link )类似的东西,看起来不错,但是它仍然没有doxygen用户手册的许多功能。 For example, page/section index on the left and page wise table of content on the right. 例如,左侧的页面/节索引和右侧的逐页目录。

Is there any way of generating expandable index/table of content and attach it in every pages using doxygen (as in link )? 有什么方法可以生成可扩展的目录索引/表,并使用doxygen将其附加在每页中(如link所示 )? Is there a better of doing this? 这样做有更好的办法吗? Any other tips? 还有其他提示吗?

Setting the GENERATE_TREEVIEW flag to YES in your Doxyfile will cause Doxygen to create the side panel. 在Doxyfile中将GENERATE_TREEVIEW标志设置为YES将导致Doxygen创建侧面板。

Example: 例:

GENERATE_TREEVIEW = YES

This feature requires that browsers support JavaScript, DHTML, CSS and frames. 此功能要求浏览器支持JavaScript,DHTML,CSS和框架。

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM