From 8c6f53db9242813675bd4d334a9094ae7821472e Mon Sep 17 00:00:00 2001 From: Marko Kreen Date: Sun, 27 Feb 2011 20:46:11 +0200 Subject: [PATCH] cfparser: fix docstring --- usual/cfparser.h | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/usual/cfparser.h b/usual/cfparser.h index 7929da8..d3f0889 100644 --- a/usual/cfparser.h +++ b/usual/cfparser.h @@ -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 } -- 2.39.5