Commit c3fbe657 authored by diego's avatar diego

Syntax errors fixed.


git-svn-id: file:///var/local/repositories/ffmpeg/trunk@3773 9553f0bf-9b14-0410-a0b8-cfaf0461ba5b
parent 1c942d0b
...@@ -981,7 +981,7 @@ the @samp{inline} keyword; ...@@ -981,7 +981,7 @@ the @samp{inline} keyword;
@item @item
designated struct initializers (@samp{struct s x = @{ .i = 17 @};}) designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
@item @item
compound literals (@samp{x = (struct s) { 17, 23 @};}) compound literals (@samp{x = (struct s) @{ 17, 23 @};})
@end itemize @end itemize
These features are supported by all compilers we care about, so we won't These features are supported by all compilers we care about, so we won't
...@@ -1017,9 +1017,9 @@ above it explaining what the function does, even if its just one sentance. ...@@ -1017,9 +1017,9 @@ above it explaining what the function does, even if its just one sentance.
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 ...
 */  */
/** /**
...@@ -1027,19 +1027,19 @@ All Structures and their member variables should be documented too. ...@@ -1027,19 +1027,19 @@ All Structures and their member variables should be documented too.
 * 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 sentance.  * Summary sentance.
 * 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)
... ...
...@@ -1091,7 +1091,7 @@ please use av_log() instead. ...@@ -1091,7 +1091,7 @@ please use av_log() instead.
indentation changes (try to avoid this), separate them strictly from real indentation changes (try to avoid this), separate them strictly from real
changes. changes.
NOTE: If you had to put if(){ .. } over a large (> 5 lines) chunk of code, NOTE: If you had to put if()@{ .. @} over a large (> 5 lines) chunk of code,
then either do NOT change the indentation of the inner part within (don't then either do NOT change the indentation of the inner part within (don't
move it to the right)! or do so in a seperate commit move it to the right)! or do so in a seperate commit
@item @item
...@@ -1124,7 +1124,7 @@ please use av_log() instead. ...@@ -1124,7 +1124,7 @@ please use av_log() instead.
Never revert changes made a long time ago or buggy code. Fix it in the Never revert changes made a long time ago or buggy code. Fix it in the
normal way instead. normal way instead.
@end itemize @end enumerate
We think our rules are not too hard. If you have comments, contact us. We think our rules are not too hard. If you have comments, contact us.
......
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