1. ffmpeg
  2. Commit ebd1edf36c81155e2817edaa056b0bc9eb21e8f5
Browse code

avfiltergraph: clarify doxy for avfilter_graph_parse() open_inputs/outputs params

Make it clear that open_inputs/open_outputs are updated only if non-NULL.

Stefano Sabatini authored on 2011/07/02 23:09:55
Showing 1 changed files
libavfilter/avfiltergraph.h
History View file @ ebd1edf
... ... 
@@ -124,12 +124,12 @@ void avfilter_inout_free(AVFilterInOut **inout);
124 124 
  *
125 125 
  * @param graph   the filter graph where to link the parsed graph context
126 126 
  * @param filters string to be parsed
127 
- * @param inputs  linked list to the inputs of the graph, may be NULL.
128 
- *                It is updated to contain the list of open inputs after the parsing,
129 
- *                should be freed with avfilter_inout_free().
130 
- * @param outputs linked list to the outputs of the graph, may be NULL.
131 
- *                It is updated to contain the list of open outputs after the parsing,
132 
- *                should be freed with avfilter_inout_free().
127 
+ * @param inputs  pointer to a linked list to the inputs of the graph, may be NULL.
128 
+ *                If non-NULL, *inputs is updated to contain the list of open inputs
129 
+ *                after the parsing, should be freed with avfilter_inout_free().
130 
+ * @param outputs pointer to a linked list to the outputs of the graph, may be NULL.
131 
+ *                If non-NULL, *outputs is updated to contain the list of open outputs
132 
+ *                after the parsing, should be freed with avfilter_inout_free().
133 133 
  * @return zero on success, a negative AVERROR code on error
134 134 
  */
135 135 
 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,