Diff: VarStore.h

Revision:

15:a794a7ef6170

Parent:

14:6cbe8366d587

Child:

16:19ea694d96c0

--- a/VarStore.h	Tue Aug 26 09:09:50 2014 +0000
+++ b/VarStore.h	Tue Aug 26 09:20:44 2014 +0000
@@ -6,65 +6,65 @@
 #define STR_OK ""
 
 /** VarStore Class beta !!!!!!!
-*  Used for reading/modifying program variables
-*  from the console at runtime. Helpful for
-*  debugging.
-*  It has a facility as well to reset the mbed
-*  from the serial console without pressing  
-*  any button.
-*  It does not block the serial/input channel
-*  in case it is needed for other stuff
-*  
-* Example:
-* @code
-
-* #include "mbed.h"
-* #include "rtos.h"
-* #include "VarStore.h"
-*
-* #include <RawSerial.h>
-*
-* RawSerial  pc(USBTX,USBRX);  // Be aware !!!! need rawserial. No printf for you anymore !! 
-*                              // no malloc nither as this works in ISR
-*
-* VarStore Store(&pc,20);      // create storage for 20 variables/arrays attach to serial pc
-* 
-* DigitalOut led1(LED1);
-* DigitalOut led2(LED2);
-* 
-* void led2_thread(void const *args) {
-*    
-*    int wait2=1000;
-*    Store.Load("wait2",&wait2,T_int);   // load variable wait2 in Store
-*    
-*    while (true) {
-*        led2 = !led2;
-*        Thread::wait(wait2);  // remember, no WAIT, STOPS CPU FROM RUNNING WHOLE PROGRAM.
-                               // use Thread::wait to stop just your path of execution.
-*    }
-* }
-* 
-* int main() {
-*    
-*    int wait1=500;
-*    Store.Load("wait1",&wait1,T_int);  // Load variable wait1 in Store
-*    Thread VS_thread(VarStore::Worker,&Store,osPriorityNormal,DEFAULT_STACK_SIZE,NULL); // launch VarStore Thread
-*    
-*    Thread thread(led2_thread);
-*    
-*    while (true) {
-*        led1 = !led1;
-*        Thread::wait(wait1); // remember, no WAIT, STOPS CPU FROM RUNNING WHOLE PROGRAM.
-*                              // use Thread::wait to stop just your path of execution.
-*    }
-* }
-*
-* @endcode
-*
-*
-*
-*
-*/
+ *  Used for reading/modifying program variables
+ *  from the console at runtime. Helpful for
+ *  debugging.
+ *  It has a facility as well to reset the mbed
+ *  from the serial console without pressing  
+ *  any button.
+ *  It does not block the serial/input channel
+ *  in case it is needed for other stuff
+ *  
+ * Example:
+ * @code
+ *
+ * #include "mbed.h"
+ * #include "rtos.h"
+ * #include "VarStore.h"
+ *
+ * #include <RawSerial.h>
+ *
+ * RawSerial  pc(USBTX,USBRX);  // Be aware !!!! need rawserial. No printf for you anymore !! 
+ *                              // no malloc nither as this works in ISR
+ *
+ * VarStore Store(&pc,20);      // create storage for 20 variables/arrays attach to serial pc
+ * 
+ * DigitalOut led1(LED1);
+ * DigitalOut led2(LED2);
+ * 
+ * void led2_thread(void const *args) {
+ *    
+ *    int wait2=1000;
+ *    Store.Load("wait2",&wait2,T_int);   // load variable wait2 in Store
+ *    
+ *    while (true) {
+ *        led2 = !led2;
+ *        Thread::wait(wait2);  // remember, no WAIT, STOPS CPU FROM RUNNING WHOLE PROGRAM.
+ *                               // use Thread::wait to stop just your path of execution.
+ *    }
+ * }
+ * 
+ * int main() {
+ *    
+ *    int wait1=500;
+ *    Store.Load("wait1",&wait1,T_int);  // Load variable wait1 in Store
+ *    Thread VS_thread(VarStore::Worker,&Store,osPriorityNormal,DEFAULT_STACK_SIZE,NULL); // launch VarStore Thread
+ *    
+ *    Thread thread(led2_thread);
+ *    
+ *    while (true) {
+ *        led1 = !led1;
+ *        Thread::wait(wait1); // remember, no WAIT, STOPS CPU FROM RUNNING WHOLE PROGRAM.
+ *                              // use Thread::wait to stop just your path of execution.
+ *    }
+ * }
+ *
+ * @endcode
+ *
+ *
+ *
+ *
+ */
 class VarStore
 {