aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/gdisp/ST7565
diff options
context:
space:
mode:
authorJoel Bodenmann <joel@unormal.org>2014-03-28 19:45:08 +0100
committerJoel Bodenmann <joel@unormal.org>2014-03-28 19:45:08 +0100
commit08e1b0ebc7a5b9a960994e16710465dfb67f66ee (patch)
tree72137dac1330a3ebb41b294a8d762b98dc559553 /drivers/gdisp/ST7565
parent16f86ed2e6980fd0ddfa4cedb6bdaf51881f0e3c (diff)
downloaduGFX-08e1b0ebc7a5b9a960994e16710465dfb67f66ee.tar.gz
uGFX-08e1b0ebc7a5b9a960994e16710465dfb67f66ee.tar.bz2
uGFX-08e1b0ebc7a5b9a960994e16710465dfb67f66ee.zip
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.
Diffstat (limited to 'drivers/gdisp/ST7565')
-rw-r--r--drivers/gdisp/ST7565/board_ST7565_template.h68
-rw-r--r--drivers/gdisp/ST7565/gdisp_lld_ST7565.c7
-rw-r--r--drivers/gdisp/ST7565/gdisp_lld_config.h2
-rw-r--r--drivers/gdisp/ST7565/st7565.h2
4 files changed, 1 insertions, 78 deletions
diff --git a/drivers/gdisp/ST7565/board_ST7565_template.h b/drivers/gdisp/ST7565/board_ST7565_template.h
index 4eb45701..3efdbd46 100644
--- a/drivers/gdisp/ST7565/board_ST7565_template.h
+++ b/drivers/gdisp/ST7565/board_ST7565_template.h
@@ -5,20 +5,9 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/gdisp/ST7565/board_ST7565_template.h
- * @brief GDISP Graphic Driver subsystem board interface for the ST7565 display.
- *
- * @addtogroup GDISP
- * @{
- */
-
#ifndef _GDISP_LLD_BOARD_H
#define _GDISP_LLD_BOARD_H
-/**
- * Driver configuration
- */
#define ST7565_LCD_BIAS ST7565_LCD_BIAS_7
#define ST7565_ADC ST7565_ADC_NORMAL
#define ST7565_COM_SCAN ST7565_COM_SCAN_INC
@@ -28,87 +17,32 @@
* #define ST7565_PAGE_ORDER 4,5,6,7,0,1,2,3
*/
-/**
- * @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 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 a command to the controller.
- *
- * @param[in] g The GDisplay structure
- * @param[in] cmd The command to send *
- *
- * @notapi
- */
static inline void write_cmd(GDisplay *g, uint8_t cmd) {
(void) g;
(void) cmd;
}
-/**
- * @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, uint8_t* data, uint16_t length) {
(void) g;
(void) data;
@@ -116,5 +50,3 @@ static inline void write_data(GDisplay *g, uint8_t* data, uint16_t length) {
}
#endif /* _GDISP_LLD_BOARD_H */
-/** @} */
-
diff --git a/drivers/gdisp/ST7565/gdisp_lld_ST7565.c b/drivers/gdisp/ST7565/gdisp_lld_ST7565.c
index b3029391..8d331fbc 100644
--- a/drivers/gdisp/ST7565/gdisp_lld_ST7565.c
+++ b/drivers/gdisp/ST7565/gdisp_lld_ST7565.c
@@ -5,11 +5,6 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/gdisp/ST7565/gdisp_lld.c
- * @brief GDISP Graphics Driver subsystem low level driver source for the ST7565 display.
- */
-
#include "gfx.h"
#if GFX_USE_GDISP
@@ -77,7 +72,7 @@
/* Driver exported functions. */
/*===========================================================================*/
-/**
+/*
* As this controller can't update on a pixel boundary we need to maintain the
* the entire display surface in memory so that we can do the necessary bit
* operations. Fortunately it is a small display in monochrome.
diff --git a/drivers/gdisp/ST7565/gdisp_lld_config.h b/drivers/gdisp/ST7565/gdisp_lld_config.h
index f774e8fa..48587b9e 100644
--- a/drivers/gdisp/ST7565/gdisp_lld_config.h
+++ b/drivers/gdisp/ST7565/gdisp_lld_config.h
@@ -24,5 +24,3 @@
#endif /* GFX_USE_GDISP */
#endif /* _GDISP_LLD_CONFIG_H */
-/** @} */
-
diff --git a/drivers/gdisp/ST7565/st7565.h b/drivers/gdisp/ST7565/st7565.h
index 9542dd3f..48636b33 100644
--- a/drivers/gdisp/ST7565/st7565.h
+++ b/drivers/gdisp/ST7565/st7565.h
@@ -35,5 +35,3 @@
#define ST7565_POWER_CONTROL 0x28
#endif /* _ST7565_H */
-/** @} */
-