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.

4 files changed, 1 insertions, 92 deletions

diff --git a/drivers/ginput/touch/STMPE811/ginput_lld_mouse.c b/drivers/ginput/touch/STMPE811/ginput_lld_mouse.c
index d650e603..e658fae2 100644
--- a/drivers/ginput/touch/STMPE811/ginput_lld_mouse.c
+++ b/drivers/ginput/touch/STMPE811/ginput_lld_mouse.c
@@ -4,16 +4,7 @@
  *
  *              http://ugfx.org/license.html
  */
-
-/**
- * @file    drivers/ginput/touch/STMPE811/ginput_lld_mouse.c
- * @brief   GINPUT Touch low level driver source for the STMPE811.
- *
- * @defgroup Mouse Mouse
- * @ingroup GINPUT
- * @{
- */
-
+ 
 #include "gfx.h"
 
 #if (GFX_USE_GINPUT && GINPUT_NEED_MOUSE) /*|| defined(__DOXYGEN__)*/
@@ -43,11 +34,6 @@ static void setActiveWindow(uint16_t bl_x, uint16_t bl_y, uint16_t tr_x, uint16_
 	write_reg(STMPE811_REG_WDW_BL_Y, 2, bl_y);
 }
 
-/**
- * @brief   Initialise the mouse/touch.
- *
- * @notapi
- */
 void ginput_lld_mouse_init(void)
 {
 	init_board();
@@ -81,20 +67,6 @@ void ginput_lld_mouse_init(void)
 	write_reg(STMPE811_REG_INT_CTRL,		1, 0x01);	// Level interrupt, enable intrrupts
 }
 
-/**
- * @brief   Read the mouse/touch position.
- *
- * @param[in] pt	A pointer to the structure to fill
- *
- * @note			For drivers that don't support returning a position
- *					when the touch is up (most touch devices), it should
- *					return the previous position with the new Z value.
- *					The z value is the pressure for those touch devices
- *					that support it (-100 to 100 where > 0 is touched)
- *					or, 0 or 100 for those drivers that don't.
- *
- * @notapi
- */
 void ginput_lld_mouse_get_reading(MouseReading *pt)
 {
 	bool_t	clearfifo;		// Do we need to clear the FIFO
@@ -158,5 +130,3 @@ void ginput_lld_mouse_get_reading(MouseReading *pt)
 }
 
 #endif /* GFX_USE_GINPUT && GINPUT_NEED_MOUSE */
-/** @} */
-
diff --git a/drivers/ginput/touch/STMPE811/ginput_lld_mouse_board_template.h b/drivers/ginput/touch/STMPE811/ginput_lld_mouse_board_template.h
index 3df898da..b7744a49 100644
--- a/drivers/ginput/touch/STMPE811/ginput_lld_mouse_board_template.h
+++ b/drivers/ginput/touch/STMPE811/ginput_lld_mouse_board_template.h
@@ -5,64 +5,23 @@
  *              http://ugfx.org/license.html
  */
 
-/**
- * @file    drivers/ginput/touch/STMPE811/ginput_lld_mouse_board_template.h
- * @brief   GINPUT Touch low level driver source for the STMPE811 on the example board.
- *
- * @defgroup Mouse Mouse
- * @ingroup GINPUT
- * @{
- */
-
 #ifndef _GINPUT_LLD_MOUSE_BOARD_H
 #define _GINPUT_LLD_MOUSE_BOARD_H
 
-/**
- * @brief   Initialise the board for the touch.
- *
- * @notapi
- */
 static void init_board(void) {
 
 }
 
-/**
- * @brief   Check whether an interrupt is raised
- * @return	TRUE if there is an interrupt signal present
- *
- * @notapi
- */
 static inline bool_t getpin_irq(void) {
 
 }
 
-/**
- * @brief	Write a value into a certain register
- *
- * @param[in] reg	The register address
- * @param[in] n		The amount of bytes (one or two)
- * @param[in] val	The value
- *
- * @notapi
- */
 static void write_reg(uint8_t reg, uint8_t n, uint16_t val) {
 
 }
 
-/**
- * @brief	Read the value of a certain register
- *
- * @param[in] reg	The register address
- * @param[in] n		The amount of bytes (one or two)
- *
- * @return Data read from device (one byte or two depending on n param)
- *
- * @notapi
- */
 static uint16_t read_reg(uint8_t reg, uint8_t n) {
 
 }
 
 #endif /* _GINPUT_LLD_MOUSE_BOARD_H */
-/** @} */
-
diff --git a/drivers/ginput/touch/STMPE811/ginput_lld_mouse_config.h b/drivers/ginput/touch/STMPE811/ginput_lld_mouse_config.h
index c7427958..5cd512eb 100644
--- a/drivers/ginput/touch/STMPE811/ginput_lld_mouse_config.h
+++ b/drivers/ginput/touch/STMPE811/ginput_lld_mouse_config.h
@@ -5,16 +5,6 @@
  *              http://ugfx.org/license.html
  */
 
-/**
- * @file    drivers/ginput/touch/STMPE811/ginput_lld_mouse_config.h
- * @brief   GINPUT LLD header file for mouse/touch driver.
- *
- * @defgroup Mouse Mouse
- * @ingroup GINPUT 
- *
- * @{
- */
-
 #ifndef _LLD_GINPUT_MOUSE_CONFIG_H
 #define _LLD_GINPUT_MOUSE_CONFIG_H
 
@@ -33,4 +23,3 @@
 #define STMP811_NO_GPIO_IRQPIN 					FALSE
 
 #endif /* _LLD_GINPUT_MOUSE_CONFIG_H */
-/** @} */
diff --git a/drivers/ginput/touch/STMPE811/stmpe811.h b/drivers/ginput/touch/STMPE811/stmpe811.h
index 494b5f5c..1ee9c211 100644
--- a/drivers/ginput/touch/STMPE811/stmpe811.h
+++ b/drivers/ginput/touch/STMPE811/stmpe811.h
@@ -5,14 +5,6 @@
  *              http://ugfx.org/license.html
  */
 
-/**
- * @file    drivers/ginput/touch/STMPE811/stmpe811.h
- * @brief   Register definition header for the STMPE811 touch controller.
- *
- * @addtogroup GINPUT
- * @{
- */
-
 #ifndef _STMPE811_H
 #define _STMPE811_H
 
@@ -89,4 +81,3 @@
 #define STMPE811_REG_TEMP_TH        0x62
 
 #endif /* _STMPE811_H */
-/** @} */