aboutsummaryrefslogtreecommitdiffstats
path: root/doc/examples/resample_audio.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/resample_audio.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/resample_audio.c')
-rw-r--r--doc/examples/resample_audio.c6
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/examples/resample_audio.c b/doc/examples/resample_audio.c
index 890d30c934..db9b4e5e08 100644
--- a/doc/examples/resample_audio.c
+++ b/doc/examples/resample_audio.c
@@ -21,8 +21,12 @@
*/
/**
+ * @file audio resampling API usage example
* @example resample_audio.c
- * libswresample API use example.
+ *
+ * Generate a synthetic audio signal, and Use libswresample API to perform audio
+ * resampling. The output is written to a raw audio file to be played with
+ * ffplay.
*/
#include <libavutil/opt.h>