Skip to content

F
ffmpeg-mt
Commit 2d24c71f authored by mru's avatar mru
Browse files
Options

remove junk characters 


git-svn-id: file:///var/local/repositories/ffmpeg/trunk@4530 9553f0bf-9b14-0410-a0b8-cfaf0461ba5b
parent 138fadff
Show whitespace changes
Inline Side-by-side
Showing with 18 additions and 18 deletions
doc/ffmpeg-doc.texi
View file @ 2d24c71f
...@@ -1033,30 +1033,30 @@ above them explaining what the function does, even if it's just one sentence. ...@@ -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
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment