summaryrefslogtreecommitdiffstats
path: root/libavfilter/buffersrc.h
diff options
context:
space:
mode:
authorDiego Biurrun <diego@biurrun.de>2014-02-11 22:15:07 +0100
committerDiego Biurrun <diego@biurrun.de>2014-02-12 12:08:02 +0100
commit4a7d3837b4dd17fff270b55166597c093204e542 (patch)
tree72840d568e05e33a6f738c69a27d838b8092e961 /libavfilter/buffersrc.h
parent25a1ba814ad80056247fd357ec4c6911324a3f66 (diff)
downloadffmpeg-streaming-4a7d3837b4dd17fff270b55166597c093204e542.zip
ffmpeg-streaming-4a7d3837b4dd17fff270b55166597c093204e542.tar.gz
buffersrc: Have function parameter names match between .c and .h file
This fixes two related Doxygen warnings. Also document one parameter.
Diffstat (limited to 'libavfilter/buffersrc.h')
-rw-r--r--libavfilter/buffersrc.h11
1 files changed, 6 insertions, 5 deletions
diff --git a/libavfilter/buffersrc.h b/libavfilter/buffersrc.h
index c6f7ff9..0f9d93a 100644
--- a/libavfilter/buffersrc.h
+++ b/libavfilter/buffersrc.h
@@ -29,8 +29,9 @@
#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.
* 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.
@@ -38,25 +39,25 @@
* @deprecated use av_buffersrc_write_frame() or av_buffersrc_add_frame()
*/
attribute_deprecated
-int av_buffersrc_buffer(AVFilterContext *s, AVFilterBufferRef *buf);
+int av_buffersrc_buffer(AVFilterContext *ctx, AVFilterBufferRef *buf);
#endif
/**
* 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
* function will make a new reference to it. Otherwise the frame data will be
* copied.
*
* @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.
*
- * @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
* 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,
OpenPOWER on IntegriCloud