michaelh/zephyr
1
0
Fork 0
Code Releases Activity

settings: Include entire API into doxygen

Browse source 
The Runtime API and the name processing API were omitted in
the documentation as were not included in any doxygen group.

This patch includes them in dedicated settings API doxygen
sub-groups.

Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
This commit is contained in:
Andrzej Puzdrowski 2020-02-14 16:47:14 +01:00 • committed by Maureen Helm
commit ead335cb40
1 changed files with 27 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

32
include/settings/settings.h
View file

@ -349,6 +349,12 @@ int settings_commit_subtree(const char *subtree);
*/
/**
* @defgroup settings_backend Settings backend interface
* @ingroup file_system_storage
* @{
*/
/*
* API for config storage
*/
@ -488,8 +494,15 @@ int settings_call_set_handler(const char *name,
settings_read_cb read_cb,
void *read_cb_arg,
const struct settings_load_arg *load_arg);
/*
* API for const name processing
/**
* @}
*/
/**
* @defgroup settings_name_proc Settings name processing
* @brief API for const name processing
* @ingroup settings
* @{
*/
/**
@ -525,13 +538,19 @@ int settings_name_steq(const char *name, const char *key, const char **next);
*
*/
int settings_name_next(const char *name, const char **next);
/*
* API for runtime settings
/**
* @}
*/
#ifdef CONFIG_SETTINGS_RUNTIME
/**
* @defgroup settings_rt Settings subsystem runtime
* @brief API for runtime settings
* @ingroup settings
* @{
*/
/**
* Set a value with a specific key to a module handler.
*
@ -562,6 +581,9 @@ int settings_runtime_get(const char *name, void *data, size_t len);
* @return 0 on success, non-zero on failure.
*/
int settings_runtime_commit(const char *name);
/**
* @}
*/
#endif /* CONFIG_SETTINGS_RUNTIME */