Doxygen mainpage12/20/2023 ![]() Online documentation for Doxygen's command is at this link.I commented out the links for these using HTML-style comment tags. ![]() This is because my API documentation is not finished yet, so I created "placeholders" for pages that haven't been written yet. Note that some of the entries in my table of contents are not links (e.g. The page for the above excerpt is rendered by Doxygen as shown in the below screenshot: *! users_guide STFishFinder API User's Table of Contents I put this page in a document named "pages.dox", and added a reference to "pages.dox" to the INPUT tag in the Doxyfile. Doxygen also supports the hardware description language VHDL. ![]() Here is an excerpt from the doxygen documentation for my own project. Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, and to some extent D. Use nested indented bulleted lists in your markdown to manually create a multi-level hierarchy, and use (or \ref) command tags to create hyperlinks. The Table of Contents in the right pane can be generated manually as follows. This will cause the index to appear in the left pane. The default value for the GENERATE_TREEVIEW tag is NO. To create an automatically-generated hierarchical index, edit your Doxyfile, and make sure the following tag appears as shown: GENERATE_TREEVIEW = YES These are produced using different methods. On the example web page in your link, there are two main panes: on the left is an automatically-generated hierarchical index (what Doxygen calls a " treeview"), and on the right is a manually-generated table of contents.
0 Comments
Leave a Reply.AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |