Skip to content

Commit b0b4597

Browse files
Johan Hedbergioannisg
authored andcommitted
Bluetooth: UUID: Fix confusing documentation of bt_uuid_create()
Remove any references to internal usage, which were both confusing and unnecessary. Signed-off-by: Johan Hedberg <[email protected]>
1 parent 51ffabf commit b0b4597

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

include/bluetooth/uuid.h

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -465,19 +465,15 @@ struct bt_uuid_128 {
465465
*/
466466
int bt_uuid_cmp(const struct bt_uuid *u1, const struct bt_uuid *u2);
467467

468-
/** @brief Copy UUID from internal variable to internal bt_uuid.
468+
/** @brief Create a bt_uuid from a little-endian data buffer.
469469
*
470-
* Copy little endian format UUID from packet data or internal variable
471-
* pointer to internal bt_uuid format.The data parameter points to a variable
472-
* (originally stored in bt_uuid_128, bt_uuid_32 or bt_uuid_16 format)
473-
* and therefore take into account of alignment of the val member.
474-
* The data_len parameter is used to determine whether to copy the UUID from
475-
* 16, 32 or 128 bit format (length 2, 4 or 16).
476-
* 32 bit format is not allowed over the air.
470+
* Create a bt_uuid from a little-endian data buffer. The data_len parameter
471+
* is used to determine whether the UUID is in 16, 32 or 128 bit format
472+
* (length 2, 4 or 16). Note: 32 bit format is not allowed over the air.
477473
*
478-
* @param uuid Pointer to where to write the Bluetooth UUID
479-
* @param data pointer to location of the UUID variable/in the packet
480-
* @param data_len length of the UUID variable/in the packet
474+
* @param uuid Pointer to the bt_uuid variable
475+
* @param data pointer to UUID stored in little-endian data buffer
476+
* @param data_len length of the UUID in the data buffer
481477
*
482478
* @return true if the data was valid and the UUID was successfully created.
483479
*/

0 commit comments

Comments
 (0)