Raspberries/mraa
Private
Public Access
2
0
Fork 0
Code Activity

i2c.h: Fix docs that incorectly states -1 is failure

Browse Source 
Fixes #228

Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
Brendan Le Foll
2015-06-20 20:41:42 +01:00
parent a06757b62b
commit 41d71e6ce2
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
api/mraa/i2c.h
View File

@@ -93,7 +93,7 @@ int mraa_i2c_read(mraa_i2c_context dev, uint8_t* data, int length);
* with the i2c offset 0x0 * with the i2c offset 0x0
* *
* @param dev The i2c context * @param dev The i2c context
* @return The result of the read or -1 if failed * @return The result of the read and 0 if failed
*/ */
uint8_t mraa_i2c_read_byte(mraa_i2c_context dev); uint8_t mraa_i2c_read_byte(mraa_i2c_context dev);
@@ -102,7 +102,7 @@ uint8_t mraa_i2c_read_byte(mraa_i2c_context dev);
* *
* @param dev The i2c context * @param dev The i2c context
* @param command The register * @param command The register
* @return The result of the read or -1 if failed * @return The result of the read and 0 if failed
*/ */
uint8_t mraa_i2c_read_byte_data(mraa_i2c_context dev, const uint8_t command); uint8_t mraa_i2c_read_byte_data(mraa_i2c_context dev, const uint8_t command);
@@ -111,7 +111,7 @@ uint8_t mraa_i2c_read_byte_data(mraa_i2c_context dev, const uint8_t command);
* *
* @param dev The i2c context * @param dev The i2c context
* @param command The register * @param command The register
* @return The result of the read or -1 if failed * @return The result of the read and 0 if failed
*/ */
uint16_t mraa_i2c_read_word_data(mraa_i2c_context dev, const uint8_t command); uint16_t mraa_i2c_read_word_data(mraa_i2c_context dev, const uint8_t command);