Diff: source/drivers/MicroBitSerial.cpp

Revision:

59:d73a257e9f89

Parent:

46:c5bb7af0a3f0

Child:

60:122814b3e76e

diff -r 2ac8d45f1b08 -r d73a257e9f89 source/drivers/MicroBitSerial.cpp
--- a/source/drivers/MicroBitSerial.cpp	Wed Jul 13 12:18:38 2016 +0100
+++ b/source/drivers/MicroBitSerial.cpp	Wed Jul 13 12:18:39 2016 +0100
@@ -853,6 +853,8 @@
 /**
   * Configures an event to be fired after "len" characters.
   *
+  * Will generate an event with the ID: MICROBIT_ID_SERIAL and the value MICROBIT_SERIAL_EVT_HEAD_MATCH.
+  *
   * @param len the number of characters to wait before triggering the event.
   *
   * @param mode the selected mode, one of: ASYNC, SYNC_SPINWAIT, SYNC_SLEEP. Each mode
@@ -885,7 +887,9 @@
 /**
   * Configures an event to be fired on a match with one of the delimeters.
   *
-  * @param delimeters the characters to match received characters against e.g. ManagedString("\r\n")
+  * Will generate an event with the ID: MICROBIT_ID_SERIAL and the value MICROBIT_SERIAL_EVT_DELIM_MATCH.
+  *
+  * @param delimeters the characters to match received characters against e.g. ManagedString("\n")
   *
   * @param mode the selected mode, one of: ASYNC, SYNC_SPINWAIT, SYNC_SLEEP. Each mode
   *        gives a different behaviour: