[FFmpeg-cvslog] r20935 - trunk/libavutil/mathematics.h

[michael]

Author: michael
Date: Sun Dec 27 13:20:06 2009
New Revision: 20935

Log:
Document av_gcd().

Modified:
   trunk/libavutil/mathematics.h

Modified: trunk/libavutil/mathematics.h
==============================================================================
--- trunk/libavutil/mathematics.h	Sun Dec 27 10:12:50 2009	(r20934)
+++ trunk/libavutil/mathematics.h	Sun Dec 27 13:20:06 2009	(r20935)
@@ -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);
 
 /**