har0ke/FFmpeg
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

remove junk characters

Browse Source 
Originally committed as revision 4530 to svn://svn.ffmpeg.org/ffmpeg/trunk
This commit is contained in:
Måns Rullgård 2005-08-16 18:08:29 +00:00
parent a1043f9c50
commit 2185824b10
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
doc/ffmpeg-doc.texi
View File

@ -1033,30 +1033,30 @@ above them explaining what the function does, even if it's just one sentence.
All structures and their member variables should be documented, too. All structures and their member variables should be documented, too.
@example @example
/** /**
 * @@file mpeg.c * @@file mpeg.c
 * MPEG codec. * MPEG codec.
 * @@author ... * @@author ...
 */ */
/** /**
 * Summary sentence. * Summary sentence.
 * more text ... * more text ...
 * ... * ...
 */ */
typedef struct Foobar@{ typedef struct Foobar@{
    int var1; /**< var1 description */ int var1; /**< var1 description */
    int var2; ///< var2 description int var2; ///< var2 description
    /** var3 description */ /** var3 description */
    int var3; int var3;
@} Foobar; @} Foobar;
/** /**
 * Summary sentence. * Summary sentence.
 * more text ... * more text ...
 * ... * ...
 * @@param my_parameter description of my_parameter * @@param my_parameter description of my_parameter
 * @@return return value description * @@return return value description
 */ */
int myfunc(int my_parameter) int myfunc(int my_parameter)
... ...
@end example @end example