pixdesc: fix and extend doxy for av_pix_fmt_get_chroma_sub_sample()
authorAnton Khirnov <anton@khirnov.net>
Thu, 21 Jan 2016 12:28:42 +0000 (13:28 +0100)
committerAnton Khirnov <anton@khirnov.net>
Sat, 23 Jan 2016 19:16:42 +0000 (20:16 +0100)
The parameters in the docs are currently swapped.

libavutil/pixdesc.h

index fe06d94..aea1e38 100644 (file)
@@ -268,8 +268,8 @@ enum AVPixelFormat av_pix_fmt_desc_get_id(const AVPixFmtDescriptor *desc);
  * the pixel format AVPixFmtDescriptor.
  *
  * @param[in]  pix_fmt the pixel format
- * @param[out] h_shift store log2_chroma_h
- * @param[out] v_shift store log2_chroma_w
+ * @param[out] h_shift store log2_chroma_w (horizontal/width shift)
+ * @param[out] v_shift store log2_chroma_h (vertical/height shift)
  *
  * @return 0 on success, AVERROR(ENOSYS) on invalid or unknown pixel format
  */