aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTimothy Gu <timothygu99@gmail.com>2014-07-06 09:53:54 -0700
committerMichael Niedermayer <michaelni@gmx.at>2014-07-06 22:06:51 +0200
commit81f47e272d661cd247498677244dbb216acec35f (patch)
tree50f6fa65014c18d55dd0291ead92a53ccc2cca67
parent2711b4708a20eb8c22970e86ad5137016a358946 (diff)
downloadffmpeg-81f47e272d661cd247498677244dbb216acec35f.tar.gz
swresample: better doxy for configuration-returning functions
Signed-off-by: Timothy Gu <timothygu99@gmail.com> Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
-rw-r--r--libswresample/swresample.h11
1 files changed, 10 insertions, 1 deletions
diff --git a/libswresample/swresample.h b/libswresample/swresample.h
index ae72e4715f..f140abd001 100644
--- a/libswresample/swresample.h
+++ b/libswresample/swresample.h
@@ -352,17 +352,26 @@ int swr_inject_silence(struct SwrContext *s, int count);
int64_t swr_get_delay(struct SwrContext *s, int64_t base);
/**
- * Return the LIBSWRESAMPLE_VERSION_INT constant.
+ * Return the @ref LIBSWRESAMPLE_VERSION_INT constant.
+ *
+ * This is useful to check if the build-time libswresample has the same version
+ * as the run-time one.
+ *
+ * @returns the unsigned int-typed version
*/
unsigned swresample_version(void);
/**
* Return the swr build-time configuration.
+ *
+ * @returns the build-time @c ./configure flags
*/
const char *swresample_configuration(void);
/**
* Return the swr license.
+ *
+ * @returns the license of libswresample, determined at build-time
*/
const char *swresample_license(void);