Removed the doxygen inside of every driver as doxygen is only meant for highlevel API documentation.

Documenting the drivers interface should be done inside a template driver or the gdisp LLD abstraction.

7 files changed, 0 insertions, 141 deletions

diff --git a/drivers/gaudio/Win32/gaudio_play_config.h b/drivers/gaudio/Win32/gaudio_play_config.h
index 4013e91f..c4830010 100644
--- a/drivers/gaudio/Win32/gaudio_play_config.h
+++ b/drivers/gaudio/Win32/gaudio_play_config.h
@@ -5,14 +5,6 @@
  *              http://ugfx.org/license.html
  */
 
-/**
- * @file    drivers/gaudio/Win32/gaudio_play_config.h
- * @brief   GAUDIO Play Driver config file.
- *
- * @addtogroup GAUDIO
- * @{
- */
-
 #ifndef GAUDIO_PLAY_CONFIG_H
 #define GAUDIO_PLAY_CONFIG_H
 
@@ -22,42 +14,16 @@
 /* Driver hardware support.                                                  */
 /*===========================================================================*/
 
-/**
- * @brief	The maximum sample frequency supported by this audio device
- */
 #define GAUDIO_PLAY_MAX_SAMPLE_FREQUENCY		44100
-
-/**
- * @brief	The number of audio formats supported by this driver
- */
 #define GAUDIO_PLAY_NUM_FORMATS					2
-
-/**
- * @brief	The available audio sample formats in order of preference
- */
 #define GAUDIO_PLAY_FORMAT1						ARRAY_DATA_16BITSIGNED
 #define GAUDIO_PLAY_FORMAT2						ARRAY_DATA_8BITUNSIGNED
-
-/**
- * @brief	The number of audio channels supported by this driver
- */
 #define GAUDIO_PLAY_NUM_CHANNELS				2
-
-/**
- * @brief	Whether each channel is mono or stereo
- */
 #define GAUDIO_PLAY_CHANNEL0_IS_STEREO			FALSE
 #define GAUDIO_PLAY_CHANNEL1_IS_STEREO			TRUE
-
-/**
- * @brief	The list of audio channel names and their uses
- * @{
- */
 #define	GAUDIO_PLAY_MONO						0
 #define	GAUDIO_PLAY_STEREO						1
-/** @} */
 
 #endif	/* GFX_USE_GAUDIO && GAUDIO_NEED_PLAY */
 
 #endif	/* GAUDIO_PLAY_CONFIG_H */
-/** @} */
diff --git a/drivers/gaudio/Win32/gaudio_play_lld.c b/drivers/gaudio/Win32/gaudio_play_lld.c
index 35a1fc99..c0adf03e 100644
--- a/drivers/gaudio/Win32/gaudio_play_lld.c
+++ b/drivers/gaudio/Win32/gaudio_play_lld.c
@@ -5,11 +5,6 @@
  *              http://ugfx.org/license.html
  */
 
-/**
- * @file    drivers/gaudio/Win32/gaudio_play_lld.c
- * @brief   GAUDIO - Play Driver file for Win32.
- */
-
 #include "gfx.h"
 
 #if GFX_USE_GAUDIO && GAUDIO_NEED_PLAY
diff --git a/drivers/gaudio/Win32/gaudio_record_config.h b/drivers/gaudio/Win32/gaudio_record_config.h
index 4d952e1d..5897212b 100644
--- a/drivers/gaudio/Win32/gaudio_record_config.h
+++ b/drivers/gaudio/Win32/gaudio_record_config.h
@@ -5,14 +5,6 @@
  *              http://ugfx.org/license.html
  */
 
-/**
- * @file    drivers/gaudio/Win32/gaudio_record_config.h
- * @brief   GAUDIO Record Driver config file.
- *
- * @addtogroup GAUDIO
- * @{
- */
-
 #ifndef GAUDIO_RECORD_CONFIG_H
 #define GAUDIO_RECORD_CONFIG_H
 
@@ -22,42 +14,16 @@
 /* Driver hardware support.                                                  */
 /*===========================================================================*/
 
-/**
- * @brief	The maximum sample frequency supported by this audio device
- */
 #define GAUDIO_RECORD_MAX_SAMPLE_FREQUENCY			44100
-
-/**
- * @brief	The number of audio formats supported by this driver
- */
 #define GAUDIO_RECORD_NUM_FORMATS					2
-
-/**
- * @brief	The available audio sample formats in order of preference
- */
 #define GAUDIO_RECORD_FORMAT1						ARRAY_DATA_16BITSIGNED
 #define GAUDIO_RECORD_FORMAT2						ARRAY_DATA_8BITUNSIGNED
-
-/**
- * @brief	The number of audio channels supported by this driver
- */
 #define GAUDIO_RECORD_NUM_CHANNELS					2
-
-/**
- * @brief	Whether each channel is mono or stereo
- */
 #define GAUDIO_RECORD_CHANNEL0_IS_STEREO			FALSE
 #define GAUDIO_RECORD_CHANNEL1_IS_STEREO			TRUE
-
-/**
- * @brief	The list of audio channels and their uses
- * @{
- */
 #define	GAUDIO_RECORD_MONO							0
 #define	GAUDIO_RECORD_STEREO						1
-/** @} */
 
 #endif	/* GFX_USE_GAUDIO && GAUDIO_NEED_RECORD */
 
 #endif	/* GAUDIO_RECORD_CONFIG_H */
-/** @} */
diff --git a/drivers/gaudio/Win32/gaudio_record_lld.c b/drivers/gaudio/Win32/gaudio_record_lld.c
index 9f63ff2f..c9ac8187 100644
--- a/drivers/gaudio/Win32/gaudio_record_lld.c
+++ b/drivers/gaudio/Win32/gaudio_record_lld.c
@@ -5,11 +5,6 @@
  *              http://ugfx.org/license.html
  */
 
-/**
- * @file    drivers/gaudio/Win32/gaudio_record_lld.c
- * @brief   GAUDIO - Record Driver file for Win32.
- */
-
 #include "gfx.h"
 
 #if GFX_USE_GAUDIO && GAUDIO_NEED_RECORD
diff --git a/drivers/gaudio/gadc/gaudio_record_board_template.h b/drivers/gaudio/gadc/gaudio_record_board_template.h
index 59168be1..42c15205 100644
--- a/drivers/gaudio/gadc/gaudio_record_board_template.h
+++ b/drivers/gaudio/gadc/gaudio_record_board_template.h
@@ -5,14 +5,6 @@
  *              http://ugfx.org/license.html
  */
 
-/**
- * @file    drivers/gaudio/gadc/gaudio_record_board_template.h
- * @brief   GAUDIO Record Driver board config board file
- *
- * @addtogroup GAUDIO
- * @{
- */
-
 #ifndef _GAUDIO_RECORD_BOARD_H
 #define _GAUDIO_RECORD_BOARD_H
 
@@ -20,37 +12,16 @@
 /* Audio inputs on this board                                                */
 /*===========================================================================*/
 
-/**
- * @brief	The number of audio channels supported by this driver
- * @note	This is an example
- */
 #define GAUDIO_RECORD_NUM_CHANNELS					1
 
-/**
- * @brief	Whether each channel is mono or stereo
- * @note	This is an example
- */
 #define GAUDIO_RECORD_CHANNEL0_IS_STEREO			FALSE
 
-/**
- * @brief	The list of audio channels and their uses
- * @note	This is an example
- * @{
- */
 #define	GAUDIO_RECORD_MICROPHONE					0
-/** @} */
 
-/**
- * @brief	The audio channel to GADC physical device assignment
- * @note	This is an example
- * @{
- */
 #ifdef GAUDIO_RECORD_LLD_IMPLEMENTATION
 	static uint32_t gaudio_gadc_physdevs[GAUDIO_RECORD_NUM_CHANNELS] = {
 			GADC_PHYSDEV_MICROPHONE,
 			};
 #endif
-/** @} */
 
 #endif	/* _GAUDIO_RECORD_BOARD_H */
-/** @} */
diff --git a/drivers/gaudio/gadc/gaudio_record_config.h b/drivers/gaudio/gadc/gaudio_record_config.h
index 88092a63..345625ff 100644
--- a/drivers/gaudio/gadc/gaudio_record_config.h
+++ b/drivers/gaudio/gadc/gaudio_record_config.h
@@ -5,14 +5,6 @@
  *              http://ugfx.org/license.html
  */
 
-/**
- * @file    drivers/gaudio/gadc/gaudio_record_config.h
- * @brief   GAUDIN Record Driver config file.
- *
- * @addtogroup GAUDIO
- * @{
- */
-
 #ifndef GAUDIO_RECORD_CONFIG_H
 #define GAUDIO_RECORD_CONFIG_H
 
@@ -22,30 +14,13 @@
 /* Driver hardware support.                                                  */
 /*===========================================================================*/
 
-/**
- * @brief	The maximum sample frequency supported by this audio device
- * @details	For this driver it matches the GADC maximum high speed sample rate
- */
 #define GAUDIO_RECORD_MAX_SAMPLE_FREQUENCY			GADC_MAX_HIGH_SPEED_SAMPLERATE
-
-/**
- * @brief	The number of audio formats supported by this driver
- */
 #define GAUDIO_RECORD_NUM_FORMATS					1
-
-/**
- * @brief	The available audio sample formats in order of preference
- */
 #define GAUDIO_RECORD_FORMAT1						GADC_SAMPLE_FORMAT
 
-/**
- * For the GAUDIO driver that uses GADC - all the remaining config definitions are specific
- * to the board.
- */
 /* Include the user supplied board definitions */
 #include "gaudio_record_board.h"
 
 #endif	/* GFX_USE_GAUDIO && GAUDIO_NEED_RECORD */
 
 #endif	/* GAUDIO_RECORD_CONFIG_H */
-/** @} */
diff --git a/drivers/gaudio/gadc/gaudio_record_lld.c b/drivers/gaudio/gadc/gaudio_record_lld.c
index 6f4cb2de..1d70a259 100644
--- a/drivers/gaudio/gadc/gaudio_record_lld.c
+++ b/drivers/gaudio/gadc/gaudio_record_lld.c
@@ -5,15 +5,6 @@
  *              http://ugfx.org/license.html
  */
 
-/**
- * @file    drivers/gaudio/gadc/gaudio_record_lld.c
- * @brief   GAUDIO - Record Driver file for using the cpu ADC (via GADC).
- */
-
-/**
- * We are now implementing the driver - pull in our channel table
- * from the board definitions.
- */
 #define GAUDIO_RECORD_IMPLEMENTATION
 #include "gfx.h"