From: Lauri Kasanen <cand@gmx.com>
Date: Fri, 9 Jun 2017 07:54:50 +0000 (+0300)
Subject: Add lz4 doc
X-Git-Tag: V2.17~124^2~1
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=135041ac3cc809a1cc38e4567a559bdcf0f0c1dc;p=cc65

Add lz4 doc
---

diff --git a/doc/funcref.sgml b/doc/funcref.sgml
index d160082bf..3e74b2785 100644
--- a/doc/funcref.sgml
+++ b/doc/funcref.sgml
@@ -398,6 +398,13 @@ function.
 (incomplete)
 
 
+<sect1><tt/lz4.h/<label id="lz4.h"><p>
+
+<itemize>
+<item><ref id="decompress_lz4" name="decompress_lz4">
+</itemize>
+
+
 <sect1><tt/modload.h/<label id="modload.h"><p>
 
 <itemize>
@@ -2632,6 +2639,23 @@ used in presence of a prototype.
 </quote>
 
 
+<sect1>decompress_lz4<label id="decompress_lz4"><p>
+
+<quote>
+<descrip>
+<tag/Function/Uncompress a LZ4-compressed buffer.
+<tag/Header/<tt/<ref id="lz4.h" name="lz4.h">/
+<tag/Declaration/<tt/void decompress_lz4 (const unsigned char* src, unsigned char* const dst, const unsigned short uncompressed_size);/
+<tag/Description/<tt/decompress_lz4/ uncompresses a LZ4-compressed buffer.
+<tag/Notes/<itemize>
+<item>Use LZ4_compress_HC with compression level 16 for best compression.
+</itemize>
+<tag/Availability/cc65
+<tag/Example/None.
+</descrip>
+</quote>
+
+
 <sect1>div<label id="div"><p>
 
 <quote>