Note that comments should be doxygen javadoc style

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

diff --git a/CONVENTIONS b/CONVENTIONS
index 7e78a9c8d5aba74a0c85d77ef590a9a9a6426bbb..60811b0baebdec5b8663134d8b754b912039b6c4 100644 (file)
--- 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
 --------------------