swresample: better doxy for configuration-returning functions
authorTimothy Gu <timothygu99@gmail.com>
Sun, 6 Jul 2014 16:53:54 +0000 (09:53 -0700)
committerMichael Niedermayer <michaelni@gmx.at>
Sun, 6 Jul 2014 20:06:51 +0000 (22:06 +0200)
Signed-off-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
libswresample/swresample.h

index ae72e47..f140abd 100644 (file)
@@ -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);