From 69b076e1f9ebfed8d654033041d68427a8334b8b Mon Sep 17 00:00:00 2001 From: DawnFire42 Date: Tue, 19 May 2026 10:44:59 -0400 Subject: [PATCH] Update .github/CONTRIBUTING.md Co-authored-by: tooomm --- .github/CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ccbe7b8f6..56ad64283 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -211,11 +211,11 @@ into smaller parts, for example at spaces or after opening a brace. ### 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 -- **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 Doxygen's [\todo command](https://www.doxygen.nl/manual/commands.html#cmdtodo))