documentationdoxygenuser-guideuser-manual

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)

I used .md files subpageed from the mainpage to create my document hierarchy. 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. 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)? Is there a better of doing this? Any other tips?


Solution

  • Setting the GENERATE_TREEVIEW flag to YES in your Doxyfile will cause Doxygen to create the side panel.

    Example:

    GENERATE_TREEVIEW = YES

    This feature requires that browsers support JavaScript, DHTML, CSS and frames.