Skip to content

Commit

Permalink
Update Doxygen guide to improve autobrief processing
Browse files Browse the repository at this point in the history
Unlike docstring blocks starting with '\**', Doxygen does not
automatically process brief documentations that start with '\*!'.

See https://www.doxygen.nl/manual/docblocks.html
  • Loading branch information
ischoegl committed Jul 29, 2023
1 parent 6bf5b2b commit ef3470b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@

* All classes, member variables, and methods should have Doxygen-style comments
(for example, comment lines starting with `//!` or comment blocks starting with
`/*!`; do not use `///` or `/**` in new code)
`/**`; do not use `///` or `/*!` in new code)
* Doxygen-style groupings should bracket code using `//! @{` and `//! @}`
* Doxygen commands should use the `@` prefix instead of `\` in order to better
differentiate from LaTeX input.
Expand Down

0 comments on commit ef3470b

Please sign in to comment.