buffersrc: Have function parameter names match between .c and .h file
authorDiego Biurrun <diego@biurrun.de>
Tue, 11 Feb 2014 21:15:07 +0000 (22:15 +0100)
committerDiego Biurrun <diego@biurrun.de>
Wed, 12 Feb 2014 11:08:02 +0000 (12:08 +0100)
This fixes two related Doxygen warnings.  Also document one parameter.

libavfilter/buffersrc.h

index c6f7ff964b5d503edfcedf5bff5a72bca1bae64e..0f9d93ac2f3d900c3f56829225e00f5da354ba81 100644 (file)
@@ -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.
  * @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,