From f4638399e33686734425fa0eaac302863aefd49b Mon Sep 17 00:00:00 2001 From: DawnFire42 Date: Wed, 13 May 2026 19:07:29 -0400 Subject: [PATCH] Add Doxygen and comment style standards to CONTRIBUTING.md --- .github/CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b293b3937..ccbe7b8f6 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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