Diff: sbDriver.h

Revision:

1:4a62ae180af0

Parent:

0:f76850de7b57

Child:

2:3935d2ed40cd

--- a/sbDriver.h	Tue Aug 19 07:09:20 2014 +0000
+++ b/sbDriver.h	Tue Aug 19 07:16:17 2014 +0000
@@ -88,12 +88,12 @@
 * Takes in references for the required hardware: SPI, Latch, Enable, and, if implemented, Reset.
 * Shiftbrite modules does NOT have a reset line but can be reset by removing the power. The reset line
 * referenced will toggle to allow you to implement the required hardware.
-* @param Serial Pointer
-  @param Latch Pin
-  @param Enable Pin 
-  @param Reset Pin 
-  @param SPI Port (Data and Clock)
-  @param moduleCount int
+* @param Serial Pointer to instance of Serial object.
+  @param Latch Pin used to control data latching on shiftbrite module.
+  @param Enable Pin used to control LED output buffers of shiftbrite module.
+  @param Reset Pin used to signal a circuit that control the +ve power to the shiftbrite modules. This can be ignored if no reset required.
+  @param SPI Port to send serial data to shoftbrite module. (Data and Clock).
+  @param moduleCount int, the number of connected modules.
 *
 *   Example:
 *   @code