Skip to content

Commit

Permalink
Added documentation to offset and flag parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
vChavezB authored Apr 26, 2024
1 parent 41eb3ca commit a3b7fa5
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions include/ble_utils/ble_utils.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ class Characteristic
*
* @param buf Buffer to place the read result in
* @param len Length of data to read
* @param offset Offset to start reading from
* @return Number of bytes read, or in case of an error
* BT_GATT_ERR() with a specific BT_ATT_ERR_* error code.
*/
Expand All @@ -71,11 +72,13 @@ class Characteristic
};

/**
* @brief Callback function that requests to write data
* @brief Callback function that requests to write data
* to the characteristic.
*
* @param buf Buffer with the data to write
* @param len Number of bytes in the buffer
* @param buf Buffer with the data to write
* @param len Number of bytes in the buffer
* @param offset Offset to start writing from
* @param flags Flags (``BT_GATT_WRITE_FLAG_*``)
* @return Number of bytes written, or in case of an error
* BT_GATT_ERR() with a specific BT_ATT_ERR_* error code.
*/
Expand Down

0 comments on commit a3b7fa5

Please sign in to comment.