doxygen: Remove documentation for non-existing parameters; misc small fixes.
authorDiego Biurrun <diego@biurrun.de>
Tue, 21 Feb 2012 22:33:01 +0000 (23:33 +0100)
committerDiego Biurrun <diego@biurrun.de>
Tue, 28 Feb 2012 19:48:43 +0000 (20:48 +0100)
libavcodec/aacdec.c
libavcodec/wmaprodec.c
libavcodec/wmavoice.c
libavdevice/x11grab.c
libavformat/mov_chan.h
libavformat/mpegts.h
libavformat/rl2.c
libavutil/avutil.h

index 186de96..811ec0b 100644 (file)
@@ -399,8 +399,6 @@ static uint64_t sniff_channel_order(uint8_t (*layout_map)[3], int tags)
 /**
  * Configure output channel order based on the current program configuration element.
  *
- * @param   che_pos current channel position configuration
- *
  * @return  Returns error status. 0 - OK, !0 - error
  */
 static av_cold int output_configure(AACContext *ac,
@@ -442,8 +440,6 @@ static av_cold int output_configure(AACContext *ac,
 /**
  * Decode an array of 4 bit element IDs, optionally interleaved with a stereo/mono switching bit.
  *
- * @param cpe_map Stereo (Channel Pair Element) map, NULL if stereo bit is not present.
- * @param sce_map mono (Single Channel Element) map
  * @param type speaker type/position for these channels
  */
 static void decode_channel_map(uint8_t layout_map[][3],
index 444e8a5..2b9f4a5 100644 (file)
@@ -1481,7 +1481,6 @@ static void save_bits(WMAProDecodeCtx *s, GetBitContext* gb, int len,
  *@brief Decode a single WMA packet.
  *@param avctx codec context
  *@param data the output buffer
- *@param data_size number of bytes that were written to the output buffer
  *@param avpkt input packet
  *@return number of bytes that were read from the input buffer
  */
index 8854e35..9553089 100644 (file)
@@ -1725,9 +1725,6 @@ static int check_bits_for_superframe(GetBitContext *orig_gb,
  * (if less than 480), usually used to prevent blanks at track boundaries.
  *
  * @param ctx WMA Voice decoder context
- * @param samples pointer to output buffer for voice samples
- * @param data_size pointer containing the size of #samples on input, and the
- *                  amount of #samples filled on output
  * @return 0 on success, <0 on error or 1 if there was not enough data to
  *         fully parse the superframe
  */
index bf3011b..305fda6 100644 (file)
@@ -146,7 +146,6 @@ x11grab_region_win_init(struct x11_grab *s)
  * Initialize the x11 grab device demuxer (public device demuxer API).
  *
  * @param s1 Context from avformat core
- * @param ap Parameters from avformat core
  * @return <ul>
  *          <li>AVERROR(ENOMEM) no memory left</li>
  *          <li>AVERROR(EIO) other failure case</li>
index abb6916..bd6adf6 100644 (file)
@@ -40,9 +40,9 @@
 uint64_t ff_mov_get_channel_layout(uint32_t tag, uint32_t bitmap);
 
 /**
- * Get the channel layout for the specified channel layout tag.
+ * Get the channel layout for the specified channel label.
  *
- * @param[in]  tag     channel label
+ * @param[in]  label   channel label
  * @return             channel layout mask fragment
  */
 uint32_t ff_mov_get_channel_label(uint32_t label);
index e38f2e0..9f2ba3f 100644 (file)
@@ -96,10 +96,6 @@ typedef struct {
  * @param stream_type               STREAM_TYPE_xxx
  * @param pp                        Descriptor buffer pointer
  * @param desc_list_end             End of buffer
- * @param mp4_dec_config_descr_len  Length of 'mp4_dec_config_descr', or zero if not present
- * @param mp4_es_id
- * @param pid
- * @param mp4_dec_config_descr
  * @return <0 to stop processing
  */
 int ff_parse_mpeg2_descriptor(AVFormatContext *fc, AVStream *st, int stream_type,
index bb0a961..d84b8b9 100644 (file)
@@ -69,7 +69,6 @@ static int rl2_probe(AVProbeData *p)
 /**
  * read rl2 header data and setup the avstreams
  * @param s demuxer context
- * @param ap format parameters
  * @return 0 on success, AVERROR otherwise
  */
 static av_cold int rl2_read_header(AVFormatContext *s)
index c9c7141..e4219eb 100644 (file)
@@ -31,7 +31,7 @@
  *
  * @section libav_intro Introduction
  *
- * This document describe the usage of the different libraries
+ * This document describes the usage of the different libraries
  * provided by Libav.
  *
  * @li @ref libavc "libavcodec" encoding/decoding library
@@ -40,7 +40,6 @@
  * @li @ref lavd "libavdevice" special devices muxing/demuxing library
  * @li @ref lavu "libavutil" common utility library
  * @li @subpage libswscale  color conversion and scaling library
- *
  */
 
 /**