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

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

diff --git a/Demos/AudioInput/AudioInput.txt b/Demos/AudioInput/AudioInput.txt
index 09b77f7..36e71e9 100644 (file)
--- a/Demos/AudioInput/AudioInput.txt
+++ b/Demos/AudioInput/AudioInput.txt
@@ -5,21 +5,10 @@
  */\r
  \r
 /** \mainpage Audio Input Device Demo\r
- *  \r
- *  Audio demonstration application. This gives a simple reference\r
- *  application for implementing a USB Audio Input device using the\r
- *  basic USB Audio drivers in all modern OSes (i.e. no special drivers\r
- *  required).\r
- *  \r
- *  On startup the system will automatically enumerate and function\r
- *  as a USB microphone. Incomming audio from the ADC channel 1 will\r
- *  be sampled and sent to the host computer.\r
- *  \r
- *  To use, connect a microphone to the ADC channel 2.\r
- *  \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_Info USB Information:\r
+ *\r
+ *  The following table gives a rundown of the USB utilization of this demo.\r
  *\r
  *  <table>\r
  *   <tr>\r
@@ -45,4 +34,37 @@
  *    <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 Input device using the\r
+ *  basic USB Audio drivers in all modern OSes (i.e. no special drivers\r
+ *  required).\r
+ *  \r
+ *  On startup the system will automatically enumerate and function\r
+ *  as a USB microphone. Incomming audio from the ADC channel 1 will\r
+ *  be sampled and sent to the host computer.\r
+ *  \r
+ *  To use, connect a microphone to the ADC channel 2.\r
+ *  \r
+ *  Under Windows, if a driver request dialogue pops up, select the option\r
+ *  to automatically install the appropriate drivers.\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>Define Name:</b></td>\r
+ *    <td><b>Location:</b></td>\r
+ *    <td><b>Description:</b></td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>MICROPHONE_BIASED_TO_HALF_RAIL</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>When defined, this alters the demo so that the half VCC bias of the microphone input is subtracted.</td>\r
+ *   </tr>\r
+ *  </table>\r
  */
\ No newline at end of file