diff src/lzfu.h @ 193:cf3df962f1e5 stable-0-6-37

prep for fedora build
author Carl Byington <carl@five-ten-sg.com>
date Fri, 17 Apr 2009 12:51:59 -0700
parents 6954d315aaa8
children
line wrap: on
line diff
--- a/src/lzfu.h	Thu Apr 16 08:59:56 2009 -0700
+++ b/src/lzfu.h	Fri Apr 17 12:51:59 2009 -0700
@@ -1,6 +1,14 @@
 #ifndef LZFU_H
 #define LZFU_H
 
+/** decompress lz compressed rtf data. The initial lz dictionary is preloaded
+    with rtf specific data.
+ * @param rtfcomp  pointer to the rtf compressed data
+ * @param compsize size of the compressed data buffer
+ * @param size     pointer to location to return size of the output buffer
+ * @return         pointer to the output buffer containing the decompressed data.
+ *                 The caller must free this buffer.
+ */
 char* pst_lzfu_decompress (char* rtfcomp, uint32_t compsize, size_t *size);
 
 #endif