patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

mgmt: mcumgr: Doxygen tags update

Browse source 
Added a missing defgroup and ingroup for mcmumgr client
and smp client.

Signed-off-by: Juha Heiskanen <juha.heiskanen@nordicsemi.no>
This commit is contained in:
Juha Heiskanen 2023-11-16 12:46:47 +02:00 committed by Carles Cufí
parent 6670dbe834
commit 07ae06f8fe
3 changed files with 33 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
include/zephyr/mgmt/mcumgr/grp/img_mgmt/img_mgmt_client.h
View file

@ -11,6 +11,13 @@
#include <zephyr/mgmt/mcumgr/grp/img_mgmt/img_mgmt.h>
#include <zephyr/mgmt/mcumgr/smp/smp_client.h>
/**
* @brief MCUmgr Image management client API
* @defgroup mcumgr_img_mgmt_client MCUmgr img_mgmt_client API
* @ingroup mcumgr
* @{
*/
#ifdef __cplusplus
extern "C" {
#endif
@ -186,6 +193,10 @@ int img_mgmt_client_state_read(struct img_mgmt_client *client, struct mcumgr_ima
int img_mgmt_client_erase(struct img_mgmt_client *client, uint32_t slot);
/**
* @}
*/
#ifdef __cplusplus
}
#endif

11
include/zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt_client.h
View file

@ -10,6 +10,13 @@
#include <inttypes.h>
#include <zephyr/mgmt/mcumgr/smp/smp_client.h>
/**
* @brief MCUmgr OS management client API
* @defgroup mcumgr_os_mgmt_client MCUmgr os_mgmt_client API
* @ingroup mcumgr
* @{
*/
#ifdef __cplusplus
extern "C" {
#endif
@ -54,6 +61,10 @@ int os_mgmt_client_echo(struct os_mgmt_client *client, const char *echo_string);
*/
int os_mgmt_client_reset(struct os_mgmt_client *client);
/**
* @}
*/
#ifdef __cplusplus
}
#endif

11
include/zephyr/mgmt/mcumgr/smp/smp_client.h
View file

@ -13,6 +13,13 @@
#include <zephyr/mgmt/mcumgr/smp/smp.h>
#include <zephyr/mgmt/mcumgr/transport/smp.h>
/**
* @brief MCUmgr SMP client API
* @defgroup mcumgr_smp_client SMP client API
* @ingroup mcumgr
* @{
*/
/**
* @brief SMP client object
*/
@ -102,6 +109,10 @@ void smp_client_buf_free(struct net_buf *nb);
int smp_client_send_cmd(struct smp_client_object *smp_client, struct net_buf *nb,
smp_client_res_fn cb, void *user_data, int timeout_in_sec);
/**
* @}
*/
#ifdef __cplusplus
}
#endif