[FFmpeg-devel] [PATCH 5/7] swresample: better doxy for configuration-returning functions

[Timothy Gu]

Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
---
 libswresample/swresample.h | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/libswresample/swresample.h b/libswresample/swresample.h
index 5977c9c..a427f2a 100644
--- a/libswresample/swresample.h
+++ b/libswresample/swresample.h
@@ -325,17 +325,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);
 
-- 
1.9.1