diff options
Diffstat (limited to 'doc/developer.texi')
| -rw-r--r-- | doc/developer.texi | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/developer.texi b/doc/developer.texi index a63bea746c..c9cf7bde98 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -105,6 +105,11 @@ Use the JavaDoc/Doxygen format (see examples below) so that code documentation can be generated automatically. All nontrivial functions should have a comment above them explaining what the function does, even if it is just one sentence. All structures and their member variables should be documented, too. + +Avoid Qt-style and similar Doxygen syntax with @code{!} in it, i.e. replace +@code{//!} with @code{///} and similar. Also @@ syntax should be employed +for markup commands, i.e. use @code{@@param} and not @code{\param}. + @example /** * @@file |