From 9dd352a5c007198c997f354487590b9d34a48dd0 Mon Sep 17 00:00:00 2001
From: diego <diego@b3059339-0415-0410-9bf9-f77b7e298cf2>
Date: Thu, 3 Mar 2005 12:14:08 +0000
Subject: 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 | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'DOCS/tech/code-documentation.txt')

diff --git a/DOCS/tech/code-documentation.txt b/DOCS/tech/code-documentation.txt
index da2f47d763..da16b2a81c 100644
--- a/DOCS/tech/code-documentation.txt
+++ b/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>
-- 
cgit v1.2.3