diff options
Diffstat (limited to 'Demos/AudioInput')
-rw-r--r-- | Demos/AudioInput/AudioInput.c | 4 | ||||
-rw-r--r-- | Demos/AudioInput/AudioInput.txt | 52 |
2 files changed, 37 insertions, 19 deletions
diff --git a/Demos/AudioInput/AudioInput.c b/Demos/AudioInput/AudioInput.c index 6ead7a015..f41306f3b 100644 --- a/Demos/AudioInput/AudioInput.c +++ b/Demos/AudioInput/AudioInput.c @@ -33,10 +33,6 @@ * Main source file for the Audio Input demo. This file contains the main tasks of the demo and
* is responsible for the initial application hardware configuration.
*/
-
-/* --- Project Configuration --- */
-//#define MICROPHONE_BIASED_TO_HALF_RAIL
-/* --- --- --- --- --- --- --- --- */
#include "AudioInput.h"
diff --git a/Demos/AudioInput/AudioInput.txt b/Demos/AudioInput/AudioInput.txt index 09b77f7ec..36e71e975 100644 --- a/Demos/AudioInput/AudioInput.txt +++ b/Demos/AudioInput/AudioInput.txt @@ -5,21 +5,10 @@ */
/** \mainpage Audio Input Device Demo
- *
- * 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
- * required).
- *
- * On startup the system will automatically enumerate and function
- * as a USB microphone. Incomming audio from the ADC channel 1 will
- * be sampled and sent to the host computer.
- *
- * To use, 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.
- *
+ *
+ * \section SSec_Info USB Information:
+ *
+ * The following table gives a rundown of the USB utilization of this demo.
*
* <table>
* <tr>
@@ -45,4 +34,37 @@ * <td>Full Speed Mode</td>
* </tr>
* </table>
+ *
+ * \section SSec_Description Project Description:
+ *
+ * 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
+ * required).
+ *
+ * On startup the system will automatically enumerate and function
+ * as a USB microphone. Incomming audio from the ADC channel 1 will
+ * be sampled and sent to the host computer.
+ *
+ * To use, 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.
+ *
+ * \section SSec_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>
+ * <td><b>Define Name:</b></td>
+ * <td><b>Location:</b></td>
+ * <td><b>Description:</b></td>
+ * </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>
+ * </tr>
+ * </table>
*/
\ No newline at end of file |