[FFmpeg-cvslog] avutil/softfloat: document av_int2sf()

[Michael Niedermayer]

ffmpeg | branch: master | Michael Niedermayer <michaelni at gmx.at> | Sat Apr 25 14:51:02 2015 +0200| [a3110beebd781c422ab98792227f51c46ac5918e] | committer: Michael Niedermayer

avutil/softfloat: document av_int2sf()

Signed-off-by: Michael Niedermayer <michaelni at gmx.at>

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=a3110beebd781c422ab98792227f51c46ac5918e
---

 libavutil/softfloat.h |    4 ++++
 1 file changed, 4 insertions(+)

diff --git a/libavutil/softfloat.h b/libavutil/softfloat.h
index 654a31f..2e85765 100644
--- 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});
 }