1
0
mirror of https://github.com/FFmpeg/FFmpeg.git synced 2024-12-23 12:43:46 +02:00

Doxygenize some comments

Patch by Dujardin Bernard % dujardin P iut A numericable P fr %

Originally committed as revision 8131 to svn://svn.ffmpeg.org/ffmpeg/trunk
This commit is contained in:
Dujardin Bernard 2007-02-26 08:52:21 +00:00 committed by Guillaume Poirier
parent 24dbec7c84
commit 1c95ef8b97

View File

@ -38,7 +38,10 @@ typedef struct AVRational{
} AVRational; } 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){ 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; const int64_t tmp= a.num * (int64_t)b.den - b.num * (int64_t)a.den;
@ -48,15 +51,21 @@ static inline int av_cmp_q(AVRational a, AVRational b){
} }
/** /**
* 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){ static inline double av_q2d(AVRational a){
return a.num / (double) a.den; return a.num / (double) a.den;
} }
/** /**
* reduce a fraction. * Reduce a fraction.
* This is useful for framerate calculations. * 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 * @param max the maximum allowed for dst_nom & dst_den
* @return 1 if exact, 0 otherwise * @return 1 if exact, 0 otherwise
*/ */