swresample: add SwrContext doxy
authorTimothy Gu <timothygu99@gmail.com>
Sun, 6 Jul 2014 16:53:53 +0000 (09:53 -0700)
committerMichael Niedermayer <michaelni@gmx.at>
Sun, 6 Jul 2014 18:58:58 +0000 (20:58 +0200)
Signed-off-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
libswresample/swresample.h

index 27526ef..5977c9c 100644 (file)
@@ -149,6 +149,12 @@ enum SwrFilterType {
  * @}
  */
 
+/**
+ * The libswresample context. Unlike libavcodec and libavformat, this structure
+ * is opaque. This means that if you would like to set options, you must use
+ * the @ref avoptions API and cannot directly set values to members of the
+ * structure.
+ */
 typedef struct SwrContext SwrContext;
 
 /**