Add checks to the endpoint and pipe configure functions and fail if the requested...
[pub/USBasp.git] / Projects / MediaController / MediaController.txt
index ac1506b..dece213 100644 (file)
@@ -1,66 +1,66 @@
-/** \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 Media Controller Project\r
- *\r
- *  \section Sec_Compat Project Compatibility:\r
- *\r
- *  The following list indicates what microcontrollers are compatible with this project.\r
- *\r
- *  - Series 7 USB AVRs (AT90USBxxx7)\r
- *  - Series 6 USB AVRs (AT90USBxxx6)\r
- *  - Series 4 USB AVRs (ATMEGAxxU4)\r
- *  - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)\r
- *\r
- *  \section Sec_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>Human Interface Device (HID)</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td><b>USB Subclass:</b></td>\r
- *    <td>N/A</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td><b>Relevant Standards:</b></td>\r
- *    <td>USBIF HID Specification \n\r
- *        USBIF HID Usage Tables</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td><b>Usable Speeds:</b></td>\r
- *    <td>Low Speed Mode \n\r
- *        Full Speed Mode</td>\r
- *   </tr>\r
- *  </table>\r
- *\r
- *  \section Sec_Description Project Description:\r
- *\r
- *  Media Controller project. This project implements a basic Media Control device, to signal the host to play, pause, toggle playback,\r
- *  mute and/or adjust the host volume, in addition to other such media commands. This project may be extended to create a dedicated\r
- *  media playback control device, for home media centers or other equipment. By default, some of the most commonly used playback controls\r
- *  are controlled by the board joystick and LEDs, however this may be altered as desired.\r
- *\r
- *  \section Sec_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
- */\r
-\r
+/** \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 Media Controller Project
+ *
+ *  \section Sec_Compat Project Compatibility:
+ *
+ *  The following list indicates what microcontrollers are compatible with this project.
+ *
+ *  \li Series 7 USB AVRs (AT90USBxxx7)
+ *  \li Series 6 USB AVRs (AT90USBxxx6)
+ *  \li Series 4 USB AVRs (ATMEGAxxU4)
+ *  \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
+ *
+ *  \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>Human Interface Device (HID)</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>USB Subclass:</b></td>
+ *    <td>N/A</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Relevant Standards:</b></td>
+ *    <td>USBIF HID Specification \n
+ *        USBIF HID Usage Tables</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Supported USB Speeds:</b></td>
+ *    <td>Low Speed Mode \n
+ *        Full Speed Mode</td>
+ *   </tr>
+ *  </table>
+ *
+ *  \section Sec_Description Project Description:
+ *
+ *  Media Controller project. This project implements a basic Media Control device, to signal the host to play, pause, toggle playback,
+ *  mute and/or adjust the host volume, in addition to other such media commands. This project may be extended to create a dedicated
+ *  media playback control device, for home media centers or other equipment. By default, some of the most commonly used playback controls
+ *  are controlled by the board joystick and LEDs, however this may be altered as desired.
+ *
+ *  \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>
+ */
+