search

DrylandEcology / SOILWAT2

An ecosystem water balance simulation model
GNU General Public License v3.0
5 stars 2 forks source link

Change Doxygen configuration for better formatted end product #219

Open CaitlinA opened 6 years ago

CaitlinA commented 6 years ago

Currently, the end product of Docygen Doxyfile is an .html with a non-intuitive interface and table of contents.

I believe, that by changing options in the configuration file (currently the doxyfile), that these features can be formatted. More information here.

cjb643 commented 6 years ago

To customize the output of Doxygen it is probably best to look at this section in the manual.
The "dynamic content" section of the manual can be ignored because we are only dealing with text.
The "header, footer, and stylesheet changes" section can also be ignored. Instead of using these options we are editing the entire layout. The default layout is named DoxygenLayout.xml and is generated via the console with the command doxygen -l. There are more comprehensive instructions in the link above, but for the most part you drag the lines of code beginning with <tab ... in the DoxygenLayout.xml file so they are listed in the desired order. Somewhere in the manual it says to never delete any of these lines. To turn a tab off, change visible="yes" to visible="no" at the desired line. To change the name of a tab, edit the title="" to title="New Title". If left blank the default name is used. There is also a Doxywizard that I have not played around with, but may be helpful.