michaelh/zephyr
1
0
Fork 0
Code Releases Activity

Bluetooth: CSIS: Update minor documentation for the CSIS server

Browse source 
A few of the functions were poorly or wrongly described.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
This commit is contained in:
Emil Gydesen 2021-12-13 15:40:43 +01:00 • committed by Anas Nashif
commit c075ec28a3
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
include/bluetooth/audio/csis.h
View file

@ -145,7 +145,7 @@ struct bt_csis_register_param {
void *bt_csis_svc_decl_get(const struct bt_csis *csis); void *bt_csis_svc_decl_get(const struct bt_csis *csis);
/** /**
* @brief Register the Coordinated Set Identification Service. * @brief Register a Coordinated Set Identification Service instance.
* *
* This will register and enable the service and make it discoverable by * This will register and enable the service and make it discoverable by
* clients. * clients.
@ -162,14 +162,14 @@ int bt_csis_register(const struct bt_csis_register_param *param,
struct bt_csis **csis); struct bt_csis **csis);
/** /**
* @brief Print the sirk to the debug output * @brief Print the SIRK to the debug output
* *
* @param csis Pointer to the Coordinated Set Identification Service. * @param csis Pointer to the Coordinated Set Identification Service.
*/ */
void bt_csis_print_sirk(const struct bt_csis *csis); void bt_csis_print_sirk(const struct bt_csis *csis);
/** /**
* @brief Starts advertising the PRSI value. * @brief Starts advertising the Resolveable Set Identifier value.
* *
* This cannot be used with other connectable advertising sets. * This cannot be used with other connectable advertising sets.
* *
@ -181,7 +181,7 @@ void bt_csis_print_sirk(const struct bt_csis *csis);
int bt_csis_advertise(struct bt_csis *csis, bool enable); int bt_csis_advertise(struct bt_csis *csis, bool enable);
/** /**
* @brief Locks the sets on the server. * @brief Locks a specific Coordinated Set Identification Service instance on the server.
* *
* @param csis Pointer to the Coordinated Set Identification Service. * @param csis Pointer to the Coordinated Set Identification Service.
* @param lock If true lock the set, if false release the set. * @param lock If true lock the set, if false release the set.