bartoszek/zephyr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Bluetooth: GATT: Add proper documentation for bt_gatt_notify attribute

Browse Source 
Document the expected attribute shall be the Characteristic Value
Descriptor.

Signed-off-by: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
This commit is contained in:
Luiz Augusto von Dentz 2017-05-30 10:53:59 +03:00 committed by Johan Hedberg
parent d2ba7950c5
commit 64bf41254f
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/bluetooth/gatt.h
View File

@ -680,8 +680,12 @@ ssize_t bt_gatt_attr_read_cpf(struct bt_conn *conn,
* all peer that have notification enabled via CCC otherwise do a direct
* notification only the given connection.
*
* The attribute object must be the so called Characteristic Value Descriptor,
* its usually declared with BT_GATT_DESCRIPTOR after BT_GATT_CHARACTERISTIC
* and before BT_GATT_CCC.
*
* @param conn Connection object.
* @param attr Attribute object.
* @param attr Characteristic Value Descriptor attribute.
* @param data Pointer to Attribute data.
* @param len Attribute value length.
*/