aboutsummaryrefslogtreecommitdiffstats
path: root/doc/examples/mux.c
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2023-01-15 02:57:14 +0100
committerStefano Sabatini <stefasab@gmail.com>2023-02-11 17:49:01 +0100
commit34ff361921ef3698d18626a7b7e1e9a48821c69a (patch)
treee3ebaa1f074f747dc02d843108a4825701b3bc11 /doc/examples/mux.c
parent3d4dc6aa778e60073f608d379139b46051da2302 (diff)
downloadffmpeg-34ff361921ef3698d18626a7b7e1e9a48821c69a.tar.gz
examples: apply doxy entries consistency fixes
Use consistent format for the @file field and file description.
Diffstat (limited to 'doc/examples/mux.c')
-rw-r--r--doc/examples/mux.c9
1 files changed, 4 insertions, 5 deletions
diff --git a/doc/examples/mux.c b/doc/examples/mux.c
index e3062c5003..d1f682e196 100644
--- a/doc/examples/mux.c
+++ b/doc/examples/mux.c
@@ -21,12 +21,11 @@
*/
/**
- * @file
- * libavformat API example.
- *
- * Output a media file in any supported libavformat format. The default
- * codecs are used.
+ * @file libavformat muxing API usage example
* @example mux.c
+ *
+ * Generate a synthetic audio and video signal and mux them to a media file in
+ * any supported libavformat format. The default codecs are used.
*/
#include <stdlib.h>