From: Martin Mares <mj@ucw.cz>
Date: Tue, 28 Jan 2014 17:00:25 +0000 (+0100)
Subject: Opt: Document CT_USER with optional values
X-Git-Tag: v5.99~12
X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=e7e3fdba9fdab66e15a63cbbf2c19d7241649713;p=libucw.git

Opt: Document CT_USER with optional values
---

diff --git a/ucw/opt.h b/ucw/opt.h
index 38046136..aea225a2 100644
--- a/ucw/opt.h
+++ b/ucw/opt.h
@@ -192,7 +192,8 @@ struct opt_item {
 
 /**
  * An option with user-defined syntax. @ttype is a <<conf:struct_cf_user_type,`cf_user_type`>>
- * describing the syntax, @target is a variable of the corresponding type.
+ * describing the syntax, @target is a variable of the corresponding type. If the @OPT_REQUIRED_VALUE
+ * flag is not set, the parser must be able to parse a NULL value.
  **/
 #define OPT_USER(shortopt, longopt, target, ttype, fl, desc) { .letter = shortopt, .name = longopt, .ptr = &target, .u.utype = &ttype, .flags = fl, .help = desc, .cls = OPT_CL_STATIC, .type = CT_USER }