Apply misc fixes for sws_getCachedContext() documentation.
authorStefano Sabatini <stefano.sabatini-lala@poste.it>
Thu, 12 Feb 2009 00:12:10 +0000 (00:12 +0000)
committerStefano Sabatini <stefano.sabatini-lala@poste.it>
Thu, 12 Feb 2009 00:12:10 +0000 (00:12 +0000)
Originally committed as revision 28537 to svn://svn.mplayerhq.hu/mplayer/trunk/libswscale

libswscale/swscale.h

index 41d1539..35db84c 100644 (file)
@@ -187,14 +187,17 @@ SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
 void sws_freeFilter(SwsFilter *filter);
 
 /**
- * Checks if context is valid or reallocs a new one instead.
- * If context is NULL, just calls sws_getContext() to get a new one.
- * Otherwise, checks if the parameters are the ones already saved in context.
- * If that is the case, returns the current context.
- * Otherwise, frees context and gets a new one.
+ * Checks if \p context can be reused, otherwise reallocates a new
+ * one.
  *
- * Be warned that srcFilter, dstFilter are not checked, they are
- * asumed to remain valid.
+ * If \p context is NULL, just calls sws_getContext() to get a new
+ * context. Otherwise, checks if the parameters are the ones already
+ * saved in \p context. If that is the case, returns the current
+ * context. Otherwise, frees \p context and gets a new context with
+ * the new parameters.
+ *
+ * Be warned that \p srcFilter and \p dstFilter are not checked, they
+ * are assumed to remain the same.
  */
 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
                                         int srcW, int srcH, enum PixelFormat srcFormat,