Add legacy mode in documentation

2019-03-18 20:33:15 -07:00
parent 20aa1b455c
commit 0a3fa6f909
16 changed files with 39 additions and 7 deletions
@@ -56,6 +56,9 @@ ZSTDv07_findFrameSizeInfoLegacy() : get the source length and decompressed bound
                               or an errorCode if it fails (which can be tested using ZSTDv01_isError())
    dBound (output paramter) : an upper-bound for the decompressed size of the data in the frame
                               or ZSTD_CONTENTSIZE_ERROR if an error occurs
+
+    note : assumes `cSize` and `dBound` are _not_ NULL.
+
 */
 void ZSTDv07_findFrameSizeInfoLegacy(const void *src, size_t srcSize,
                                     size_t* cSize, unsigned long long* dBound);