Diff: potentiometer.h

Revision:

2:6bfe732ba6bc

Parent:

1:b5c534165dfe

diff -r b5c534165dfe -r 6bfe732ba6bc potentiometer.h
--- a/potentiometer.h	Wed Mar 14 07:59:21 2018 +0000
+++ b/potentiometer.h	Mon Mar 19 11:32:54 2018 +0000
@@ -5,7 +5,20 @@
         
         class Potentiometer{
             public:
+                /*
+                * Constructor for Potentiometer class
+                *
+                @param The pins connected to the potentiometer on the application board.
+                @return Nothing.
+                */
                 Potentiometer(PinName analogPin=p19);
+                
+                /*
+                * Method gets the potentiometer value.
+                *
+                @param Nothing.
+                @return A float containing the potentiometer value (0...255).
+                */
                 float getPotValue(void);
             private:
                 AnalogIn pot1;