From 08e1b0ebc7a5b9a960994e16710465dfb67f66ee Mon Sep 17 00:00:00 2001
From: Joel Bodenmann <joel@unormal.org>
Date: Fri, 28 Mar 2014 19:45:08 +0100
Subject: 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.

---
 drivers/gdisp/SSD1289/board_SSD1289_template.h | 115 -------------------------
 1 file changed, 115 deletions(-)

(limited to 'drivers/gdisp/SSD1289/board_SSD1289_template.h')

diff --git a/drivers/gdisp/SSD1289/board_SSD1289_template.h b/drivers/gdisp/SSD1289/board_SSD1289_template.h
index 7c9cd757..b86d9579 100644
--- a/drivers/gdisp/SSD1289/board_SSD1289_template.h
+++ b/drivers/gdisp/SSD1289/board_SSD1289_template.h
@@ -5,181 +5,67 @@
  *              http://ugfx.org/license.html
  */
 
-/**
- * @file    drivers/gdisp/SSD1289/board_SSD1289_template.h
- * @brief   GDISP Graphic Driver subsystem board interface for the SSD1289 display.
- *
- * @addtogroup GDISP
- * @{
- */
-
 #ifndef _GDISP_LLD_BOARD_H
 #define _GDISP_LLD_BOARD_H
 
-/**
- * @brief   Initialise the board for the display.
- *
- * @param[in] g			The GDisplay structure
- *
- * @note	Set the g->board member to whatever is appropriate. For multiple
- * 			displays this might be a pointer to the appropriate register set.
- *
- * @notapi
- */
 static inline void init_board(GDisplay *g) {
 	(void) g;
 }
 
-/**
- * @brief   After the initialisation.
- *
- * @param[in] g			The GDisplay structure
- *
- * @notapi
- */
 static inline void post_init_board(GDisplay *g) {
 	(void) g;
 }
 
-/**
- * @brief   Set or clear the lcd reset pin.
- *
- * @param[in] g			The GDisplay structure
- * @param[in] state		TRUE = lcd in reset, FALSE = normal operation
- * 
- * @notapi
- */
 static inline void setpin_reset(GDisplay *g, bool_t state) {
 	(void) g;
 	(void) state;
 }
 
-/**
- * @brief   Set the lcd back-light level.
- *
- * @param[in] g				The GDisplay structure
- * @param[in] percent		0 to 100%
- * 
- * @notapi
- */
 static inline void set_backlight(GDisplay *g, uint8_t percent) {
 	(void) g;
 	(void) percent;
 }
 
-/**
- * @brief   Take exclusive control of the bus
- *
- * @param[in] g				The GDisplay structure
- *
- * @notapi
- */
 static inline void acquire_bus(GDisplay *g) {
 	(void) g;
 }
 
-/**
- * @brief   Release exclusive control of the bus
- *
- * @param[in] g				The GDisplay structure
- *
- * @notapi
- */
 static inline void release_bus(GDisplay *g) {
 	(void) g;
 }
 
-/**
- * @brief   Send data to the index register.
- *
- * @param[in] g				The GDisplay structure
- * @param[in] index			The index register to set
- *
- * @notapi
- */
 static inline void write_index(GDisplay *g, uint16_t index) {
 	(void) g;
 	(void) index;
 }
 
-/**
- * @brief   Send data to the lcd.
- *
- * @param[in] g				The GDisplay structure
- * @param[in] data			The data to send
- * 
- * @notapi
- */
 static inline void write_data(GDisplay *g, uint16_t data) {
 	(void) g;
 	(void) data;
 }
 
-/**
- * @brief   Set the bus in read mode
- *
- * @param[in] g				The GDisplay structure
- *
- * @notapi
- */
 static inline void setreadmode(GDisplay *g) {
 	(void) g;
 }
 
-/**
- * @brief   Set the bus back into write mode
- *
- * @param[in] g				The GDisplay structure
- *
- * @notapi
- */
 static inline void setwritemode(GDisplay *g) {
 	(void) g;
 }
 
-/**
- * @brief   Read data from the lcd.
- * @return	The data from the lcd
- *
- * @param[in] g				The GDisplay structure
- *
- * @notapi
- */
 static inline uint16_t read_data(GDisplay *g) {
 	(void) g;
 	return 0;
 }
 
-/**
- * The below section you can replace with #error if your interface doesn't support DMA
- */
 #if defined(GDISP_USE_DMA) || defined(__DOXYGEN__)
 	//#error "GDISP - SSD1289: This interface does not support DMA"
 
-	/**
-	 * @brief	Transfer data using DMA but don't increment the source address
-	 *
-	 * @param[in] g				The GDisplay structure
-	 * @param[in] buffer		The source buffer location
-	 * @param[in] area			The number of pixels to transfer
-	 *
-	 * @notapi
-	 */
 	static inline void dma_with_noinc(GDisplay *g, color_t *buffer, int area) {
 		(void) g;
 		(void) buffer;
 		(void) area;
 	}
 
-	/**
-	 * @brief	Transfer data using DMA incrementing the source address
-	 *
-	 * @param[in] g				The GDisplay structure
-	 * @param[in] buffer		The source buffer location
-	 * @param[in] area			The number of pixels to transfer
-	 *
-	 * @notapi
-	 */
 	static inline void dma_with_inc(GDisplay *g, color_t *buffer, int area) {
 		(void) g;
 		(void) buffer;
@@ -188,4 +74,3 @@ static inline uint16_t read_data(GDisplay *g) {
 #endif
 
 #endif /* _GDISP_LLD_BOARD_H */
-/** @} */
-- 
cgit v1.2.3