1
0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2026-02-08 12:35:46 +01:00

Add some rough source documentation for IO.

This commit is contained in:
Doug Kearns
2009-01-11 01:12:30 +11:00
parent 975088262b
commit 5dbcd6f7e0
7 changed files with 325 additions and 143 deletions

View File

@@ -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.