changeset 28502:514300a59359

Apply misc fixes for sws_getCachedContext() documentation.
author stefano
date Thu, 12 Feb 2009 00:12:10 +0000
parents a8a945fe6b09
children 3d22c6da29c9
files libswscale/swscale.h
diffstat 1 files changed, 10 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/libswscale/swscale.h	Thu Feb 12 00:07:44 2009 +0000
+++ b/libswscale/swscale.h	Thu Feb 12 00:12:10 2009 +0000
@@ -187,14 +187,17 @@
 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,