fixed comments as suggested by @terrelln

This commit is contained in:
Yann Collet
2018-03-30 20:09:27 -07:00
parent e6e848bfe9
commit 8be984ec45
2 changed files with 7 additions and 6 deletions
+3 -2
View File
@@ -298,14 +298,15 @@ static size_t ZSTD_frameHeaderSize_internal(const void* src, size_t srcSize, ZST
/** ZSTD_frameHeaderSize() : /** ZSTD_frameHeaderSize() :
* srcSize must be >= ZSTD_frameHeaderSize_prefix. * srcSize must be >= ZSTD_frameHeaderSize_prefix.
* @return : size of the Frame Header */ * @return : size of the Frame Header,
* or an error code (if srcSize is too small) */
size_t ZSTD_frameHeaderSize(const void* src, size_t srcSize) size_t ZSTD_frameHeaderSize(const void* src, size_t srcSize)
{ {
return ZSTD_frameHeaderSize_internal(src, srcSize, ZSTD_f_zstd1); return ZSTD_frameHeaderSize_internal(src, srcSize, ZSTD_f_zstd1);
} }
/** ZSTD_getFrameHeader_advanced`() : /** ZSTD_getFrameHeader_advanced() :
* decode Frame Header, or require larger `srcSize`. * decode Frame Header, or require larger `srcSize`.
* note : only works for formats ZSTD_f_zstd1 and ZSTD_f_zstd1_magicless * note : only works for formats ZSTD_f_zstd1 and ZSTD_f_zstd1_magicless
* @return : 0, `zfhPtr` is correctly filled, * @return : 0, `zfhPtr` is correctly filled,
+4 -4
View File
@@ -479,10 +479,10 @@ ZSTDLIB_API size_t ZSTD_findFrameCompressedSize(const void* src, size_t srcSize)
* however it does mean that all frame data must be present and valid. */ * however it does mean that all frame data must be present and valid. */
ZSTDLIB_API unsigned long long ZSTD_findDecompressedSize(const void* src, size_t srcSize); ZSTDLIB_API unsigned long long ZSTD_findDecompressedSize(const void* src, size_t srcSize);
/*! ZSTD_frameHeaderSize() : /** ZSTD_frameHeaderSize() :
* `src` should point to the start of a ZSTD frame * srcSize must be >= ZSTD_frameHeaderSize_prefix.
* `srcSize` must be >= ZSTD_frameHeaderSize_prefix. * @return : size of the Frame Header,
* @return : size of the Frame Header */ * or an error code (if srcSize is too small) */
ZSTDLIB_API size_t ZSTD_frameHeaderSize(const void* src, size_t srcSize); ZSTDLIB_API size_t ZSTD_frameHeaderSize(const void* src, size_t srcSize);