# HG changeset patch
# User diego
# Date 1109852048 0
# Node ID 335964188675c742f391003d61a4a448428ddd97
# Parent  57d00d7a918282821f93fecfa67ed1aa37a3879a
better explain where and how to use doxygen comments
patch by Oded Shimon <ods15 at ods15 dot dyndns dot org>

diff -r 57d00d7a9182 -r 335964188675 DOCS/tech/code-documentation.txt
--- a/DOCS/tech/code-documentation.txt	Thu Mar 03 11:29:33 2005 +0000
+++ b/DOCS/tech/code-documentation.txt	Thu Mar 03 12:14:08 2005 +0000
@@ -87,6 +87,16 @@
 
 /* Neither is this. */
 
+Doxygen comments should come before the definition:
+
+/** description */
+int a_variable;
+
+However, you can use '<' to describe things AFTER they are defined, like this:
+
+int some_var; ///< description
+#define foo(x) (x + 2) /**< returns x plus 2 */
+
 There are a couple of special tags for doxygen:
 
 \brief <one line text>