Diff: USBHostSerial/USBHostSerial.h

Revision:

7:e7e63ac7ae5f

Parent:

4:b320d68e98e7

Child:

8:93da8ea2708b

diff -r 1571e517a91b -r e7e63ac7ae5f USBHostSerial/USBHostSerial.h
--- a/USBHostSerial/USBHostSerial.h	Wed Mar 13 15:43:54 2013 +0000
+++ b/USBHostSerial/USBHostSerial.h	Wed Mar 13 17:30:42 2013 +0000
@@ -104,7 +104,18 @@
         }
     }
     
-    void baud(int baudrate);
+    /** Set the baud rate of the serial port
+     *
+     *  @param baudrate The baudrate of the serial port (default = 9600).
+     */
+    void baud(int baudrate = 9600);
+    
+    /** Set the transmission format used by the Serial port
+     *
+     *  @param bits The number of bits in a word (default = 8)
+     *  @param parity The parity used (USBHostSerial::None, USBHostSerial::Odd, USBHostSerial::Even, USBHostSerial::Mark, USBHostSerial::Space; default = USBHostSerial::None)
+     *  @param stop The number of stop bits (1 or 2; default = 1)
+     */
     void format(int bits = 8, Parity parity = USBHostSerial::None, int stop_bits = 1);