Edoardo De Marchi / MODSERIAL

MODSERIAL with support for more devices. Added support for LPC4330

Dependents:   HC05_AT_mode GPS_U-blox_NEO-6M_Test_Code GPS_U-blox_NEO-6M_Code UbloxGPSWithThread ... more

Fork of MODSERIAL by Erik -

Diff: MODSERIAL.h

Revision:
32:f42def64c4ee
Parent:
31:b90b20f78f04
--- a/MODSERIAL.h	Fri Oct 11 18:31:01 2013 +0000
+++ b/MODSERIAL.h	Sat Oct 12 09:53:06 2013 +0000
@@ -734,7 +734,19 @@
     *
     * Redirect a stream to this MODSERIAL object
     *
-    * Important: A name parameter must have been added when creating the MODSERIAL object
+    * Important: A name parameter must have been added when creating the MODSERIAL object:
+    *
+    * @code
+    * #include "MODSERIAL.h"
+    * ...
+    * MODSERIAL pc(USBTX, USBRX, "modser");
+    * 
+    * int main() {
+    *   pc.claim()            // capture <stdout>
+    *   pc.printf("Uses the MODSERIAL library\r\n");
+    *   printf("So does this!\r\n");
+    * }
+    * @endcode
     *
     * @ingroup API
     * @param FILE *stream The stream to redirect (default = stdout)