Minor documentation page updates.

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

diff --git a/Demos/Device/CDC/CDC.c b/Demos/Device/CDC/CDC.c
index e6bc1a4..6f15393 100644 (file)
--- a/Demos/Device/CDC/CDC.c
+++ b/Demos/Device/CDC/CDC.c
@@ -28,8 +28,18 @@
   this software.\r
 */\r
 \r
+/** \file\r
+ *\r
+ *  Main source file for the CDC demo. This file contains the main tasks of\r
+ *  the demo and is responsible for the initial application hardware configuration.\r
+ */\r
+ \r
 #include "CDC.h"\r
 \r
+/** LUFA CDC Class driver interface configuration and state information. This structure is\r
+ *  passed to all CDC 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_CDC_t VirtualSerial_CDC_Interface =\r
        {\r
                .ControlInterfaceNumber     = 0,\r
@@ -44,6 +54,9 @@ USB_ClassInfo_CDC_t VirtualSerial_CDC_Interface =
                .NotificationEndpointSize   = CDC_NOTIFICATION_EPSIZE,\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
@@ -63,6 +76,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
@@ -78,11 +92,12 @@ void SetupHardware(void)
        USB_Init();\r
 }\r
 \r
+/** Checks for changes in the position of the board joystick, sending strings to the host upon each change. */\r
 void CheckJoystickMovement(void)\r
 {\r
        uint8_t     JoyStatus_LCL = Joystick_GetStatus();\r
        char*       ReportString  = NULL;\r
-       static bool ActionSent = false;\r
+       static bool ActionSent    = false;\r
        \r
        char* JoystickStrings[] =\r
                {\r
@@ -114,16 +129,19 @@ void CheckJoystickMovement(void)
        }\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
@@ -132,6 +150,7 @@ 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_CDC_ProcessControlPacket(&VirtualSerial_CDC_Interface);\r