update doc / comments

diff --git a/NEWS b/NEWS
index ccbf15eb583b188a6efa7d1af65329f91e828c0f..f1d4ed214dd1859e2b24eb179eefa6e488dabfb8 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -1,3 +1,7 @@
+v0.6.0
+Stronger high compression modes, thanks to Przemyslaw Skibinski
+API : ZSTD_getFrameParams() provides size of decompressed content
+
 v0.5.1
 New : Optimal parsing => Very high compression modes, thanks to Przemyslaw Skibinski
 Changed : Dictionary builder integrated into libzstd and zstd cli

diff --git a/lib/zstd_static.h b/lib/zstd_static.h
index f6eb8aa3975582e71ec539d5e3252f8218a97a21..be67784ef75b45ec5baf087e150acbab87077dba 100644 (file)
--- a/lib/zstd_static.h
+++ b/lib/zstd_static.h
@@ -187,11 +187,14 @@ ZSTDLIB_API size_t ZSTD_decompressContinue(ZSTD_DCtx* dctx, void* dst, size_t ds
   A ZSTD_DCtx object can be re-used multiple times.
 
   First optional operation is to retrieve frame parameters, using ZSTD_getFrameParams().
-  It requires to read the beginning of compressed frame.
+  It can provide the minimum size of buffer required to properly decompress data,
+  and optionally the final size of uncompressed content.
+  (Note : content size is an optional info that may not be present. 0 means : content size unknown)
+  It is done by reading a certain amount of the beginning of compressed frame.
   The amount of data to read is variable, from ZSTD_frameHeaderSize_min to ZSTD_frameHeaderSize_max.
-  If you don't provide enough length, function will return the minimum size it wants to produce a result.
+  If `srcSize` is too small for operation to succeed, function will return the minimum size it requires to produce a result.
   Result : 0 when successful, it means the ZSTD_frameParams structure has been filled.
-          >0 : means there is not enough data into src. Provides the expected size to successfully decode header.
+          >0 : means there is not enough data into `src`. Provides the expected size to successfully decode header.
            errorCode, which can be tested using ZSTD_isError()
 
   Start decompression, with ZSTD_decompressBegin() or ZSTD_decompressBegin_usingDict().