documentation

fivdi · Oct 18, 2014 · 2e7bf93 · 2e7bf93
1 parent 9357b3c
commit 2e7bf93
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 13 deletions.
diff --git a/doc/ain.md b/doc/ain.md
@@ -8,7 +8,7 @@ Creates an Ain (analog input) object for reading the value from an analog
 capable input pin.
 
 The following options are supported:
-- vsenseScale: number (optional, default 100)
+- vsenseScale - number (optional, default 100)
 
 ### Method: rawValue()
 Returns the raw value of the analog input pin.

diff --git a/doc/button.md b/doc/button.md
@@ -43,8 +43,8 @@ button is pressed or released. The options object can be used to configure
 the debounce interval, pull type, and active state for the button.
 
 The following options are supported:
-- debounceInterval: debounce interval in milliseconds (optional, default 50 milliseconds)
-- pullType: pullType.NONE, pullTypes.PULL_UP, or pullTypes.PULL_DOWN (optional, default pullTypes.PULL_UP)
+- debounceInterval - debounce interval in milliseconds (optional, default 50 milliseconds)
+- pullType - pullType.NONE, pullTypes.PULL_UP, or pullTypes.PULL_DOWN (optional, default pullTypes.PULL_UP)
 - isActiveLow - true or false (optional, default true)
 
 ### Event: 'ready'

diff --git a/doc/gpio.md b/doc/gpio.md
@@ -1,7 +1,7 @@
 ## Gpio Class - General Purpose Input Output
 
-Gpio objects can be used to interact with GPIOs. They support input, output,
-interrupt detection, pull-up resistors, and pull-down resistors.
+Gpio objects can be used to control GPIOs. They support input, output, interrupt
+detection, pull-up resistors, and pull-down resistors.
 
 The following circuit shows how to wire a button to pin 24 and an LED to pin
 26 on the P9 header. When the button is pressed, P9_24 will be pulled low.
@@ -40,7 +40,7 @@ The following options are supported:
 - direction - Gpio.IN, Gpio.OUT, Gpio.OUT_HIGH, or Gpio.OUT_LOW (optional, default Gpio.OUT)
 - edge - Gpio.NONE, Gpio.FALLING, Gpio.RISING, or Gpio.BOTH (optional, default Gpio.NONE)
 - isActiveLow - true or false (optional, default false)
-- pullType: pullType.NONE, pullTypes.PULL_UP, or pullTypes.PULL_DOWN (optional, default pullTypes.NONE)
+- pullType - pullType.NONE, pullTypes.PULL_UP, or pullTypes.PULL_DOWN (optional, default pullTypes.NONE)
 
 ### Method: direction(value)
 - value - Gpio.IN or Gpio.OUT (optional)

diff --git a/doc/pwm.md b/doc/pwm.md
@@ -10,9 +10,9 @@ frequency and duty cycle. Additional options are available for configuring the
 PWM polarity and whether or not the PWM signal is initially enabled.
 
 The following options are supported:
-- period: period in nannoseconds (optional, default 500000 nanoseconds)
-- duty: duty in nanoseconds (optional, default 0 nanoseconds)
-- enabled: true or false (optional, default true)
+- period - period in nannoseconds (optional, default 500000 nanoseconds)
+- duty - duty in nanoseconds (optional, default 0 nanoseconds)
+- enabled - true or false (optional, default true)
 - polarity - Pwm.LOW or Pwm.HIGH (optional, default Pwm.LOW)
 
 ### Method: period(value)

diff --git a/doc/uart.md b/doc/uart.md
@@ -9,9 +9,9 @@ communication. A Uart is a streams2 duplex stream. The options object can be
 used to configure the various aspects of the UART such as its baud rate. 
 
 The following options are supported:
-- baudRate: one of the [baud rate constants](https://github.com/fivdi/brkontru/blob/master/doc/uart.md#baud-rate-constants) (optional, default Uart.B38400)
-- highWaterMark: number (optional, default 512)
-- encoding: string (optional, default null)
+- baudRate - one of the [baud rate constants](https://github.com/fivdi/brkontru/blob/master/doc/uart.md#baud-rate-constants) (optional, default Uart.B38400)
+- highWaterMark - number (optional, default 512)
+- encoding - string (optional, default null)
 
 Uart is a streams2 [Duplex](http://nodejs.org/api/stream.html#stream_class_stream_duplex)
 stream that implements both the
@@ -21,7 +21,7 @@ interfaces. Internally, [Duplexify](https://www.npmjs.org/package/duplexify)
 is used to achaive this.
 
 ### Method: baudRate(rate)
-- rate: one of the [baud rate constants](https://github.com/fivdi/brkontru/blob/master/doc/uart.md#baud-rate-constants) (optional)
+- rate - one of the [baud rate constants](https://github.com/fivdi/brkontru/blob/master/doc/uart.md#baud-rate-constants) (optional)
 
 Returns the baud rate of the UART if no rate is specified, else sets the baud
 rate to the specified rate.