Gordon Craig / mbed-dev

Forked.

Fork of mbed-dev by mbed official

Diff: drivers/I2C.h

Revision:
161:2cc1468da177
Parent:
153:fa9ff456f731
Child:
167:e84263d55307
--- a/drivers/I2C.h	Tue Mar 14 16:40:56 2017 +0000
+++ b/drivers/I2C.h	Thu Mar 30 13:45:57 2017 +0100
@@ -117,8 +117,8 @@
      *  @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);