diff options
| author | Michael Niedermayer <michaelni@gmx.at> | 2008-04-02 22:07:21 +0000 |
|---|---|---|
| committer | Michael Niedermayer <michaelni@gmx.at> | 2008-04-02 22:07:21 +0000 |
| commit | a27c8d5fa9839edbae0a73e48809ce88f138b073 (patch) | |
| tree | c12063c8e0638c5abb91f01cbabe9534339dc039 | |
| parent | 7bfacd4e75a773c2cdf8ce81bed5aeff9a698140 (diff) | |
| download | ffmpeg-a27c8d5fa9839edbae0a73e48809ce88f138b073.tar.gz | |
Improve AVFilterFormats doxy.
Originally committed as revision 12672 to svn://svn.ffmpeg.org/ffmpeg/trunk
| -rw-r--r-- | libavfilter/avfilter.h | 28 |
1 files changed, 19 insertions, 9 deletions
diff --git a/libavfilter/avfilter.h b/libavfilter/avfilter.h index ab3214825a..2f0e6abdb4 100644 --- a/libavfilter/avfilter.h +++ b/libavfilter/avfilter.h @@ -188,22 +188,32 @@ AVFilterFormats *avfilter_all_colorspaces(void); AVFilterFormats *avfilter_merge_formats(AVFilterFormats *a, AVFilterFormats *b); /** - * Adds *ref as a new reference to f. + * Adds *ref as a new reference to formats. * That is the pointers will point like in the ascii art below: * ________ - * | f |<--------. - * | ____ | | - * | |refs| | __|_ - * | |* * | | | | | + * |formats |<--------. + * | ____ | ____|___________________ + * | |refs| | | __|_ + * | |* * | | | | | | AVFilterLink * | |* *--------->|*ref| - * | |____| | |____| - * |________| + * | |____| | | |____| + * |________| |________________________ */ -void avfilter_formats_ref(AVFilterFormats *f, AVFilterFormats **ref); +void avfilter_formats_ref(AVFilterFormats *formats, AVFilterFormats **ref); /** * Remove *ref as a reference to the format list it currently points to, * deallocate that list if this was the last reference, and set *ref to NULL. + * + * Before After + * ________ ________ NULL + * |formats |<--------. |formats | ^ + * | ____ | ____|________________ | ____ | ____|________________ + * | |refs| | | __|_ | |refs| | | __|_ + * | |* * | | | | | | AVFilterLink | |* * | | | | | | AVFilterLink + * | |* *--------->|*ref| | |* | | | |*ref| + * | |____| | | |____| | |____| | | |____| + * |________| |_____________________ |________| |_____________________ */ void avfilter_formats_unref(AVFilterFormats **ref); @@ -211,7 +221,7 @@ void avfilter_formats_unref(AVFilterFormats **ref); * * Before After * ________ ________ - * | f |<---------. | f |<---------. + * |formats |<---------. |formats |<---------. * | ____ | ___|___ | ____ | ___|___ * | |refs| | | | | | |refs| | | | | NULL * | |* *--------->|*oldref| | |* *--------->|*newref| ^ |