Kernel - Doxygen fixes

[tpg/acess2.git] / Kernel / include / api_drv_joystick.h

diff --git a/Kernel/include/api_drv_joystick.h b/Kernel/include/api_drv_joystick.h
index 9225c5e..4319021 100644 (file)
--- a/Kernel/include/api_drv_joystick.h
+++ b/Kernel/include/api_drv_joystick.h
@@ -1,5 +1,5 @@
 /**\r
- * \file api_drv_joystick\r
+ * \file api_drv_joystick.h\r
  * \brief Joystick Driver Interface Definitions\r
  * \author John Hodge (thePowersGang)\r
  * \r
@@ -80,6 +80,9 @@ enum eTplJoystick_IOCtl {
        JOY_IOCTL_GETSETBUTTONFLAGS,\r
 };\r
 \r
+/**\r
+ * \brief Symbolic names for Joystick IOCtls\r
+ */\r
 #define        DRV_JOY_IOCTLNAMES      "set_callback", "set_callback_arg", "getset_axis_limit", "getset_axis_position", \\r
        "getset_axis_flags", "getset_button_flags"\r
 \r
@@ -106,6 +109,7 @@ typedef void (*tJoystick_Callback)(int Ident, int bIsAxis, int Num, int Delta);
 \r
 /**\r
  * \struct sJoystick_FileHeader\r
+ * \brief Format of the joystick VFS node's first bytes\r
  */\r
 struct sJoystick_FileHeader\r
 {\r
@@ -130,6 +134,13 @@ struct sJoystick_Axis
        Uint16  CursorPos;      //!< Current state (cursor position)\r
 };\r
 \r
+/**\r
+ * \brief Macro to define a structure for a joystick's node\r
+ * \param _naxies      Number of axies\r
+ * \param _nbuttons    Number of buttons\r
+ * \note This just defines the structure, it's up to the driver to set the\r
+ *       sJoystick_FileHeader.NAxies and sJoystick_FileHeader.NButtons fields.\r
+ */\r
 #define JOY_INFOSTRUCT(_naxies, _nbuttons) struct { \\r
        Uint16  NAxies, NButtons;\\r
        tJoystick_Axis  Axies[_naxies];\\r