Mercurial > libavutil.hg
changeset 253:5647be712b27 libavutil
Doxygenize some comments
Patch by Dujardin Bernard % dujardin P iut A numericable P fr %
| author | gpoirier |
|---|---|
| date | Mon, 26 Feb 2007 08:52:21 +0000 |
| parents | 3c7dd1a3cfe8 |
| children | 77e39bbb7219 |
| files | rational.h |
| diffstat | 1 files changed, 12 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/rational.h Sun Feb 25 19:30:55 2007 +0000 +++ b/rational.h Mon Feb 26 08:52:21 2007 +0000 @@ -38,7 +38,10 @@ } AVRational; /** - * returns 0 if a==b, 1 if a>b and -1 if a<b. + * Compare two rationals. + * @param a first rational + * @param b second rational + * @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; @@ -48,15 +51,21 @@ } /** - * converts the given AVRational to a double. + * Rational to double conversion + * @param a rational to convert + * @return (double) a */ static inline double av_q2d(AVRational a){ return a.num / (double) a.den; } /** - * reduce a fraction. + * Reduce a fraction. * This is useful for framerate calculations. + * @param dst_nom destination numerator + * @param dst_den destination denominator + * @param nom source numerator + * @param den source denominator * @param max the maximum allowed for dst_nom & dst_den * @return 1 if exact, 0 otherwise */