Cansat
/
esp32_Adafruit_BusIO
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Write functions' description updated that explains why the buffer arguments are const.

This commit is contained in:
DESKTOP\fahadmirza 2020-11-29 01:54:32 -06:00
parent 9af0ac41cc
commit d220abdabb
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Adafruit_I2CDevice.cpp
View File

@ -58,10 +58,12 @@ bool Adafruit_I2CDevice::detected(void) {
/*! /*!
* @brief Write a buffer or two to the I2C device. Cannot be more than * @brief Write a buffer or two to the I2C device. Cannot be more than
* maxBufferSize() bytes. * maxBufferSize() bytes.
* @param buffer Pointer to buffer of data to write * @param buffer Pointer to buffer of data to write. This is const to
* ensure the content of this buffer doesn't change.
* @param len Number of bytes from buffer to write * @param len Number of bytes from buffer to write
* @param prefix_buffer Pointer to optional array of data to write before * @param prefix_buffer Pointer to optional array of data to write before
* buffer. Cannot be more than maxBufferSize() bytes. * buffer. Cannot be more than maxBufferSize() bytes. This is const to
* ensure the content of this buffer doesn't change.
* @param prefix_len Number of bytes from prefix buffer to write * @param prefix_len Number of bytes from prefix buffer to write
* @param stop Whether to send an I2C STOP signal on write * @param stop Whether to send an I2C STOP signal on write
* @return True if write was successful, otherwise false. * @return True if write was successful, otherwise false.