changeset 9642:d706b300b89f libavcodec

Document av_set_string3() returned error codes.
author stefano
date Thu, 14 May 2009 19:03:22 +0000
parents 04d77f7cc7fd
children 5c9d3a72aabf
files opt.h
diffstat 1 files changed, 5 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/opt.h	Thu May 14 18:50:58 2009 +0000
+++ b/opt.h	Thu May 14 19:03:22 2009 +0000
@@ -136,8 +136,11 @@
  * @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);