From ead335cb40e05ed5117e789618bcc4c354aaef90 Mon Sep 17 00:00:00 2001 From: Andrzej Puzdrowski Date: Fri, 14 Feb 2020 16:47:14 +0100 Subject: [PATCH] settings: Include entire API into doxygen 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 --- include/settings/settings.h | 32 +++++++++++++++++++++++++++----- 1 file changed, 27 insertions(+), 5 deletions(-) diff --git a/include/settings/settings.h b/include/settings/settings.h index dc5086336ec..4ee101f9f46 100644 --- a/include/settings/settings.h +++ b/include/settings/settings.h @@ -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 */