Skip to content

Commit f19e5bc

Browse files
nordicjmkartben
authored andcommitted
mgmt: mcumgr: mgmt: callbacks: Align doxygen links
Aligns doxygen links to have the same style for all in the file. Also adds some missed links Signed-off-by: Jamie McCrae <[email protected]>
1 parent 6a19162 commit f19e5bc

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

include/zephyr/mgmt/mcumgr/mgmt/callbacks.h

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -185,13 +185,22 @@ enum img_mgmt_group_events {
185185
/** Callback when an image write command has finished writing to flash. */
186186
MGMT_EVT_OP_IMG_MGMT_DFU_CHUNK_WRITE_COMPLETE = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 5),
187187

188-
/** Callback when an image slot's state is encoded for a response. */
188+
/**
189+
* Callback when an image slot's state is encoded for a response, data is
190+
* img_mgmt_state_slot_encode().
191+
*/
189192
MGMT_EVT_OP_IMG_MGMT_IMAGE_SLOT_STATE = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 6),
190193

191-
/** Callback when an slot list command outputs fields for an image. */
194+
/**
195+
* Callback when a slot list command outputs fields for an image, data is
196+
* img_mgmt_slot_info_image().
197+
*/
192198
MGMT_EVT_OP_IMG_MGMT_SLOT_INFO_IMAGE = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 7),
193199

194-
/** Callback when an slot list command outputs fields for a slot of an image. */
200+
/**
201+
* Callback when a slot list command outputs fields for a slot of an image, data is
202+
* img_mgmt_slot_info_slot().
203+
*/
195204
MGMT_EVT_OP_IMG_MGMT_SLOT_INFO_SLOT = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 8),
196205

197206
/** Used to enable all img_mgmt_group events. */
@@ -202,13 +211,13 @@ enum img_mgmt_group_events {
202211
* MGMT event opcodes for operating system management group.
203212
*/
204213
enum os_mgmt_group_events {
205-
/** Callback when a reset command has been received, data is os_mgmt_reset_data. */
214+
/** Callback when a reset command has been received, data is os_mgmt_reset_data(). */
206215
MGMT_EVT_OP_OS_MGMT_RESET = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_OS, 0),
207216

208-
/** Callback when an info command is processed, data is os_mgmt_info_check. */
217+
/** Callback when an info command is processed, data is os_mgmt_info_check(). */
209218
MGMT_EVT_OP_OS_MGMT_INFO_CHECK = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_OS, 1),
210219

211-
/** Callback when an info command needs to output data, data is os_mgmt_info_append. */
220+
/** Callback when an info command needs to output data, data is os_mgmt_info_append(). */
212221
MGMT_EVT_OP_OS_MGMT_INFO_APPEND = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_OS, 2),
213222

214223
/** Callback when a datetime get command has been received. */
@@ -219,7 +228,7 @@ enum os_mgmt_group_events {
219228

220229
/**
221230
* Callback when a bootloader info command has been received, data is
222-
* os_mgmt_bootloader_info_data.
231+
* os_mgmt_bootloader_info_data().
223232
*/
224233
MGMT_EVT_OP_OS_MGMT_BOOTLOADER_INFO = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_OS, 5),
225234

0 commit comments

Comments
 (0)