[FFmpeg-cvslog] swresample: better doxy for configuration-returning functions

[Timothy Gu]

ffmpeg | branch: master | Timothy Gu <timothygu99 at gmail.com> | Sun Jul  6 09:53:54 2014 -0700| [81f47e272d661cd247498677244dbb216acec35f] | committer: Michael Niedermayer

swresample: better doxy for configuration-returning functions

Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
Signed-off-by: Michael Niedermayer <michaelni at gmx.at>

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=81f47e272d661cd247498677244dbb216acec35f
---

 libswresample/swresample.h |   11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/libswresample/swresample.h b/libswresample/swresample.h
index ae72e47..f140abd 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);