Diff: io/MTSSerial.h

Revision:

36:bb6b293c7495

Parent:

10:2bd727a4b329

Child:

40:14342c4de476

Child:

45:40745c2036cf

--- a/io/MTSSerial.h	Wed Dec 18 23:05:31 2013 +0000
+++ b/io/MTSSerial.h	Thu Dec 19 16:47:26 2013 +0000
@@ -4,16 +4,49 @@
 #include "mbed.h"
 #include "MTSBufferedIO.h"
 
+/** This class derives from MTSBufferedIO and provides a buffered wrapper to the
+* standard Mbed Serial class. Since it depends only on the Mbed Serial class for
+* accessing serial data, this class is inherently portable accross Mbed platforms.
+*/
 class MTSSerial : public MTSBufferedIO
 {
 public:
+    /** Creates a new MTSSerial object that can be used to talk to an Mbed serial port
+    * through internal SW buffers.
+    *
+    * @param TXD the transmit data pin on the desired Mbed serial interface.
+    * @param RXD the receive data pin on the desired Mbed serial interface.
+    * @param txBufferSize the size in bytes of the internal SW transmit buffer. The
+    * default is 64 bytes.
+    * @param rxBufferSize the size in bytes of the internal SW receive buffer. The
+    * default is 64 bytes.
+    * @param name an optional name for the serial port. The default is blank.
+    */
     MTSSerial(PinName TXD, PinName RXD, int txBufferSize = 64, int rxBufferSize = 64, char* name = "");
+
+    /** Destructs an MTSSerial object and frees all related resources, including
+    * internal buffers.
+    */
     ~MTSSerial();
+    
+    /** This method is used to the set the baud rate of the serial port.
+    * 
+    * @param baudrate the baudrate in bps as an int. The internal interface
+    * default is 9600 bps.
+    */
     void baud(int baudrate);
+    
 //    void format(int bits=8, Parity parity=SerialBase::None, int stop_bits=1);
 
-    virtual void handleRead(); // Overridden function to handle reading from the serial port
-    virtual void handleWrite(); // Overridden function to handle writing to the serial port
+    /** Overridden method used internally to handle reading from the serial interface.
+    * Do not call directly, use data access methods available in MTSBufferedIO.
+    */
+    virtual void handleRead();
+
+    /** Overridden method used internally to handle writing to the serial interface.
+    * Do not call directly, use data access methods available in MTSBufferedIO.
+    */
+    virtual void handleWrite();
 
 private:
     Serial* serial; // Internal mbed Serial object