[FFmpeg-devel] [PATCH] all: Fix doxy comments wrongly designated as trailing ///<

[Andreas Rheinhardt <andreas.rheinhardt@outlook.com>]

[-- Attachment #1: Type: text/plain, Size: 27 bytes --]

Patch attached.

- Andreas

[-- Attachment #2: 0001-all-Fix-doxy-comments-wrongly-designated-as-trailing.patch --]
[-- Type: text/x-patch, Size: 13034 bytes --]

From 012c851e18bbf91e6b28d855785ebbc67f24ad76 Mon Sep 17 00:00:00 2001
From: Andreas Rheinhardt <andreas.rheinhardt@outlook.com>
Date: Sun, 9 Mar 2025 16:03:20 +0100
Subject: [PATCH] all: Fix doxy comments wrongly designated as trailing ///<

The ///< or /**< form of doxygen comments are only to be used
when the documentation follows the member and the comment
block starts on the same line as the member. This commit
fixes wrong uses of them; in particular, this fixes the comment
for mb_height in H.264 SPS's structure which was wrongly added
to mb_width.

Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@outlook.com>
---
 fftools/cmdutils.h              |  2 +-
 fftools/ffmpeg_demux.c          |  4 ++--
 fftools/ffmpeg_filter.c         |  2 +-
 libavcodec/aacsbrdata.h         |  2 +-
 libavcodec/av1dec.c             |  2 +-
 libavcodec/error_resilience.h   |  2 +-
 libavcodec/h264_ps.h            |  2 +-
 libavcodec/h264dec.h            |  6 +++---
 libavcodec/hevc/hevcdec.h       |  8 ++++----
 libavcodec/hevc/ps.h            |  2 +-
 libavcodec/mpegvideo.h          |  2 +-
 libavcodec/wmavoice.c           | 19 ++++++++-----------
 libavfilter/avfilter_internal.h |  4 ++--
 libavformat/rdt.c               |  2 +-
 libavutil/channel_layout.h      |  2 +-
 15 files changed, 29 insertions(+), 32 deletions(-)

diff --git a/fftools/cmdutils.h b/fftools/cmdutils.h
index 316b6a8c64..ad020f893a 100644
--- a/fftools/cmdutils.h
+++ b/fftools/cmdutils.h
@@ -319,7 +319,7 @@ typedef struct Option {
 } Option;
 
 typedef struct OptionGroupDef {
-    /**< group name */
+    /** group name */
     const char *name;
     /**
      * Option to be used as group separator. Can be NULL for groups which
diff --git a/fftools/ffmpeg_demux.c b/fftools/ffmpeg_demux.c
index 4a4a134afa..b8171e336e 100644
--- a/fftools/ffmpeg_demux.c
+++ b/fftools/ffmpeg_demux.c
@@ -71,13 +71,13 @@ typedef struct DemuxStream {
 
     int                      wrap_correction_done;
     int                      saw_first_ts;
-    ///< dts of the first packet read for this stream (in AV_TIME_BASE units)
+    /// dts of the first packet read for this stream (in AV_TIME_BASE units)
     int64_t                  first_dts;
 
     /* predicted dts of the next packet read for this stream or (when there are
      * several frames in a packet) of the next frame in current packet (in AV_TIME_BASE units) */
     int64_t                  next_dts;
-    ///< dts of the last packet read for this stream (in AV_TIME_BASE units)
+    /// dts of the last packet read for this stream (in AV_TIME_BASE units)
     int64_t                  dts;
 
     const AVCodecDescriptor *codec_desc;
diff --git a/fftools/ffmpeg_filter.c b/fftools/ffmpeg_filter.c
index cd8a4abc52..ef35c3988f 100644
--- a/fftools/ffmpeg_filter.c
+++ b/fftools/ffmpeg_filter.c
@@ -160,7 +160,7 @@ typedef struct InputFilterPriv {
         int64_t last_pts;
         int64_t end_pts;
 
-        ///< marks if sub2video_update should force an initialization
+        /// marks if sub2video_update should force an initialization
         unsigned int initialize;
     } sub2video;
 } InputFilterPriv;
diff --git a/libavcodec/aacsbrdata.h b/libavcodec/aacsbrdata.h
index 9c25098240..996e557059 100644
--- a/libavcodec/aacsbrdata.h
+++ b/libavcodec/aacsbrdata.h
@@ -41,7 +41,7 @@ static const int8_t sbr_offset[6][16] = {
     {-2, -1,  0,  1,  2,  3,  4,  5,  6,  7,  9, 11, 13, 16, 20, 24}, // 64000 Hz <  fs_sbr
 };
 
-///< window coefficients for analysis/synthesis QMF banks
+/// window coefficients for analysis/synthesis QMF banks
 static const DECLARE_ALIGNED(32, INTFLOAT, sbr_qmf_window_ds)[320] = {
      Q31( 0.0000000000f), Q31(-0.0005617692f),
      Q31(-0.0004875227f), Q31(-0.0005040714f),
diff --git a/libavcodec/av1dec.c b/libavcodec/av1dec.c
index 7c54e36220..ed504ace85 100644
--- a/libavcodec/av1dec.c
+++ b/libavcodec/av1dec.c
@@ -41,7 +41,7 @@
 #include "progressframe.h"
 #include "libavutil/refstruct.h"
 
-/**< same with Div_Lut defined in spec 7.11.3.7 */
+/** same with Div_Lut defined in spec 7.11.3.7 */
 static const uint16_t div_lut[AV1_DIV_LUT_NUM] = {
   16384, 16320, 16257, 16194, 16132, 16070, 16009, 15948, 15888, 15828, 15768,
   15709, 15650, 15592, 15534, 15477, 15420, 15364, 15308, 15252, 15197, 15142,
diff --git a/libavcodec/error_resilience.h b/libavcodec/error_resilience.h
index a1b9b9ec1a..4005018676 100644
--- a/libavcodec/error_resilience.h
+++ b/libavcodec/error_resilience.h
@@ -25,7 +25,7 @@
 #include "avcodec.h"
 #include "me_cmp.h"
 
-///< current MB is the first after a resync marker
+/// current MB is the first after a resync marker
 #define VP_START               1
 #define ER_AC_ERROR            2
 #define ER_DC_ERROR            4
diff --git a/libavcodec/h264_ps.h b/libavcodec/h264_ps.h
index 80af4832fe..f216e4989f 100644
--- a/libavcodec/h264_ps.h
+++ b/libavcodec/h264_ps.h
@@ -57,7 +57,7 @@ typedef struct SPS {
     int ref_frame_count;               ///< num_ref_frames
     int gaps_in_frame_num_allowed_flag;
     int mb_width;                      ///< pic_width_in_mbs_minus1 + 1
-    ///< (pic_height_in_map_units_minus1 + 1) * (2 - frame_mbs_only_flag)
+    /// (pic_height_in_map_units_minus1 + 1) * (2 - frame_mbs_only_flag)
     int mb_height;
     int frame_mbs_only_flag;
     int mb_aff;                        ///< mb_adaptive_frame_field_flag
diff --git a/libavcodec/h264dec.h b/libavcodec/h264dec.h
index 5abc60c09d..c28d278240 100644
--- a/libavcodec/h264dec.h
+++ b/libavcodec/h264dec.h
@@ -305,11 +305,11 @@ typedef struct H264SliceContext {
 
     DECLARE_ALIGNED(8, uint16_t, sub_mb_type)[4];
 
-    ///< as a DCT coefficient is int32_t in high depth, we need to reserve twice the space.
+    /// as a DCT coefficient is int32_t in high depth, we need to reserve twice the space.
     DECLARE_ALIGNED(16, int16_t, mb)[16 * 48 * 2];
     DECLARE_ALIGNED(16, int16_t, mb_luma_dc)[3][16 * 2];
-    ///< as mb is addressed by scantable[i] and scantable is uint8_t we can either
-    ///< check that i is not too large or ensure that there is some unused stuff after mb
+    /// as mb is addressed by scantable[i] and scantable is uint8_t we can either
+    /// check that i is not too large or ensure that there is some unused stuff after mb
     int16_t mb_padding[256 * 2];
 
     uint8_t (*mvd_table[2])[2];
diff --git a/libavcodec/hevc/hevcdec.h b/libavcodec/hevc/hevcdec.h
index 5bfaf89d79..911d5c3ae3 100644
--- a/libavcodec/hevc/hevcdec.h
+++ b/libavcodec/hevc/hevcdec.h
@@ -207,9 +207,9 @@ typedef struct RefPicListTab {
 typedef struct SliceHeader {
     unsigned int pps_id;
 
-    ///< address (in raster order) of the first block in the current slice segment
+    /// address (in raster order) of the first block in the current slice segment
     unsigned int   slice_segment_addr;
-    ///< address (in raster order) of the first block in the current slice
+    /// address (in raster order) of the first block in the current slice
     unsigned int   slice_addr;
 
     enum HEVCSliceType slice_type;
@@ -223,7 +223,7 @@ typedef struct SliceHeader {
     uint8_t colour_plane_id;
     uint8_t inter_layer_pred;
 
-    ///< RPS coded in the slice header itself is stored here
+    /// RPS coded in the slice header itself is stored here
     int short_term_ref_pic_set_sps_flag;
     int short_term_ref_pic_set_size;
     ShortTermRPS slice_rps;
@@ -513,7 +513,7 @@ typedef struct HEVCContext {
     HEVCSEI sei;
     struct AVMD5 *md5_ctx;
 
-    ///< candidate references for the current frame
+    /// candidate references for the current frame
     RefPicList rps[NB_RPS_TYPE];
 
     const HEVCVPS *vps; ///< RefStruct reference
diff --git a/libavcodec/hevc/ps.h b/libavcodec/hevc/ps.h
index 2b5c2c0c1d..25475b5593 100644
--- a/libavcodec/hevc/ps.h
+++ b/libavcodec/hevc/ps.h
@@ -346,7 +346,7 @@ typedef struct HEVCSPS {
     int sps_palette_predictor_initializer[3][HEVC_MAX_PALETTE_PREDICTOR_SIZE];
     int motion_vector_resolution_control_idc;
 
-    ///< coded frame dimension in various units
+    /// coded frame dimension in various units
     int width;
     int height;
     int ctb_width;
diff --git a/libavcodec/mpegvideo.h b/libavcodec/mpegvideo.h
index 10be87450a..afd18591c4 100644
--- a/libavcodec/mpegvideo.h
+++ b/libavcodec/mpegvideo.h
@@ -372,7 +372,7 @@ typedef struct MpegEncContext {
     /* MPEG-4 specific */
     int studio_profile;
     int dct_precision;
-    ///< number of bits to represent the fractional part of time (encoder only)
+    /// number of bits to represent the fractional part of time (encoder only)
     int time_increment_bits;
     int last_time_base;
     int time_base;                  ///< time in seconds of last I,P,S Frame
diff --git a/libavcodec/wmavoice.c b/libavcodec/wmavoice.c
index 39868e02b3..a1f89aeb76 100644
--- a/libavcodec/wmavoice.c
+++ b/libavcodec/wmavoice.c
@@ -199,7 +199,7 @@ typedef struct WMAVoiceContext {
                                   ///< to #wmavoice_decode_packet() (since
                                   ///< they're part of the previous superframe)
 
-    uint8_t sframe_cache[SFRAME_CACHE_MAXSIZE + AV_INPUT_BUFFER_PADDING_SIZE];
+    uint8_t sframe_cache[SFRAME_CACHE_MAXSIZE + AV_INPUT_BUFFER_PADDING_SIZE]; ///<
                                   ///< cache for superframe data split over
                                   ///< multiple packets
     int sframe_cache_size;        ///< set to >0 if we have data from an
@@ -249,10 +249,9 @@ typedef struct WMAVoiceContext {
                                   ///< only used for comfort noise in #pRNG()
     int nb_superframes;           ///< number of superframes in current packet
     float gain_pred_err[6];       ///< cache for gain prediction
-    float excitation_history[MAX_SIGNAL_HISTORY];
-                                  ///< cache of the signal of previous
-                                  ///< superframes, used as a history for
-                                  ///< signal generation
+    float excitation_history[MAX_SIGNAL_HISTORY]; ///< cache of the signal of
+                                  ///< previous superframes, used as a history
+                                  ///< for signal generation
     float synth_history[MAX_LSPS]; ///< see #excitation_history
     /**
      * @}
@@ -272,18 +271,16 @@ typedef struct WMAVoiceContext {
     float postfilter_agc;         ///< gain control memory, used in
                                   ///< #adaptive_gain_control()
     float dcf_mem[2];             ///< DC filter history
+    /// zero filter output (i.e. excitation) by postfilter
     float zero_exc_pf[MAX_SIGNAL_HISTORY + MAX_SFRAMESIZE];
-                                  ///< zero filter output (i.e. excitation)
-                                  ///< by postfilter
     float denoise_filter_cache[MAX_FRAMESIZE];
     int   denoise_filter_cache_size; ///< samples in #denoise_filter_cache
+    /// aligned buffer for LPC tilting
     DECLARE_ALIGNED(32, float, tilted_lpcs_pf)[0x82];
-                                  ///< aligned buffer for LPC tilting
+    /// aligned buffer for denoise coefficients
     DECLARE_ALIGNED(32, float, denoise_coeffs_pf)[0x82];
-                                  ///< aligned buffer for denoise coefficients
+    /// aligned buffer for postfilter speech synthesis
     DECLARE_ALIGNED(32, float, synth_filter_out_buf)[0x80 + MAX_LSPS_ALIGN16];
-                                  ///< aligned buffer for postfilter speech
-                                  ///< synthesis
     /**
      * @}
      */
diff --git a/libavfilter/avfilter_internal.h b/libavfilter/avfilter_internal.h
index e0aee20a32..cad4b2124b 100644
--- a/libavfilter/avfilter_internal.h
+++ b/libavfilter/avfilter_internal.h
@@ -110,9 +110,9 @@ typedef struct FFFilterContext {
      */
     unsigned ready;
 
-    ///< parsed expression
+    /// parsed expression
     struct AVExpr *enable;
-    ///< variable values for the enable expression
+    /// variable values for the enable expression
     double *var_values;
 
     struct AVFilterCommand *command_queue;
diff --git a/libavformat/rdt.c b/libavformat/rdt.c
index 2fa53d34a8..63f908a9d3 100644
--- a/libavformat/rdt.c
+++ b/libavformat/rdt.c
@@ -293,7 +293,7 @@ ff_rdt_parse_header(const uint8_t *buf, int len,
     return consumed + (get_bits_count(&gb) >> 3);
 }
 
-/**< return 0 on packet, no more left, 1 on packet, 1 on partial packet... */
+/** return 0 on packet, no more left, 1 on packet, 1 on partial packet... */
 static int
 rdt_parse_packet (AVFormatContext *ctx, PayloadContext *rdt, AVStream *st,
                   AVPacket *pkt, uint32_t *timestamp,
diff --git a/libavutil/channel_layout.h b/libavutil/channel_layout.h
index 793df44c12..b82d07eb5e 100644
--- a/libavutil/channel_layout.h
+++ b/libavutil/channel_layout.h
@@ -45,7 +45,7 @@
  */
 
 enum AVChannel {
-    ///< Invalid channel index
+    /// Invalid channel index
     AV_CHAN_NONE = -1,
     AV_CHAN_FRONT_LEFT,
     AV_CHAN_FRONT_RIGHT,
-- 
2.45.2


[-- Attachment #3: Type: text/plain, Size: 251 bytes --]

_______________________________________________
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".