From 64bf41254fa092926c621cabc30fd1bf00a44daf Mon Sep 17 00:00:00 2001 From: Luiz Augusto von Dentz Date: Tue, 30 May 2017 10:53:59 +0300 Subject: [PATCH] Bluetooth: GATT: Add proper documentation for bt_gatt_notify attribute Document the expected attribute shall be the Characteristic Value Descriptor. Signed-off-by: Luiz Augusto von Dentz --- include/bluetooth/gatt.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/include/bluetooth/gatt.h b/include/bluetooth/gatt.h index eb5002fb027..173f3c87548 100644 --- a/include/bluetooth/gatt.h +++ b/include/bluetooth/gatt.h @@ -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. */