Doxygened clavier.h and brush.h

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

clavier.h

@@ -20,9 +20,35 @@
     59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
 
+/*!
+  Convert an SDL keysym to an ANSI/ASCII character.
+  @param Sym SDL symbol to convert
+*/
 word Conversion_ANSI(SDL_keysym Sym);
+
+/*!
+  Convert an SDL keysym to an internal keycode number.
+  This is needed because SDL tends to split the information across the unicode sym, the regular sym, and the raw keycode.
+  We also need to differenciate 1 (keypad) and 1 (regular keyboard), and some other things.
+  @param Sym SDL symbol to convert
+*/
 word Conversion_Touche(SDL_keysym Sym);
+
+/*!
+    Helper function to convert between SDL system and old coding for keycodes. This is needed because some SDL keycode are actually unicode and won't fit in 8 bits.
+  @param scancode Scancode to convert
+*/
 word Touche_pour_scancode(word scancode);
+
+/*!
+    Returns key name in a string. Used to display them in the helpscreens and in the keymapper window.
+  @param Touche keycode of the key to translate, including modifiers
+*/
 const char * Nom_touche(word Touche);
+
+/*!
+  Gets the modifiers in our format from the SDL_Mod information.
+  @param Mod SDL modifiers state
+*/
 word Modificateurs_Touche(SDLMod Mod);