diff mbox series

[FFmpeg-devel,v2,1/7] avcodec: Fix Doxygen trailing brief comments

Message ID 20220922020400.46715-1-epirat07@gmail.com
State New
Headers show
Series [FFmpeg-devel,v2,1/7] avcodec: Fix Doxygen trailing brief comments | expand

Checks

Context Check Description
andriy/configure_x86 warning Failed to run configure
yinshiyou/make_loongarch64 success Make finished
yinshiyou/make_fate_loongarch64 success Make fate finished

Commit Message

Marvin Scholz Sept. 22, 2022, 2:03 a.m. UTC
The //< comment is not any magic comment supported by Doxygen,
instead use //!< to mark them as brief doc for the members.
---
 libavcodec/avcodec.h   | 8 ++++----
 libavcodec/codec_par.h | 8 ++++----
 2 files changed, 8 insertions(+), 8 deletions(-)

Comments

Michael Niedermayer Sept. 23, 2022, 7:32 a.m. UTC | #1
On Thu, Sep 22, 2022 at 04:03:54AM +0200, Marvin Scholz wrote:
> The //< comment is not any magic comment supported by Doxygen,
> instead use //!< to mark them as brief doc for the members.

///< is more commonly used in ffmpeg

thx

[...]
Marvin Scholz Sept. 25, 2022, 12:10 a.m. UTC | #2
I've spent some more time to fix most of the issues
and warnings reported by Doxygen. There are a few
left, all undocumented arguments that were not
immediately obvious to me what they do so I could
not confidently document them.

Changes since last version:
 - Use ///< in "Fix Doxygen trailing brief comments"
 - All patches after "avcodec/avcodec: Escape Doxygen reference"
   are new and were not in the previous set.

Marvin Scholz (54):
  avcodec: Fix Doxygen trailing brief comments
  avdevice/avdevice: Fix mismatching argument name
  avformat/avformat: Fix mismatching argument names
  avutil: Fix mismatching argument names
  swresample/swresample: Fix mismatching argument names
  avformat/avformat: Improve doxy style
  avcodec/avcodec: Escape Doxygen reference
  avutil/channel_layout: Remove bogus closing group
  avutil/channel_layout: Move to its own group
  avutil/channel_layout: Group deprecated functions
  avutil/channel_layout: Group pre-defined channel layouts
  avutil/twofish: Fix doxy @param typo
  avcodec/vdpau: Fix doxy comment typo
  avcodec/codec_par: Add missing doxy group opening
  avcodec/videotoolbox: Add proper doxy group
  avutil/aes_ctr: Add proper doxy group
  avutil/display: consolidate group doxy
  avutil/display: Add file to doxy group
  avutil/spherical: consolidate group doxy
  avutil/spherical: Add file to doxy group
  avutil/stereo3d: consolidate group doxy
  avutil/stereo3d: Add file to doxy group
  avutil/csp: Fix bogus doxy filename
  swscale: Fix bogus doxy comment #ifdefs
  avcodec/mediacodec: use inline code for coderefs
  avcodec/mediacodec: link to related documentation
  doc/Doxyfile: Add FF_PAD_STRUCTURE to PREDEFINED
  avutil/bprint: Improve doxy documentation
  swresample: Fix Doxy reference to AVOptions
  avutil/camellia: Fix doxy @param typo
  avutil/channel_layout: Use inline code for Doxy
  avutil/channel_layout: Document missing arguments
  avfilter: Fix doxy references
  avformat/avio: Add doxy for missing argument
  avutil/detection_bbox: Add doxy for missing argument
  avutil/eval: Add doxy for missing arguments
  avutil/file: Add doxy for missing arguments
  avutil/lfg: Add doxy for missing argument
  avutil/lfg: Minor doxy improvements
  avutil/hwcontext: Add doxy for missing argument
  avutil/parseutils: Add doxy for missing arguments
  avutil/parseutils: Use inline code and properly escape
  avutil/uuid: Remove bogus doxy return  doc
  avutil/rc4: Add doxy for missing arguments
  avutil/frame: Add doxy for missing argument
  avutil/avstring: Add doxy for missing argument
  avutil/des: Add doxy for missing arguments
  avutil/crc: Add doxy for missing arguments
  avutil/imgutils: document some missing arguments
  swscale: document some missing arguments
  avcodec/bsf: document missing arguments
  avutil/aes: document some missing arguments
  avutil/aes_ctr: document some missing arguments
  avutil/samplefmt: document missing argument

 doc/Doxyfile               |   1 +
 libavcodec/avcodec.h       |  10 +-
 libavcodec/bsf.h           |   4 +
 libavcodec/codec_par.h     |   9 +-
 libavcodec/mediacodec.h    |   8 +-
 libavcodec/vdpau.h         |   2 +-
 libavcodec/videotoolbox.h  |   9 ++
 libavdevice/avdevice.h     |   2 +-
 libavfilter/avfilter.h     |  21 +++--
 libavformat/avformat.h     | 182 +++++++++++++++++++++----------------
 libavformat/avio.h         |   1 +
 libavutil/aes.h            |   7 +-
 libavutil/aes_ctr.h        |  12 +++
 libavutil/avstring.h       |   1 +
 libavutil/bprint.h         |  78 +++++++++++-----
 libavutil/camellia.h       |   2 +-
 libavutil/channel_layout.h |  41 +++++++--
 libavutil/crc.h            |   3 +
 libavutil/csp.h            |   7 +-
 libavutil/des.h            |   8 +-
 libavutil/detection_bbox.h |   1 +
 libavutil/display.h        |  14 +--
 libavutil/eval.h           |   5 +
 libavutil/file.h           |   4 +
 libavutil/frame.h          |   1 +
 libavutil/hwcontext.h      |   3 +-
 libavutil/imgutils.h       |  20 ++++
 libavutil/lfg.h            |   5 +-
 libavutil/mathematics.h    |   6 +-
 libavutil/mem.h            |   3 +-
 libavutil/parseutils.h     |  24 +++--
 libavutil/rational.h       |   3 +-
 libavutil/rc4.h            |   3 +
 libavutil/samplefmt.h      |   1 +
 libavutil/spherical.h      |  13 +--
 libavutil/stereo3d.h       |  16 ++--
 libavutil/twofish.h        |   2 +-
 libavutil/uuid.h           |   1 -
 libswresample/swresample.h |  10 +-
 libswscale/swscale.h       |  25 +++--
 40 files changed, 372 insertions(+), 196 deletions(-)
diff mbox series

Patch

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index 7db5d1b1c5..665a5eadaf 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -2804,10 +2804,10 @@  int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
  */
 
 enum AVPictureStructure {
-    AV_PICTURE_STRUCTURE_UNKNOWN,      //< unknown
-    AV_PICTURE_STRUCTURE_TOP_FIELD,    //< coded as top field
-    AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
-    AV_PICTURE_STRUCTURE_FRAME,        //< coded as frame
+    AV_PICTURE_STRUCTURE_UNKNOWN,      //!< unknown
+    AV_PICTURE_STRUCTURE_TOP_FIELD,    //!< coded as top field
+    AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //!< coded as bottom field
+    AV_PICTURE_STRUCTURE_FRAME,        //!< coded as frame
 };
 
 typedef struct AVCodecParserContext {
diff --git a/libavcodec/codec_par.h b/libavcodec/codec_par.h
index 7660791a12..8caad71b5e 100644
--- a/libavcodec/codec_par.h
+++ b/libavcodec/codec_par.h
@@ -37,10 +37,10 @@ 
 enum AVFieldOrder {
     AV_FIELD_UNKNOWN,
     AV_FIELD_PROGRESSIVE,
-    AV_FIELD_TT,          //< Top coded_first, top displayed first
-    AV_FIELD_BB,          //< Bottom coded first, bottom displayed first
-    AV_FIELD_TB,          //< Top coded first, bottom displayed first
-    AV_FIELD_BT,          //< Bottom coded first, top displayed first
+    AV_FIELD_TT,          //!< Top coded_first, top displayed first
+    AV_FIELD_BB,          //!< Bottom coded first, bottom displayed first
+    AV_FIELD_TB,          //!< Top coded first, bottom displayed first
+    AV_FIELD_BT,          //!< Bottom coded first, top displayed first
 };
 
 /**