From 7cb79fbbad769672d6a96e8a1994adca60c81859 Mon Sep 17 00:00:00 2001 From: Nikita Kogut Date: Tue, 14 Jan 2025 21:38:02 +0200 Subject: [PATCH] Clarify return value for decode() functions --- include/opus.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/include/opus.h b/include/opus.h index eadeda75a..2692d6fc6 100644 --- a/include/opus.h +++ b/include/opus.h @@ -472,7 +472,7 @@ OPUS_EXPORT int opus_decoder_init( * FEC cases, frame_size must be a multiple of 2.5 ms. * @param [in] decode_fec int: Flag (0 or 1) to request that any in-band forward error correction data be * decoded. If no such data is available, the frame is decoded as if it were lost. - * @returns Number of decoded samples or @ref opus_errorcodes + * @returns Number of decoded samples per channel or @ref opus_errorcodes */ OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decode( OpusDecoder *st, @@ -497,7 +497,7 @@ OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decode( * FEC cases, frame_size must be a multiple of 2.5 ms. * @param [in] decode_fec int: Flag (0 or 1) to request that any in-band forward error correction data be * decoded. If no such data is available the frame is decoded as if it were lost. - * @returns Number of decoded samples or @ref opus_errorcodes + * @returns Number of decoded samples per channel or @ref opus_errorcodes */ OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decode_float( OpusDecoder *st,