Browse code

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

This fixes two related Doxygen warnings. Also document one parameter.

Diego Biurrun authored on 2014/02/12 06:15:07
Showing 1 changed files
... ...
@@ -29,8 +29,9 @@
29 29
 
30 30
 #if FF_API_AVFILTERBUFFER
31 31
 /**
32
- * Add a buffer to the filtergraph s.
32
+ * Add a buffer to a filtergraph.
33 33
  *
34
+ * @param ctx an instance of the buffersrc filter
34 35
  * @param buf buffer containing frame data to be passed down the filtergraph.
35 36
  * This function will take ownership of buf, the user must not free it.
36 37
  * A NULL buf signals EOF -- i.e. no more frames will be sent to this filter.
... ...
@@ -38,25 +39,25 @@
38 38
  * @deprecated use av_buffersrc_write_frame() or av_buffersrc_add_frame()
39 39
  */
40 40
 attribute_deprecated
41
-int av_buffersrc_buffer(AVFilterContext *s, AVFilterBufferRef *buf);
41
+int av_buffersrc_buffer(AVFilterContext *ctx, AVFilterBufferRef *buf);
42 42
 #endif
43 43
 
44 44
 /**
45 45
  * Add a frame to the buffer source.
46 46
  *
47
- * @param s an instance of the buffersrc filter.
47
+ * @param ctx   an instance of the buffersrc filter
48 48
  * @param frame frame to be added. If the frame is reference counted, this
49 49
  * function will make a new reference to it. Otherwise the frame data will be
50 50
  * copied.
51 51
  *
52 52
  * @return 0 on success, a negative AVERROR on error
53 53
  */
54
-int av_buffersrc_write_frame(AVFilterContext *s, const AVFrame *frame);
54
+int av_buffersrc_write_frame(AVFilterContext *ctx, const AVFrame *frame);
55 55
 
56 56
 /**
57 57
  * Add a frame to the buffer source.
58 58
  *
59
- * @param s an instance of the buffersrc filter.
59
+ * @param ctx   an instance of the buffersrc filter
60 60
  * @param frame frame to be added. If the frame is reference counted, this
61 61
  * function will take ownership of the reference(s) and reset the frame.
62 62
  * Otherwise the frame data will be copied. If this function returns an error,