Cristiano Barbosa / microbit-dal

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   BLE_API mbed-dev-bin nRF51822

Fork of microbit-dal by Lancaster University

Diff: source/drivers/MicroBitSerial.cpp

Revision:
59:d73a257e9f89
Parent:
46:c5bb7af0a3f0
Child:
60:122814b3e76e
--- 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: