From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org [79.124.17.100]) by master.gitmailbox.com (Postfix) with ESMTP id BA84848E70 for ; Wed, 28 Feb 2024 17:10:55 +0000 (UTC) Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 751BE68CE01; Wed, 28 Feb 2024 19:10:33 +0200 (EET) Received: from alt2.a-painless.mh.aa.net.uk (alt2.a-painless.mh.aa.net.uk [81.187.30.51]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id E4D4868AA84 for ; Wed, 28 Feb 2024 19:10:23 +0200 (EET) Received: from e.f.4.d.3.6.c.2.8.5.f.0.e.8.a.1.0.5.8.0.9.1.8.0.0.b.8.0.1.0.0.2.ip6.arpa ([2001:8b0:819:850:1a8e:f58:2c63:d4fe] helo=andrews-2024-laptop.lan) by painless-a.thn.aa.net.uk with esmtp (Exim 4.96) (envelope-from ) id 1rfNRn-00C68W-1G; Wed, 28 Feb 2024 17:10:23 +0000 From: Andrew Sayers To: ffmpeg-devel@ffmpeg.org Date: Wed, 28 Feb 2024 17:09:40 +0000 Message-ID: <20240228171014.816489-3-ffmpeg-devel@pileofstuff.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240228171014.816489-1-ffmpeg-devel@pileofstuff.org> References: <20240228171014.816489-1-ffmpeg-devel@pileofstuff.org> MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH 2/3] avcodec/ivi: Make comments more Doxygen-friendly 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 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" Archived-At: List-Archive: List-Post: Doxygen eats the newline in the first comment, making it harder to read. Join the lines and add a comma, so source and documentation are equally readable. Doxygen only associates the second comment with cust_dec. The comments for cust_dec and cust_tab make perfect sense without it, so downgrade it to a non-doxygen "//" comment. The third comment was missed by the command in the previous commit, because it (correctly but uniquely) doesn't have a trailing comma. Signed-off-by: Andrew Sayers --- libavcodec/ivi.h | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/libavcodec/ivi.h b/libavcodec/ivi.h index ec54f65f30..afc3ec2a75 100644 --- a/libavcodec/ivi.h +++ b/libavcodec/ivi.h @@ -61,18 +61,17 @@ typedef struct IVIHuffDesc { * macroblock/block huffman table descriptor */ typedef struct IVIHuffTab { - int32_t tab_sel; ///< index of one of the predefined tables - /// or "7" for custom one + int32_t tab_sel; ///< index of one of the predefined tables, or "7" for custom one VLC *tab; ///< pointer to the table associated with tab_sel - /// the following are used only when tab_sel == 7 + // the following are used only when tab_sel == 7 IVIHuffDesc cust_desc; ///< custom Huffman codebook descriptor VLC cust_tab; ///< vlc table for custom codebook } IVIHuffTab; enum { IVI_MB_HUFF = 0, ///< Huffman table is used for coding macroblocks - IVI_BLK_HUFF = 1 /// Huffman table is used for coding blocks + IVI_BLK_HUFF = 1 ///< Huffman table is used for coding blocks }; -- 2.43.0 _______________________________________________ ffmpeg-devel mailing list ffmpeg-devel@ffmpeg.org https://ffmpeg.org/mailman/listinfo/ffmpeg-devel To unsubscribe, visit link above, or email ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".