Diff: keypad.h

Revision:

8:862b0a362754

Parent:

7:51ed72b695a5

Child:

9:1f7793af2f64

--- a/keypad.h	Sat Sep 19 09:17:07 2015 +0000
+++ b/keypad.h	Sat Sep 19 16:28:14 2015 +0000
@@ -77,49 +77,50 @@
                      
 class Keypad{    
     public:
-    /** Create a 4x4 (col, row) or 4x4 keypad interface\n
-     *\n
-     *@table
+    /**  @brief Create a 4x4 (col, row) or 4x4 keypad interface\n
+     * \n
+     * @table
      *          | Col0 | Col1 | Col2 | Col3   \n
      *   -------+------+------+------+-----   \n
      *   Row 0  |   x  |   x  |   x  |  x     \n
      *   Row 1  |   x  |   x  |   x  |  x     \n
      *   Row 2  |   x  |   x  |   x  |  x     \n
      *   Row 3  |   x  |   x  |   x  |  x     \n
-     *@endtabl
+     * @endtable
      *
      *  @param col<0..3>     Row data lines
      *  @param row<0..3>     Column data lines
      */
         Keypad(PinName col0, PinName col1, PinName col2, PinName col3, PinName row0,PinName row1, PinName row2, PinName row3);
     
-       /** User-defined function that returns the letter of the pressed key
-        *      if no walid key was pressed
-        *      the value -1 is returned
+       /** @brief  Returns the letter of the pressed key \n
+        *      if no walid key was pressed\n
+        *      the value -1 is returned\n
         *          
-        *  returns char
+        *  @return char - The pressed character or -1 if no char was pressed
         */
         char getKey();
         
-        /** User-defined function that returns true if any key is pressed 
+        /** @brief Detects if any key was pressed   
         *          
-        *  returns bool
+        *   @return bool - true is returned if any key is pressed
         */
         bool getKeyPressed();
-        /** User-defined function enables PullUp resistors on the 
+        /**  Enables internal PullUp resistors on the coloums pins 
         *          
-        *  returns bool
+        *  @return void
         */
         void enablePullUp();
 
     protected:
         BusIn  _cols;    
         BusOut _rows;
-         /** User-defined function that return the index value 
-        *      representating the pressed key if no walid key was pressed
-        *      the value 0 is returned
+         /** @brief return the index value \n
+        *      representating the pressed key \n 
+        *      if no walid key was pressed \n
+        *      the value -1 is returned
         *          
-        *  returns int
+        *  @return int 
         */
         int getKeyIndex();