From 81f47e272d661cd247498677244dbb216acec35f Mon Sep 17 00:00:00 2001 From: Timothy Gu <timothygu99@gmail.com> Date: Sun, 6 Jul 2014 09:53:54 -0700 Subject: [PATCH] swresample: better doxy for configuration-returning functions Signed-off-by: Timothy Gu <timothygu99@gmail.com> Signed-off-by: Michael Niedermayer <michaelni@gmx.at> --- libswresample/swresample.h | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/libswresample/swresample.h b/libswresample/swresample.h index ae72e4715f9..f140abd0019 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); -- GitLab