Diff: inc/drivers/MicroBitSerial.h

Revision:

67:99cfde195ff3

Parent:

66:2fc7d7c2fffc

diff -r 2fc7d7c2fffc -r 99cfde195ff3 inc/drivers/MicroBitSerial.h
--- a/inc/drivers/MicroBitSerial.h	Wed Jul 13 12:18:46 2016 +0100
+++ b/inc/drivers/MicroBitSerial.h	Wed Jul 13 12:18:47 2016 +0100
@@ -265,8 +265,9 @@
       *
       *         Defaults to SYNC_SLEEP.
       *
-      * @return the number of bytes written, or MICROBIT_SERIAL_IN_USE if another fiber
-      *         is using the serial instance for transmission.
+      * @return the number of bytes written, MICROBIT_SERIAL_IN_USE if another fiber
+      *         is using the serial instance for transmission, MICROBIT_INVALID_PARAMETER
+      *         if buffer is invalid, or the given bufferLen is <= 0.
       */
     int send(ManagedString s, MicroBitSerialMode mode = MICROBIT_DEFAULT_SERIAL_MODE);
 
@@ -292,8 +293,9 @@
       *
       *         Defaults to SYNC_SLEEP.
       *
-      * @return the number of bytes written, or MICROBIT_SERIAL_IN_USE if another fiber
-      *         is using the serial instance for transmission.
+      * @return the number of bytes written, MICROBIT_SERIAL_IN_USE if another fiber
+      *         is using the serial instance for transmission, MICROBIT_INVALID_PARAMETER
+      *         if buffer is invalid, or the given bufferLen is <= 0.
       */
     int send(uint8_t *buffer, int bufferLen, MicroBitSerialMode mode = MICROBIT_DEFAULT_SERIAL_MODE);