Note that comments should be doxygen javadoc style

Signed-off-by: Shawn O. Pearce <spearce@spearce.org>

Note that comments should be doxygen javadoc style
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
0e7fa1fe · Shawn O. Pearce · 13ce9f1b · 0e7fa1fe
Commit 0e7fa1fe authored Oct 31, 2008 by Shawn O. Pearce
Hide whitespace changes
Inline Side-by-side

Showing with 6 additions and 0 deletions

CONVENTIONS
+6 -0

No files found.
--- 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
 --------------------