Diff: keypad.h

Revision:

16:ea3c612999ac

Parent:

15:78f9c379a2e1

Child:

17:f9b292067464

--- a/keypad.h	Sat Sep 19 18:35:49 2015 +0000
+++ b/keypad.h	Sat Sep 19 18:45:01 2015 +0000
@@ -33,6 +33,8 @@
 const char NO_KEY = '\0';
 #define KEY_RELEASED NO_KEY
 
+/** @brief table showing the printed layout of the keypad \n
+ */
 const char keys[16] = {'1','2','3','A',
                        '4','5','6','B',
                        '7','8','9','C',
@@ -96,10 +98,10 @@
     Keypad(PinName col0, PinName col1, PinName col2, PinName col3, PinName row0,PinName row1, PinName row2, PinName row3);
 
     /** @brief  Returns the letter of the pressed key \n
-     *      if no walid key was pressed\n
-     *      the value -1 is returned\n
      *
-     *  @return char - The pressed character or -1 if no char was pressed
+     *  @return char
+     *  @retval -1 Error: no keys was pressed
+     *  @retval The pressed character
      */
     char getKey();
 
@@ -124,7 +126,8 @@
     *      if no walid key was pressed \n
     *      the value -1 is returned
     *
-    *  @return int - The index
+    *  @return int
+    *  @retval The index representing the pushed key used in table keys
     */
     int getKeyIndex();