From 99746eea7ea8e98eab33952eebab93dbcae32ad1 Mon Sep 17 00:00:00 2001 From: "W. Felix Handte" Date: Fri, 14 Aug 2020 14:44:08 -0400 Subject: [PATCH] Fix Documentation for ZSTD_CCtxParams_setParameter() It does not only return 0 on success. --- lib/zstd.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/lib/zstd.h b/lib/zstd.h index 3a012fda2..2cb82d7a1 100644 --- a/lib/zstd.h +++ b/lib/zstd.h @@ -1570,8 +1570,10 @@ ZSTDLIB_API size_t ZSTD_CCtxParams_init_advanced(ZSTD_CCtx_params* cctxParams, Z /*! ZSTD_CCtxParams_setParameter() : * Similar to ZSTD_CCtx_setParameter. * Set one compression parameter, selected by enum ZSTD_cParameter. - * Parameters must be applied to a ZSTD_CCtx using ZSTD_CCtx_setParametersUsingCCtxParams(). - * @result : 0, or an error code (which can be tested with ZSTD_isError()). + * Parameters must be applied to a ZSTD_CCtx using + * ZSTD_CCtx_setParametersUsingCCtxParams(). + * @result : a code representing success or failure (which can be tested with + * ZSTD_isError()). */ ZSTDLIB_API size_t ZSTD_CCtxParams_setParameter(ZSTD_CCtx_params* params, ZSTD_cParameter param, int value); -- 2.47.2