X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=libavutil%2Finteger.h;h=d4d0201db4f9131c5d06cd3497fc9a14222e3b06;hb=382cb1154c0f7f5a55e715c154af876364e7205f;hp=6c5c274141b0442d8b36b59e95369d9dd119d4fa;hpb=987903826b0dba2e134be200ac94be66b4a3acf1;p=ffmpeg

diff --git a/libavutil/integer.h b/libavutil/integer.h
index 6c5c274141b..d4d0201db4f 100644
--- a/libavutil/integer.h
+++ b/libavutil/integer.h
@@ -20,7 +20,7 @@
  */
 
 /**
- * @file integer.h
+ * @file libavutil/integer.h
  * arbitrary precision integers
  * @author Michael Niedermayer <michaelni@gmx.at>
  */
@@ -41,43 +41,45 @@ AVInteger av_add_i(AVInteger a, AVInteger b) av_const;
 AVInteger av_sub_i(AVInteger a, AVInteger b) av_const;
 
 /**
- * returns the rounded down value of the logarithm of base 2 of the given AVInteger.
- * this is simply the index of the most significant bit which is 1. Or 0 of all bits are 0
+ * Returns the rounded-down value of the base 2 logarithm of the given
+ * AVInteger. This is simply the index of the most significant bit
+ * which is 1, or 0 if all bits are 0.
  */
 int av_log2_i(AVInteger a) av_const;
 AVInteger av_mul_i(AVInteger a, AVInteger b) av_const;
 
 /**
- * returns 0 if a==b, 1 if a>b and -1 if a<b.
+ * Returns 0 if a==b, 1 if a>b and -1 if a<b.
  */
 int av_cmp_i(AVInteger a, AVInteger b) av_const;
 
 /**
- * bitwise shift.
- * @param s the number of bits by which the value should be shifted right, may be negative for shifting left
+ * bitwise shift
+ * @param s the number of bits by which the value should be shifted right,
+            may be negative for shifting left
  */
 AVInteger av_shr_i(AVInteger a, int s) av_const;
 
 /**
- * returns a % b.
- * @param quot a/b will be stored here
+ * Returns a % b.
+ * @param quot a/b will be stored here.
  */
 AVInteger av_mod_i(AVInteger *quot, AVInteger a, AVInteger b);
 
 /**
- * returns a/b.
+ * Returns a/b.
  */
 AVInteger av_div_i(AVInteger a, AVInteger b) av_const;
 
 /**
- * converts the given int64_t to an AVInteger.
+ * Converts the given int64_t to an AVInteger.
  */
 AVInteger av_int2i(int64_t a) av_const;
 
 /**
- * converts the given AVInteger to an int64_t.
- * if the AVInteger is too large to fit into an int64_t,
- * then only the least significant 64bit will be used
+ * Converts the given AVInteger to an int64_t.
+ * If the AVInteger is too large to fit into an int64_t,
+ * then only the least significant 64 bits will be used.
  */
 int64_t av_i2int(AVInteger a) av_const;