diff options
Diffstat (limited to 'include/asterisk/config.h')
| -rwxr-xr-x | include/asterisk/config.h | 51 |
1 files changed, 22 insertions, 29 deletions
diff --git a/include/asterisk/config.h b/include/asterisk/config.h index 5a6e2b22d..eff829b63 100755 --- a/include/asterisk/config.h +++ b/include/asterisk/config.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Configuration File Parser +/*! \file + * \brief Configuration File Parser */ #ifndef _ASTERISK_CONFIG_H @@ -37,8 +37,8 @@ struct ast_variable { char *name; char *value; int lineno; - int object; /* 0 for variable, 1 for object */ - int blanklines; /* Number of blanklines following entry */ + int object; /*!< 0 for variable, 1 for object */ + int blanklines; /*!< Number of blanklines following entry */ struct ast_comment *precomments; struct ast_comment *sameline; struct ast_variable *next; @@ -59,8 +59,7 @@ struct ast_config_engine { struct ast_config_engine *next; }; -/*! Load a config file */ -/*! +/*! \brief Load a config file * \param configfile path of file to open. If no preceding '/' character, path is considered relative to AST_CONFIG_DIR * Create a config structure from a given configuration file. * @@ -68,16 +67,14 @@ struct ast_config_engine { */ struct ast_config *ast_config_load(const char *filename); -/*! Destroys a config */ -/*! +/*! \brief Destroys a config * \param config pointer to config data structure * Free memory associated with a given config * */ void ast_config_destroy(struct ast_config *config); -/*! Goes through categories */ -/*! +/*! \brief Goes through categories * \param config Which config structure you wish to "browse" * \param prev A pointer to a previous category. * This funtion is kind of non-intuitive in it's use. To begin, one passes NULL as the second arguement. It will return a pointer to the string of the first category in the file. From here on after, one must then pass the previous usage's return value as the second pointer, and it will return a pointer to the category name afterwards. @@ -86,8 +83,7 @@ void ast_config_destroy(struct ast_config *config); */ char *ast_category_browse(struct ast_config *config, const char *prev); -/*! Goes through variables */ -/*! +/*! \brief Goes through variables * Somewhat similar in intent as the ast_category_browse. * List variables of config file category * @@ -95,8 +91,7 @@ char *ast_category_browse(struct ast_config *config, const char *prev); */ struct ast_variable *ast_variable_browse(const struct ast_config *config, const char *category); -/*! Gets a variable */ -/*! +/*! \brief Gets a variable * \param config which (opened) config to use * \param category category under which the variable lies * \param value which variable you wish to get the data for @@ -106,8 +101,7 @@ struct ast_variable *ast_variable_browse(const struct ast_config *config, const */ char *ast_variable_retrieve(const struct ast_config *config, const char *category, const char *variable); -/*! Retrieve a category if it exists */ -/*! +/*! \brief Retrieve a category if it exists * \param config which config to use * \param category_name name of the category you're looking for * This will search through the categories within a given config file for a match. @@ -116,8 +110,7 @@ char *ast_variable_retrieve(const struct ast_config *config, const char *categor */ struct ast_category *ast_category_get(const struct ast_config *config, const char *category_name); -/*! Check for category duplicates */ -/*! +/*! \brief Check for category duplicates * \param config which config to use * \param category_name name of the category you're looking for * This will search through the categories within a given config file for a match. @@ -126,8 +119,7 @@ struct ast_category *ast_category_get(const struct ast_config *config, const cha */ int ast_category_exist(const struct ast_config *config, const char *category_name); -/*! Retrieve realtime configuration */ -/*! +/*! \brief Retrieve realtime configuration * \param family which family/config to lookup * \param keyfield which field to use as the key * \param lookup which value to look for in the key field to match the entry. @@ -138,8 +130,7 @@ int ast_category_exist(const struct ast_config *config, const char *category_nam */ struct ast_variable *ast_load_realtime(const char *family, ...); -/*! Retrieve realtime configuration */ -/*! +/*! \brief Retrieve realtime configuration * \param family which family/config to lookup * \param keyfield which field to use as the key * \param lookup which value to look for in the key field to match the entry. @@ -151,8 +142,7 @@ struct ast_variable *ast_load_realtime(const char *family, ...); */ struct ast_config *ast_load_realtime_multientry(const char *family, ...); -/*! Update realtime configuration */ -/*! +/*! \brief Update realtime configuration * \param family which family/config to be updated * \param keyfield which field to use as the key * \param lookup which value to look for in the key field to match the entry. @@ -163,21 +153,24 @@ struct ast_config *ast_load_realtime_multientry(const char *family, ...); */ int ast_update_realtime(const char *family, const char *keyfield, const char *lookup, ...); -/*! Check if realtime engine is configured for family - returns 1 if family is configured in realtime and engine exists - \param family which family/config to be checked +/*! \brief Check if realtime engine is configured for family + * returns 1 if family is configured in realtime and engine exists + * \param family which family/config to be checked */ int ast_check_realtime(const char *family); -/*! Free variable list */ -/*! +/*! \brief Free variable list * \param var the linked list of variables to free * This function frees a list of variables. */ void ast_variables_destroy(struct ast_variable *var); +/*! \brief Register config engine */ int ast_config_engine_register(struct ast_config_engine *newconfig); + +/*! \brief Deegister config engine */ int ast_config_engine_deregister(struct ast_config_engine *del); + int register_config_cli(void); void read_config_maps(void); |