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

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

[Marvin Scholz]

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)

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

[FFmpeg-devel] [PATCH 2/7] avdevice/avdevice: Fix mismatching argument name

[Marvin Scholz]

---
 libavdevice/avdevice.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/libavdevice/avdevice.h b/libavdevice/avdevice.h
index 0b32e59fed..185593053f 100644
--- a/libavdevice/avdevice.h
+++ b/libavdevice/avdevice.h
@@ -494,7 +494,7 @@ int avdevice_list_devices(struct AVFormatContext *s, AVDeviceInfoList **device_l
 /**
  * Convenient function to free result of avdevice_list_devices().
  *
- * @param devices device list to be freed.
+ * @param device_list device list to be freed.
  */
 void avdevice_free_list_devices(AVDeviceInfoList **device_list);
 
-- 
2.37.0 (Apple Git-136)

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

[FFmpeg-devel] [PATCH 3/7] avformat/avformat: Fix mismatching argument names

[Marvin Scholz]

---
 libavformat/avformat.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 9d46875cce..c695cfc6de 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -2003,7 +2003,7 @@ AVProgram *av_new_program(AVFormatContext *s, int id);
  * avformat_free_context() can be used to free the context and
  * everything allocated by the framework within it.
  *
- * @param *ctx is set to the created format context, or to NULL in
+ * @param ctx pointee is set to the created format context, or to NULL in
  * case of failure
  * @param oformat format to use for allocating the context, if NULL
  * format_name and filename are used instead
@@ -2656,7 +2656,7 @@ const AVIndexEntry *avformat_index_get_entry(AVStream *st, int idx);
  * Get the AVIndexEntry corresponding to the given timestamp.
  *
  * @param st          Stream containing the requested AVIndexEntry.
- * @param timestamp   Timestamp to retrieve the index entry for.
+ * @param wanted_timestamp   Timestamp to retrieve the index entry for.
  * @param flags       If AVSEEK_FLAG_BACKWARD then the returned entry will correspond
  *                    to the timestamp which is <= the requested one, if backward
  *                    is 0, then it will be >=
-- 
2.37.0 (Apple Git-136)

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