diff --git a/coreapi/lpconfig.h b/coreapi/lpconfig.h index b3d2aa892..aa65fb38f 100644 --- a/coreapi/lpconfig.h +++ b/coreapi/lpconfig.h @@ -89,6 +89,7 @@ LINPHONE_PUBLIC LpConfig * lp_config_new(const char *filename); LINPHONE_PUBLIC LpConfig * lp_config_new_with_factory(const char *config_filename, const char *factory_config_filename); int lp_config_read_file(LpConfig *lpconfig, const char *filename); + /** * Retrieves a configuration item as a string, given its section, key, and default value. * @@ -96,7 +97,7 @@ int lp_config_read_file(LpConfig *lpconfig, const char *filename); * The default value string is returned if the config item isn't found. **/ LINPHONE_PUBLIC const char *lp_config_get_string(const LpConfig *lpconfig, const char *section, const char *key, const char *default_string); -int lp_config_read_file(LpConfig *lpconfig, const char *filename); + /** * Retrieves a configuration item as a range, given its section, key, and default min and max values. * @@ -105,6 +106,7 @@ int lp_config_read_file(LpConfig *lpconfig, const char *filename); * If FALSE is returned, min and max are filled respectively with default_min and default_max values. */ LINPHONE_PUBLIC bool_t lp_config_get_range(const LpConfig *lpconfig, const char *section, const char *key, int *min, int *max, int default_min, int default_max); + /** * Retrieves a configuration item as an integer, given its section, key, and default value. * @@ -121,8 +123,6 @@ LINPHONE_PUBLIC int lp_config_get_int(const LpConfig *lpconfig,const char *secti **/ LINPHONE_PUBLIC int64_t lp_config_get_int64(const LpConfig *lpconfig,const char *section, const char *key, int64_t default_value); - -int lp_config_read_file(LpConfig *lpconfig, const char *filename); /** * Retrieves a configuration item as a float, given its section, key, and default value. * @@ -130,18 +130,21 @@ int lp_config_read_file(LpConfig *lpconfig, const char *filename); * The default float value is returned if the config item isn't found. **/ LINPHONE_PUBLIC float lp_config_get_float(const LpConfig *lpconfig,const char *section, const char *key, float default_value); + /** * Sets a string config item * * @ingroup misc **/ LINPHONE_PUBLIC void lp_config_set_string(LpConfig *lpconfig,const char *section, const char *key, const char *value); + /** * Sets a range config item * * @ingroup misc */ LINPHONE_PUBLIC void lp_config_set_range(LpConfig *lpconfig, const char *section, const char *key, int min_value, int max_value); + /** * Sets an integer config item * @@ -169,30 +172,35 @@ LINPHONE_PUBLIC void lp_config_set_int64(LpConfig *lpconfig,const char *section, * @ingroup misc **/ LINPHONE_PUBLIC void lp_config_set_float(LpConfig *lpconfig,const char *section, const char *key, float value); + /** * Writes the config file to disk. * * @ingroup misc **/ int lp_config_sync(LpConfig *lpconfig); + /** * Returns 1 if a given section is present in the configuration. * * @ingroup misc **/ int lp_config_has_section(const LpConfig *lpconfig, const char *section); + /** * Removes every pair of key,value in a section and remove the section. * * @ingroup misc **/ void lp_config_clean_section(LpConfig *lpconfig, const char *section); + /** * Call a function for each section present in the configuration. * * @ingroup misc **/ void lp_config_for_each_section(const LpConfig *lpconfig, void (*callback)(const char *section, void *ctx), void *ctx); + /** * Call a function for each entry present in a section configuration. *