[MPlayer-cvslog] CVS: main/DOCS/tech code-documentation.txt, 1.2, 1.3

[Diego Biurrun CVS]

CVS change done by Diego Biurrun CVS

Update of /cvsroot/mplayer/main/DOCS/tech
In directory mail:/var2/tmp/cvs-serv24425/DOCS/tech

Modified Files:
	code-documentation.txt 
Log Message:
better explain where and how to use doxygen comments
patch by Oded Shimon <ods15 at ods15 dot dyndns dot org>


Index: code-documentation.txt
===================================================================
RCS file: /cvsroot/mplayer/main/DOCS/tech/code-documentation.txt,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- code-documentation.txt	10 Sep 2004 10:15:50 -0000	1.2
+++ code-documentation.txt	3 Mar 2005 12:14:08 -0000	1.3
@@ -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>