Skip to content

Commit 6221251

Browse files
committed
include: mgmt: mcumgr: fix few incorrect doxygen comments in os_mgmt.h
A few documentation comments in os_mgmt.h were not using the proper "javadoc-style" comments. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 477c762 commit 6221251

File tree

1 file changed

+3
-3
lines changed
  • include/zephyr/mgmt/mcumgr/grp/os_mgmt

1 file changed

+3
-3
lines changed

include/zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ enum os_mgmt_info_formats {
8585
OS_MGMT_INFO_FORMAT_USER_CUSTOM_START = BIT(9), /**< Custom user-level start bit */
8686
};
8787

88-
/* Structure provided in the #MGMT_EVT_OP_OS_MGMT_INFO_CHECK notification callback */
88+
/** Structure provided in the #MGMT_EVT_OP_OS_MGMT_INFO_CHECK notification callback */
8989
struct os_mgmt_info_check {
9090
/** Input format string from the mcumgr client */
9191
struct zcbor_string *format;
@@ -99,7 +99,7 @@ struct os_mgmt_info_check {
9999
bool *custom_os_name;
100100
};
101101

102-
/* Structure provided in the MGMT_EVT_OP_OS_MGMT_INFO_APPEND notification callback */
102+
/** Structure provided in the MGMT_EVT_OP_OS_MGMT_INFO_APPEND notification callback */
103103
struct os_mgmt_info_append {
104104
/** The format bitmask from the processed commands, the bits should be cleared once
105105
* processed, note that if all_format_specified is specified, the corresponding bits here
@@ -121,7 +121,7 @@ struct os_mgmt_info_append {
121121
* memory error to the client
122122
*/
123123
uint16_t buffer_size;
124-
/* If there has been prior output, must be set to true if a response has been output */
124+
/** If there has been prior output, must be set to true if a response has been output */
125125
bool *prior_output;
126126
};
127127

0 commit comments

Comments
 (0)