diff options
Diffstat (limited to 'DOCS/tech/code-documentation.txt')
| -rw-r--r-- | DOCS/tech/code-documentation.txt | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/DOCS/tech/code-documentation.txt b/DOCS/tech/code-documentation.txt index da2f47d763..da16b2a81c 100644 --- a/DOCS/tech/code-documentation.txt +++ b/DOCS/tech/code-documentation.txt @@ -87,6 +87,16 @@ too */ /* Neither is this. */ +Doxygen comments should come before the definition: + +/** description */ +int a_variable; + +However, you can use '<' to describe things AFTER they are defined, like this: + +int some_var; ///< description +#define foo(x) (x + 2) /**< returns x plus 2 */ + There are a couple of special tags for doxygen: \brief <one line text> |