From 1f74e0b1f75eff63568c1c807f003df7c3b7793b Mon Sep 17 00:00:00 2001 From: Johan Hedberg Date: Thu, 7 Mar 2019 18:00:51 +0200 Subject: [PATCH] Bluetooth: Clarify bt_conn_create_slave_le documentation Clarify how the bt_conn_create_slave_le() API can be used to get each of the two possible advertising packet types. Fixes #14160 Signed-off-by: Johan Hedberg --- include/bluetooth/conn.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/include/bluetooth/conn.h b/include/bluetooth/conn.h index 921d1ab930a..a83115aaa22 100644 --- a/include/bluetooth/conn.h +++ b/include/bluetooth/conn.h @@ -231,8 +231,9 @@ int bt_le_set_auto_conn(const bt_addr_le_t *addr, * Allows initiating a new LE connection to remote peer with the remote * acting in central role and the local device in peripheral role. * - * The advertising type must be either BT_LE_ADV_DIRECT_IND or - * BT_LE_ADV_DIRECT_IND_LOW_DUTY. + * The advertising type will either be BT_LE_ADV_DIRECT_IND, or + * BT_LE_ADV_DIRECT_IND_LOW_DUTY if the BT_LE_ADV_OPT_DIR_MODE_LOW_DUTY + * option was used as part of the advertising parameters. * * In case of high duty cycle this will result in a callback with * connected() with a new connection or with an error.