From patchwork Thu Feb 29 15:58:58 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrew Sayers X-Patchwork-Id: 46654 Delivered-To: ffmpegpatchwork2@gmail.com Received: by 2002:a05:6a20:a919:b0:19e:cdac:8cce with SMTP id cd25csp687358pzb; Thu, 29 Feb 2024 07:59:10 -0800 (PST) X-Forwarded-Encrypted: i=2; AJvYcCX27b2yja9uqXbol5+lRZUkHGu3nGJKDOVyTF7BosLYgyc1Z8OET/uzvMgy1Ecb9MLG5WoqxE15eXqrW6+ocpgo9VbpjfYBhX2QLQ== X-Google-Smtp-Source: AGHT+IHQlZKbRtIUE1Yp9S+LM3w5zY9SoZw3V5dI51Zxudps0AupLFmpp1edqKrPvU8Y7A4hUc4x X-Received: by 2002:a05:6402:2689:b0:565:9c76:73c3 with SMTP id w9-20020a056402268900b005659c7673c3mr1987261edd.29.1709222350225; Thu, 29 Feb 2024 07:59:10 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1709222350; cv=none; d=google.com; s=arc-20160816; b=fNvrBmUtDVoa8gx7VZbvhRclUptnBDaXhQyYIXPQxkAGYynWQXupTLGwViDG1xX6NQ spoegEoS+fRpVima5J25mzflH0Eiazb9bIGpPor3Y3GCUihBLYnGJIT6MlxYiajqje5t uWmGee/hz9gLfa/+L14s0QqM89d+Hh7hK0bKLrjA1bMRTRQ7WhLshBTeUv51FQjMTDfV 5hBurEjc+5GxUQ1nJCOaJHcwTwcWNiOnqyp4rObUFF8EBHn4Y1CemSh07IzukSj8HqBg MMvZr+NNj7+uACgPddWEc6zbTVRBbbt2reZzJTg1JBnjYlI+Z4ds3rJL9k3CVobUa3sR O2jg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:cc:reply-to :list-subscribe:list-help:list-post:list-archive:list-unsubscribe :list-id:precedence:subject:mime-version:message-id:date:to:from :delivered-to; bh=B/dcUhIdTGYRKU9QSEvB1QszxTVePI3msxZxI9e2mPk=; fh=73ExZnkQ8FYbu/qeQNmI0dtHCfShNh8/NmZJs1umltM=; b=leyW/DjKQ/ZLX649aV9VMcKH5QDI2eQlUKl6sVjRbsgpL7ptfh5gzKPVTQZFs+U6bh 76Kp4siTVhTblkfDB56+aQrZtE862Y3YT5MEZfGaPFknu5AhoHlKtSLVDNfZMPBEDIeZ fAxL3P+3kmVjBLyK25urid65EupvsC48oX7W1ryeVWpxo33Unal69UT0soyykBGo9UlW +hb3ooGtRwXrSh3kLIJpOVhoL5gyVlOGJtxQideB4t7dQgxHfYUj8D8GavxY4kOkicNC Q2kpV6jkPEsndYNdxI+1Q0+XQAisCu+1P/s6cdTsXfYQLhmK4RqHfazF8QuQ80bT8FQJ g30A==; dara=google.com ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) smtp.mailfrom=ffmpeg-devel-bounces@ffmpeg.org Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org. [79.124.17.100]) by mx.google.com with ESMTP id s17-20020a056402037100b00564cff54b86si679081edw.511.2024.02.29.07.59.09; Thu, 29 Feb 2024 07:59:10 -0800 (PST) Received-SPF: pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) client-ip=79.124.17.100; Authentication-Results: mx.google.com; spf=pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) smtp.mailfrom=ffmpeg-devel-bounces@ffmpeg.org Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id B489B68D18A; Thu, 29 Feb 2024 17:59:07 +0200 (EET) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from b-painless.mh.aa.net.uk (b-painless.mh.aa.net.uk [81.187.30.52]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 6CA4B68CEE3 for ; Thu, 29 Feb 2024 17:59:01 +0200 (EET) Received: from c.e.9.3.3.0.b.1.e.3.4.b.6.2.c.9.0.5.8.0.9.1.8.0.0.b.8.0.1.0.0.2.ip6.arpa ([2001:8b0:819:850:9c26:b43e:1b03:39ec] helo=andrews-2024-laptop.lan) by painless-b.tch.aa.net.uk with esmtp (Exim 4.96) (envelope-from ) id 1rfioG-00Cifi-2d; Thu, 29 Feb 2024 15:59:00 +0000 From: Andrew Sayers To: ffmpeg-devel@ffmpeg.org Date: Thu, 29 Feb 2024 15:58:58 +0000 Message-ID: <20240229155858.849549-1-ffmpeg-devel@pileofstuff.org> X-Mailer: git-send-email 2.43.0 MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH] all: fix "@param foo[in/out]" to "@param[in, out] foo" X-BeenThere: ffmpeg-devel@ffmpeg.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: FFmpeg development discussions and patches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: FFmpeg development discussions and patches Cc: Andrew Sayers Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" X-TUID: CdNUMzgwUEmG Fix a few invalid doxygen comments: /** * @param[in,out] correctly_formatted * @param incorrect1[in] - [in] must come immediately after @param * @param incorrect2[in/out] - '/' must be ',' */ Actual command: sed -i -e "s/\(\* .*param\)\( [^\[]*\)\(\[.*\]\)/\1\3\2/g" -e "s/in\//in,/" $( git grep -l "\* .*param .*\[\(in\|out\)" ) Signed-off-by: Andrew Sayers --- libavcodec/g729postfilter.c | 8 ++++---- libavcodec/g729postfilter.h | 14 +++++++------- libavutil/hdr_dynamic_metadata.h | 4 ++-- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/libavcodec/g729postfilter.c b/libavcodec/g729postfilter.c index 382db92432..b1880b2fe1 100644 --- a/libavcodec/g729postfilter.c +++ b/libavcodec/g729postfilter.c @@ -78,7 +78,7 @@ static const int16_t formant_pp_factor_den_pow[10] = { /** * \brief Residual signal calculation (4.2.1 if G.729) - * \param out [out] output data filtered through A(z/FORMANT_PP_FACTOR_NUM) + * \param[out] out output data filtered through A(z/FORMANT_PP_FACTOR_NUM) * \param filter_coeffs (3.12) A(z/FORMANT_PP_FACTOR_NUM) filter coefficients * \param in input speech data to process * \param subframe_size size of one subframe @@ -105,7 +105,7 @@ static void residual_filter(int16_t* out, const int16_t* filter_coeffs, const in * \param dsp initialized DSP context * \param pitch_delay_int integer part of the pitch delay in the first subframe * \param residual filtering input data - * \param residual_filt [out] speech signal with applied A(z/FORMANT_PP_FACTOR_NUM) filter + * \param[out] residual_filt speech signal with applied A(z/FORMANT_PP_FACTOR_NUM) filter * \param subframe_size size of subframe * * \return 0 if long-term prediction gain is less than 3dB, 1 - otherwise @@ -472,7 +472,7 @@ static int16_t get_tilt_comp(AudioDSPContext *adsp, int16_t *lp_gn, /** * \brief Apply tilt compensation filter (4.2.3). - * \param res_pst [in/out] residual signal (partially filtered) + * \param[in,out] res_pst residual signal (partially filtered) * \param k1 (3.12) reflection coefficient * \param subframe_size size of subframe * \param ht_prev_data previous data for 4.2.3, equation 86 @@ -572,7 +572,7 @@ void ff_g729_postfilter(AudioDSPContext *adsp, int16_t* ht_prev_data, int* voici * \brief Adaptive gain control (4.2.4) * \param gain_before gain of speech before applying postfilters * \param gain_after gain of speech after applying postfilters - * \param speech [in/out] signal buffer + * \param[in,out] speech signal buffer * \param subframe_size length of subframe * \param gain_prev (3.12) previous value of gain coefficient * diff --git a/libavcodec/g729postfilter.h b/libavcodec/g729postfilter.h index 69815341ed..0421ed8720 100644 --- a/libavcodec/g729postfilter.h +++ b/libavcodec/g729postfilter.h @@ -79,15 +79,15 @@ /** * \brief Signal postfiltering (4.2) * \param dsp initialized DSP context - * \param ht_prev_data [in/out] (Q12) pointer to variable receiving tilt + * \param[in,out] ht_prev_data (Q12) pointer to variable receiving tilt * compensation filter data from previous subframe - * \param voicing [in/out] (Q0) pointer to variable receiving voicing decision + * \param[in,out] voicing (Q0) pointer to variable receiving voicing decision * \param lp_filter_coeffs (Q12) LP filter coefficients * \param pitch_delay_int integer part of the pitch delay - * \param residual [in/out] (Q0) residual signal buffer (used in long-term postfilter) - * \param res_filter_data [in/out] (Q0) speech data of previous subframe - * \param pos_filter_data [in/out] (Q0) previous speech data for short-term postfilter - * \param speech [in/out] (Q0) signal buffer + * \param[in,out] residual (Q0) residual signal buffer (used in long-term postfilter) + * \param[in,out] res_filter_data (Q0) speech data of previous subframe + * \param[in,out] pos_filter_data (Q0) previous speech data for short-term postfilter + * \param[in,out] speech (Q0) signal buffer * \param subframe_size size of subframe * * Filtering has the following stages: @@ -105,7 +105,7 @@ void ff_g729_postfilter(AudioDSPContext *adsp, int16_t* ht_prev_data, int* voici * \brief Adaptive gain control (4.2.4) * \param gain_before (Q0) gain of speech before applying postfilters * \param gain_after (Q0) gain of speech after applying postfilters - * \param speech [in/out] (Q0) signal buffer + * \param[in,out] speech (Q0) signal buffer * \param subframe_size length of subframe * \param gain_prev (Q12) previous value of gain coefficient * diff --git a/libavutil/hdr_dynamic_metadata.h b/libavutil/hdr_dynamic_metadata.h index 09e9d8bbcc..5100ed6f41 100644 --- a/libavutil/hdr_dynamic_metadata.h +++ b/libavutil/hdr_dynamic_metadata.h @@ -359,13 +359,13 @@ int av_dynamic_hdr_plus_from_t35(AVDynamicHDRPlus *s, const uint8_t *data, * Serialize dynamic HDR10+ metadata to a user data registered ITU-T T.35 buffer, * excluding the first 48 bytes of the header, and beginning with the application mode. * @param s A pointer containing the decoded AVDynamicHDRPlus structure. - * @param data[in,out] A pointer to pointer to a byte buffer to be filled with the + * @param[in,out] data A pointer to pointer to a byte buffer to be filled with the * serialized metadata. * If *data is NULL, a buffer be will be allocated and a pointer to * it stored in its place. The caller assumes ownership of the buffer. * May be NULL, in which case the function will only store the * required buffer size in *size. - * @param size[in,out] A pointer to a size to be set to the returned buffer's size. + * @param[in,out] size A pointer to a size to be set to the returned buffer's size. * If *data is not NULL, *size must contain the size of the input * buffer. May be NULL only if *data is NULL. *