Remove angular brackets from Doxygen comments; Doxygen confuses them for HTML.
authorDiego Biurrun <diego@biurrun.de>
Fri, 2 Jul 2010 12:48:32 +0000 (12:48 +0000)
committerDiego Biurrun <diego@biurrun.de>
Fri, 2 Jul 2010 12:48:32 +0000 (12:48 +0000)
Originally committed as revision 23991 to svn://svn.ffmpeg.org/ffmpeg/trunk

cmdutils.h
libavcodec/avcodec.h
libavcodec/fraps.c
libavformat/rdt.c
libavformat/rdt.h

index 1dfe68e..d48abab 100644 (file)
@@ -124,7 +124,7 @@ void show_help_options(const OptionDef *options, const char *msg, int mask, int
 /**
  * Parse the command line arguments.
  * @param options Array with the definitions required to interpret every
 /**
  * Parse the command line arguments.
  * @param options Array with the definitions required to interpret every
- * option of the form: -<option_name> [<argument>]
+ * option of the form: -option_name [argument]
  * @param parse_arg_function Name of the function called to process every
  * argument without a leading option name flag. NULL if such arguments do
  * not have to be processed.
  * @param parse_arg_function Name of the function called to process every
  * argument without a leading option name flag. NULL if such arguments do
  * not have to be processed.
index 8727c60..b99b94d 100644 (file)
@@ -3913,7 +3913,7 @@ unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
  *
  * @return 0 in case of a successful parsing, a negative value otherwise
  * @param[in] str the string to parse: it has to be a string in the format
  *
  * @return 0 in case of a successful parsing, a negative value otherwise
  * @param[in] str the string to parse: it has to be a string in the format
- * <width>x<height> or a valid video frame size abbreviation.
+ * width x height or a valid video frame size abbreviation.
  * @param[in,out] width_ptr pointer to the variable which will contain the detected
  * frame width value
  * @param[in,out] height_ptr pointer to the variable which will contain the detected
  * @param[in,out] width_ptr pointer to the variable which will contain the detected
  * frame width value
  * @param[in,out] height_ptr pointer to the variable which will contain the detected
@@ -3926,7 +3926,7 @@ int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
  *
  * @return 0 in case of a successful parsing, a negative value otherwise
  * @param[in] str the string to parse: it has to be a string in the format
  *
  * @return 0 in case of a successful parsing, a negative value otherwise
  * @param[in] str the string to parse: it has to be a string in the format
- * <frame_rate_num>/<frame_rate_den>, a float number or a valid video rate abbreviation
+ * frame_rate_num / frame_rate_den, a float number or a valid video rate abbreviation
  * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
  * frame rate
  */
  * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
  * frame rate
  */
index 3cb5cca..b66dc6c 100644 (file)
@@ -23,7 +23,7 @@
 /**
  * @file
  * Lossless Fraps 'FPS1' decoder
 /**
  * @file
  * Lossless Fraps 'FPS1' decoder
- * @author Roine Gustafsson <roine at users sf net>
+ * @author Roine Gustafsson (roine at users sf net)
  * @author Konstantin Shishkov
  *
  * Codec algorithm for version 0 is taken from Transcode <www.transcoding.org>
  * @author Konstantin Shishkov
  *
  * Codec algorithm for version 0 is taken from Transcode <www.transcoding.org>
index 7dda3f3..284665e 100644 (file)
@@ -140,14 +140,14 @@ rdt_load_mdpr (PayloadContext *rdt, AVStream *st, int rule_nr)
 
     /**
      * Layout of the MLTI chunk:
 
     /**
      * Layout of the MLTI chunk:
-     * 4:MLTI
-     * 2:<number of streams>
+     * 4: MLTI
+     * 2: number of streams
      * Then for each stream ([number_of_streams] times):
      * Then for each stream ([number_of_streams] times):
-     *     2:<mdpr index>
-     * 2:<number of mdpr chunks>
+     *     2: mdpr index
+     * 2: number of mdpr chunks
      * Then for each mdpr chunk ([number_of_mdpr_chunks] times):
      * Then for each mdpr chunk ([number_of_mdpr_chunks] times):
-     *     4:<size>
-     *     [size]:<data>
+     *     4: size
+     *     [size]: data
      * we skip MDPR chunks until we reach the one of the stream
      * we're interested in, and forward that ([size]+[data]) to
      * the RM demuxer to parse the stream-specific header data.
      * we skip MDPR chunks until we reach the one of the stream
      * we're interested in, and forward that ([size]+[data]) to
      * the RM demuxer to parse the stream-specific header data.
index 1592c2f..8117989 100644 (file)
@@ -85,7 +85,7 @@ void ff_rdt_subscribe_rule(char *cmd, int size,
  * @param stream_id will be set to the stream ID this packet belongs to
  * @param is_keyframe will be whether this packet belongs to a keyframe
  * @param timestamp will be set to the timestamp of the packet
  * @param stream_id will be set to the stream ID this packet belongs to
  * @param is_keyframe will be whether this packet belongs to a keyframe
  * @param timestamp will be set to the timestamp of the packet
- * @return the amount of bytes consumed, or <0 on error
+ * @return the amount of bytes consumed, or negative on error
  */
 int ff_rdt_parse_header(const uint8_t *buf, int len,
                         int *set_id, int *seq_no, int *stream_id,
  */
 int ff_rdt_parse_header(const uint8_t *buf, int len,
                         int *set_id, int *seq_no, int *stream_id,