diff rational.h @ 633:8c48a1b999a3 libavutil

spelling/grammar/consistency review part I

--- a/rational.h	Tue Jan 27 00:46:18 2009 +0000
+++ b/rational.h	Wed Jan 28 00:16:05 2009 +0000
@@ -1,5 +1,5 @@
 /*
- * Rational numbers
+ * rational numbers
  * Copyright (c) 2003 Michael Niedermayer <[e-mail]>
  *
  * This file is part of FFmpeg.
@@ -21,7 +21,7 @@
 
 /**
  * @file rational.h
- * Rational numbers.
+ * rational numbers
  * @author Michael Niedermayer <[e-mail]>
  */
 
@@ -32,7 +32,7 @@
 #include "common.h"
 
 /**
- * Rational number num/den.
+ * rational number numerator/denominator
  */
 typedef struct AVRational{
     int num; ///< numerator
@@ -40,10 +40,10 @@
 } AVRational;
 
 /**
- * Compare two rationals.
+ * Compares two rationals.
  * @param a first rational
  * @param b second rational
- * @return 0 if a==b, 1 if a>b and -1 if a<b.
+ * @return 0 if a==b, 1 if a>b and -1 if a<b
  */
 static inline int av_cmp_q(AVRational a, AVRational b){
     const int64_t tmp= a.num * (int64_t)b.den - b.num * (int64_t)a.den;
@@ -53,7 +53,7 @@
 }
 
 /**
- * Rational to double conversion.
+ * Converts rational to double.
  * @param a rational to convert
  * @return (double) a
  */
@@ -62,7 +62,7 @@
 }
 
 /**
- * Reduce a fraction.
+ * Reduces a fraction.
  * This is useful for framerate calculations.
  * @param dst_nom destination numerator
  * @param dst_den destination denominator
@@ -75,33 +75,33 @@
 
 /**
  * Multiplies two rationals.
- * @param b first rational.
- * @param c second rational.
- * @return b*c.
+ * @param b first rational
+ * @param c second rational
+ * @return b*c
  */
 AVRational av_mul_q(AVRational b, AVRational c) av_const;
 
 /**
  * Divides one rational by another.
- * @param b first rational.
- * @param c second rational.
- * @return b/c.
+ * @param b first rational
+ * @param c second rational
+ * @return b/c
  */
 AVRational av_div_q(AVRational b, AVRational c) av_const;
 
 /**
  * Adds two rationals.
- * @param b first rational.
- * @param c second rational.
- * @return b+c.
+ * @param b first rational
+ * @param c second rational
+ * @return b+c
  */
 AVRational av_add_q(AVRational b, AVRational c) av_const;
 
 /**
  * Subtracts one rational from another.
- * @param b first rational.
- * @param c second rational.
- * @return b-c.
+ * @param b first rational
+ * @param c second rational
+ * @return b-c
  */
 AVRational av_sub_q(AVRational b, AVRational c) av_const;
 
@@ -109,7 +109,7 @@
  * Converts a double precision floating point number to a rational.
  * @param d double to convert
  * @param max the maximum allowed numerator and denominator
- * @return (AVRational) d.
+ * @return (AVRational) d
  */
 AVRational av_d2q(double d, int max) av_const;