From 0e7fa1fe6837a46fad03e7fa9a3df0815364982d Mon Sep 17 00:00:00 2001 From: "Shawn O. Pearce" Date: Fri, 31 Oct 2008 12:30:04 -0700 Subject: [PATCH] Note that comments should be doxygen javadoc style Signed-off-by: Shawn O. Pearce --- CONVENTIONS | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONVENTIONS b/CONVENTIONS index 7e78a9c8d..60811b0ba 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 -------------------- -- 2.39.2