mirror of
https://github.com/Cockatrice/Cockatrice.git
synced 2026-11-10 20:13:24 -08:00
9c60ae98d4
RickyRister asked for cmdRevealCards and cmdRevealRandomCards to share a helper instead of threading a randomCount parameter through the reveal virtual. Restore the three-argument cmdRevealCards signature, resolve the reveal preconditions and zone in resolveRevealZone, and let both commands build their card list and hand it to revealCards, which owns the private and public Event_RevealCards construction and the enqueue. The random command no longer fabricates a Command_RevealCards with the -2 sentinel to re-enter the legacy path; its behaviour is unchanged. Name the CardRef fields in random_reveal_test instead of relying on declaration order, and state in the user documentation that a rejected reveal is not reported in the client, matching what the client does. |
||
|---|---|---|
| .. | ||
| css | ||
| filters | ||
| groups | ||
| html | ||
| images | ||
| js | ||
| pages | ||
| theme@46483f1e5a | ||
| DoxygenLayout.xml | ||
| 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.