doc: Discourage trailing doxygen comments, and fix the broken ones

This commit is contained in:
MarcoFalke
2026-03-31 18:45:03 +02:00
parent 8cc690ea9b
commit facaeb9c76
4 changed files with 20 additions and 16 deletions

View File

@@ -225,16 +225,15 @@ To describe a class, use the same construct above the class definition:
class CAlert
```
To describe a member or variable use:
To describe a member or variable, place the comment on the line(s) before it, using `/**` and `*/`, `//!`, or `///`:
```c++
//! Description before the member
int var;
```
or
```c++
int var; //!< Description after the member
```
Avoid trailing (inline) member comments like `int var; //!< Description after the member`.
- *Rationale*: Forgetting the `<` silently breaks Doxygen output.
Also OK:
```c++