Minor documentation page updates.

[pub/USBasp.git] / Demos / Device / Joystick / Joystick.c

diff --git a/Demos/Device/Joystick/Joystick.c b/Demos/Device/Joystick/Joystick.c
index d5c2073..66cb808 100644 (file)
--- a/Demos/Device/Joystick/Joystick.c
+++ b/Demos/Device/Joystick/Joystick.c
@@ -28,8 +28,18 @@
   this software.\r
 */\r
 \r
+/** \file\r
+ *\r
+ *  Main source file for the Joystick demo. This file contains the main tasks of\r
+ *  the demo and is responsible for the initial application hardware configuration.\r
+ */\r
+\r
 #include "Joystick.h"\r
 \r
+/** LUFA HID Class driver interface configuration and state information. This structure is\r
+ *  passed to all HID Class driver functions, so that multiple instances of the same class\r
+ *  within a device can be differentiated from one another.\r
+ */\r
 USB_ClassInfo_HID_t Joystick_HID_Interface =\r
        {\r
                .InterfaceNumber         = 0,\r
@@ -42,6 +52,9 @@ USB_ClassInfo_HID_t Joystick_HID_Interface =
                .UsingReportProtocol     = true,\r
        };\r
 \r
+/** Main program entry point. This routine contains the overall program flow, including initial\r
+ *  setup of all components and the main program loop.\r
+ */\r
 int main(void)\r
 {\r
        SetupHardware();\r
@@ -55,6 +68,7 @@ int main(void)
        }\r
 }\r
 \r
+/** Configures the board hardware and chip peripherals for the demo's functionality. */\r
 void SetupHardware(void)\r
 {\r
        /* Disable watchdog if enabled by bootloader/fuses */\r
@@ -77,16 +91,19 @@ void SetupHardware(void)
        TIMSK0 = (1 << OCIE0A);\r
 }\r
 \r
+/** Event handler for the library USB Connection event. */\r
 void EVENT_USB_Connect(void)\r
 {\r
        LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
 }\r
 \r
+/** Event handler for the library USB Disconnection event. */\r
 void EVENT_USB_Disconnect(void)\r
 {\r
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
 }\r
 \r
+/** Event handler for the library USB Configuration Changed event. */\r
 void EVENT_USB_ConfigurationChanged(void)\r
 {\r
        LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
@@ -95,17 +112,26 @@ void EVENT_USB_ConfigurationChanged(void)
          LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
 }\r
 \r
+/** Event handler for the library USB Unhandled Control Packet event. */\r
 void EVENT_USB_UnhandledControlPacket(void)\r
 {\r
        USB_HID_ProcessControlPacket(&Joystick_HID_Interface);\r
 }\r
 \r
+/** ISR to keep track of each millisecond interrupt, for determining the HID class idle period remaining when set. */\r
 ISR(TIMER0_COMPA_vect, ISR_BLOCK)\r
 {\r
        if (Joystick_HID_Interface.IdleMSRemaining)\r
          Joystick_HID_Interface.IdleMSRemaining--;\r
 }\r
 \r
+/** HID class driver callback function for the creation of HID reports to the host.\r
+ *\r
+ *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced\r
+ *  \param ReportData  Pointer to a buffer where the created report should be stored\r
+ *\r
+ *  \return Number of bytes written in the report (or zero if no report is to be sent\r
+ */\r
 uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData)\r
 {\r
        USB_JoystickReport_Data_t* JoystickReport = (USB_JoystickReport_Data_t*)ReportData;\r
@@ -132,6 +158,12 @@ uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceI
        return sizeof(USB_JoystickReport_Data_t);\r
 }\r
 \r
+/** HID class driver callback function for the processing of HID reports from the host.\r
+ *\r
+ *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced\r
+ *  \param ReportData  Pointer to a buffer where the created report has been stored\r
+ *  \param ReportSize  Size in bytes of the received HID report\r
+ */\r
 void CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData, uint16_t ReportSize)\r
 {\r
        // Unused (but mandatory for the HID class driver) in this demo, since there are no Host->Device reports\r