From 5dbcd6f7e01c8596409519b887dc19e30c19290d Mon Sep 17 00:00:00 2001 From: Doug Kearns Date: Sun, 11 Jan 2009 01:12:30 +1100 Subject: Add some rough source documentation for IO. --- HACKING | 1 + 1 file changed, 1 insertion(+) (limited to 'HACKING') 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. -- cgit v1.2.3