diff mbox series

[FFmpeg-devel,13/15] examples: apply doxy entries consistency fixes

Message ID 20230115161035.584474-14-stefasab@gmail.com
State New
Headers show
Series [FFmpeg-devel,01/15] examples: rename avio_reading to avio_read_callback | expand

Checks

Context Check Description
yinshiyou/make_loongarch64 success Make finished
yinshiyou/make_fate_loongarch64 success Make fate finished

Commit Message

Stefano Sabatini Jan. 15, 2023, 4:10 p.m. UTC 
---
 doc/examples/avio_list_dir.c | 8 ++++++++
 doc/examples/encode_audio.c  | 2 +-
 doc/examples/encode_video.c  | 2 +-
 3 files changed, 10 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/doc/examples/avio_list_dir.c b/doc/examples/avio_list_dir.c
index 3073baaefa..13b46e1718 100644
--- a/doc/examples/avio_list_dir.c
+++ b/doc/examples/avio_list_dir.c
@@ -20,6 +20,14 @@ 
  * THE SOFTWARE.
  */
 
+/**
+ * @file
+ * libavformat AVIOContext API example to list directory.
+ *
+ * Show how to list directories through the libavformat AVIOContext API.
+ * @example avio_list_dir.c
+ */
+
 #include <libavcodec/avcodec.h>
 #include <libavformat/avformat.h>
 #include <libavformat/avio.h>
diff --git a/doc/examples/encode_audio.c b/doc/examples/encode_audio.c
index 9a1792b725..4688084e29 100644
--- a/doc/examples/encode_audio.c
+++ b/doc/examples/encode_audio.c
@@ -22,7 +22,7 @@ 
 
 /**
  * @file
- * audio encoding with libavcodec API example.
+ * libavcodec API example to encode audio.
  *
  * @example encode_audio.c
  */
diff --git a/doc/examples/encode_video.c b/doc/examples/encode_video.c
index 6c3a3f5684..e9365e4bbd 100644
--- a/doc/examples/encode_video.c
+++ b/doc/examples/encode_video.c
@@ -22,7 +22,7 @@ 
 
 /**
  * @file
- * video encoding with libavcodec API example
+ * libavcodec API example to encode video
  *
  * @example encode_video.c
  */