aboutsummaryrefslogtreecommitdiffstats
path: root/wirish
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@mit.edu>2010-11-29 01:49:26 -0500
committerMarti Bolivar <mbolivar@mit.edu>2010-11-29 01:49:26 -0500
commit078edc158da7906ba72e7e6528e1a811e07270e7 (patch)
tree1bc7b2e8137fb5ebfc7b59d59294d7adb9e95468 /wirish
parent5e587be27a7c3bd854b686952a5c9637a2432ff0 (diff)
downloadlibrambutan-078edc158da7906ba72e7e6528e1a811e07270e7.tar.gz
librambutan-078edc158da7906ba72e7e6528e1a811e07270e7.zip
Finished converting the Arduino docs
Diffstat (limited to 'wirish')
-rw-r--r--wirish/comm/HardwareSerial.h9
-rw-r--r--wirish/io.h6
2 files changed, 11 insertions, 4 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);
diff --git a/wirish/io.h b/wirish/io.h
index f01efcb..24f2611 100644
--- a/wirish/io.h
+++ b/wirish/io.h
@@ -79,8 +79,8 @@ typedef enum WiringPinMode {
when it is closer to 0v (ground) it is low. If no
external circuit is pulling the pin voltage to high or
low, it will tend to randomly oscillate and be very
- sensitive to noise (eg a breath of air across the pin
- will cause the state to flip). */
+ sensitive to noise (e.g., a breath of air across the pin
+ might cause the state to flip). */
INPUT_ANALOG, /**< This is a special mode for when the pin will be
used for analog (not digital) reads. Enables ADC
@@ -101,7 +101,7 @@ typedef enum WiringPinMode {
the state will be low unless an external device
is specifically pulling the pin up to 3.3v, in
which case the "gentle" pull down will not
- effect the state of the input. */
+ affect the state of the input. */
INPUT_FLOATING, /**< Synonym for INPUT. */