Correct return values for `I2C::write(int, const char*, int, bool)`

2017-02-23 09:18:34 +01:00 · 2017-02-23 09:18:34 +01:00 · c7453b2452
parent a8a31da2e8
commit c7453b2452
1 changed files with 2 additions and 2 deletions
--- a/drivers/I2C.h
+++ b/drivers/I2C.h
@ -117,8 +117,8 @@ public:
     *  @param repeated Repeated start, true - do not send stop at end
     *
     *  @returns
-     *      0 or non-zero - written number of bytes,
-     *      negative - I2C_ERROR_XXX status
+     *       0 on success (ack),
+     *   non-0 on failure (nack)
     */
    int write(int address, const char *data, int length, bool repeated = false);