]> granicus.if.org Git - neomutt/commitdiff
doxy: config functions
authorRichard Russon <rich@flatcap.org>
Sat, 4 Aug 2018 21:49:38 +0000 (22:49 +0100)
committerRichard Russon <rich@flatcap.org>
Sat, 4 Aug 2018 22:20:21 +0000 (23:20 +0100)
12 files changed:
config/address.c
config/bool.c
config/long.c
config/magic.c
config/mbtable.c
config/number.c
config/path.c
config/quad.c
config/regex.c
config/set.h
config/sort.c
config/string.c

index 1bd0ce4bbb6d02502c58ecb405ecea79e30f294d..019218b0cd86418c7335b4a815ab6c42be82ef3d 100644 (file)
 #include "types.h"
 
 /**
- * address_destroy - Destroy an Address object
- * @param cs   Config items
- * @param var  Variable to destroy
- * @param cdef Variable definition
+ * address_destroy - Destroy an Address object - Implements ::cst_destroy
  */
 static void address_destroy(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef)
 {
@@ -57,15 +54,7 @@ static void address_destroy(const struct ConfigSet *cs, void *var, const struct
 }
 
 /**
- * address_string_set - Set an Address by string
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Value to set
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be set.
+ * address_string_set - Set an Address by string - Implements ::cst_string_set
  */
 static int address_string_set(const struct ConfigSet *cs, void *var, struct ConfigDef *cdef,
                               const char *value, struct Buffer *err)
@@ -118,14 +107,7 @@ static int address_string_set(const struct ConfigSet *cs, void *var, struct Conf
 }
 
 /**
- * address_string_get - Get an Address as a string
- * @param cs     Config items
- * @param var    Variable to get
- * @param cdef   Variable definition
- * @param result Buffer for results or error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be returned.
+ * address_string_get - Get an Address as a string - Implements ::cst_string_get
  */
 static int address_string_get(const struct ConfigSet *cs, void *var,
                               const struct ConfigDef *cdef, struct Buffer *result)
@@ -174,13 +156,7 @@ static struct Address *address_dup(struct Address *addr)
 }
 
 /**
- * address_native_set - Set an Address config item by Address object
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Address pointer
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * address_native_set - Set an Address config item by Address object - Implements ::cst_native_set
  */
 static int address_native_set(const struct ConfigSet *cs, void *var,
                               const struct ConfigDef *cdef, intptr_t value,
@@ -212,12 +188,7 @@ static int address_native_set(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * address_native_get - Get an Address object from an Address config item
- * @param cs   Config items
- * @param var  Variable to get
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval intptr_t Address pointer
+ * address_native_get - Get an Address object from an Address config item - Implements ::cst_native_get
  */
 static intptr_t address_native_get(const struct ConfigSet *cs, void *var,
                                    const struct ConfigDef *cdef, struct Buffer *err)
@@ -231,12 +202,7 @@ static intptr_t address_native_get(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * address_reset - Reset an Address to its initial value
- * @param cs   Config items
- * @param var  Variable to reset
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * address_reset - Reset an Address to its initial value - Implements ::cst_regex
  */
 static int address_reset(const struct ConfigSet *cs, void *var,
                          const struct ConfigDef *cdef, struct Buffer *err)
index 30fca1c24120dda954fc94555e3b8bc0dcbc9950..fe0975da56008c57630b2769523ef889fc983ebf 100644 (file)
@@ -49,15 +49,7 @@ const char *bool_values[] = {
 };
 
 /**
- * bool_string_set - Set a Bool by string
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Value to set
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be set.
+ * bool_string_set - Set a Bool by string - Implements ::cst_string_set
  */
 static int bool_string_set(const struct ConfigSet *cs, void *var, struct ConfigDef *cdef,
                            const char *value, struct Buffer *err)
@@ -105,14 +97,7 @@ static int bool_string_set(const struct ConfigSet *cs, void *var, struct ConfigD
 }
 
 /**
- * bool_string_get - Get a Bool as a string
- * @param cs     Config items
- * @param var    Variable to get
- * @param cdef   Variable definition
- * @param result Buffer for results or error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be returned.
+ * bool_string_get - Get a Bool as a string - Implements ::cst_string_get
  */
 static int bool_string_get(const struct ConfigSet *cs, void *var,
                            const struct ConfigDef *cdef, struct Buffer *result)
@@ -138,13 +123,7 @@ static int bool_string_get(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * bool_native_set - Set a Bool config item by bool
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Bool value
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * bool_native_set - Set a Bool config item by bool - Implements ::cst_native_set
  */
 static int bool_native_set(const struct ConfigSet *cs, void *var,
                            const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
@@ -174,12 +153,7 @@ static int bool_native_set(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * bool_native_get - Get a bool from a Bool config item
- * @param cs   Config items
- * @param var  Variable to get
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval intptr_t Bool
+ * bool_native_get - Get a bool from a Bool config item - Implements ::cst_native_get
  */
 static intptr_t bool_native_get(const struct ConfigSet *cs, void *var,
                                 const struct ConfigDef *cdef, struct Buffer *err)
@@ -191,12 +165,7 @@ static intptr_t bool_native_get(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * bool_reset - Reset a Bool to its initial value
- * @param cs   Config items
- * @param var  Variable to reset
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * bool_reset - Reset a Bool to its initial value - Implements ::cst_regex
  */
 static int bool_reset(const struct ConfigSet *cs, void *var,
                       const struct ConfigDef *cdef, struct Buffer *err)
index 9bbd84f22497b83a588f2288b17887ee008331f5..27f713afb8109e2ccf6304e00cb062c8a7bc1445 100644 (file)
 #include "types.h"
 
 /**
- * long_string_set - Set a Long by string
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Value to set
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be set.
+ * long_string_set - Set a Long by string - Implements ::cst_string_set
  */
 static int long_string_set(const struct ConfigSet *cs, void *var, struct ConfigDef *cdef,
                            const char *value, struct Buffer *err)
@@ -89,14 +81,7 @@ static int long_string_set(const struct ConfigSet *cs, void *var, struct ConfigD
 }
 
 /**
- * long_string_get - Get a Long as a string
- * @param cs     Config items
- * @param var    Variable to get
- * @param cdef   Variable definition
- * @param result Buffer for results or error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be returned.
+ * long_string_get - Get a Long as a string - Implements ::cst_string_get
  */
 static int long_string_get(const struct ConfigSet *cs, void *var,
                            const struct ConfigDef *cdef, struct Buffer *result)
@@ -116,13 +101,7 @@ static int long_string_get(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * long_native_set - Set a Long config item by int
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Long
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * long_native_set - Set a Long config item by int - Implements ::cst_native_set
  */
 static int long_native_set(const struct ConfigSet *cs, void *var,
                            const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
@@ -152,12 +131,7 @@ static int long_native_set(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * long_native_get - Get an int from a Long config item
- * @param cs   Config items
- * @param var  Variable to get
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval intptr_t Long
+ * long_native_get - Get an int from a Long config item - Implements ::cst_native_get
  */
 static intptr_t long_native_get(const struct ConfigSet *cs, void *var,
                                 const struct ConfigDef *cdef, struct Buffer *err)
@@ -169,12 +143,7 @@ static intptr_t long_native_get(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * long_reset - Reset a Long to its initial value
- * @param cs   Config items
- * @param var  Variable to reset
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * long_reset - Reset a Long to its initial value - Implements ::cst_regex
  */
 static int long_reset(const struct ConfigSet *cs, void *var,
                       const struct ConfigDef *cdef, struct Buffer *err)
index dae2b83cfb122ef1562c1f13415289161dad7520..2e1651bfcece90c29fa5d74952720187b6d2caf3 100644 (file)
@@ -45,15 +45,7 @@ const char *magic_values[] = {
 };
 
 /**
- * magic_string_set - Set a Mailbox Magic by string
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Value to set
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be set.
+ * magic_string_set - Set a Mailbox Magic by string - Implements ::cst_string_set
  */
 static int magic_string_set(const struct ConfigSet *cs, void *var, struct ConfigDef *cdef,
                             const char *value, struct Buffer *err)
@@ -107,14 +99,7 @@ static int magic_string_set(const struct ConfigSet *cs, void *var, struct Config
 }
 
 /**
- * magic_string_get - Get a Mailbox Magic as a string
- * @param cs     Config items
- * @param var    Variable to get
- * @param cdef   Variable definition
- * @param result Buffer for results or error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be returned.
+ * magic_string_get - Get a Mailbox Magic as a string - Implements ::cst_string_get
  */
 static int magic_string_get(const struct ConfigSet *cs, void *var,
                             const struct ConfigDef *cdef, struct Buffer *result)
@@ -140,13 +125,7 @@ static int magic_string_get(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * magic_native_set - Set a Mailbox Magic config item by int
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Mailbox magic
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * magic_native_set - Set a Mailbox Magic config item by int - Implements ::cst_native_set
  */
 static int magic_native_set(const struct ConfigSet *cs, void *var,
                             const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
@@ -176,12 +155,7 @@ static int magic_native_set(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * magic_native_get - Get an int from a Mailbox Magic config item
- * @param cs   Config items
- * @param var  Variable to get
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval intptr_t Mailbox magic
+ * magic_native_get - Get an int from a Mailbox Magic config item - Implements ::cst_native_get
  */
 static intptr_t magic_native_get(const struct ConfigSet *cs, void *var,
                                  const struct ConfigDef *cdef, struct Buffer *err)
@@ -193,12 +167,7 @@ static intptr_t magic_native_get(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * magic_reset - Reset a Mailbox Magic to its initial value
- * @param cs   Config items
- * @param var  Variable to reset
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * magic_reset - Reset a Mailbox Magic to its initial value - Implements ::cst_regex
  */
 static int magic_reset(const struct ConfigSet *cs, void *var,
                        const struct ConfigDef *cdef, struct Buffer *err)
index 2f7073829f0eb3978d7a7c8c9a63d25a5e4dfc72..b48dba9b48bd9fcec02fba52cf37db5ab7f54c2c 100644 (file)
@@ -87,10 +87,7 @@ struct MbTable *mbtable_parse(const char *s)
 }
 
 /**
- * mbtable_destroy - Destroy an MbTable object
- * @param cs   Config items
- * @param var  Variable to destroy
- * @param cdef Variable definition
+ * mbtable_destroy - Destroy an MbTable object - Implements ::cst_destroy
  */
 static void mbtable_destroy(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef)
 {
@@ -105,15 +102,7 @@ static void mbtable_destroy(const struct ConfigSet *cs, void *var, const struct
 }
 
 /**
- * mbtable_string_set - Set a MbTable by string
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Value to set
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be set.
+ * mbtable_string_set - Set a MbTable by string - Implements ::cst_string_set
  */
 static int mbtable_string_set(const struct ConfigSet *cs, void *var, struct ConfigDef *cdef,
                               const char *value, struct Buffer *err)
@@ -167,14 +156,7 @@ static int mbtable_string_set(const struct ConfigSet *cs, void *var, struct Conf
 }
 
 /**
- * mbtable_string_get - Get a MbTable as a string
- * @param cs     Config items
- * @param var    Variable to get
- * @param cdef   Variable definition
- * @param result Buffer for results or error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be returned.
+ * mbtable_string_get - Get a MbTable as a string - Implements ::cst_string_get
  */
 static int mbtable_string_get(const struct ConfigSet *cs, void *var,
                               const struct ConfigDef *cdef, struct Buffer *result)
@@ -216,13 +198,7 @@ static struct MbTable *mbtable_dup(struct MbTable *table)
 }
 
 /**
- * mbtable_native_set - Set a MbTable config item by MbTable object
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value MbTable pointer
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * mbtable_native_set - Set a MbTable config item by MbTable object - Implements ::cst_native_set
  */
 static int mbtable_native_set(const struct ConfigSet *cs, void *var,
                               const struct ConfigDef *cdef, intptr_t value,
@@ -254,12 +230,7 @@ static int mbtable_native_set(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * mbtable_native_get - Get an MbTable object from a MbTable config item
- * @param cs   Config items
- * @param var  Variable to get
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval intptr_t MbTable pointer
+ * mbtable_native_get - Get an MbTable object from a MbTable config item - Implements ::cst_native_get
  */
 static intptr_t mbtable_native_get(const struct ConfigSet *cs, void *var,
                                    const struct ConfigDef *cdef, struct Buffer *err)
@@ -273,12 +244,7 @@ static intptr_t mbtable_native_get(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * mbtable_reset - Reset an MbTable to its initial value
- * @param cs   Config items
- * @param var  Variable to reset
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * mbtable_reset - Reset an MbTable to its initial value - Implements ::cst_regex
  */
 static int mbtable_reset(const struct ConfigSet *cs, void *var,
                          const struct ConfigDef *cdef, struct Buffer *err)
index a6ef7a0fe0d432077944b65dfeacf1c82886844e..81a598cce0ded63bef3b4734fcf0fc75f5ed250c 100644 (file)
 #include "types.h"
 
 /**
- * number_string_set - Set a Number by string
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Value to set
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be set.
+ * number_string_set - Set a Number by string - Implements ::cst_string_set
  */
 static int number_string_set(const struct ConfigSet *cs, void *var, struct ConfigDef *cdef,
                              const char *value, struct Buffer *err)
@@ -101,14 +93,7 @@ static int number_string_set(const struct ConfigSet *cs, void *var, struct Confi
 }
 
 /**
- * number_string_get - Get a Number as a string
- * @param cs     Config items
- * @param var    Variable to get
- * @param cdef   Variable definition
- * @param result Buffer for results or error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be returned.
+ * number_string_get - Get a Number as a string - Implements ::cst_string_get
  */
 static int number_string_get(const struct ConfigSet *cs, void *var,
                              const struct ConfigDef *cdef, struct Buffer *result)
@@ -128,13 +113,7 @@ static int number_string_get(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * number_native_set - Set a Number config item by int
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Number
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * number_native_set - Set a Number config item by int - Implements ::cst_native_set
  */
 static int number_native_set(const struct ConfigSet *cs, void *var,
                              const struct ConfigDef *cdef, intptr_t value,
@@ -171,12 +150,7 @@ static int number_native_set(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * number_native_get - Get an int from a Number config item
- * @param cs   Config items
- * @param var  Variable to get
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval intptr_t Number
+ * number_native_get - Get an int from a Number config item - Implements ::cst_native_get
  */
 static intptr_t number_native_get(const struct ConfigSet *cs, void *var,
                                   const struct ConfigDef *cdef, struct Buffer *err)
@@ -188,12 +162,7 @@ static intptr_t number_native_get(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * number_reset - Reset a Number to its initial value
- * @param cs   Config items
- * @param var  Variable to reset
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * number_reset - Reset a Number to its initial value - Implements ::cst_regex
  */
 static int number_reset(const struct ConfigSet *cs, void *var,
                         const struct ConfigDef *cdef, struct Buffer *err)
index 158e89737689b2b24ee9711f4d1803813fb29090..10976b178d46a2687fbdd192f28e4fa9b1cee98e 100644 (file)
 #include "types.h"
 
 /**
- * path_destroy - Destroy a Path
- * @param cs   Config items
- * @param var  Variable to destroy
- * @param cdef Variable definition
+ * path_destroy - Destroy a Path - Implements ::cst_destroy
  */
 static void path_destroy(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef)
 {
@@ -62,15 +59,7 @@ static void path_destroy(const struct ConfigSet *cs, void *var, const struct Con
 }
 
 /**
- * path_string_set - Set a Path by string
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Value to set
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be set.
+ * path_string_set - Set a Path by string - Implements ::cst_string_set
  */
 static int path_string_set(const struct ConfigSet *cs, void *var, struct ConfigDef *cdef,
                            const char *value, struct Buffer *err)
@@ -128,14 +117,7 @@ static int path_string_set(const struct ConfigSet *cs, void *var, struct ConfigD
 }
 
 /**
- * path_string_get - Get a Path as a string
- * @param cs     Config items
- * @param var    Variable to get
- * @param cdef   Variable definition
- * @param result Buffer for results or error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be returned.
+ * path_string_get - Get a Path as a string - Implements ::cst_string_get
  */
 static int path_string_get(const struct ConfigSet *cs, void *var,
                            const struct ConfigDef *cdef, struct Buffer *result)
@@ -158,13 +140,7 @@ static int path_string_get(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * path_native_set - Set a Path config item by string
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Native pointer/value to set
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * path_native_set - Set a Path config item by string - Implements ::cst_native_set
  */
 static int path_native_set(const struct ConfigSet *cs, void *var,
                            const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
@@ -209,12 +185,7 @@ static int path_native_set(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * path_native_get - Get a string from a Path config item
- * @param cs   Config items
- * @param var  Variable to get
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval intptr_t Path string
+ * path_native_get - Get a string from a Path config item - Implements ::cst_native_get
  */
 static intptr_t path_native_get(const struct ConfigSet *cs, void *var,
                                 const struct ConfigDef *cdef, struct Buffer *err)
@@ -228,12 +199,7 @@ static intptr_t path_native_get(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * path_reset - Reset a Path to its initial value
- * @param cs   Config items
- * @param var  Variable to reset
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * path_reset - Reset a Path to its initial value - Implements ::cst_regex
  */
 static int path_reset(const struct ConfigSet *cs, void *var,
                       const struct ConfigDef *cdef, struct Buffer *err)
index fbdc307a5175abb04d4d047f51e811482081c421..5bbf8c5151a15ea7f29b98fb574989ecd865a6ad 100644 (file)
@@ -48,15 +48,7 @@ const char *quad_values[] = {
 };
 
 /**
- * quad_string_set - Set a Quad-option by string
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Value to set
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be set.
+ * quad_string_set - Set a Quad-option by string - Implements ::cst_string_set
  */
 static int quad_string_set(const struct ConfigSet *cs, void *var, struct ConfigDef *cdef,
                            const char *value, struct Buffer *err)
@@ -104,14 +96,7 @@ static int quad_string_set(const struct ConfigSet *cs, void *var, struct ConfigD
 }
 
 /**
- * quad_string_get - Get a Quad-option as a string
- * @param cs     Config items
- * @param var    Variable to get
- * @param cdef   Variable definition
- * @param result Buffer for results or error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be returned.
+ * quad_string_get - Get a Quad-option as a string - Implements ::cst_string_get
  */
 static int quad_string_get(const struct ConfigSet *cs, void *var,
                            const struct ConfigDef *cdef, struct Buffer *result)
@@ -137,13 +122,7 @@ static int quad_string_get(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * quad_native_set - Set a Quad-option config item by int
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Quad-option value
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * quad_native_set - Set a Quad-option config item by int - Implements ::cst_native_set
  */
 static int quad_native_set(const struct ConfigSet *cs, void *var,
                            const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
@@ -173,12 +152,7 @@ static int quad_native_set(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * quad_native_get - Get an int object from a Quad-option config item
- * @param cs   Config items
- * @param var  Variable to get
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval intptr_t Quad-option value
+ * quad_native_get - Get an int object from a Quad-option config item - Implements ::cst_native_get
  */
 static intptr_t quad_native_get(const struct ConfigSet *cs, void *var,
                                 const struct ConfigDef *cdef, struct Buffer *err)
@@ -190,12 +164,7 @@ static intptr_t quad_native_get(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * quad_reset - Reset a Quad-option to its initial value
- * @param cs   Config items
- * @param var  Variable to reset
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * quad_reset - Reset a Quad-option to its initial value - Implements ::cst_regex
  */
 static int quad_reset(const struct ConfigSet *cs, void *var,
                       const struct ConfigDef *cdef, struct Buffer *err)
index 36c2094ebdb6c00e5c915a4d8d2686954ff2ffa8..3f761b321337286bf553d05635b4c94d8078f6d7 100644 (file)
 #include "types.h"
 
 /**
- * regex_destroy - Destroy a Regex object
- * @param cs   Config items
- * @param var  Variable to destroy
- * @param cdef Variable definition
+ * regex_destroy - Destroy a Regex object - Implements ::cst_destroy
  */
 static void regex_destroy(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef)
 {
@@ -60,15 +57,7 @@ static void regex_destroy(const struct ConfigSet *cs, void *var, const struct Co
 }
 
 /**
- * regex_string_set - Set a Regex by string
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Value to set
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be set.
+ * regex_string_set - Set a Regex by string - Implements ::cst_string_set
  */
 static int regex_string_set(const struct ConfigSet *cs, void *var, struct ConfigDef *cdef,
                             const char *value, struct Buffer *err)
@@ -128,14 +117,7 @@ static int regex_string_set(const struct ConfigSet *cs, void *var, struct Config
 }
 
 /**
- * regex_string_get - Get a Regex as a string
- * @param cs     Config items
- * @param var    Variable to get
- * @param cdef   Variable definition
- * @param result Buffer for results or error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be returned.
+ * regex_string_get - Get a Regex as a string - Implements ::cst_string_get
  */
 static int regex_string_get(const struct ConfigSet *cs, void *var,
                             const struct ConfigDef *cdef, struct Buffer *result)
@@ -164,13 +146,7 @@ static int regex_string_get(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * regex_native_set - Set a Regex config item by Regex object
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Regex pointer
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * regex_native_set - Set a Regex config item by Regex object - Implements ::cst_native_set
  */
 static int regex_native_set(const struct ConfigSet *cs, void *var,
                             const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
@@ -214,12 +190,7 @@ static int regex_native_set(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * regex_native_get - Get a Regex object from a Regex config item
- * @param cs   Config items
- * @param var  Variable to get
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval intptr_t Regex pointer
+ * regex_native_get - Get a Regex object from a Regex config item - Implements ::cst_native_get
  */
 static intptr_t regex_native_get(const struct ConfigSet *cs, void *var,
                                  const struct ConfigDef *cdef, struct Buffer *err)
@@ -233,12 +204,7 @@ static intptr_t regex_native_get(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * regex_reset - Reset a Regex to its initial value
- * @param cs   Config items
- * @param var  Variable to reset
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * regex_reset - Reset a Regex to its initial value - Implements ::cst_regex
  */
 static int regex_reset(const struct ConfigSet *cs, void *var,
                        const struct ConfigDef *cdef, struct Buffer *err)
index 5b48195bac357a26722a7a3591c2c3eea1dc35e2..039d7f8c026d7e9aa3872af40f9efc12c094b45e 100644 (file)
@@ -89,12 +89,64 @@ typedef bool    (*cs_listener)   (const struct ConfigSet *cs, struct HashElem *h
  */
 typedef int     (*cs_validator)  (const struct ConfigSet *cs, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err);
 
+/**
+ * cst_string_set - Set a config item by string
+ * @param cs    Config items
+ * @param var   Variable to set
+ * @param cdef  Variable definition
+ * @param value Value to set
+ * @param err   Buffer for error messages
+ * @retval int Result, e.g. #CSR_SUCCESS
+ *
+ * If var is NULL, then the config item's initial value will be set.
+ */
 typedef int     (*cst_string_set)(const struct ConfigSet *cs, void *var,       struct ConfigDef *cdef, const char *value, struct Buffer *err);
+/**
+ * cst_string_get - Get a config item as a string
+ * @param cs     Config items
+ * @param var    Variable to get
+ * @param cdef   Variable definition
+ * @param result Buffer for results or error messages
+ * @retval int Result, e.g. #CSR_SUCCESS
+ *
+ * If var is NULL, then the config item's initial value will be returned.
+ */
 typedef int     (*cst_string_get)(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef,                    struct Buffer *result);
+/**
+ * cst_native_set - Set a config item by string
+ * @param cs    Config items
+ * @param var   Variable to set
+ * @param cdef  Variable definition
+ * @param value Native pointer/value to set
+ * @param err   Buffer for error messages
+ * @retval int Result, e.g. #CSR_SUCCESS
+ */
 typedef int     (*cst_native_set)(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, intptr_t value,    struct Buffer *err);
+/**
+ * cst_native_get - Get a string from a config item
+ * @param cs   Config items
+ * @param var  Variable to get
+ * @param cdef Variable definition
+ * @param err  Buffer for error messages
+ * @retval intptr_t Config item string
+ */
 typedef intptr_t(*cst_native_get)(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef,                    struct Buffer *err);
 
+/**
+ * cst_reset - Reset a config item to its initial value
+ * @param cs   Config items
+ * @param var  Variable to reset
+ * @param cdef Variable definition
+ * @param err  Buffer for error messages
+ * @retval int Result, e.g. #CSR_SUCCESS
+ */
 typedef int     (*cst_reset)     (const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err);
+/**
+ * cst_destroy - Destroy a config item
+ * @param cs   Config items
+ * @param var  Variable to destroy
+ * @param cdef Variable definition
+ */
 typedef void    (*cst_destroy)   (const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef);
 
 #define IP (intptr_t)
index fb36d2c162f2e748b238a9eeed8688ce78ec309e..ced454d10a314e870842b11d3bf1ebf4019f47fb 100644 (file)
@@ -132,15 +132,7 @@ const struct Mapping SortSidebarMethods[] = {
 // clang-format on
 
 /**
- * sort_string_set - Set a Sort by string
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Value to set
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be set.
+ * sort_string_set - Set a Sort by string - Implements ::cst_string_set
  */
 static int sort_string_set(const struct ConfigSet *cs, void *var, struct ConfigDef *cdef,
                            const char *value, struct Buffer *err)
@@ -227,14 +219,7 @@ static int sort_string_set(const struct ConfigSet *cs, void *var, struct ConfigD
 }
 
 /**
- * sort_string_get - Get a Sort as a string
- * @param cs     Config items
- * @param var    Variable to get
- * @param cdef   Variable definition
- * @param result Buffer for results or error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be returned.
+ * sort_string_get - Get a Sort as a string - Implements ::cst_string_get
  */
 static int sort_string_get(const struct ConfigSet *cs, void *var,
                            const struct ConfigDef *cdef, struct Buffer *result)
@@ -296,13 +281,7 @@ static int sort_string_get(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * sort_native_set - Set a Sort config item by int
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Sort value
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * sort_native_set - Set a Sort config item by int - Implements ::cst_native_set
  */
 static int sort_native_set(const struct ConfigSet *cs, void *var,
                            const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
@@ -360,12 +339,7 @@ static int sort_native_set(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * sort_native_get - Get an int from a Sort config item
- * @param cs   Config items
- * @param var  Variable to get
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval intptr_t Sort ID
+ * sort_native_get - Get an int from a Sort config item - Implements ::cst_native_get
  */
 static intptr_t sort_native_get(const struct ConfigSet *cs, void *var,
                                 const struct ConfigDef *cdef, struct Buffer *err)
@@ -377,12 +351,7 @@ static intptr_t sort_native_get(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * sort_reset - Reset a Sort to its initial value
- * @param cs   Config items
- * @param var  Variable to reset
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * sort_reset - Reset a Sort to its initial value - Implements ::cst_regex
  */
 static int sort_reset(const struct ConfigSet *cs, void *var,
                       const struct ConfigDef *cdef, struct Buffer *err)
index 5ffe910d4b401a26284c6f10acd603d39ad952ee..4a44d7ced5d14441ec51aadde79332b3c1f5d317 100644 (file)
 #include "types.h"
 
 /**
- * string_destroy - Destroy a String
- * @param cs   Config items
- * @param var  Variable to destroy
- * @param cdef Variable definition
+ * string_destroy - Destroy a String - Implements ::cst_destroy
  */
 static void string_destroy(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef)
 {
@@ -62,15 +59,7 @@ static void string_destroy(const struct ConfigSet *cs, void *var, const struct C
 }
 
 /**
- * string_string_set - Set a String by string
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Value to set
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be set.
+ * string_string_set - Set a String by string - Implements ::cst_string_set
  */
 static int string_string_set(const struct ConfigSet *cs, void *var, struct ConfigDef *cdef,
                              const char *value, struct Buffer *err)
@@ -128,14 +117,7 @@ static int string_string_set(const struct ConfigSet *cs, void *var, struct Confi
 }
 
 /**
- * string_string_get - Get a String as a string
- * @param cs     Config items
- * @param var    Variable to get
- * @param cdef   Variable definition
- * @param result Buffer for results or error messages
- * @retval int Result, e.g. #CSR_SUCCESS
- *
- * If var is NULL, then the config item's initial value will be returned.
+ * string_string_get - Get a String as a string - Implements ::cst_string_get
  */
 static int string_string_get(const struct ConfigSet *cs, void *var,
                              const struct ConfigDef *cdef, struct Buffer *result)
@@ -158,13 +140,7 @@ static int string_string_get(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * string_native_set - Set a String config item by string
- * @param cs    Config items
- * @param var   Variable to set
- * @param cdef  Variable definition
- * @param value Native pointer/value to set
- * @param err   Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * string_native_set - Set a String config item by string - Implements ::cst_native_set
  */
 static int string_native_set(const struct ConfigSet *cs, void *var,
                              const struct ConfigDef *cdef, intptr_t value,
@@ -210,12 +186,7 @@ static int string_native_set(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * string_native_get - Get a string from a String config item
- * @param cs   Config items
- * @param var  Variable to get
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval intptr_t String pointer
+ * string_native_get - Get a string from a String config item - Implements ::cst_native_get
  */
 static intptr_t string_native_get(const struct ConfigSet *cs, void *var,
                                   const struct ConfigDef *cdef, struct Buffer *err)
@@ -229,12 +200,7 @@ static intptr_t string_native_get(const struct ConfigSet *cs, void *var,
 }
 
 /**
- * string_reset - Reset a String to its initial value
- * @param cs   Config items
- * @param var  Variable to reset
- * @param cdef Variable definition
- * @param err  Buffer for error messages
- * @retval int Result, e.g. #CSR_SUCCESS
+ * string_reset - Reset a String to its initial value - Implements ::cst_regex
  */
 static int string_reset(const struct ConfigSet *cs, void *var,
                         const struct ConfigDef *cdef, struct Buffer *err)