On 05/16/2013 09:17 AM, Anton Khirnov wrote:
On Wed, 15 May 2013 23:15:24 +0200, Diego Biurrun <[email protected]> wrote:
On 05/14/2013 09:37 AM, Anton Khirnov wrote:
--- a/libavfilter/avfilter.h
+++ b/libavfilter/avfilter.h
@@ -427,29 +448,71 @@ typedef struct AVFilter {
/**
+ * Filter initialization function.
+ *
+ * This callback will be called only once during the filter lifetime, after
Let's increase literary value via s/called/invoked/.
I think the documentation should be above all easy to understand. Invoke is a
much more obscure word than call, some non-native readers might have problems
with it. Also 'call a function' is a standard term, so i'd go with that.
Documentation in simple English? :) I don't think that's our target
audience. Anyway, I don't care.
+ * This callback must set AVFilterLink.out_formats on every input link and
+ * AVFilterLink.in_formats on every output link to a list of supported
+ * pixel/sample formats on that link.
.. on every output link to a list of pixel/sample formats that the link
supports.
It's not the link that supports the formats. A link has two ends, there is a
filter on each end. Each filter has its own list of supported formats.
This should be more explicit then. Suggestion:
This callback must set AVFilterLink.out_formats on every input link and
AVFilterLink.in_formats on every output link to a list of pixel/sample
formats that the input/output link supports.
@@ -458,6 +521,9 @@ typedef struct AVFilter {
+ /**
+ * Used by the filter registration system.
+ */
struct AVFilter *next;
That's a tad terse.
That's intended. This field is only meant to be used by the registration
system, nobody else should touch it. So the doxy should just say that.
So be explicit about not touching that part IMO.
Diego
_______________________________________________
libav-devel mailing list
[email protected]
https://lists.libav.org/mailman/listinfo/libav-devel
