From 5817bce969f2845493f22f85ca5f19c70adc1c2f Mon Sep 17 00:00:00 2001 From: Wan-Teh Chang Date: Mon, 20 Mar 2023 16:05:11 -0700 Subject: [PATCH] Fix comment typos (likely copy-and-paste errors) Fix comment typos for vpx_codec_destroy() and vpx_codec_enc_init_ver(). Based on the change made in libaom: https://aomedia.googlesource.com/aom/+/365a968684 365a968684 Fix comment typos (likely copy-and-paste errors) Change-Id: I39edae835ed0752b569e8e7328d0709c59724ac2 --- vpx/vpx_codec.h | 8 +++++--- vpx/vpx_decoder.h | 2 +- vpx/vpx_encoder.h | 2 +- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/vpx/vpx_codec.h b/vpx/vpx_codec.h index b0a931e..11bf8aa 100644 --- a/vpx/vpx_codec.h +++ b/vpx/vpx_codec.h @@ -345,9 +345,11 @@ const char *vpx_codec_error_detail(vpx_codec_ctx_t *ctx); * \param[in] ctx Pointer to this instance's context * * \retval #VPX_CODEC_OK - * The codec algorithm initialized. - * \retval #VPX_CODEC_MEM_ERROR - * Memory allocation failed. + * The codec instance has been destroyed. + * \retval #VPX_CODEC_INVALID_PARAM + * ctx is a null pointer. + * \retval #VPX_CODEC_ERROR + * Codec context not initialized. */ vpx_codec_err_t vpx_codec_destroy(vpx_codec_ctx_t *ctx); diff --git a/vpx/vpx_decoder.h b/vpx/vpx_decoder.h index 39e5f58..99dd8cf 100644 --- a/vpx/vpx_decoder.h +++ b/vpx/vpx_decoder.h @@ -127,7 +127,7 @@ typedef struct vpx_codec_dec_cfg { * \param[in] ver ABI version number. Must be set to * VPX_DECODER_ABI_VERSION * \retval #VPX_CODEC_OK - * The decoder algorithm initialized. + * The decoder algorithm has been initialized. * \retval #VPX_CODEC_MEM_ERROR * Memory allocation failed. */ diff --git a/vpx/vpx_encoder.h b/vpx/vpx_encoder.h index efaf5ef..a0d2c87 100644 --- a/vpx/vpx_encoder.h +++ b/vpx/vpx_encoder.h @@ -906,7 +906,7 @@ vpx_codec_err_t vpx_codec_enc_init_ver(vpx_codec_ctx_t *ctx, * \param[in] ver ABI version number. Must be set to * VPX_ENCODER_ABI_VERSION * \retval #VPX_CODEC_OK - * The decoder algorithm initialized. + * The encoder algorithm has been initialized. * \retval #VPX_CODEC_MEM_ERROR * Memory allocation failed. */ -- 2.7.4