Bluetooth: host: Document name option behavior in update adv params

Document the behavior of the include name option when this is changed by
updating the advertising parameters of the advertising set.
In this case we cannot update the advertising data since the host does
not have a copy to modify. The application will have to do update with
its current advertising data.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
This commit is contained in:
Joakim Andersson 2021-08-13 13:35:36 +02:00 committed by Carles Cufí
commit 8c2e99d328

View file

@ -981,6 +981,10 @@ int bt_le_ext_adv_set_data(struct bt_le_ext_adv *adv,
* advertiser set is currently advertising. Stop the advertising set before * advertiser set is currently advertising. Stop the advertising set before
* calling this function. * calling this function.
* *
* @note When changing the option @ref BT_LE_ADV_OPT_USE_NAME then
* @ref bt_le_ext_adv_set_data needs to be called in order to update the
* advertising data and scan response data.
*
* @param adv Advertising set object. * @param adv Advertising set object.
* @param param Advertising parameters. * @param param Advertising parameters.
* *