Mercurial > mplayer.hg
diff DOCS/tech/code-documentation.txt @ 14899:335964188675
better explain where and how to use doxygen comments
patch by Oded Shimon <ods15 at ods15 dot dyndns dot org>
| author | diego |
|---|---|
| date | Thu, 03 Mar 2005 12:14:08 +0000 |
| parents | 05d3254e05b1 |
| children | e438a5af7771 |
line wrap: on
line diff
--- 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>