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

Add Doxygen and comment style standards to CONTRIBUTING.md

Browse source
This commit is contained in:
DawnFire42 2026-05-13 19:07:29 -04:00
parent 330ea7b8c6
commit f4638399e3
No known key found for this signature in database
GPG key ID: 24BB855EE2911B33
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
.github/CONTRIBUTING.md vendored
View file

@ -209,6 +209,16 @@ nowadays and clean it up for you.
Lines should be 120 characters or less. Please break up lines that are too long Lines should be 120 characters or less. Please break up lines that are too long
into smaller parts, for example at spaces or after opening a brace. into smaller parts, for example at spaces or after opening a brace.
### Documentation Comments ###
Use [Doxygen](https://www.doxygen.nl/) for API documentation:
- **Doc blocks**: Use `/** @brief Description */` (JavaDoc-style), not `///`
- **Member comments**: Use trailing `///<` for inline member documentation
- **TODOs**: Use `//! \todo Description` (Qt-style) so Doxygen collects them into a Todo List
(uses [Qt-style comments](https://www.doxygen.nl/manual/docblocks.html) with
Doxygen's [\todo command](https://www.doxygen.nl/manual/commands.html#cmdtodo))
### Memory Management ### ### Memory Management ###
New code should be written using references over pointers and stack allocation New code should be written using references over pointers and stack allocation