aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorElliot Gorokhovsky <embg@fb.com>2024-03-14 15:55:01 -0400
committerGitHub <noreply@github.com>2024-03-14 15:55:01 -0400
commit559762da12f54712d44f619098aa4a7e7bc5727b (patch)
tree9ecf2946b1948e440753f82dea299506cd76e8b6
parenta0a9bc6c95436c85002ffca972ae545f862e1638 (diff)
downloadzstd-559762da12f54712d44f619098aa4a7e7bc5727b.tar.gz
Remove duplicate and incorrect docs in zstd_decompress.c (#3967)
-rw-r--r--lib/decompress/zstd_decompress.c6
1 files changed, 2 insertions, 4 deletions
diff --git a/lib/decompress/zstd_decompress.c b/lib/decompress/zstd_decompress.c
index 42636d57..f6579743 100644
--- a/lib/decompress/zstd_decompress.c
+++ b/lib/decompress/zstd_decompress.c
@@ -797,10 +797,8 @@ static ZSTD_frameSizeInfo ZSTD_findFrameSizeInfo(const void* src, size_t srcSize
}
/** ZSTD_findFrameCompressedSize() :
- * compatible with legacy mode
- * `src` must point to the start of a ZSTD frame, ZSTD legacy frame, or skippable frame
- * `srcSize` must be at least as large as the frame contained
- * @return : the compressed size of the frame starting at `src` */
+ * See docs in zstd.h
+ * Note: compatible with legacy mode */
size_t ZSTD_findFrameCompressedSize(const void *src, size_t srcSize)
{
ZSTD_frameSizeInfo const frameSizeInfo = ZSTD_findFrameSizeInfo(src, srcSize);