patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

Doc: Clearify bt_conn_set_security documentation

Browse source 
Clearify the sec parameter in the documentation of bt_conn_set_security.

This should make the API documentation easier to understand.

Signed-off-by: Jan Müller <jan.mueller@nordicsemi.no>
This commit is contained in:
Jan Müller 2024-01-02 15:42:51 +01:00 committed by Carles Cufí
parent bc2826c1cb
commit 8f0abaf87f
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
include/zephyr/bluetooth/conn.h
View file

@ -871,11 +871,12 @@ int bt_le_set_auto_conn(const bt_addr_le_t *addr,
* the device has bond information or is already paired and the keys are too
* weak then the pairing procedure will be initiated.
*
* This function may return error if required level of security is not possible
* to achieve due to local or remote device limitation (e.g., input output
* capabilities), or if the maximum number of paired devices has been reached.
* This function may return an error if the required level of security defined using
* @p sec is not possible to achieve due to local or remote device limitation
* (e.g., input output capabilities), or if the maximum number of paired devices
* has been reached.
*
* This function may return error if the pairing procedure has already been
* This function may return an error if the pairing procedure has already been
* initiated by the local device or the peer device.
*
* @note When @kconfig{CONFIG_BT_SMP_SC_ONLY} is enabled then the security
@ -888,7 +889,7 @@ int bt_le_set_auto_conn(const bt_addr_le_t *addr,
* procedure will always be initiated.
*
* @param conn Connection object.
* @param sec Requested security level.
* @param sec Requested minimum security level.
*
* @return 0 on success or negative error
*/