added doxygen html generated documenation

fixe doxygen tags.

8 files changed, 47 insertions, 155 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) {

 	/*

diff --git a/Graphic_Equalizer/src/display.hcc b/Graphic_Equalizer/src/display.hcc
index 98145a8..8aafea4 100644
--- a/Graphic_Equalizer/src/display.hcc
+++ b/Graphic_Equalizer/src/display.hcc
@@ -48,14 +48,15 @@ chan unsigned 1 maskupdate_notification;
 

 

 

-/*! \fn		void display_main(skindata_t *skindata, audiodata_t *audiodata,

- *					events_t *events, mousedata_t *mousedata)

+/*! \fn		void display_main(skindata_t *skindata, audiodata_t *audiodata,	events_t *events, mousedata_t *mousedata)

  *

  * \brief	This routine handles all drawing of pixels. It never returns!

  * 

- * \param	events_t *events	struct with all events.

- * \param	mousedata_t *mousedata	struct with coordinates to current

- *					X en Y.

+ * \param	*skindata	struct with all skin information.

+ * \param	*audiodata	struct with (i)fft data to be drawn.

+ * \param	*events		struct with all events.

+ * \param	*mousedata	struct with coordinates to current.

+ *				X en Y.

  * 

  * \return	Never Returns.

  * \retval	void

@@ -321,14 +322,14 @@ void display_main(skindata_t *skindata, audiodata_t *audiodata, events_t *events
 

 

 

-/*! \fn		void reload_equalizer(events_t *events, 

- *						unsigned 4 *equalizer_levels)

+/*! \fn		void reload_equalizer(events_t *events, unsigned 4 *equalizer_levels)

+

  * \brief	This function copies the supplied equalizer values to the array

  *		used for displaying equalizer data.

  *

- * \param	events_t *events		events struct

- * \param	unsigned 4 *equalizer_levels	pointer to 128 entries where

- *						equalizer is to be copied from.

+ * \param	*events			events struct

+ * \param	*equalizer_levels	pointer to 128 entries where equalizer

+ *					is to be copied from.

  *

  * \return	void

  * \retval	void

diff --git a/Graphic_Equalizer/src/eventhandler.hcc b/Graphic_Equalizer/src/eventhandler.hcc
index ab59322..6526618 100644
--- a/Graphic_Equalizer/src/eventhandler.hcc
+++ b/Graphic_Equalizer/src/eventhandler.hcc
@@ -49,12 +49,13 @@ static rom unsigned 3 equalizer_mode_table[5] = {EQUALIZERMODE_CONVEX_FULL, EQUA
 

 

 

-/*! \fn		void eventhandler_main(audiodata_t *audiodata,

- * 			events_t *events, mousedata_t *mousedata);

+/*! \fn		void eventhandler_main(audiodata_t *audiodata, events_t *events, mousedata_t *mousedata);

  * \brief	

  * 

- * \param	events_t *events	pointer to struct with all events->

- * \param	mousedata_t *mousedata	pointer to struct with mouse data.

+ * \param	*audiodata	pointer to struct for setting equalizer levels.

+ * \param	*events	pointer to struct with all events for display states.

+ * \param	*mousedata	pointer to struct with mouse data for X and Y

+ *				coordinates.

  *

  * \return	Never Returns.

  * \retval	void

diff --git a/Graphic_Equalizer/src/events.hcc b/Graphic_Equalizer/src/events.hcc
index 9424392..3772193 100644
--- a/Graphic_Equalizer/src/events.hcc
+++ b/Graphic_Equalizer/src/events.hcc
@@ -34,13 +34,14 @@
 #endif

 

 

-/*! \fn		void load_preset(unsigned 20 preset_address,

- *						unsigned 4 *equalizer_levels);

+/*! \fn		void load_preset(unsigned 20 preset_address, unsigned 4 *equalizer_levels);

  * \brief	This function loads 768 4bits presets into the equalizer_levels

  *		array pointed to by equalizer_levels.

  *

- * \param	unsigned 20 	PL2Ram address where preset to be loaded is.

- * \param	unsigned 4 *	Pointer to preset location.	

+ * \param	preset_address 		PL2Ram address where preset to be

+ *					loaded is.

+ * \param	*equalizer_levels	Location where to store presets loaded

+ *					from ram.

  *

  * \return	void

  * \retval	void

diff --git a/Graphic_Equalizer/src/main.hcc b/Graphic_Equalizer/src/main.hcc
index 3593637..91509fc 100644
--- a/Graphic_Equalizer/src/main.hcc
+++ b/Graphic_Equalizer/src/main.hcc
@@ -1,4 +1,3 @@
-

 /*! \file main.hcc

  *

  * \section generic Message build up information and more

@@ -46,8 +45,6 @@
 /*! \fn		void main(void);

  * \brief	Main Application Loop.

  * 

- * \param	void

- *

  * \return	void

  * \retval	void

  */

diff --git a/Graphic_Equalizer/src/mouse.hcc b/Graphic_Equalizer/src/mouse.hcc
index 0469fda..61ce619 100644
--- a/Graphic_Equalizer/src/mouse.hcc
+++ b/Graphic_Equalizer/src/mouse.hcc
@@ -1,4 +1,4 @@
-/*! \file mousedriver.hcc

+/*! \file mouse.hcc

  *

  * \section generic	This module takes care of mouse input. The mouse

  *			input function itself is however performed by the

@@ -38,9 +38,9 @@
 /*! \fn		void mouse_main(mousedata_t *mousedata);

  * \brief	Main mousedriver. This function never returns! It calls the

  *		main mousehandler and returns the States and coordinates

- *		into the shared mpram.

+ *		into a shared store.

  * 

- * \param	void	None.

+ * \param	*mousedata	Storage for all mousedata and states.

  *

  * \return	Never Returns.

  * \retval	void

diff --git a/Graphic_Equalizer/src/sample.hcc b/Graphic_Equalizer/src/sample.hcc
deleted file mode 100644
index 000baf9..0000000
--- a/Graphic_Equalizer/src/sample.hcc
+++ /dev/null
@@ -1,106 +0,0 @@
-/*! \file sample.hcc

- *

- * \section generic Handle audio sampling and buffer rotation.

- *

- * \section project Project information.

- * Project Graphic Equalizer\n

- * \author O.M. Schinagl

- * \date 20041021

- * \version 0.1

- *

- * \section copyright Copyright

- * Copyright ©2004 Koninklijke Philips Electronics N.V. All rights reserved

- *

- * \section history Change history

- * 20041021: O.M. Schinagl\n	Initial version

- *

- ********************************************************************/

-

-/******** System Includes *************/

-

-/******** Application Includes ********/

-#include "sample.hch"

-

-

-

-/*

- * Pointer that points towards the current 64 bits samples.

- */

-signed 16 *audio_in_ptr;

-

-/*

- * 64 step counter to keep track of our samples. This is a private variable.

- */

-unsigned 8 sample_count;

-

-

-

-/*! \fn		void sample_add(signed 16 in_sample);

- * \brief	This procedure adds the supplied sample to the input buffer.

- * 

- * \param	signed 16 in_sample	16 bits signed sample to be added.

- *

- * \return	void

- * \retval	void

- */

-void sample_add(signed 16 in_sample) {

-	/*

-	 * We only sample 64 bits in our buffer, hence we circulate around the

-	 * last 6 bits.

-	 */

-	audio_in_ptr[sample_count <-6] = in_sample;

-	sample_count++;

-} /* --- sample_add() --- */

-

-

-

-/*! \fn		void sample_get(signed 16 *out_sample);

- * \brief	This procedure gets the sample from the current output buffer.

- * 

- * \param	* in_sample	pointer to storage for sample.

- *

- * \return	void

- * \retval	void

- */

-void sample_get(signed 16 *out_sample) {

-	/*

-	 * We circulate around a 64 bits buffer, therefor we only use the last

-	 *  6 bits.

-	 */

-	*out_sample = audio_out_ptr[sample_count <-6];

-} /* --- sample_get() --- */

-

-

-

-/*! \fn		unsigned 1 sample_rotate_buffers(void);

- * \brief	This procedure rotates our buffers around if 64 samples are

- *		read into our current buffer.

- * 

- * \param	in_sample	16 bits signed sample to be added.

- *

- * \return	1 when 64 samples have passed, 0 otherwise.

- * \retval	unsigned 1;

- */

-unsigned 1 sample_rotate_buffers(void) {

-	unsigned 1 retval;	/* store for returnvalue */

-

-	retval = 0;

-	/*

-	 * We only want to read 64 samples, but calculations work nicer if we

-	 * use 256 samples. Therefor we circulate our audio pointer around.

-	 */

-	if (!(sample_count <- 6)) {

-		/*

-		 * 64 Samples have passed. We are back at '0'. Use the full

-		 * sample count as index which is 0 64 128 or 192 and back to

-	         * 0. Our Output is only 128 big so we only look at the

-		 * 7 LSB. Also, notify the main application that 64 samples

-		 * have been processed.

-		 */

-		par {

-			audio_in_ptr = &pcm_audio_in[sample_count];

-			audio_out_ptr = &pcm_audio_out[(sample_count <- 7)];

-			retval = 1;

-		}

-	}

-} /* --- sample_rotate_buffers() --- */

diff --git a/Graphic_Equalizer/src/smartmedia.hcc b/Graphic_Equalizer/src/smartmedia.hcc
index efc0e3d..757cc17 100644
--- a/Graphic_Equalizer/src/smartmedia.hcc
+++ b/Graphic_Equalizer/src/smartmedia.hcc
@@ -35,12 +35,10 @@
 #include "eventhandler_shared.hch"

 #include "display.hch" /* FIXME: temporary include, needs to be moved to 'init' */

 

-/*! \fn		unsigned 1  smartmedia_init(void);

+/*! \fn		unsigned 1 smartmedia_init(void);

  * \brief	We here initialize the Smart Media card and verify wether the

  *		card is inserted and such.

  * 

- * \param	void	None.

- *

  * \return	We return 0 on success, 1 on error.

  * \retval	unsigned 1

  */

@@ -65,7 +63,7 @@ unsigned 1 smartmedia_init(void) {
 /*! \fn		void smartmedia_loaddata(skindata_t *skindata);

  * \brief	We load our memory with skin and help data from the smartmedia.

  * 

- * \param	skindata_t *skindata	pointer to skindata struct.

+ * \param	*skindata	skindata like boundries and colors of elements.

  *

  * \return	void

  * \retval	void