Bryce Williams / FivePosSwitch

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of FivePosSwitch by Bryce Williams

Diff: FivePosSwitch.h

Revision:
2:a415472059c3
Parent:
0:0388385d4480
Child:
3:dcb9eef119cf
diff -r 2e82709484bc -r a415472059c3 FivePosSwitch.h
--- a/FivePosSwitch.h	Sun Oct 04 19:18:10 2015 +0000
+++ b/FivePosSwitch.h	Sun Oct 04 19:31:36 2015 +0000
@@ -52,7 +52,13 @@
 
 class FivePosSwitch{
     public:
+        /** Constructor for FivePosSwitch
+            @param <pin> The AnalogIn Pin
+        */ 
         FivePosSwitch(AnalogIn pin);
+        /** Get the currently pressed switch position
+            @return The currently pressed switch position 
+        */
         ACTIVE_POSITION getPosition();
     private:
         AnalogIn _pin;