Skip to content

Commit 76a780d

Browse files
kartbenMaureenHelm
authored andcommitted
include: sys: uuid: add kconfig_dep Doxygen tags to public API functions
This ensures public Doxygen documentation clearly indicate what Kconfig options need to be enabled for the documented functions to be available. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
1 parent a910195 commit 76a780d

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

‎include/zephyr/sys/uuid.h‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ struct uuid {
5656
*
5757
* @param out The UUID where the result will be written.
5858
*
59+
* @kconfig_dep{CONFIG_UUID_V4}
60+
*
5961
* @retval 0 The UUID has been correctly generated and stored in @p out
6062
* @retval -EINVAL @p out is not acceptable
6163
*/
@@ -67,6 +69,8 @@ int uuid_generate_v4(struct uuid *out);
6769
* @details This function computes a deterministic UUID starting from a namespace UUID and binary
6870
* data.
6971
*
72+
* @kconfig_dep{CONFIG_UUID_V5}
73+
*
7074
* @param ns A pointer to an UUID to be used as namespace.
7175
* @param data A pointer to the data that will be hashed to produce the UUID.
7276
* @param data_size The size of the data buffer.
@@ -140,6 +144,8 @@ int uuid_to_string(const struct uuid *data, char out[UUID_STR_LEN]);
140144
/**
141145
* @brief Convert a UUID to its base 64 (RFC 3548, RFC 4648) string representation.
142146
*
147+
* @kconfig_dep{CONFIG_UUID_BASE64}
148+
*
143149
* @param data The UUID to convert to string.
144150
* @param out A pointer to a previously allocated buffer where the result will be written.
145151
*

0 commit comments

Comments
 (0)