diff options
author | Marti Bolivar <mbolivar@mit.edu> | 2010-11-29 01:49:26 -0500 |
---|---|---|
committer | Marti Bolivar <mbolivar@mit.edu> | 2010-11-29 01:49:26 -0500 |
commit | 078edc158da7906ba72e7e6528e1a811e07270e7 (patch) | |
tree | 1bc7b2e8137fb5ebfc7b59d59294d7adb9e95468 /wirish/comm | |
parent | 5e587be27a7c3bd854b686952a5c9637a2432ff0 (diff) | |
download | librambutan-078edc158da7906ba72e7e6528e1a811e07270e7.tar.gz librambutan-078edc158da7906ba72e7e6528e1a811e07270e7.zip |
Finished converting the Arduino docs
Diffstat (limited to 'wirish/comm')
-rw-r--r-- | wirish/comm/HardwareSerial.h | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/wirish/comm/HardwareSerial.h b/wirish/comm/HardwareSerial.h index 17be49f..fdfc06d 100644 --- a/wirish/comm/HardwareSerial.h +++ b/wirish/comm/HardwareSerial.h @@ -33,6 +33,13 @@ #include "Print.h" +/* NB: this class documented "by hand" (i.e., not using Doxygen) in: + + libmaple/docs/source/lang/serial.rst + + If you alter the public HardwareSerial interface, you must update + the documentation accordingly. */ + class HardwareSerial : public Print { private: uint8 usart_num; @@ -50,7 +57,7 @@ class HardwareSerial : public Print { uint8 rx_pin, uint8 timer_num, uint8 compare_num); - void begin(uint32); + void begin(uint32 baud); void end(void); uint32 available(void); uint8 read(void); |