From: Yann Collet Date: Thu, 28 Jul 2016 19:01:17 +0000 (+0200) Subject: clarified comment X-Git-Tag: v0.8.0^2~20 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ffa7d0ac1e186bf78db274f205f35b994e378919;p=thirdparty%2Fzstd.git clarified comment --- diff --git a/lib/common/zbuff.h b/lib/common/zbuff.h index 8e6305e64..f7db57302 100644 --- a/lib/common/zbuff.h +++ b/lib/common/zbuff.h @@ -138,7 +138,8 @@ ZSTDLIB_API size_t ZBUFF_decompressContinue(ZBUFF_DCtx* dctx, * Note that it may not consume the entire input, in which case it's up to the caller to present remaining input again. * The content of `dst` will be overwritten (up to *dstCapacityPtr) at each function call, so save its content if it matters, or change `dst`. * @return : 0 when a frame is completely decoded and fully flushed, - >0 when decoding is not finished, with value being a suggested next input size (it's just a hint, tends to help latency), +* 1 when there is still some data left within internal buffer to flush, +* >1 when more data is expected, with value being a suggested next input size (it's just a hint, which helps latency), * or an error code, which can be tested using ZBUFF_isError(). * * Hint : recommended buffer sizes (not compulsory) : ZBUFF_recommendedDInSize() and ZBUFF_recommendedDOutSize()