Skip to content

Commit a3b7fa5

Browse files
authored
Added documentation to offset and flag parameters
1 parent 41eb3ca commit a3b7fa5

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

include/ble_utils/ble_utils.hpp

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ class Characteristic
5959
*
6060
* @param buf Buffer to place the read result in
6161
* @param len Length of data to read
62+
* @param offset Offset to start reading from
6263
* @return Number of bytes read, or in case of an error
6364
* BT_GATT_ERR() with a specific BT_ATT_ERR_* error code.
6465
*/
@@ -71,11 +72,13 @@ class Characteristic
7172
};
7273

7374
/**
74-
* @brief Callback function that requests to write data
75+
* @brief Callback function that requests to write data
7576
* to the characteristic.
7677
*
77-
* @param buf Buffer with the data to write
78-
* @param len Number of bytes in the buffer
78+
* @param buf Buffer with the data to write
79+
* @param len Number of bytes in the buffer
80+
* @param offset Offset to start writing from
81+
* @param flags Flags (``BT_GATT_WRITE_FLAG_*``)
7982
* @return Number of bytes written, or in case of an error
8083
* BT_GATT_ERR() with a specific BT_ATT_ERR_* error code.
8184
*/

0 commit comments

Comments
 (0)