diff options
Diffstat (limited to 'docs/HACKING.txt')
| -rw-r--r-- | docs/HACKING.txt | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/HACKING.txt b/docs/HACKING.txt index 00a2d0b6..763d608f 100644 --- a/docs/HACKING.txt +++ b/docs/HACKING.txt @@ -34,9 +34,12 @@ necessary. while (condition) { } - /* + /** * Documentation about behaviour * ... + * + * @param param1 the first argument + * @param param2 the second argument */ void function(param1, param2) { } @@ -75,6 +78,10 @@ necessary. comment */ + Note that for documenting functions, methods and other things that can use + documentation, you should use Doxygen style as in the function example above. + For details see the manual at http://www.doxygen.org/. + * Whitespace examples: Good: |