summaryrefslogtreecommitdiff
path: root/docs/HACKING.txt
diff options
context:
space:
mode:
authorBjørn Lindeijer <bjorn@lindeijer.nl>2004-12-16 01:12:33 +0000
committerBjørn Lindeijer <bjorn@lindeijer.nl>2004-12-16 01:12:33 +0000
commited1a5a1f37bf760cccaa133013a5c73f4c8897e3 (patch)
tree430ecbefa75253222b21b7e4d81c66adde3ec709 /docs/HACKING.txt
parent8f4085c268d7f94d8eb8218c2750edee3a57519b (diff)
downloadmana-client-ed1a5a1f37bf760cccaa133013a5c73f4c8897e3.tar.gz
mana-client-ed1a5a1f37bf760cccaa133013a5c73f4c8897e3.tar.bz2
mana-client-ed1a5a1f37bf760cccaa133013a5c73f4c8897e3.tar.xz
mana-client-ed1a5a1f37bf760cccaa133013a5c73f4c8897e3.zip
Added note about Doxygen style to hacking guide.
Diffstat (limited to 'docs/HACKING.txt')
-rw-r--r--docs/HACKING.txt9
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: