aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMåns Rullgård <mans@mansr.com>2005-08-16 18:08:29 +0000
committerMåns Rullgård <mans@mansr.com>2005-08-16 18:08:29 +0000
commit2185824b1082e449587dfab5c649bd4f687c7e22 (patch)
treed4da827b3e9eda273a73bb772a1e216223ca6d24
parenta1043f9c50a07de5e9eee9e3b012e5a181eb5733 (diff)
downloadffmpeg-2185824b1082e449587dfab5c649bd4f687c7e22.tar.gz
remove junk characters
Originally committed as revision 4530 to svn://svn.ffmpeg.org/ffmpeg/trunk
-rw-r--r--doc/ffmpeg-doc.texi36
1 files changed, 18 insertions, 18 deletions
diff --git a/doc/ffmpeg-doc.texi b/doc/ffmpeg-doc.texi
index 8101ff927b..208889f40f 100644
--- a/doc/ffmpeg-doc.texi
+++ b/doc/ffmpeg-doc.texi
@@ -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