Color control of Doxygen HTML output
One of the tasks as part of the current programming challenge is the generation of a proper (source code) documentation. The obvious choice (at least for me) when dealing with a C/C++ project is using Doxygen, since a) not only does it produce a nicely organize and well readable documentation for the source code but b) also allows for the integration of extended documentation, such as design consideration notes, etc.
Without any modifications to the related configuration settings w.r.t. to the HTML output the documentation for a C++ class will be looking pretty much like in the picture below:
While the default HTML output presents a good choice, sometimes you might want to
integrate the pages generated by Doxygen with another set of pages which follow
a certain style guide or adhere to a certain color scheme. While the ultimate adjustment
can be done by providing a custom cascading style-sheet (CSS) file, there are a few
dials you can turn in order to quickly affect the visuals. One of these dials is
the HTML_COLORSTYLE_HUE
tag in the Doxygen configuration file:
The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen will adjust the colors in the style sheet and background images according to this color. Hue is specified as an angle on a colorwheel, see http://en.wikipedia.org/wiki/Hue for more information. For instance the value 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
Minimum value: 0, maximum value: 359, default value: 220. This tag requires that the tag GENERATE_HTML is set to YES.
Using the default value
HTML_COLORSTYLE_HUE = 220
the outcome is as shown in the picture above. Adjusting the hue value towards a more red-ish color scale,
HTML_COLORSTYLE_HUE = 344
the same section of documentation will look as follows: