mirror of
https://github.com/Cockatrice/Cockatrice.git
synced 2026-07-06 05:23:56 -07:00
Add Doxygen and comment style standards to CONTRIBUTING.md
This commit is contained in:
parent
330ea7b8c6
commit
f4638399e3
1 changed files with 10 additions and 0 deletions
10
.github/CONTRIBUTING.md
vendored
10
.github/CONTRIBUTING.md
vendored
|
|
@ -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
|
||||
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 ###
|
||||
|
||||
New code should be written using references over pointers and stack allocation
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue