From 0033bb4785debbd9fc916cab34aad54cb105f4c2 Mon Sep 17 00:00:00 2001 From: shakeelrao Date: Sun, 17 Mar 2019 17:41:27 -0700 Subject: [PATCH] Update documentation for ZSTD_frameSizeInfo --- lib/common/zstd_internal.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/common/zstd_internal.h b/lib/common/zstd_internal.h index f5de27a19..31f756ab5 100644 --- a/lib/common/zstd_internal.h +++ b/lib/common/zstd_internal.h @@ -244,14 +244,14 @@ typedef struct { /** * Contains the compressed frame size and an upper-bound for the decompressed frame size. - * Note: before using `compressedSize` you must check for errors using ZSTD_isError(). - * similarly, before using `decompressedBound`, you must check for errors using: - * `decompressedBound` != ZSTD_CONTENTSIZE_ERROR + * Note: before using `compressedSize`, check for errors using ZSTD_isError(). + * similarly, before using `decompressedBound`, check for errors using: + * `decompressedBound != ZSTD_CONTENTSIZE_ERROR` */ typedef struct { size_t compressedSize; unsigned long long decompressedBound; -} ZSTD_frameSizeInfo; +} ZSTD_frameSizeInfo; /* decompress & legacy */ const seqStore_t* ZSTD_getSeqStore(const ZSTD_CCtx* ctx); /* compress & dictBuilder */ void ZSTD_seqToCodes(const seqStore_t* seqStorePtr); /* compress, dictBuilder, decodeCorpus (shouldn't get its definition from here) */