From e8c9dc5cea3b150b04059651e9322d81875e6958 Mon Sep 17 00:00:00 2001 From: Nick Terrell Date: Fri, 13 Apr 2018 12:43:38 -0700 Subject: [PATCH] Fix documentation --- lib/zstd.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/zstd.h b/lib/zstd.h index aaec49fe7..387586c1e 100644 --- a/lib/zstd.h +++ b/lib/zstd.h @@ -1141,13 +1141,15 @@ ZSTDLIB_API size_t ZSTD_CCtx_refPrefix_advanced(ZSTD_CCtx* cctx, const void* pre * Return a CCtx to clean state. * Useful after an error, or to interrupt an ongoing compression job and start a new one. * Any internal data not yet flushed is cancelled. - * Dictionary (if any) is dropped. + * The parameters and dictionary are kept unchanged, to reset them use ZSTD_CCtx_resetParameters(). */ ZSTDLIB_API void ZSTD_CCtx_reset(ZSTD_CCtx* cctx); /*! ZSTD_CCtx_resetParameters() : * All parameters are back to default values (compression level is ZSTD_CLEVEL_DEFAULT). + * Dictionary (if any) is dropped. * Resetting parameters is only possible during frame initialization (before starting compression). + * To reset the context use ZSTD_CCtx_reset(). * @return 0 or an error code (which can be checked with ZSTD_isError()). */ ZSTDLIB_API size_t ZSTD_CCtx_resetParameters(ZSTD_CCtx* cctx);