Skip to content

Commit b13cd4e

Browse files
committed
docu: small remark on docu section in style guide
1 parent dcfe21f commit b13cd4e

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

doc/source/style_guide.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,17 @@ We agreed on using the "most common" C++11 features. These are:
105105

106106
Document your code.
107107

108-
We use [Doxygen] for generating the documentation webpage. You can
109-
use pretty much all the features, Doxygen provides, including
110-
[MathJAX] for formulas and [Markdown] for easy text formatting.
108+
We use [Doxygen] for generating the documentation webpage. You can use pretty much all the features,
109+
Doxygen provides, including [MathJAX] for formulas and [Markdown] for easy text formatting.
110+
111+
It is advised to use Doxygen's special commands wherever possible to aid readability of the
112+
generated documentation.
113+
Especially, one should use `@tparam <T> <description>`, `@param[<in>,<out>] <param> <description>`,
114+
`@returns <description>`, `@throws <exception> <description>`.
115+
116+
There is an additional custom defined block available to mark documentation of internals.
117+
Therefore, sourround the respective block with `internals` and `endinternals` (as Doxygen commands).
118+
111119

112120
## Formatting
113121

0 commit comments

Comments
 (0)