Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Clarify default defines #1106
fallberg left a comment •
When a doxygen entry is supposed to go with a section (@ brief in this case) it is more clear to indent the addition to clarify this. Leaving it on a new line can give the incorrect impression that it will not be part of the section or it will be line broken in the section (which it won't). See line 1519 as reference.
Also, since the entire example is "code" it might be more clear to the user to have the entire #define expression as fixed width or syntax highlighted using @ code or similar.
One could also argue that the examples do not belong in the @ brief, since it is supposed to give the very condensed description of things. Having examples there bloats it significantly, and for most of the cases the examples are quite self explanatory.
@fallberg how about this? Brief is kept short and entire example is in monospace.