[FFmpeg-devel] [PATCH v2 1/7] avcodec: Fix Doxygen trailing brief comments
Marvin Scholz
epirat07 at gmail.com
Thu Sep 22 05:03:54 EEST 2022
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(-)
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
};
/**
--
2.37.0 (Apple Git-136)
More information about the ffmpeg-devel
mailing list