From a6694838e1067b1ec452530170a8127e0f177185 Mon Sep 17 00:00:00 2001 From: Yann Collet Date: Thu, 29 Mar 2018 15:24:17 -0600 Subject: [PATCH] added more code documentation for ZSTD_getFrameHeader() --- lib/zstd.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lib/zstd.h b/lib/zstd.h index 6405da602..72e237a57 100644 --- a/lib/zstd.h +++ b/lib/zstd.h @@ -880,6 +880,11 @@ typedef struct { unsigned dictID; unsigned checksumFlag; } ZSTD_frameHeader; +/** ZSTD_getFrameHeader() : + * decode Frame Header, or requires larger `srcSize`. + * @return : 0, `zfhPtr` is correctly filled, + * >0, `srcSize` is too small, value is wanted `srcSize` amount, + * or an error code, which can be tested using ZSTD_isError() */ ZSTDLIB_API size_t ZSTD_getFrameHeader(ZSTD_frameHeader* zfhPtr, const void* src, size_t srcSize); /**< doesn't consume input */ ZSTDLIB_API size_t ZSTD_decodingBufferSize_min(unsigned long long windowSize, unsigned long long frameContentSize); /**< when frame content size is not known, pass in frameContentSize == ZSTD_CONTENTSIZE_UNKNOWN */