Fork of X_NUCLEO_COMMON lib adding 16-bit SPI support
Fork of X_NUCLEO_COMMON by
Diff: DevI2C/DevI2C.h
- Revision:
- 6:e16d452ac87b
- Parent:
- 5:efc56a90dc5a
- Child:
- 7:55d59a1605c3
diff -r efc56a90dc5a -r e16d452ac87b DevI2C/DevI2C.h --- a/DevI2C/DevI2C.h Wed May 27 11:56:24 2015 +0200 +++ b/DevI2C/DevI2C.h Fri Jun 05 16:54:47 2015 +0200 @@ -65,8 +65,8 @@ * where to start writing to (must be correctly masked). * @param NumByteToWrite number of bytes to be written. * @retval 0 if ok, - * -1 if an I2C error has occured, or - * -2 on temporary buffer overflow (i.e. NumByteToWrite was too high) + * @retval -1 if an I2C error has occured, or + * @retval -2 on temporary buffer overflow (i.e. NumByteToWrite was too high) * @note On some devices if NumByteToWrite is greater * than one, the RegisterAddr must be masked correctly! */ @@ -95,7 +95,8 @@ * @param RegisterAddr specifies the internal address register * where to start reading from (must be correctly masked). * @param NumByteToRead number of bytes to be read. - * @retval 0 if ok, -1 if an I2C error has occured + * @retval 0 if ok, + * @retval -1 if an I2C error has occured * @note On some devices if NumByteToWrite is greater * than one, the RegisterAddr must be masked correctly! */