Revision 59:d73a257e9f89, committed 2016-07-13

Comitter:

LancasterUniversity

Date:

Wed Jul 13 12:18:39 2016 +0100

Parent:

58:2ac8d45f1b08

Child:

60:122814b3e76e

Commit message:

Synchronized with git rev 158eb43b
Author: James Devine
microbit-dal: MicroBitSerial.[eventOn, eventAfter] clarity

The documentation for MicroBitSerial.[eventOn, eventAfter] is now
clearer on what events are generated.

Changed in this revision

--- a/inc/drivers/MicroBitSerial.h	Wed Jul 13 12:18:38 2016 +0100
+++ b/inc/drivers/MicroBitSerial.h	Wed Jul 13 12:18:39 2016 +0100
@@ -436,6 +436,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
@@ -455,7 +457,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:

--- 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: