Cockatrice/docs/doxygen

Building Doxygen Documentation

We use Doxygen for our code documentation.
After installing the tool, you can build a HTML webpage into the /docs-output folder according to our configuration:

doxygen Doxyfile

Open the index.html file in the /docs-output/html/ folder to browse the result locally.
There is also an online version we host at the Cockatrice webpage: cockatrice.github.io/docs

Doxygen's own documenation can be found at www.doxygen.nl/manual.

Doxygen Documentation Theme

Required changes to the Doxyfile config from the theme docs to make doxygen-awesome-css work:

HTML_EXTRA_STYLESHEET  = doxygen-awesome.css      # Main CSS file of the theme
GENERATE_TREEVIEW      = YES                      # Optional, also works without
HTML_COLORSTYLE        = LIGHT                    # Required with doxygen-awesome-css theme, Auto Dark Mode will still work
DISABLE_INDEX          = NO                       # YES is bugged in the theme, see jothepro/doxygen-awesome-css/issues/201
FULL_SIDEBAR           = NO                       # Required for doxygen-awesome-css theme

Cockatrice dedicated color adjustments are configured in the cockatrice_docs_style.css file that uses & overrides the theme definitions.