diff options
author | Doug Kearns <dougkearns@gmail.com> | 2009-01-11 01:12:30 +1100 |
---|---|---|
committer | Doug Kearns <dougkearns@gmail.com> | 2009-01-11 01:12:30 +1100 |
commit | 5dbcd6f7e01c8596409519b887dc19e30c19290d (patch) | |
tree | 90f0fd171031a1a20603c593cf5e20a381bf4306 /HACKING | |
parent | 975088262b16cecbea68d245c6c15d5093237b22 (diff) | |
download | pentadactyl-5dbcd6f7e01c8596409519b887dc19e30c19290d.tar.gz |
Add some rough source documentation for IO.
Diffstat (limited to 'HACKING')
-rw-r--r-- | HACKING | 1 |
1 files changed, 1 insertions, 0 deletions
@@ -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. |