John Mitchell / DMSupport

Subdirectory provided by Embedded Artists

Dependencies:   DM_FATFileSystem DM_HttpServer DM_USBHost EthernetInterface USBDevice mbed-rpc mbed-rtos mbed-src

Dependents:   lpc4088_displaymodule_hello_world_Sept_2018

Fork of DMSupport by Embedded Artists

Diff: RtosLog.h

Revision:
9:a33326afd686
Parent:
2:887c6b45e7fa
Child:
34:fc366bab393f
--- a/RtosLog.h	Thu Dec 11 11:50:29 2014 +0000
+++ b/RtosLog.h	Thu Dec 11 18:23:07 2014 +0000
@@ -23,9 +23,25 @@
 
 /**
  * All threads can independantly call the printf function in the RtosLog class
- * without risc of getting the output tangled up.
+ * without risk of getting the output tangled up.
  *
  * The RtosLog class uses a Thread to process the messages one at a time.
+ *
+ *
+ * Example of using the RtosLog class:
+ *
+ * @code
+ * #include "mbed.h"
+ * #include "DMBoard.h"
+ *
+ * void myTask(void const*args) {
+ *    RtosLog* log = DMBoard::instance().logger();
+ *    ...
+ *    log->printf("Hello world!\n");
+ *    ...
+ * }
+ * @endcode
+ *
  */
 class RtosLog {
 public:
@@ -60,5 +76,3 @@
 };
 
 #endif
-
-