Combined Mouse, MouseViaInt and MouseFullInt demos into a single unified demo.

[pub/lufa.git] / Demos / AudioOutput / AudioOutput.txt

diff --git a/Demos/AudioOutput/AudioOutput.txt b/Demos/AudioOutput/AudioOutput.txt
index ce7d4ed..0638c47 100644 (file)
--- a/Demos/AudioOutput/AudioOutput.txt
+++ b/Demos/AudioOutput/AudioOutput.txt
@@ -5,7 +5,38 @@
  */\r
  \r
 /** \mainpage Audio Output Device Demo\r
- *  \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>Audio Class</td>\r
+ *   </tr>\r
+ *   <tr> \r
+ *    <td><b>USB Subclass:</b></td>\r
+ *    <td>Standard Audio Device</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Relevant Standards:</b></td>\r
+ *    <td>USBIF Audio Class Specification</td>\r
+ *    <td>USBIF Audio Class Terminal Types Specification</td>\r
+ *    <td>USBIF Audio Data Formats Specification</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
  *  Audio demonstration application. This gives a simple reference\r
  *  application for implementing a USB Audio Output device using the\r
  *  basic USB Audio drivers in all modern OSes (i.e. no special drivers\r
@@ -21,30 +52,37 @@
  *  \r
  *  Under Windows, if a driver request dialogue pops up, select the option\r
  *  to automatically install the appropriate drivers.\r
- *  \r
+ *\r
+ *  \section SSec_Options Project Options\r
+ *\r
+ *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.\r
  *\r
  *  <table>\r
  *   <tr>\r
- *    <td><b>USB Mode:</b></td>\r
- *    <td>Device</td>\r
+ *    <td><b>Define Name:</b></td>\r
+ *    <td><b>Location:</b></td>\r
+ *    <td><b>Description:</b></td>\r
  *   </tr>\r
  *   <tr>\r
- *    <td><b>USB Class:</b></td>\r
- *    <td>Audio Class</td>\r
+ *    <td>AUDIO_OUT_STEREO</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>When defined, this outputs the audio samples in stereo to the timer output pins of the microcontroller.</td>\r
  *   </tr>\r
- *   <tr> \r
- *    <td><b>USB Subclass:</b></td>\r
- *    <td>Standard Audio Device</td>\r
+ *   <tr>\r
+ *    <td>AUDIO_OUT_MONO</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>When defined, this outputs the audio samples in mono to the timer output pin of the microcontroller.</td>\r
  *   </tr>\r
  *   <tr>\r
- *    <td><b>Relevant Standards:</b></td>\r
- *    <td>USBIF Audio Class Specification</td>\r
- *    <td>USBIF Audio Class Terminal Types Specification</td>\r
- *    <td>USBIF Audio Data Formats Specification</td>\r
+ *    <td>AUDIO_OUT_LEDS</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>When defined, this outputs the audio samples in stereo to the board LEDs.</td>\r
  *   </tr>\r
  *   <tr>\r
- *    <td><b>Usable Speeds:</b></td>\r
- *    <td>Full Speed Mode</td>\r
+ *    <td>AUDIO_OUT_PORTC</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>When defined, this outputs the audio samples in mono to port C of the microcontroller, for connection to an\r
+ *        external DAC.</td>\r
  *   </tr>\r
  *  </table>\r
  */
\ No newline at end of file