jeirmeister/Cockatrice
1
0
Fork 0
mirror of https://github.com/Cockatrice/Cockatrice.git synced 2026-07-06 05:23:56 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Update .github/CONTRIBUTING.md

Browse source 
Co-authored-by: tooomm <tooomm@users.noreply.github.com>
This commit is contained in:
DawnFire42 2026-05-19 10:44:59 -04:00
parent 18a77dd78b
commit 69b076e1f9
No known key found for this signature in database
GPG key ID: 24BB855EE2911B33
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
.github/CONTRIBUTING.md vendored
View file

@ -211,11 +211,11 @@ into smaller parts, for example at spaces or after opening a brace.
### Documentation Comments ### ### Documentation Comments ###
Use [Doxygen](https://www.doxygen.nl/) for API documentation: Use [Doxygen](https://www.doxygen.nl/) for code documentation:
- **Doc blocks**: Use `/** @brief Description */` (JavaDoc-style), not `///` - **Doc blocks**: Use `/** @brief Description */` (Javadoc-style), not `///`
- **Member comments**: Use trailing `///<` for inline member documentation - **Member comments**: Use trailing `///<` for inline member documentation
- **TODOs**: Use `//! \todo Description` (Qt-style) so Doxygen collects them into a Todo List - **TODOs**: Use `//! \todo Description` (Qt-style), Doxygen collects them into a Todo List
(uses [Qt-style comments](https://www.doxygen.nl/manual/docblocks.html) with (uses [Qt-style comments](https://www.doxygen.nl/manual/docblocks.html) with
Doxygen's [\todo command](https://www.doxygen.nl/manual/commands.html#cmdtodo)) Doxygen's [\todo command](https://www.doxygen.nl/manual/commands.html#cmdtodo))