Skip to content

Use correct Doxygen return / retval #3520

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
steven-bellock merged 1 commit into from
Feb 18, 2026
Merged

Use correct Doxygen return / retval #3520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions include/hal/library/responder/key_pair_info.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* Copyright Notice:
* Copyright 2024-2025 DMTF. All rights reserved.
* Copyright 2024-2026 DMTF. All rights reserved.
* License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/libspdm/blob/main/LICENSE.md
**/

Expand All @@ -17,7 +17,7 @@
* return the total key pairs number.
* It is a fixed number per SPDM connection.
*
* @retval the total key pairs number.
* @return the total key pairs number.
*/
extern uint8_t libspdm_read_total_key_pairs (void *spdm_context);

Expand Down
58 changes: 29 additions & 29 deletions include/internal/libspdm_common_lib.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* Copyright Notice:
* Copyright 2021-2025 DMTF. All rights reserved.
* Copyright 2021-2026 DMTF. All rights reserved.
* License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/libspdm/blob/main/LICENSE.md
**/

Expand Down Expand Up @@ -1330,7 +1330,7 @@ void libspdm_get_receiver_buffer (
*
* @param[in] context A pointer to the SPDM context.
*
* @retval slot_mask get slot mask
* @return slot_mask get slot mask
**/
uint8_t libspdm_get_cert_slot_mask (libspdm_context_t *spdm_context);

Expand All @@ -1339,7 +1339,7 @@ uint8_t libspdm_get_cert_slot_mask (libspdm_context_t *spdm_context);
*
* @param[in] context A pointer to the SPDM context.
*
* @retval slot_count get slot count
* @return slot_count get slot count
**/
uint8_t libspdm_get_cert_slot_count(libspdm_context_t *spdm_context);

Expand Down Expand Up @@ -1451,8 +1451,8 @@ void libspdm_reset_message_encap_e(libspdm_context_t *spdm_context, void *sessio
* @param message Message buffer.
* @param message_size Size in bytes of message buffer.
*
* @return RETURN_SUCCESS message is appended.
* @return RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
* @retval RETURN_SUCCESS message is appended.
* @retval RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
**/
libspdm_return_t libspdm_append_message_a(libspdm_context_t *spdm_context, const void *message,
size_t message_size);
Expand All @@ -1464,8 +1464,8 @@ libspdm_return_t libspdm_append_message_a(libspdm_context_t *spdm_context, const
* @param message Message buffer.
* @param message_size Size in bytes of message buffer.
*
* @return RETURN_SUCCESS message is appended.
* @return RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
* @retval RETURN_SUCCESS message is appended.
* @retval RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
**/
libspdm_return_t libspdm_append_message_d(libspdm_context_t *spdm_context, const void *message,
size_t message_size);
Expand All @@ -1477,8 +1477,8 @@ libspdm_return_t libspdm_append_message_d(libspdm_context_t *spdm_context, const
* @param message Message buffer.
* @param message_size Size in bytes of message buffer.
*
* @return RETURN_SUCCESS message is appended.
* @return RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
* @retval RETURN_SUCCESS message is appended.
* @retval RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
**/
libspdm_return_t libspdm_append_message_b(libspdm_context_t *spdm_context, const void *message,
size_t message_size);
Expand All @@ -1490,8 +1490,8 @@ libspdm_return_t libspdm_append_message_b(libspdm_context_t *spdm_context, const
* @param message Message buffer.
* @param message_size Size in bytes of message buffer.
*
* @return RETURN_SUCCESS message is appended.
* @return RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
* @retval RETURN_SUCCESS message is appended.
* @retval RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
**/
libspdm_return_t libspdm_append_message_c(libspdm_context_t *spdm_context, const void *message,
size_t message_size);
Expand All @@ -1503,8 +1503,8 @@ libspdm_return_t libspdm_append_message_c(libspdm_context_t *spdm_context, const
* @param message Message buffer.
* @param message_size Size in bytes of message buffer.
*
* @return RETURN_SUCCESS message is appended.
* @return RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
* @retval RETURN_SUCCESS message is appended.
* @retval RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
**/
libspdm_return_t libspdm_append_message_mut_b(libspdm_context_t *spdm_context, const void *message,
size_t message_size);
Expand All @@ -1516,8 +1516,8 @@ libspdm_return_t libspdm_append_message_mut_b(libspdm_context_t *spdm_context, c
* @param message Message buffer.
* @param message_size Size in bytes of message buffer.
*
* @return RETURN_SUCCESS message is appended.
* @return RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
* @retval RETURN_SUCCESS message is appended.
* @retval RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
**/
libspdm_return_t libspdm_append_message_mut_c(libspdm_context_t *spdm_context, const void *message,
size_t message_size);
Expand All @@ -1532,8 +1532,8 @@ libspdm_return_t libspdm_append_message_mut_c(libspdm_context_t *spdm_context, c
* @param message Message buffer.
* @param message_size Size in bytes of message buffer.
*
* @return RETURN_SUCCESS message is appended.
* @return RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
* @retval RETURN_SUCCESS message is appended.
* @retval RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
**/
libspdm_return_t libspdm_append_message_m(libspdm_context_t *spdm_context,
void *session_info,
Expand All @@ -1548,8 +1548,8 @@ libspdm_return_t libspdm_append_message_m(libspdm_context_t *spdm_context,
* @param message Message buffer.
* @param message_size Size in bytes of message buffer.
*
* @return RETURN_SUCCESS message is appended.
* @return RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
* @retval RETURN_SUCCESS message is appended.
* @retval RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
**/
libspdm_return_t libspdm_append_message_k(libspdm_context_t *spdm_context,
void *spdm_session_info,
Expand All @@ -1565,8 +1565,8 @@ libspdm_return_t libspdm_append_message_k(libspdm_context_t *spdm_context,
* @param message Message buffer.
* @param message_size Size in bytes of message buffer.
*
* @return RETURN_SUCCESS message is appended.
* @return RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
* @retval RETURN_SUCCESS message is appended.
* @retval RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
**/
libspdm_return_t libspdm_append_message_encap_d(libspdm_context_t *spdm_context,
void *spdm_session_info,
Expand All @@ -1582,8 +1582,8 @@ libspdm_return_t libspdm_append_message_encap_d(libspdm_context_t *spdm_context,
* @param message Message buffer.
* @param message_size Size in bytes of message buffer.
*
* @return RETURN_SUCCESS message is appended.
* @return RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
* @retval RETURN_SUCCESS message is appended.
* @retval RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
**/
libspdm_return_t libspdm_append_message_f(libspdm_context_t *spdm_context,
void *spdm_session_info,
Expand All @@ -1600,8 +1600,8 @@ libspdm_return_t libspdm_append_message_f(libspdm_context_t *spdm_context,
* @param message message buffer.
* @param message_size size in bytes of message buffer.
*
* @return RETURN_SUCCESS message is appended.
* @return RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
* @retval RETURN_SUCCESS message is appended.
* @retval RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
**/
libspdm_return_t libspdm_append_message_e(libspdm_context_t *spdm_context, void *session_info,
const void *message, size_t message_size);
Expand All @@ -1616,8 +1616,8 @@ libspdm_return_t libspdm_append_message_e(libspdm_context_t *spdm_context, void
* @param message message buffer.
* @param message_size size in bytes of message buffer.
*
* @return RETURN_SUCCESS message is appended.
* @return RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
* @retval RETURN_SUCCESS message is appended.
* @retval RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
**/
libspdm_return_t libspdm_append_message_encap_e(libspdm_context_t *spdm_context, void *session_info,
const void *message, size_t message_size);
Expand Down Expand Up @@ -1872,8 +1872,8 @@ void libspdm_write_uint64(uint8_t *buffer, uint64_t value);
*
* @param mask The bitmask to be tested.
*
* @return true At most one bit is set.
* @return false More than one bit is set.
* @retval true At most one bit is set.
* @retval false More than one bit is set.
*/
static inline bool libspdm_onehot0(uint32_t mask)
{
Expand Down
4 changes: 2 additions & 2 deletions include/library/spdm_common_lib.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* Copyright Notice:
* Copyright 2021-2025 DMTF. All rights reserved.
* Copyright 2021-2026 DMTF. All rights reserved.
* License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/libspdm/blob/main/LICENSE.md
**/

Expand Down Expand Up @@ -384,7 +384,7 @@ size_t libspdm_get_fips_selftest_context_size(void);
/**
* Returns the required buffer size for FIPS self-tests.
*
* @retval The required buffer size in bytes.
* @return The required buffer size in bytes.
*/
size_t libspdm_get_fips_selftest_buffer_size(void);

Expand Down
4 changes: 2 additions & 2 deletions include/library/spdm_crypt_lib.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1035,7 +1035,7 @@ bool libspdm_is_root_certificate(const uint8_t *cert, size_t cert_size);
* @param[in,out] oid_size The buffersize for required OID
*
* @retval true Get the subjectAltName string successfully
* @retval failed Get the subjectAltName string failed
* @retval false Get the subjectAltName string failed
**/
bool libspdm_get_dmtf_subject_alt_name_from_bytes(
uint8_t *buffer, const size_t len, char *name_buffer,
Expand All @@ -1059,7 +1059,7 @@ bool libspdm_get_dmtf_subject_alt_name_from_bytes(
* @param[in,out] oid_size The buffersize for required OID
*
* @retval true Get the subjectAltName string successfully
* @retval failed Get the subjectAltName string failed
* @retval false Get the subjectAltName string failed
**/
bool libspdm_get_dmtf_subject_alt_name(const uint8_t *cert, const size_t cert_size,
char *name_buffer,
Expand Down
4 changes: 2 additions & 2 deletions include/library/spdm_requester_lib.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1028,7 +1028,7 @@ void libspdm_set_msg_log_mode (void *spdm_context, uint32_t mode);
*
* @param context A pointer to the SPDM context.
*
* @retval uint32_t A bitmask giving the status of the message logger.
* @return uint32_t A bitmask giving the status of the message logger.
* LIBSPDM_MSG_LOG_STATUS_BUFFER_FULL - if set the message logging buffer has
* reached capacity.
*/
Expand All @@ -1038,7 +1038,7 @@ uint32_t libspdm_get_msg_log_status (void *spdm_context);
* This function returns the size of the message log.
*
* @param context A pointer to the SPDM context.
* @retval size_t The size of the message log in bytes.
* @return size_t The size of the message log in bytes.
*/
size_t libspdm_get_msg_log_size (void *spdm_context);

Expand Down