avutil/softfloat: document av_int2sf()

Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
10 years ago · a3110beebd
parent 663321ed50
commit a3110beebd
1 changed files with 4 additions and 0 deletions
--- a/libavutil/softfloat.h
+++ b/libavutil/softfloat.h
@ -116,6 +116,10 @@ static inline av_const SoftFloat av_sub_sf(SoftFloat a, SoftFloat b){

 //FIXME sqrt, log, exp, pow, sin, cos

+/**
+ * Converts a mantisse and exponent to a SoftFloat
+ * @returns a SoftFloat with value v * 2^frac_bits
+ */
 static inline av_const SoftFloat av_int2sf(int v, int frac_bits){
    return av_normalize_sf((SoftFloat){v, ONE_BITS-frac_bits});
 }