Skip to content

Commit 5018fe0

Browse files
committed
[nrf fromtree] bluetooth: host: Update doc for bt_conn_le_conn_rate_set_defaults
The previous documentation was confusing. This adds much clearer language. Signed-off-by: Timothy Keys <timothy.keys@nordicsemi.no> (cherry picked from commit 237dcf2)
1 parent 2b3d253 commit 5018fe0

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

  • include/zephyr/bluetooth

include/zephyr/bluetooth/conn.h

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1577,11 +1577,15 @@ int bt_conn_le_read_min_conn_interval(uint16_t *min_interval_us);
15771577

15781578
/** @brief Set Default Connection Rate Parameters.
15791579
*
1580-
* Set default connection rate parameters to be used for future connections.
1581-
* This command does not affect any existing connection.
1582-
* Parameters set for specific connection will always have precedence.
1580+
* Configure the range of Connection Rate values that this device will
1581+
* accept from a Peripheral initiating a Connection Rate Update procedure.
15831582
*
1584-
* @kconfig_dep{CONFIG_BT_SHORTER_CONNECTION_INTERVALS}
1583+
* The configured bounds:
1584+
* - Apply only to connections established after this call.
1585+
* - Are overridden on a given connection by any
1586+
* @ref bt_conn_le_conn_rate_request on that connection.
1587+
*
1588+
* @kconfig_dep{CONFIG_BT_SHORTER_CONNECTION_INTERVALS,CONFIG_BT_CENTRAL}
15851589
*
15861590
* @param params Connection rate parameters.
15871591
*

0 commit comments

Comments
 (0)