From 09b63a42a5b837c241abfec486baf22bfedf3f72 Mon Sep 17 00:00:00 2001 From: Michael Niedermayer Date: Thu, 21 Feb 2008 22:02:53 +0000 Subject: [PATCH] Document avfilter_formats_ref() with some ascii art. Originally committed as revision 12172 to svn://svn.ffmpeg.org/ffmpeg/trunk --- libavfilter/avfilter.h | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/libavfilter/avfilter.h b/libavfilter/avfilter.h index 911cdd6226..49d90cf522 100644 --- a/libavfilter/avfilter.h +++ b/libavfilter/avfilter.h @@ -177,7 +177,18 @@ 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 f. + * That is the pointers will point like in the ascii art below: + * ________ + * | f |<--------. + * | ____ | | + * | |refs| | __|_ + * | |* * | | | | | + * | |* *--------->|*ref| + * | |____| | |____| + * |________| + */ void avfilter_formats_ref(AVFilterFormats *f, AVFilterFormats **ref); /**