From 0d0957841e9cbae94880be73604376b7fd72aa7b Mon Sep 17 00:00:00 2001 From: Joakim Andersson Date: Wed, 8 Jan 2020 12:12:10 +0100 Subject: [PATCH] Bluetooth: host: Document behaviour of the whitelist initiator. Add documentation for the whitelist initiator behaviour, describing the one-shot behaviour. Signed-off-by: Joakim Andersson --- include/bluetooth/conn.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/include/bluetooth/conn.h b/include/bluetooth/conn.h index a7ee9b38e7f..11dc05948f8 100644 --- a/include/bluetooth/conn.h +++ b/include/bluetooth/conn.h @@ -295,6 +295,11 @@ struct bt_conn *bt_conn_create_le(const bt_addr_le_t *peer, /** @brief Automatically connect to remote devices in whitelist. * * This uses the Auto Connection Establishment procedure. + * The procedure will continue until a single connection is established or the + * procedure is stopped through @ref bt_conn_create_auto_stop. + * To establish connections to all devices in the whitelist the procedure + * should be started again in the connected callback after a new connection has + * been established. * * @param param Initial connection parameters. *