Diff: class/freemaster_class.h

Revision:

1:5033fe82d4c2

Parent:

0:fb135bf60f82

Child:

2:1895e8ed1c25

--- a/class/freemaster_class.h	Mon May 05 20:13:09 2014 +0000
+++ b/class/freemaster_class.h	Wed May 14 13:28:45 2014 +0000
@@ -45,11 +45,42 @@
 class Freemaster {
 
 public:
+    /** Create FreeMASTER interface
+     *
+     *  @param tx            Transmit pin
+     *  @param rx            Receive pin
+     *  @param tsaMembers    Maximum of variables to register dynamically. (optional)
+     *  @param recBufferSize Buffer size for recorder feature. (optional)
+     *  @param flags         Advanced configuration. (optional)
+     *
+     */
     Freemaster(PinName tx, PinName rx, uint32_t tsaMembers = 20, uint32_t recBufferSize = 1024, uint32_t flags = 0);
+
+    /** Set the baud rate of the serial port
+     *
+     *  @param baudrate The baudrate of the serial port (default = 9600).
+     */
     void baud(int baudrate);
+    
+    /** Catch initialized variables into recorder buffer.
+     */
     void Recorder(void);
     void Poll(void);
 
+    /** Register variables to TSA table
+     *
+     *  @param name, type, addr, info, use following macros to register variable
+     *               FMSTR_TSA_STRUCT_CFG(name) - register structure
+     *               FMSTR_TSA_MEMBER_CFG(parenttype,name,type) - register member of structure
+     *               FMSTR_TSA_RO_VAR_CFG(name,type) - register Read Only variable
+     *               FMSTR_TSA_RW_VAR_CFG(name,type) - register variable
+     *               FMSTR_TSA_RO_MEM_CFG(name,type,addr,size) - register read only of memory block
+     *               FMSTR_TSA_RW_MEM_CFG(name,type,addr,size) - register memory block
+     *
+     *  @returns
+     *    1 if there is space to register a variable,
+     *    0 otherwise
+     */
     FMSTR_BOOL TsaAddVar(FMSTR_TSATBL_STRPTR name, FMSTR_TSATBL_STRPTR type, FMSTR_TSATBL_VOIDPTR addr, FMSTR_TSATBL_VOIDPTR info);
 
     static void _irq_handler(uint32_t id, SerialIrq irq_type);