Commit 0e7fa1fe6837a46fad03e7fa9a3df0815364982d

Shawn O. Pearce 2008-10-31T12:30:04

Note that comments should be doxygen javadoc style Signed-off-by: Shawn O. Pearce <spearce@spearce.org>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
diff --git a/CONVENTIONS b/CONVENTIONS
index 7e78a9c..60811b0 100644
--- a/CONVENTIONS
+++ b/CONVENTIONS
@@ -50,6 +50,12 @@ error.  This permits common POSIX result testing:
 ----
 
 
+Documentation Fomatting
+-----------------------
+
+All comments should conform to Doxygen "javadoc" style conventions
+for formatting the public API documentation.
+
 
 Public Header Format
 --------------------