Commit 2185824b authored by Måns Rullgård's avatar Måns Rullgård

remove junk characters

Originally committed as revision 4530 to svn://svn.ffmpeg.org/ffmpeg/trunk
parent a1043f9c
......@@ -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.
@example
/**
 * @@file mpeg.c
 * MPEG codec.
 * @@author ...
 */
* @@file mpeg.c
* MPEG codec.
* @@author ...
*/
/**
 * Summary sentence.
 * more text ...
 * ...
 */
* Summary sentence.
* more text ...
* ...
*/
typedef struct Foobar@{
    int var1; /**< var1 description */
    int var2; ///< var2 description
    /** var3 description */
    int var3;
int var1; /**< var1 description */
int var2; ///< var2 description
/** var3 description */
int var3;
@} Foobar;
/**
 * Summary sentence.
 * more text ...
 * ...
 * @@param my_parameter description of my_parameter
 * @@return return value description
 */
* Summary sentence.
* more text ...
* ...
* @@param my_parameter description of my_parameter
* @@return return value description
*/
int myfunc(int my_parameter)
...
@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