Get rid of the redundant ATTR_NEVER_INLINE macro which translated to the same as...
[pub/USBasp.git] / Projects / LEDNotifier / LEDNotifier.txt
index f9314b7..53728f4 100644 (file)
@@ -1,65 +1,63 @@
-/** \file\r
- *\r
- *  This file contains special DoxyGen information for the generation of the main page and other special\r
- *  documentation pages. It is not a project source file.\r
- */\r
\r
-/** \mainpage Communications Device Class (Virtual Serial Port) Demo\r
- *\r
- *  \section SSec_Compat Demo Compatibility:\r
- *\r
- *  The following list indicates what microcontrollers are compatible with this demo.\r
- *\r
- *  - AT90USB646\r
- *\r
- *  \section SSec_Info USB Information:\r
- *\r
- *  The following table gives a rundown of the USB utilization of this demo.\r
- *\r
- *  <table>\r
- *   <tr>\r
- *    <td><b>USB Mode:</b></td>\r
- *    <td>Device</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td><b>USB Class:</b></td>\r
- *    <td>Communications Device Class (CDC)</td>\r
- *   </tr>\r
- *   <tr> \r
- *    <td><b>USB Subclass:</b></td>\r
- *    <td>Abstract Control Model (ACM)</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td><b>Relevant Standards:</b></td>\r
- *    <td>USBIF CDC Class Standard</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td><b>Usable Speeds:</b></td>\r
- *    <td>Full Speed Mode</td>\r
- *   </tr>\r
- *  </table>\r
- *\r
- *  \section SSec_Description Project Description: \r
- *\r
- *  Hotmail Email Notifier Project. This project is designed for the Busware BUI board, however it can run easily on any\r
- *  USB AVR. It consists of a host application (written in C#) and a device firmware which work together to provide a\r
- *  visual mail notification system via the board's RGB LED. While the sample host application uses the Windows Live\r
- *  Messenger API for its email notifications, the hardware simply adjusts the LED color based on bytes sent to it - thus\r
- *  with a little coding, this project can be adapted for any sort of visual notification.\r
- *\r
- *  To compile the host application, you will need Microsoft Visual Studio 2008 (the free Express edition should be\r
- *  sufficient) as well as a recent version of Windows Live Messenger installed. When run, you will need to set the COM port\r
- *  number used by the hardware on the host PC, whereupon the host will send new email notifications to the device.\r
- *\r
- *  \section SSec_Options Project Options\r
- *\r
- *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.\r
- *\r
- *  <table>\r
- *   <tr>\r
- *    <td>\r
- *     None\r
- *    </td>\r
- *   </tr>\r
- *  </table>\r
- */
\ No newline at end of file
+/** \file
+ *
+ *  This file contains special DoxyGen information for the generation of the main page and other special
+ *  documentation pages. It is not a project source file.
+ */
+
+/** \mainpage USB LED Notifier Project
+ *
+ *  \section Sec_Compat Demo Compatibility:
+ *
+ *  The following list indicates what microcontrollers are compatible with this demo.
+ *
+ *  \li AT90USB646
+ *
+ *  \section Sec_Info USB Information:
+ *
+ *  The following table gives a rundown of the USB utilization of this demo.
+ *
+ *  <table>
+ *   <tr>
+ *    <td><b>USB Mode:</b></td>
+ *    <td>Device</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>USB Class:</b></td>
+ *    <td>Communications Device Class (CDC)</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>USB Subclass:</b></td>
+ *    <td>Abstract Control Model (ACM)</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Relevant Standards:</b></td>
+ *    <td>USBIF CDC Class Standard</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Supported USB Speeds:</b></td>
+ *    <td>Full Speed Mode</td>
+ *   </tr>
+ *  </table>
+ *
+ *  \section Sec_Description Project Description:
+ *
+ *  USB LED Notifier Project. This project is designed for the Busware BUI board, however it can run easily on any
+ *  USB AVR. It is a generic RGB LED controller (via a three channel software PWM) which listens for commands from the
+ *  host on a CDC virtual serial port. When new commands are received, it updates the board LEDs.
+ *
+ *  This can be controlled with any host application that can write to the virtual serial port, allowing it to become
+ *  a visual notification system for any number of custom host applications, such as a new unread email notifier.
+ *
+ *  \section Sec_Options Project Options
+ *
+ *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
+ *
+ *  <table>
+ *   <tr>
+ *    <td>
+ *     None
+ *    </td>
+ *   </tr>
+ *  </table>
+ */
+