Commit 9a58234f authored by Diego Biurrun's avatar Diego Biurrun

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
parent 5298b070
...@@ -166,9 +166,9 @@ static void IMLT(float *pInput, float *pOutput, int odd_band) ...@@ -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 * Atrac 3 indata descrambling, only used for data coming from the rm container
* *
* @param in pointer to 8 bit array of indata * @param inbuffer pointer to 8 bit array of indata
* @param bits amount of bits
* @param out pointer to 8 bit array of outdata * @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){ static int decode_bytes(const uint8_t* inbuffer, uint8_t* out, int bytes){
......
...@@ -708,7 +708,7 @@ static void interpolate_float(COOKContext *q, float* buffer, ...@@ -708,7 +708,7 @@ static void interpolate_float(COOKContext *q, float* buffer,
* Apply transform window, overlap buffers. * Apply transform window, overlap buffers.
* *
* @param q pointer to the COOKContext * @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 gains_ptr current and previous gains
* @param previous_buffer pointer to the previous buffer to be used for overlapping * @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, ...@@ -877,7 +877,7 @@ static void joint_decode(COOKContext *q, COOKSubpacket *p, float* mlt_buffer1,
* *
* @param q pointer to the COOKContext * @param q pointer to the COOKContext
* @param inbuffer pointer to raw stream data * @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 static inline void
...@@ -923,7 +923,7 @@ saturate_output_float (COOKContext *q, int chan, int16_t *out) ...@@ -923,7 +923,7 @@ saturate_output_float (COOKContext *q, int chan, int16_t *out)
* *
* @param q pointer to the COOKContext * @param q pointer to the COOKContext
* @param decode_buffer pointer to the mlt coefficients * @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 previous_buffer pointer to the previous buffer to be used for overlapping
* @param out pointer to the output buffer * @param out pointer to the output buffer
* @param chan 0: left or single channel, 1: right channel * @param chan 0: left or single channel, 1: right channel
......
...@@ -249,7 +249,7 @@ static void update_utility_and_n_cb(elbg_data *elbg, int idx, int newutility) ...@@ -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. * and update elbg->error, elbg->utility and elbg->nearest_cb.
* *
* @param elbg Internal elbg data * @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]) static void try_shift_candidate(elbg_data *elbg, int idx[3])
{ {
......
...@@ -121,7 +121,7 @@ av_cold void ff_lzw_decode_close(LZWState **p) ...@@ -121,7 +121,7 @@ av_cold void ff_lzw_decode_close(LZWState **p)
/** /**
* Initialize LZW decoder * Initialize LZW decoder
* @param s LZW context * @param p LZW context
* @param csize initial code size in bits * @param csize initial code size in bits
* @param buf input data * @param buf input data
* @param buf_size input data size * @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, ...@@ -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 * NOTE: the algorithm here is inspired from the LZW GIF decoder
* written by Steven A. Bennett in 1987. * written by Steven A. Bennett in 1987.
* *
* @param s LZW context * @param p LZW context
* @param buf output buffer * @param buf output buffer
* @param len number of bytes to decode * @param len number of bytes to decode
* @return number of bytes decoded * @return number of bytes decoded
......
...@@ -1650,7 +1650,7 @@ static inline void chroma_4mv_motion_lowres(MpegEncContext *s, ...@@ -1650,7 +1650,7 @@ static inline void chroma_4mv_motion_lowres(MpegEncContext *s,
* @param dest_cr chroma cr/v destination pointer * @param dest_cr chroma cr/v destination pointer
* @param dir direction (0->forward, 1->backward) * @param dir direction (0->forward, 1->backward)
* @param ref_picture array[3] of pointers to the 3 planes of the reference picture * @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 * the motion vectors are taken from s->mv and the MV type from s->mv_type
*/ */
static inline void MPV_motion_lowres(MpegEncContext *s, static inline void MPV_motion_lowres(MpegEncContext *s,
......
...@@ -631,8 +631,8 @@ static inline void prefetch_motion(MpegEncContext *s, uint8_t **pix, int dir){ ...@@ -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 dest_cr chroma cr/v destination pointer
* @param dir direction (0->forward, 1->backward) * @param dir direction (0->forward, 1->backward)
* @param ref_picture array[3] of pointers to the 3 planes of the reference picture * @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)
* @param pic_op qpel 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 * 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, static av_always_inline void MPV_motion_internal(MpegEncContext *s,
......
...@@ -50,7 +50,7 @@ typedef struct Rl2Context { ...@@ -50,7 +50,7 @@ typedef struct Rl2Context {
/** /**
* Run Length Decode a single 320x200 frame * Run Length Decode a single 320x200 frame
* @param s rl2 context * @param s rl2 context
* @param buf input buffer * @param in input buffer
* @param size input buffer size * @param size input buffer size
* @param out ouput buffer * @param out ouput buffer
* @param stride stride of the output buffer * @param stride stride of the output buffer
......
...@@ -28,7 +28,7 @@ ...@@ -28,7 +28,7 @@
* Value before raw bytes is (count ^ xor_raw) + add_raw. * Value before raw bytes is (count ^ xor_raw) + add_raw.
* @param outbuf Output buffer * @param outbuf Output buffer
* @param out_size Maximum output size * @param out_size Maximum output size
* @param ptr Input buffer * @param inbuf Input buffer
* @param bpp Bytes per pixel * @param bpp Bytes per pixel
* @param w Image width * @param w Image width
* @return Size of output in bytes, or -1 if larger than out_size * @return Size of output in bytes, or -1 if larger than out_size
......
...@@ -190,7 +190,7 @@ struct AVFilterFormats ...@@ -190,7 +190,7 @@ struct AVFilterFormats
/** /**
* Create a list of supported formats. This is intended for use in * Create a list of supported formats. This is intended for use in
* AVFilter->query_formats(). * 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 * @return the format list, with no existing references
*/ */
AVFilterFormats *avfilter_make_format_list(const enum PixelFormat *pix_fmts); AVFilterFormats *avfilter_make_format_list(const enum PixelFormat *pix_fmts);
......
...@@ -42,7 +42,7 @@ AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, char *name); ...@@ -42,7 +42,7 @@ AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, char *name);
/** /**
* Add an existing filter instance to a filter graph. * 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 * @param filter the filter to be added
*/ */
int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter); int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter);
......
...@@ -1259,7 +1259,7 @@ int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt); ...@@ -1259,7 +1259,7 @@ int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
* *
* @param s media file handle * @param s media file handle
* @param out the interleaved packet will be output here * @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 * @param flush 1 if no further packets are available as input and all
* remaining packets should be output * remaining packets should be output
* @return 1 if a packet was output, 0 if no packet could be output, * @return 1 if a packet was output, 0 if no packet could be output,
......
...@@ -71,7 +71,7 @@ static int gxf_probe(AVProbeData *p) { ...@@ -71,7 +71,7 @@ static int gxf_probe(AVProbeData *p) {
/** /**
* \brief gets the stream index for the track with the specified id, creates new * \brief gets the stream index for the track with the specified id, creates new
* stream if not found * 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 * \param format stream format identifier
*/ */
static int get_sindex(AVFormatContext *s, int id, int format) { static int get_sindex(AVFormatContext *s, int id, int format) {
......
...@@ -131,7 +131,7 @@ int ff_rtmp_packet_write(URLContext *h, RTMPPacket *p, ...@@ -131,7 +131,7 @@ int ff_rtmp_packet_write(URLContext *h, RTMPPacket *p,
/** /**
* Print information and contents of RTMP packet. * Print information and contents of RTMP packet.
* *
* @param h output context * @param ctx output context
* @param p packet to dump * @param p packet to dump
*/ */
void ff_rtmp_packet_dump(void *ctx, RTMPPacket *p); void ff_rtmp_packet_dump(void *ctx, RTMPPacket *p);
......
...@@ -52,7 +52,7 @@ typedef struct RTPContext { ...@@ -52,7 +52,7 @@ typedef struct RTPContext {
* get the local port first, then you must call this function to set * get the local port first, then you must call this function to set
* the remote server address. * the remote server address.
* *
* @param s1 media file context * @param h media file context
* @param uri of the remote server * @param uri of the remote server
* @return zero if no error. * @return zero if no error.
*/ */
...@@ -317,7 +317,7 @@ static int rtp_close(URLContext *h) ...@@ -317,7 +317,7 @@ static int rtp_close(URLContext *h)
/** /**
* Return the local rtp port used by the RTP connection * 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 * @return the local port number
*/ */
...@@ -329,7 +329,7 @@ int rtp_get_local_rtp_port(URLContext *h) ...@@ -329,7 +329,7 @@ int rtp_get_local_rtp_port(URLContext *h)
/** /**
* Return the local rtp port used by the RTP connection * 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 * @return the local port number
*/ */
...@@ -341,7 +341,7 @@ int rtp_get_local_port(URLContext *h) ...@@ -341,7 +341,7 @@ int rtp_get_local_port(URLContext *h)
/** /**
* Return the local rtcp port used by the RTP connection * 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 * @return the local port number
*/ */
......
...@@ -256,7 +256,7 @@ static int udp_port(struct sockaddr_storage *addr, int addr_len) ...@@ -256,7 +256,7 @@ static int udp_port(struct sockaddr_storage *addr, int addr_len)
* 'pkt_size=n' : set max packet size * 'pkt_size=n' : set max packet size
* 'reuse=1' : enable reusing the socket * 'reuse=1' : enable reusing the socket
* *
* @param s1 media file context * @param h media file context
* @param uri of the remote server * @param uri of the remote server
* @return zero if no error. * @return zero if no error.
*/ */
...@@ -280,7 +280,7 @@ int udp_set_remote_url(URLContext *h, const char *uri) ...@@ -280,7 +280,7 @@ int udp_set_remote_url(URLContext *h, const char *uri)
/** /**
* Return the local port used by the UDP connection * Return the local port used by the UDP connection
* @param s1 media file context * @param h media file context
* @return the local port number * @return the local port number
*/ */
int udp_get_local_port(URLContext *h) int udp_get_local_port(URLContext *h)
......
...@@ -97,7 +97,7 @@ extern const AVPixFmtDescriptor av_pix_fmt_descriptors[]; ...@@ -97,7 +97,7 @@ extern const AVPixFmtDescriptor av_pix_fmt_descriptors[];
* pixel format component c to dst. * pixel format component c to dst.
* *
* @param data the array containing the pointers to the planes of the image * @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 desc the pixel format descriptor for the image
* @param x the horizontal coordinate of the first pixel to read * @param x the horizontal coordinate of the first pixel to read
* @param y the vertical 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], ...@@ -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 src array containing the values to write
* @param data the array containing the pointers to the planes of the * @param data the array containing the pointers to the planes of the
* image to write into. It is supposed to be zeroed. * 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 desc the pixel format descriptor for the image
* @param x the horizontal coordinate of the first pixel to write * @param x the horizontal coordinate of the first pixel to write
* @param y the vertical coordinate of the first pixel to write * @param y the vertical coordinate of the first pixel to write
......
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