Fix possible infinite loop in the control stream write template functions.

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

diff --git a/Demos/Device/ClassDriver/AudioInput/AudioInput.txt b/Demos/Device/ClassDriver/AudioInput/AudioInput.txt
index fea31b6..4b05942 100644 (file)
--- a/Demos/Device/ClassDriver/AudioInput/AudioInput.txt
+++ b/Demos/Device/ClassDriver/AudioInput/AudioInput.txt
@@ -6,15 +6,15 @@
 
 /** \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 (AT90USBxxx7)
- *  - Series 6 USB AVRs (AT90USBxxx6)
- *  - Series 4 USB AVRs (ATMEGAxxU4)
+ *  \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.
  *


@@ -38,19 +38,19 @@
  *        USBIF Audio 1.0 Data Formats Specification</td>
  *   </tr>
  *   <tr>
  *        USBIF Audio 1.0 Data Formats Specification</td>
  *   </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
  *  basic USB Audio 1.0 drivers in all modern OSes (i.e. no special drivers
  *  required).
  *
  *
  *  Audio demonstration application. This gives a simple reference
  *  application for implementing a USB Audio Input device using the
  *  basic USB Audio 1.0 drivers in all modern OSes (i.e. no special drivers
  *  required).
  *

- *  On start-up the system will automatically enumerate and function as a 
+ *  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
  *  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


@@ -61,32 +61,32 @@
  *  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>
+ *    <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>
  *   </tr>
  *   <tr>
  *    <td>USE_TEST_TONE</td>

- *    <td>Makefile LUFA_OPTS</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>
  *    <td>MICROPHONE_BIASED_TO_HALF_RAIL</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>
  *    <td>MICROPHONE_BIASED_TO_HALF_RAIL</td>

- *    <td>Makefile LUFA_OPTS</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>
  *    <td>When defined, this alters the demo so that the half VCC bias of the microphone input is subtracted.</td>
  *   </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>
- *   </tr>

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