Skip to content

Commit a13892d

Browse files
author
Owen Jones
committed
Document classes and member variables unless obvious
1 parent 98657d8 commit a13892d

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

CODING_STANDARD.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,8 @@ Formatting is enforced using clang-format. For more information about this, see
7777
/// function. For out-parameters, use "\param [out]".
7878
return_typet my_function(argt arg_name, argt &long_arg_name)
7979
```
80+
- Classes and member variables should also be documented using the above format
81+
when it is not immediately obvious what they do.
8082
- The priority of documentation is readability. Therefore, feel free to use
8183
Doxygen features, or to add whitespace for multi-paragraph comment blocks if
8284
necessary.

0 commit comments

Comments
 (0)