Cockatrice/docs/doxygen
Bryce! 078d0858a3
[Game] Reveal multiple distinct random hand cards to a recipient (#7753)
* Add distinct random hand reveals with private recipient delivery

* 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.

* Apply project formatting to random-reveal warning construction

* Simplify random reveal to follow existing command patterns

Forward server dispatch through cmdRevealRandomCards and use ordinary PlayerActions command sending. Remove the bespoke server-version error UI and long-lived-object guards.

Reduce the test from 246 to 150 lines with two focused cases using the current RoleInfo player API, preserving distinct-card, private-event and rejected-count coverage.

* Extract the shared reveal helper and name the test's CardRef fields

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.

---------

Co-authored-by: Lukas Brübach <44814898+BruebachL@users.noreply.github.com>
2026-11-08 16:41:14 +01:00
..
css [Docs] Move documentation sources to docs/ and include CONTRIBUTING (#7584) 2026-11-07 17:47:10 +01:00
filters [Docs] Move documentation sources to docs/ and include CONTRIBUTING (#7584) 2026-11-07 17:47:10 +01:00
groups [Docs] Move documentation sources to docs/ and include CONTRIBUTING (#7584) 2026-11-07 17:47:10 +01:00
html [Docs] Move documentation sources to docs/ and include CONTRIBUTING (#7584) 2026-11-07 17:47:10 +01:00
images [Docs] Move documentation sources to docs/ and include CONTRIBUTING (#7584) 2026-11-07 17:47:10 +01:00
js [Docs] Move documentation sources to docs/ and include CONTRIBUTING (#7584) 2026-11-07 17:47:10 +01:00
pages [Game] Reveal multiple distinct random hand cards to a recipient (#7753) 2026-11-08 16:41:14 +01:00
theme@46483f1e5a [Docs] Move documentation sources to docs/ and include CONTRIBUTING (#7584) 2026-11-07 17:47:10 +01:00
DoxygenLayout.xml [Docs] Move documentation sources to docs/ and include CONTRIBUTING (#7584) 2026-11-07 17:47:10 +01:00
README.md [Docs] Move documentation sources to docs/ and include CONTRIBUTING (#7584) 2026-11-07 17:47:10 +01:00

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.