[FFmpeg-cvslog] swresample: document the need to configure the context using AVOptions

[Luca Barbato]

ffmpeg | branch: master | Luca Barbato <lu_zero at gentoo.org> | Mon Aug 11 00:35:19 2014 +0200| [c4ac48c5a1464e20bb02ef62da2503906349e297] | committer: Michael Niedermayer

swresample: document the need to configure the context using AVOptions

Signed-off-by: Michael Niedermayer <michaelni at gmx.at>

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

 libswresample/swresample.h |    4 ++++
 1 file changed, 4 insertions(+)

diff --git a/libswresample/swresample.h b/libswresample/swresample.h
index e4bbeba..4b8b045 100644
--- a/libswresample/swresample.h
+++ b/libswresample/swresample.h
@@ -211,6 +211,10 @@ struct SwrContext *swr_alloc(void);
 
 /**
  * Initialize context after user parameters have been set.
+ * @note The context must be configured using the AVOption API.
+ *
+ * @see av_opt_set_int()
+ * @see av_opt_set_dict()
  *
  * @param[in,out]   s Swr context to initialize
  * @return AVERROR error code in case of failure.