better explain where and how to use doxygen comments

patch by Oded Shimon <ods15 at ods15 dot dyndns dot org>


git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@14900 b3059339-0415-0410-9bf9-f77b7e298cf2

DOCS/tech/code-documentation.txt

@@ -87,6 +87,16 @@ too */
 
 /* 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>