summaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
authorDoug Kearns <dougkearns@gmail.com>2009-01-11 01:12:30 +1100
committerDoug Kearns <dougkearns@gmail.com>2009-01-11 01:12:30 +1100
commit5dbcd6f7e01c8596409519b887dc19e30c19290d (patch)
tree90f0fd171031a1a20603c593cf5e20a381bf4306 /HACKING
parent975088262b16cecbea68d245c6c15d5093237b22 (diff)
downloadpentadactyl-5dbcd6f7e01c8596409519b887dc19e30c19290d.tar.gz
Add some rough source documentation for IO.
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING1
1 files changed, 1 insertions, 0 deletions
diff --git a/HACKING b/HACKING
index 758ab2c1..6ac51844 100644
--- a/HACKING
+++ b/HACKING
@@ -80,6 +80,7 @@ We try to be quite consistent, but of course, that's not always possible.
Right: if (HACK) // TODO: remove hack
Wrong: if (HACK) /* TODO: remove hack */
Documentation comment blocks use /** ... */
+ Wrap comment documentation comment lines at 80 characters.
* Only wrap lines if it makes the code obviously clearer. Lines longer than 132
characters should probably be broken up rather than wrapped anyway.