]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
Remove duplicate and incorrect docs in zstd_decompress.c (#3967)
authorElliot Gorokhovsky <embg@fb.com>
Thu, 14 Mar 2024 19:55:01 +0000 (15:55 -0400)
committerGitHub <noreply@github.com>
Thu, 14 Mar 2024 19:55:01 +0000 (15:55 -0400)
lib/decompress/zstd_decompress.c

index 42636d5780ced6410f0623aba5851c426459ce0b..f6579743859daf123da3a9b61b312ddc8fc1ffb6 100644 (file)
@@ -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);