I am creating documentation for users of a library. I want to provide info only
about functions, data structures, macros, typedefs and what header file they
need to include. With Doxygen's standard structure the only way I have been
able to coerce it into providing a list of functions is to put \file comment
blocks at the top of the header files where they are declared. Doxygen then
structures the tree-view (left-pane) around the files. But API users don't
care about how the source is structured.
What I want to do is to place an item called "Functions" in the top level of
the ToC in the tree view.
The closest I have come is to create some groups that include the functions.
This adds a Modules entry to the tree-view showing the groups I have created
and the groups show the functions.
When I add a \files comment block at the top of the public header then the
expanded "Files" entry in the tree view shows each file and a "Globals" entry.
The contents of the expanded "Globals" entry is ideally what I would like to
have at the top level of the tree view: Functions, Macros, Structures,
Typedefs, etc.
How can I do this?
Asked also at stackoverflow
<http://stackoverflow.com/questions/43629688/how-can-i-get-a-functions-list-in-the-top-level-of-doxygens-tree-view>.
Regards
-Mark
------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
