[FFmpeg-cvslog] r18829 - trunk/libavcodec/opt.h

[stefano]

Author: stefano
Date: Thu May 14 21:03:22 2009
New Revision: 18829

Log:
Document av_set_string3() returned error codes.

Modified:
   trunk/libavcodec/opt.h

Modified: trunk/libavcodec/opt.h
==============================================================================
--- trunk/libavcodec/opt.h	Thu May 14 20:58:06 2009	(r18828)
+++ trunk/libavcodec/opt.h	Thu May 14 21:03:22 2009	(r18829)
@@ -136,8 +136,11 @@ attribute_deprecated const AVOption *av_
  * @param alloc when 1 then the old value will be av_freed() and the
  *                     new av_strduped()
  *              when 0 then no av_free() nor av_strdup() will be used
- * @return 0 if the value has been set, an AVERROR* error code if no
- * matching option exists, or if the value \p val is not valid
+ * @return 0 if the value has been set, or an AVERROR code in case of
+ * error:
+ * AVERROR(ENOENT) if no matching option exists
+ * AVERROR(ERANGE) if the value is out of range
+ * AVERROR(EINVAL) if the value is not valid
  */
 int av_set_string3(void *obj, const char *name, const char *val, int alloc, const AVOption **o_out);