Commit 4a7d3837 authored by Diego Biurrun's avatar Diego Biurrun

buffersrc: Have function parameter names match between .c and .h file

This fixes two related Doxygen warnings.  Also document one parameter.
parent 25a1ba81
...@@ -29,8 +29,9 @@ ...@@ -29,8 +29,9 @@
#if FF_API_AVFILTERBUFFER #if FF_API_AVFILTERBUFFER
/** /**
* Add a buffer to the filtergraph s. * Add a buffer to a filtergraph.
* *
* @param ctx an instance of the buffersrc filter
* @param buf buffer containing frame data to be passed down the filtergraph. * @param buf buffer containing frame data to be passed down the filtergraph.
* This function will take ownership of buf, the user must not free it. * This function will take ownership of buf, the user must not free it.
* A NULL buf signals EOF -- i.e. no more frames will be sent to this filter. * A NULL buf signals EOF -- i.e. no more frames will be sent to this filter.
...@@ -38,25 +39,25 @@ ...@@ -38,25 +39,25 @@
* @deprecated use av_buffersrc_write_frame() or av_buffersrc_add_frame() * @deprecated use av_buffersrc_write_frame() or av_buffersrc_add_frame()
*/ */
attribute_deprecated attribute_deprecated
int av_buffersrc_buffer(AVFilterContext *s, AVFilterBufferRef *buf); int av_buffersrc_buffer(AVFilterContext *ctx, AVFilterBufferRef *buf);
#endif #endif
/** /**
* Add a frame to the buffer source. * Add a frame to the buffer source.
* *
* @param s an instance of the buffersrc filter. * @param ctx an instance of the buffersrc filter
* @param frame frame to be added. If the frame is reference counted, this * @param frame frame to be added. If the frame is reference counted, this
* function will make a new reference to it. Otherwise the frame data will be * function will make a new reference to it. Otherwise the frame data will be
* copied. * copied.
* *
* @return 0 on success, a negative AVERROR on error * @return 0 on success, a negative AVERROR on error
*/ */
int av_buffersrc_write_frame(AVFilterContext *s, const AVFrame *frame); int av_buffersrc_write_frame(AVFilterContext *ctx, const AVFrame *frame);
/** /**
* Add a frame to the buffer source. * Add a frame to the buffer source.
* *
* @param s an instance of the buffersrc filter. * @param ctx an instance of the buffersrc filter
* @param frame frame to be added. If the frame is reference counted, this * @param frame frame to be added. If the frame is reference counted, this
* function will take ownership of the reference(s) and reset the frame. * function will take ownership of the reference(s) and reset the frame.
* Otherwise the frame data will be copied. If this function returns an error, * Otherwise the frame data will be copied. If this function returns an error,
......
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