move doxy from .c to .h

Originally committed as revision 8599 to svn://svn.ffmpeg.org/ffmpeg/trunk

1 files changed, 9 insertions, 0 deletions

diff --git a/libavcodec/rle.h b/libavcodec/rle.h
index 8961dee3d3..5da09f2731 100644
--- a/libavcodec/rle.h
+++ b/libavcodec/rle.h
@@ -22,6 +22,15 @@
 #ifndef RLE_H
 #define RLE_H
 
+/**
+ * RLE compress the row, with maximum size of out_size. Value before repeated bytes is (count ^ xor) + add.
+ * @param outbuf Output buffer
+ * @param out_size Maximum output size
+ * @param ptr Input buffer
+ * @param bpp Bytes per pixel
+ * @param w Image width
+ * @return Size of output in bytes, or -1 if larger than out_size
+ */
 int ff_rle_encode(uint8_t *outbuf, int out_size, const uint8_t *inbuf, int bpp, int w, int8_t add, uint8_t xor);
 
 #endif /* RLE_H */