diff options
Diffstat (limited to 'Graphic_Equalizer/src/audio.hcc')
| -rw-r--r-- | Graphic_Equalizer/src/audio.hcc | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/Graphic_Equalizer/src/audio.hcc b/Graphic_Equalizer/src/audio.hcc index ef8b530..34e0ffe 100644 --- a/Graphic_Equalizer/src/audio.hcc +++ b/Graphic_Equalizer/src/audio.hcc @@ -1,17 +1,17 @@ -/*! \file audio.hcc
+/*! @file audio.hcc
*
- * \section generic Audio init and main loop
+ * @section generic Audio init and main loop
*
- * \section project Project information.
+ * @section project Project information.
* Project Graphic Equalizer\n
- * \author
- * \date 20041011
- * \version 0.1
+ * @author O.M. Schinagl
+ * @date 20041011
+ * @version 0.1
*
- * \section copyright Copyright
+ * @section copyright Copyright
* Copyright ©2004 Koninklijke Philips Electronics N.V. All rights reserved
*
- * \section history Change history
+ * @section history Change history
* 20041011: \n Initial version
*
********************************************************************/
@@ -27,15 +27,14 @@ -/*! \fn void audio_init(gain_level, input_source,
- * sample_rate, AUDIOIN, AUDIOOUT)
+/*! \fn macro proc audio_init(gain_level, input_source, sample_rate, AUDIOIN, AUDIOOUT)
*
* \brief Set some inital values to the audio hardware.
*
- * \param gain_level Set the input amplifier to this
- * amplification level.
- * \param input_source Choose between microphone input
- * or linein input
+ * \param gain_level Set the input amplifier to this amplification
+ * level.
+ * \param input_source Choose between microphone input or linein
+ * input.
* \param sample_rate Set the sample rate between 8000
* and 48000
*
@@ -58,19 +57,20 @@ macro proc audio_init(gain_level, input_source, sample_rate, AUDIOIN, AUDIOOUT) #if !USE_RUNFFT
-/*! \fn void audio_main(AUDIOIN, AUDIOOUT);
+/*! @fn macro proc audio_main(audiodata, AUDIOIN, AUDIOOUT);
*
- * \brief Main audiodriver. This function never returns! It calls the
+ * @brief Main audiodriver. This function never returns! It calls the
* audiohandlers and stores samples into a global array. Once 64
* Samples are collected it raises a signal AUDIO_READY to let
* other processes know it's ready. We use quadruple buffering for
* audio input and double buffering for audio output.
- *
- * \param AUDIOIN Audio Input Handler
- * \param AUDIOOUT Audio Output Handler
*
- * \return Never Returns.
- * \retval void
+ * @param *audiodata pointer to audio information structure.
+ * @param AUDIOIN Audio Input Handler
+ * @param AUDIOOUT Audio Output Handler
+ *
+ * @return Never Returns.
+ * @retval void
*/
macro proc audio_main(audiodata, AUDIOIN, AUDIOOUT) {
/*
|