Upgrade doxygen configuration files to the latest version.

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

diff --git a/Demos/Device/ClassDriver/AudioInput/AudioInput.txt b/Demos/Device/ClassDriver/AudioInput/AudioInput.txt
index 2406cdd..4b05942 100644 (file)
--- a/Demos/Device/ClassDriver/AudioInput/AudioInput.txt
+++ b/Demos/Device/ClassDriver/AudioInput/AudioInput.txt
@@ -3,18 +3,18 @@
  *  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.
  */
  *  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 Audio Input Device Demo
  *
 /** \mainpage Audio Input Device Demo
  *

- *  \section SSec_Compat Demo Compatibility:
+ *  \section Sec_Compat Demo Compatibility:

  *
  *  The following list indicates what microcontrollers are compatible with this demo.
  *
  *
  *  The following list indicates what microcontrollers are compatible with this demo.
  *

- *  - Series 7 USB AVRs
- *  - Series 6 USB AVRs
- *  - Series 4 USB AVRs
+ *  \li Series 7 USB AVRs (AT90USBxxx7)
+ *  \li Series 6 USB AVRs (AT90USBxxx6)
+ *  \li Series 4 USB AVRs (ATMEGAxxU4)

  *
  *

- *  \section SSec_Info USB Information:
+ *  \section Sec_Info USB Information:

  *
  *  The following table gives a rundown of the USB utilization of this demo.
  *
  *
  *  The following table gives a rundown of the USB utilization of this demo.
  *


@@ -27,57 +27,66 @@
  *    <td><b>USB Class:</b></td>
  *    <td>Audio Class</td>
  *   </tr>
  *    <td><b>USB Class:</b></td>
  *    <td>Audio Class</td>
  *   </tr>

- *   <tr> 
+ *   <tr>

  *    <td><b>USB Subclass:</b></td>
  *    <td>Standard Audio Device</td>
  *   </tr>
  *   <tr>
  *    <td><b>Relevant Standards:</b></td>
  *    <td><b>USB Subclass:</b></td>
  *    <td>Standard Audio Device</td>
  *   </tr>
  *   <tr>
  *    <td><b>Relevant Standards:</b></td>

- *    <td>USBIF Audio Class Specification \n
- *        USBIF Audio Class Terminal Types Specification \n
- *        USBIF Audio Data Formats Specification</td>
+ *    <td>USBIF Audio 1.0 Class Specification \n
+ *        USBIF Audio 1.0 Class Terminal Types Specification \n
+ *        USBIF Audio 1.0 Data Formats Specification</td>

  *   </tr>
  *   <tr>
  *   </tr>
  *   <tr>

- *    <td><b>Usable Speeds:</b></td>
+ *    <td><b>Supported USB Speeds:</b></td>

  *    <td>Full Speed Mode</td>
  *   </tr>
  *  </table>
  *
  *    <td>Full Speed Mode</td>
  *   </tr>
  *  </table>
  *

- *  \section SSec_Description Project Description: 
+ *  \section Sec_Description Project Description:

  *
  *  Audio demonstration application. This gives a simple reference
  *  application for implementing a USB Audio Input device using the
  *
  *  Audio demonstration application. This gives a simple reference
  *  application for implementing a USB Audio Input device using the

- *  basic USB Audio drivers in all modern OSes (i.e. no special drivers
+ *  basic USB Audio 1.0 drivers in all modern OSes (i.e. no special drivers

  *  required).
  *  required).

- *  
- *  On start-up the system will automatically enumerate and function
- *  as a USB microphone. Incoming audio from the ADC channel 1 will
- *  be sampled and sent to the host computer.
- *  
- *  To use, connect a microphone to the ADC channel 1.
- *  
+ *
+ *  On start-up the system will automatically enumerate and function as a
+ *  USB microphone. By default, the demo will produce a square wave test tone
+ *  when the board button is pressed. If USE_TEST_TONE is not defined in the
+ *  project makefile, incoming audio from the ADC channel 1 will be sampled
+ *  and sent to the host computer instead.
+ *
+ *  When in microphone mode, connect a microphone to the ADC channel 2.
+ *

  *  Under Windows, if a driver request dialogue pops up, select the option
  *  to automatically install the appropriate drivers.
  *
  *  Under Windows, if a driver request dialogue pops up, select the option
  *  to automatically install the appropriate drivers.
  *

- *  \section SSec_Options Project Options
+ *  \section Sec_Options Project Options

  *
  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  *
  *  <table>
  *   <tr>
  *
  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  *
  *  <table>
  *   <tr>

- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>

  *   </tr>
  *   <tr>
  *   </tr>
  *   <tr>

- *    <td>MICROPHONE_BIASED_TO_HALF_RAIL</td>
- *    <td>Makefile CDEFS</td>
- *    <td>When defined, this alters the demo so that the half VCC bias of the microphone input is subtracted.</td>
+ *    <td>MIC_IN_ADC_CHANNEL</td>
+ *    <td>AppConfig.h</td>
+ *    <td>Sets the ADC channel used by the demo for the input audio samples from an attached microphone.</td>
+ *   </tr>
+ *   <tr>
+ *    <td>USE_TEST_TONE</td>
+ *    <td>AppConfig.h</td>
+ *    <td>When defined, this alters the demo to produce a square wave test tone when the first board button is pressed
+ *        instead of sampling the board microphone.</td>

  *   </tr>
  *   <tr>
  *   </tr>
  *   <tr>

- *    <td>AUDIO_SAMPLE_FREQUENCY</td>
- *    <td>Descriptors.h</td>
- *    <td>Gives the audio sample rate per channel for the audio stream, in Hz.</td>
+ *    <td>MICROPHONE_BIASED_TO_HALF_RAIL</td>
+ *    <td>AppConfig.h</td>
+ *    <td>When defined, this alters the demo so that the half VCC bias of the microphone input is subtracted.</td>

  *   </tr>
  *  </table>
  */
  *   </tr>
  *  </table>
  */

+