[FFmpeg-cvslog] r28537 - trunk/libswscale/swscale.h

[stefano]

Author: stefano
Date: Thu Feb 12 01:12:10 2009
New Revision: 28537

Log:
Apply misc fixes for sws_getCachedContext() documentation.

Modified:
   trunk/libswscale/swscale.h

Modified: trunk/libswscale/swscale.h
==============================================================================
--- trunk/libswscale/swscale.h	Thu Feb 12 01:07:44 2009	(r28536)
+++ trunk/libswscale/swscale.h	Thu Feb 12 01:12:10 2009	(r28537)
@@ -187,14 +187,17 @@ SwsFilter *sws_getDefaultFilter(float lu
 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,