jeirmeister/Cockatrice
1
0
Fork 0
mirror of https://github.com/Cockatrice/Cockatrice.git synced 2026-11-05 17:43:23 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
Cockatrice/doc/doxygen
History
Bryce! afe9bf77af Route random hand reveals through PlayerActions 
Keep command creation, dispatch and response handling in the game action
layer. HandMenu requests the typed operation and presents the count and
failure dialogs. Show the chosen recipient, distinguish the count action
from the immediate single-card reveal, and use the game window as parent.
2026-11-03 16:36:54 -05:00
..
css Docs: Use doxygen-awesome-css theme (#6512) 2026-01-24 11:22:43 +01:00
filters [Networking] Doxygen (#7030) 2026-07-27 11:27:00 +02:00
groups Doxygen: Improve file structure and includes (#6344) 2025-11-22 19:38:39 +01:00
html [Doxygen] Add javascript to toggle call/caller graph visibility. (#6195) 2025-09-28 21:22:37 +02:00
images [Docs] Add app logo to main page + cleanup (#7471) 2026-10-10 23:48:37 +02:00
js [Doxygen] Add javascript to toggle call/caller graph visibility. (#6195) 2025-09-28 21:22:37 +02:00
pages Route random hand reveals through PlayerActions 2026-11-03 16:36:54 -05:00
theme@46483f1e5a Bump doc/doxygen/theme from d52eafe to 46483f1 (#7371) 2026-10-01 20:59:20 +02:00
DoxygenLayout.xml Docs: Use doxygen-awesome-css theme (#6512) 2026-01-24 11:22:43 +01:00
README.md [Docs] Add app logo to main page + cleanup (#7471) 2026-10-10 23:48:37 +02:00

README.md

Building Doxygen Documentation

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

doxygen Doxyfile

Open the index.html file in the /docs/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.