Document av_gcd().
authorMichael Niedermayer <michaelni@gmx.at>
Sun, 27 Dec 2009 12:20:06 +0000 (12:20 +0000)
committerMichael Niedermayer <michaelni@gmx.at>
Sun, 27 Dec 2009 12:20:06 +0000 (12:20 +0000)
Originally committed as revision 20935 to svn://svn.ffmpeg.org/ffmpeg/trunk

libavutil/mathematics.h

index cb35910..852e2bf 100644 (file)
@@ -56,6 +56,11 @@ enum AVRounding {
     AV_ROUND_NEAR_INF = 5, ///< Round to nearest and halfway cases away from zero.
 };
 
+/**
+ * Returns the greatest common divisor of a and b.
+ * If either a or b are 0 or either or both are <0 then behavior is
+ * undefined.
+ */
 int64_t av_const av_gcd(int64_t a, int64_t b);
 
 /**