cfparser: fix docstring
authorMarko Kreen <markokr@gmail.com>
Sun, 27 Feb 2011 18:46:11 +0000 (20:46 +0200)
committerMarko Kreen <markokr@gmail.com>
Mon, 28 Feb 2011 05:52:18 +0000 (07:52 +0200)
usual/cfparser.h

index 7929da886ec27e889a491028dd73880eaf0c8fe0..d3f0889468d560e418c66bb528e3e81afbce1987 100644 (file)
@@ -204,11 +204,20 @@ struct CfLookup {
 /**
  * Helper to describe CfKey with relative addressing.
  *
- * Before using it do: #define CF_REL_BASE struct Foo
+ * Before using it defined CF_REL_BASE to base struct.
  *
  * The var should be field in that struct.
  *
- * Later: #undef CF_REL_BASE
+ * @code
+ * struct Foo {
+ *     char *foo_name;
+ * };
+ * #define CF_REL_BASE struct Foo
+ * ...
+ * CF_REL("name", CF_STR, foo_name, 0, NULL)
+ * ...
+ * #undef CF_REL_BASE
+ * @endcode
  */
 #define CF_REL(name, ops, var, flags, def) \
        { name, ops, flags | CF_VAL_REL, offsetof(CF_REL_BASE, var), def }