Ollie Milton / ShiftOut

Simple library for controlling a shift register using only three pins on the mbed. Defaults to controlling an 8 bit shift register.

Dependents:   Lab07_RTOS_display Lab07_RTOS_queue

Files at this revision

API Documentation at this revision

Revision 4:7333dc6fca5c, committed 2015-07-14

Comitter:
ollie8
Date:
Tue Jul 14 07:33:26 2015 +0000
Parent:
3:31000094ef1e
Commit message:
Documentation update

Changed in this revision

ShiftOut.h Show annotated file Show diff for this revision Revisions of this file 
diff -r 31000094ef1e -r 7333dc6fca5c ShiftOut.h
--- a/ShiftOut.h	Tue Jul 14 07:28:28 2015 +0000
+++ b/ShiftOut.h	Tue Jul 14 07:33:26 2015 +0000
@@ -10,11 +10,11 @@
 
     public :
     
-        /** Constructs a new ShiftOut with the given three pins.\n
-         * clk - the pin to use for the shift register clock.\n
-         * data - the pin to use for the shift register data line.\n
-         * latch - the pin to use for the shift register latch.\n
-         * registerCount - the number of registers in the shift register, defaults to eight.\n
+        /** Constructs a new ShiftOut with the given three pins.
+         * @param clk - the pin to use for the shift register clock.
+         * @param data - the pin to use for the shift register data line.
+         * @param latch - the pin to use for the shift register latch.
+         * @param registerCount - the number of registers in the shift register, defaults to eight.
          */
         ShiftOut(PinName clk, PinName data, PinName latch, int8_t registerCount = 0x08) {
             clkout = new DigitalOut(clk);