RepoMirrors
/
mpv
mirror of https://github.com/mpv-player/mpv
1
0
Fork 0
Code Issues Releases Wiki Activity

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
This commit is contained in:
diego 2005-03-03 12:14:08 +00:00
parent 1e6d873366
commit 9dd352a5c0
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
DOCS/tech/code-documentation.txt
View File

@ -87,6 +87,16 @@ too */
/* Neither is this. */ /* 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: There are a couple of special tags for doxygen:
\brief <one line text> \brief <one line text>