Doxygen documentation for text.h, SFont.h, setup.h, realpath.h, readline.h, palette.h, keyboard.h, io.h, input.h, hotkeys.h, helpfile.h, errors.h; and a basic description for all other headers.

Removed 2 unused function prototypes (They escaped translation)
In each C file, added a #include of its own header, to help doxygen generate a more complete documentation for the C files (and also double-check function prototypes)

All these changes don't change the generated executable, it's still beta 99.0.

git-svn-id: svn://pulkomandy.tk/GrafX2/trunk@752 416bcca6-2ee7-4201-b75f-2eb2f807beb1

hotkeys.h

@@ -19,6 +19,13 @@
     write to the Free Software Foundation, Inc.,
     59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
+
+//////////////////////////////////////////////////////////////////////////////
+///@file hotkeys.h
+/// Definition of the tables used by the keyboard shortcuts.
+/// The actual data is in hotkeys.c
+//////////////////////////////////////////////////////////////////////////////
+
 #include <stdbool.h>
 #include <SDL.h>
 
@@ -26,15 +33,22 @@
 
 typedef struct
 {
-    word Number;
-    char Label[36];
-    char Explic1[37];
-    char Explic2[37];
-    char Explic3[37];
-    bool Suppr;       // Shortcut facultatif
-    word Key;
-    word Key2;
+    word Number;      ///< Identifier for shortcut. This is a number starting from 0, which matches ::T_Config_shortcut_info.Number
+    char Label[36];   ///< Text to show in the screen where you can edit the shortcut.
+    char Explic1[37]; ///< Explanation text (1/3) to show in the screen where you can edit the shortcut.
+    char Explic2[37]; ///< Explanation text (2/3) to show in the screen where you can edit the shortcut.
+    char Explic3[37]; ///< Explanation text (3/3) to show in the screen where you can edit the shortcut.
+    bool Suppr;       ///< Boolean, true if the shortcut can be removed.
+    word Key;         ///< Primary shortcut. Value is a keycode, see keyboard.h
+    word Key2;        ///< Secondary shortcut. Value is a keycode, see keyboard.h
 } T_Key_config;
 
+/// Table with all the configurable shortcuts, whether they are for a menu button or a special action.
 extern T_Key_config ConfigKey[NB_SHORTCUTS];
+///
+/// Translation table from a shortcut index to a shortcut identifier.
+/// The value is either:
+/// - 0x000 + special shortcut number
+/// - 0x100 + button number (left click)
+/// - 0x200 + button number (right click)
 extern word Ordering[NB_SHORTCUTS];