avutil/imgutils: Clarify doxy for av_image_check_size2()

Reviewed-by: Andreas Cadhalpun <andreas.cadhalpun@googlemail.com> Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
8 years ago · d4c1cc2b87
parent 6672a49e5a
commit d4c1cc2b87
1 changed files with 2 additions and 1 deletions
--- a/libavutil/imgutils.h
+++ b/libavutil/imgutils.h
@ -193,7 +193,8 @@ int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *lo

 /**
 * Check if the given dimension of an image is valid, meaning that all
- * bytes of the image can be addressed with a signed int.
+ * bytes of a plane of an image with the specified pix_fmt can be addressed
+ * with a signed int.
 *
 * @param w the width of the picture
 * @param h the height of the picture