Bluetooth: Clarify bt_conn_create_slave_le documentation

Johan Hedberg · carlescufi · commit 1f74e0b1f75e · 2019-03-07T21:02:26.000+01:00
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 <johan.hedberg@intel.com>
diff --git 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.

Original file line number	Diff line number	Diff line change
`@@ -231,8 +231,9 @@ int bt_le_set_auto_conn(const bt_addr_le_t *addr,`
`231`	`231`	`* Allows initiating a new LE connection to remote peer with the remote`
`232`	`232`	`* acting in central role and the local device in peripheral role.`
`233`	`233`	`*`
`234`		`- * The advertising type must be either BT_LE_ADV_DIRECT_IND or`
`235`		`- * BT_LE_ADV_DIRECT_IND_LOW_DUTY.`
	`234`	`+ * The advertising type will either be BT_LE_ADV_DIRECT_IND, or`
	`235`	`+ * BT_LE_ADV_DIRECT_IND_LOW_DUTY if the BT_LE_ADV_OPT_DIR_MODE_LOW_DUTY`
	`236`	`+ * option was used as part of the advertising parameters.`
`236`	`237`	`*`
`237`	`238`	`* In case of high duty cycle this will result in a callback with`
`238`	`239`	`* connected() with a new connection or with an error.`