[FFmpeg-devel,3/3] avcodec/mpeg4audio: fix return value described in avpriv_mpeg4audio_get_config() doxy

Submitted by James Almer on Sept. 21, 2019, 3:52 p.m.

Details

Message ID 20190921155253.1004-3-jamrial@gmail.com
State New
Headers show

Commit Message

James Almer Sept. 21, 2019, 3:52 p.m.
Signed-off-by: James Almer <jamrial@gmail.com>
---
 libavcodec/mpeg4audio.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Patch hide | download patch | download mbox

diff --git a/libavcodec/mpeg4audio.h b/libavcodec/mpeg4audio.h
index 79ab352ce2..3774dc79c2 100644
--- a/libavcodec/mpeg4audio.h
+++ b/libavcodec/mpeg4audio.h
@@ -54,7 +54,7 @@  extern const uint8_t ff_mpeg4audio_channels[8];
  * @param[in] gb       Extradata from container.
  * @param[in] sync_extension look for a sync extension after config if true.
  * @param[in] logctx opaque struct starting with an AVClass element, used for logging.
- * @return On error -1 is returned, on success AudioSpecificConfig bit index in extradata.
+ * @return Negative AVERROR code on error, AudioSpecificConfig bit index in extradata on success.
  */
 int ff_mpeg4audio_get_config_gb(MPEG4AudioConfig *c, GetBitContext *gb,
                                 int sync_extension, void *logctx);
@@ -66,7 +66,7 @@  int ff_mpeg4audio_get_config_gb(MPEG4AudioConfig *c, GetBitContext *gb,
  * @param[in] bit_size Extradata size in bits.
  * @param[in] sync_extension look for a sync extension after config if true.
  * @param[in] logctx opaque struct starting with an AVClass element, used for logging.
- * @return On error -1 is returned, on success AudioSpecificConfig bit index in extradata.
+ * @return Negative AVERROR code on error, AudioSpecificConfig bit index in extradata on success.
  */
 int avpriv_mpeg4audio_get_config(MPEG4AudioConfig *c, const uint8_t *buf,
 #if LIBAVCODEC_VERSION_MAJOR < 59