jeirmeister/Cockatrice
1
0
Fork 0
mirror of https://github.com/Cockatrice/Cockatrice.git synced 2026-07-08 09:03:57 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions
Cockatrice/doc/doxygen
History
DawnFire42 2b8090a69e docs(command-zone): add developer and user documentation 
Add comprehensive documentation for the command zone feature.

Developer documentation:
- command_zone_architecture.md: detailed architecture overview
  - Layer separation (types, state, logic, graphics)
  - Component interactions and dependencies
  - Testing strategy and coverage
- Index update to include new architecture doc

User documentation:
- commander_format.md: how to use Commander format in Cockatrice
  - Zone configuration options
  - Gameplay mechanics (commander tax, zone reveals)
  - Tips for Commander games
- Index update to include new format doc
2026-02-26 20:13:32 -05:00
..
css Docs: Use doxygen-awesome-css theme (#6512) 2026-01-24 11:22:43 +01:00
extra-pages docs(command-zone): add developer and user documentation 2026-02-26 20:13:32 -05: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 [Doxygen] Add documentation for beta channel. (#6510) 2026-01-11 12:48:31 +01:00
js [Doxygen] Add javascript to toggle call/caller graph visibility. (#6195) 2025-09-28 21:22:37 +02:00
theme@1f3620084f Docs: Use doxygen-awesome-css theme (#6512) 2026-01-24 11:22:43 +01:00
DoxygenLayout.xml Docs: Use doxygen-awesome-css theme (#6512) 2026-01-24 11:22:43 +01:00
README.md Docs: Use doxygen-awesome-css theme (#6512) 2026-01-24 11:22:43 +01:00

README.md

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.