From 9a58234feaae8b387b7a7e41b643ec619534d26a Mon Sep 17 00:00:00 2001 From: Diego Biurrun Date: Fri, 2 Jul 2010 10:49:29 +0000 Subject: Fix misspelled parameter names in Doxygen documentation. This fixes one Doxygen warning each. Originally committed as revision 23970 to svn://svn.ffmpeg.org/ffmpeg/trunk --- libavcodec/atrac3.c | 4 ++-- libavcodec/cook.c | 6 +++--- libavcodec/elbg.c | 2 +- libavcodec/lzw.c | 4 ++-- libavcodec/mpegvideo.c | 2 +- libavcodec/mpegvideo_common.h | 4 ++-- libavcodec/rl2.c | 2 +- libavcodec/rle.h | 2 +- libavfilter/avfilter.h | 2 +- libavfilter/avfiltergraph.h | 2 +- libavformat/avformat.h | 2 +- libavformat/gxf.c | 2 +- libavformat/rtmppkt.h | 2 +- libavformat/rtpproto.c | 8 ++++---- libavformat/udp.c | 4 ++-- libavutil/pixdesc.h | 4 ++-- 16 files changed, 26 insertions(+), 26 deletions(-) diff --git a/libavcodec/atrac3.c b/libavcodec/atrac3.c index 5179c345cf..150f20171c 100644 --- a/libavcodec/atrac3.c +++ b/libavcodec/atrac3.c @@ -166,9 +166,9 @@ static void IMLT(float *pInput, float *pOutput, int odd_band) /** * Atrac 3 indata descrambling, only used for data coming from the rm container * - * @param in pointer to 8 bit array of indata - * @param bits amount of bits + * @param inbuffer pointer to 8 bit array of indata * @param out pointer to 8 bit array of outdata + * @param bytes amount of bytes */ static int decode_bytes(const uint8_t* inbuffer, uint8_t* out, int bytes){ diff --git a/libavcodec/cook.c b/libavcodec/cook.c index e406e6510e..b6f6f4a0c1 100644 --- a/libavcodec/cook.c +++ b/libavcodec/cook.c @@ -708,7 +708,7 @@ static void interpolate_float(COOKContext *q, float* buffer, * Apply transform window, overlap buffers. * * @param q pointer to the COOKContext - * @param inbuffer pointer to the mltcoefficients + * @param buffer1 pointer to the mltcoefficients * @param gains_ptr current and previous gains * @param previous_buffer pointer to the previous buffer to be used for overlapping */ @@ -877,7 +877,7 @@ static void joint_decode(COOKContext *q, COOKSubpacket *p, float* mlt_buffer1, * * @param q pointer to the COOKContext * @param inbuffer pointer to raw stream data - * @param gain_ptr array of current/prev gain pointers + * @param gains_ptr array of current/prev gain pointers */ static inline void @@ -923,7 +923,7 @@ saturate_output_float (COOKContext *q, int chan, int16_t *out) * * @param q pointer to the COOKContext * @param decode_buffer pointer to the mlt coefficients - * @param gain_ptr array of current/prev gain pointers + * @param gains array of current/prev gain pointers * @param previous_buffer pointer to the previous buffer to be used for overlapping * @param out pointer to the output buffer * @param chan 0: left or single channel, 1: right channel diff --git a/libavcodec/elbg.c b/libavcodec/elbg.c index 175d2c698e..ede863e9be 100644 --- a/libavcodec/elbg.c +++ b/libavcodec/elbg.c @@ -249,7 +249,7 @@ static void update_utility_and_n_cb(elbg_data *elbg, int idx, int newutility) * and update elbg->error, elbg->utility and elbg->nearest_cb. * * @param elbg Internal elbg data - * @param indexes {luc (low utility cell, huc (high utility cell), cluc (closest cell to low utility cell)} + * @param idx {luc (low utility cell, huc (high utility cell), cluc (closest cell to low utility cell)} */ static void try_shift_candidate(elbg_data *elbg, int idx[3]) { diff --git a/libavcodec/lzw.c b/libavcodec/lzw.c index 8043789d56..aa886910be 100644 --- a/libavcodec/lzw.c +++ b/libavcodec/lzw.c @@ -121,7 +121,7 @@ av_cold void ff_lzw_decode_close(LZWState **p) /** * Initialize LZW decoder - * @param s LZW context + * @param p LZW context * @param csize initial code size in bits * @param buf input data * @param buf_size input data size @@ -161,7 +161,7 @@ int ff_lzw_decode_init(LZWState *p, int csize, const uint8_t *buf, int buf_size, * NOTE: the algorithm here is inspired from the LZW GIF decoder * written by Steven A. Bennett in 1987. * - * @param s LZW context + * @param p LZW context * @param buf output buffer * @param len number of bytes to decode * @return number of bytes decoded diff --git a/libavcodec/mpegvideo.c b/libavcodec/mpegvideo.c index 8699f82638..a6ccd69e1d 100644 --- a/libavcodec/mpegvideo.c +++ b/libavcodec/mpegvideo.c @@ -1650,7 +1650,7 @@ static inline void chroma_4mv_motion_lowres(MpegEncContext *s, * @param dest_cr chroma cr/v destination pointer * @param dir direction (0->forward, 1->backward) * @param ref_picture array[3] of pointers to the 3 planes of the reference picture - * @param pic_op halfpel motion compensation function (average or put normally) + * @param pix_op halfpel motion compensation function (average or put normally) * the motion vectors are taken from s->mv and the MV type from s->mv_type */ static inline void MPV_motion_lowres(MpegEncContext *s, diff --git a/libavcodec/mpegvideo_common.h b/libavcodec/mpegvideo_common.h index 25ecd94a7f..8e46e692f9 100644 --- a/libavcodec/mpegvideo_common.h +++ b/libavcodec/mpegvideo_common.h @@ -631,8 +631,8 @@ static inline void prefetch_motion(MpegEncContext *s, uint8_t **pix, int dir){ * @param dest_cr chroma cr/v destination pointer * @param dir direction (0->forward, 1->backward) * @param ref_picture array[3] of pointers to the 3 planes of the reference picture - * @param pic_op halfpel motion compensation function (average or put normally) - * @param pic_op qpel motion compensation function (average or put normally) + * @param pix_op halfpel motion compensation function (average or put normally) + * @param qpix_op qpel motion compensation function (average or put normally) * the motion vectors are taken from s->mv and the MV type from s->mv_type */ static av_always_inline void MPV_motion_internal(MpegEncContext *s, diff --git a/libavcodec/rl2.c b/libavcodec/rl2.c index 30f5e839cc..1174c35d51 100644 --- a/libavcodec/rl2.c +++ b/libavcodec/rl2.c @@ -50,7 +50,7 @@ typedef struct Rl2Context { /** * Run Length Decode a single 320x200 frame * @param s rl2 context - * @param buf input buffer + * @param in input buffer * @param size input buffer size * @param out ouput buffer * @param stride stride of the output buffer diff --git a/libavcodec/rle.h b/libavcodec/rle.h index f892443266..24851321fe 100644 --- a/libavcodec/rle.h +++ b/libavcodec/rle.h @@ -28,7 +28,7 @@ * Value before raw bytes is (count ^ xor_raw) + add_raw. * @param outbuf Output buffer * @param out_size Maximum output size - * @param ptr Input buffer + * @param inbuf Input buffer * @param bpp Bytes per pixel * @param w Image width * @return Size of output in bytes, or -1 if larger than out_size diff --git a/libavfilter/avfilter.h b/libavfilter/avfilter.h index 7b473ad9b5..f8b765458d 100644 --- a/libavfilter/avfilter.h +++ b/libavfilter/avfilter.h @@ -190,7 +190,7 @@ struct AVFilterFormats /** * Create a list of supported formats. This is intended for use in * AVFilter->query_formats(). - * @param pix_fmt list of pixel formats, terminated by PIX_FMT_NONE + * @param pix_fmts list of pixel formats, terminated by PIX_FMT_NONE * @return the format list, with no existing references */ AVFilterFormats *avfilter_make_format_list(const enum PixelFormat *pix_fmts); diff --git a/libavfilter/avfiltergraph.h b/libavfilter/avfiltergraph.h index 5a0bbf7ea7..23fc57c311 100644 --- a/libavfilter/avfiltergraph.h +++ b/libavfilter/avfiltergraph.h @@ -42,7 +42,7 @@ AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, char *name); /** * Add an existing filter instance to a filter graph. * - * @param graph the filter graph + * @param graphctx the filter graph * @param filter the filter to be added */ int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter); diff --git a/libavformat/avformat.h b/libavformat/avformat.h index 49397cecce..828bb973a7 100644 --- a/libavformat/avformat.h +++ b/libavformat/avformat.h @@ -1259,7 +1259,7 @@ int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt); * * @param s media file handle * @param out the interleaved packet will be output here - * @param in the input packet + * @param pkt the input packet * @param flush 1 if no further packets are available as input and all * remaining packets should be output * @return 1 if a packet was output, 0 if no packet could be output, diff --git a/libavformat/gxf.c b/libavformat/gxf.c index 3798bb7e89..99d39e4207 100644 --- a/libavformat/gxf.c +++ b/libavformat/gxf.c @@ -71,7 +71,7 @@ static int gxf_probe(AVProbeData *p) { /** * \brief gets the stream index for the track with the specified id, creates new * stream if not found - * \param stream id of stream to find / add + * \param id id of stream to find / add * \param format stream format identifier */ static int get_sindex(AVFormatContext *s, int id, int format) { diff --git a/libavformat/rtmppkt.h b/libavformat/rtmppkt.h index 37e989101d..431095d399 100644 --- a/libavformat/rtmppkt.h +++ b/libavformat/rtmppkt.h @@ -131,7 +131,7 @@ int ff_rtmp_packet_write(URLContext *h, RTMPPacket *p, /** * Print information and contents of RTMP packet. * - * @param h output context + * @param ctx output context * @param p packet to dump */ void ff_rtmp_packet_dump(void *ctx, RTMPPacket *p); diff --git a/libavformat/rtpproto.c b/libavformat/rtpproto.c index 1875424a73..46511bab60 100644 --- a/libavformat/rtpproto.c +++ b/libavformat/rtpproto.c @@ -52,7 +52,7 @@ typedef struct RTPContext { * get the local port first, then you must call this function to set * the remote server address. * - * @param s1 media file context + * @param h media file context * @param uri of the remote server * @return zero if no error. */ @@ -317,7 +317,7 @@ static int rtp_close(URLContext *h) /** * Return the local rtp port used by the RTP connection - * @param s1 media file context + * @param h media file context * @return the local port number */ @@ -329,7 +329,7 @@ int rtp_get_local_rtp_port(URLContext *h) /** * Return the local rtp port used by the RTP connection - * @param s1 media file context + * @param h media file context * @return the local port number */ @@ -341,7 +341,7 @@ int rtp_get_local_port(URLContext *h) /** * Return the local rtcp port used by the RTP connection - * @param s1 media file context + * @param h media file context * @return the local port number */ diff --git a/libavformat/udp.c b/libavformat/udp.c index 227c0d0bee..6bd5c9c395 100644 --- a/libavformat/udp.c +++ b/libavformat/udp.c @@ -256,7 +256,7 @@ static int udp_port(struct sockaddr_storage *addr, int addr_len) * 'pkt_size=n' : set max packet size * 'reuse=1' : enable reusing the socket * - * @param s1 media file context + * @param h media file context * @param uri of the remote server * @return zero if no error. */ @@ -280,7 +280,7 @@ int udp_set_remote_url(URLContext *h, const char *uri) /** * Return the local port used by the UDP connection - * @param s1 media file context + * @param h media file context * @return the local port number */ int udp_get_local_port(URLContext *h) diff --git a/libavutil/pixdesc.h b/libavutil/pixdesc.h index 60ff4b8f80..a13d16c563 100644 --- a/libavutil/pixdesc.h +++ b/libavutil/pixdesc.h @@ -97,7 +97,7 @@ extern const AVPixFmtDescriptor av_pix_fmt_descriptors[]; * pixel format component c to dst. * * @param data the array containing the pointers to the planes of the image - * @param linesizes the array containing the linesizes of the image + * @param linesize the array containing the linesizes of the image * @param desc the pixel format descriptor for the image * @param x the horizontal coordinate of the first pixel to read * @param y the vertical coordinate of the first pixel to read @@ -118,7 +118,7 @@ void read_line(uint16_t *dst, const uint8_t *data[4], const int linesize[4], * @param src array containing the values to write * @param data the array containing the pointers to the planes of the * image to write into. It is supposed to be zeroed. - * @param linesizes the array containing the linesizes of the image + * @param linesize the array containing the linesizes of the image * @param desc the pixel format descriptor for the image * @param x the horizontal coordinate of the first pixel to write * @param y the vertical coordinate of the first pixel to write -- cgit v1.2.3