[FFmpeg-cvslog] fmtconvert: fix and extend documentation for float_interleave()

[Justin Ruggles]

ffmpeg | branch: master | Justin Ruggles <justin.ruggles at gmail.com> | Sun Oct  9 16:30:11 2011 -0400| [45add995de6a1458cd8095abb302f9a7cbd3e3ee] | committer: Justin Ruggles

fmtconvert: fix and extend documentation for float_interleave()

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

 libavcodec/fmtconvert.h |   10 +++++++++-
 1 files changed, 9 insertions(+), 1 deletions(-)

diff --git a/libavcodec/fmtconvert.h b/libavcodec/fmtconvert.h
index d774113..1b53401 100644
--- a/libavcodec/fmtconvert.h
+++ b/libavcodec/fmtconvert.h
@@ -70,7 +70,15 @@ typedef struct FmtConvertContext {
                                       long len, int channels);
 
     /**
-     * Convert an array of interleaved float to multiple arrays of float.
+     * Convert multiple arrays of float to an array of interleaved float.
+     *
+     * @param dst destination array of interleaved float.
+     *            constraints: 16-byte aligned
+     * @param src source array of float arrays, one for each channel.
+     *            constraints: 16-byte aligned
+     * @param len number of elements to convert.
+     *            constraints: multiple of 8
+     * @param channels number of channels
      */
     void (*float_interleave)(float *dst, const float **src, unsigned int len,
                              int channels);