aboutsummaryrefslogtreecommitdiffstats
path: root/boards/addons
diff options
context:
space:
mode:
authorinmarket <andrewh@inmarket.com.au>2014-03-28 08:52:30 +1000
committerinmarket <andrewh@inmarket.com.au>2014-03-28 08:52:30 +1000
commit16f86ed2e6980fd0ddfa4cedb6bdaf51881f0e3c (patch)
treecaca1dfead164a664f520e25e532545862c358b1 /boards/addons
parentcf22a7f8e377bd6ae94c982aff0c7410013e6ed2 (diff)
downloaduGFX-16f86ed2e6980fd0ddfa4cedb6bdaf51881f0e3c.tar.gz
uGFX-16f86ed2e6980fd0ddfa4cedb6bdaf51881f0e3c.tar.bz2
uGFX-16f86ed2e6980fd0ddfa4cedb6bdaf51881f0e3c.zip
Update incorrect file headers on demo board files
Diffstat (limited to 'boards/addons')
-rw-r--r--boards/addons/gdisp/board_ED060SC4_example.h6
-rw-r--r--boards/addons/gdisp/board_HX8347D_stm32f4discovery.h5
-rw-r--r--boards/addons/gdisp/board_ILI9320_olimex_pic32mx_lcd.h7
-rw-r--r--boards/addons/gdisp/board_ILI9325_hy_stm32_100p.h7
-rw-r--r--boards/addons/gdisp/board_ILI9481_firebullstm32f103.h8
-rw-r--r--boards/addons/gdisp/board_S6D1121_olimex_e407.h7
-rw-r--r--boards/addons/gdisp/board_SSD1289_stm32f4discovery.h5
-rw-r--r--boards/addons/gdisp/board_SSD1306_i2c.h5
-rw-r--r--boards/addons/gdisp/board_SSD1306_spi.h5
-rw-r--r--boards/addons/gdisp/board_SSD1963_fsmc.h5
-rw-r--r--boards/addons/gdisp/board_SSD1963_gpio.h5
-rw-r--r--boards/addons/ginput/touch/ADS7843/ginput_lld_mouse_board_olimex_stm32_e407.h9
-rw-r--r--boards/addons/ginput/touch/ADS7843/ginput_lld_mouse_board_st_stm32f4_discovery.h8
-rw-r--r--boards/addons/ginput/touch/MCU/ginput_lld_mouse_board_olimex_pic32mx_lcd.h8
14 files changed, 63 insertions, 27 deletions
diff --git a/boards/addons/gdisp/board_ED060SC4_example.h b/boards/addons/gdisp/board_ED060SC4_example.h
index cb5a92b8..008e85d4 100644
--- a/boards/addons/gdisp/board_ED060SC4_example.h
+++ b/boards/addons/gdisp/board_ED060SC4_example.h
@@ -5,8 +5,10 @@
* http://ugfx.org/license.html
*/
-/* Board interface definitions for ED060SC4 PrimeView E-ink panel.
- *
+/**
+ * @file boards/addons/gdisp/board_ED060SC4_example.h
+ * @brief GDISP Graphic Driver subsystem board interface for the ED060SC4 display.
+ *
* This file corresponds to the connections shown in example_schematics.png,
* and is designed to interface with ChibiOS/RT.
*
diff --git a/boards/addons/gdisp/board_HX8347D_stm32f4discovery.h b/boards/addons/gdisp/board_HX8347D_stm32f4discovery.h
index f486841b..341f4366 100644
--- a/boards/addons/gdisp/board_HX8347D_stm32f4discovery.h
+++ b/boards/addons/gdisp/board_HX8347D_stm32f4discovery.h
@@ -6,8 +6,11 @@
*/
/**
- * @file drivers/gdisp/HX8347D/board_HX8347D_stm32f4discovery.h
+ * @file boards/addons/gdisp/board_HX8347D_stm32f4discovery.h
* @brief GDISP Graphic Driver subsystem board SPI interface for the HX8347D display.
+ *
+ * @note This file contains a mix of hardware specific and operating system specific
+ * code. You will need to change it for your CPU and/or operating system.
*/
#ifndef _GDISP_LLD_BOARD_H
diff --git a/boards/addons/gdisp/board_ILI9320_olimex_pic32mx_lcd.h b/boards/addons/gdisp/board_ILI9320_olimex_pic32mx_lcd.h
index 5315127b..0e399f1f 100644
--- a/boards/addons/gdisp/board_ILI9320_olimex_pic32mx_lcd.h
+++ b/boards/addons/gdisp/board_ILI9320_olimex_pic32mx_lcd.h
@@ -6,8 +6,11 @@
*/
/**
- * @file drivers/gdisp/ILI9320/board_ILI9320_olimex_pic32mx_lcd.h
- * @brief GDISP Graphic Driver subsystem board interface for the ILI9325 display.
+ * @file boards/addons/gdisp/board_ILI9320_olimex_pic32mx_lcd.h
+ * @brief GDISP Graphic Driver subsystem board SPI interface for the ILI9325 display.
+ *
+ * @note This file contains a mix of hardware specific and operating system specific
+ * code. You will need to change it for your CPU and/or operating system.
*/
#ifndef GDISP_LLD_BOARD_H
diff --git a/boards/addons/gdisp/board_ILI9325_hy_stm32_100p.h b/boards/addons/gdisp/board_ILI9325_hy_stm32_100p.h
index 60508c1a..87c4530d 100644
--- a/boards/addons/gdisp/board_ILI9325_hy_stm32_100p.h
+++ b/boards/addons/gdisp/board_ILI9325_hy_stm32_100p.h
@@ -19,8 +19,11 @@
/**
- * @file drivers/gdisp/ILI9325/board_ILI9325_hy_stm32_100p.h
- * @brief GDISP Graphic Driver subsystem board interface for the ILI9325 display.
+ * @file boards/addons/gdisp/board_ILI9325_hy_stm32_100p.h
+ * @brief GDISP Graphic Driver subsystem board SPI interface for the ILI9325 display.
+ *
+ * @note This file contains a mix of hardware specific and operating system specific
+ * code. You will need to change it for your CPU and/or operating system.
*/
#ifndef GDISP_LLD_BOARD_H
diff --git a/boards/addons/gdisp/board_ILI9481_firebullstm32f103.h b/boards/addons/gdisp/board_ILI9481_firebullstm32f103.h
index 17bc554d..08cbaf3d 100644
--- a/boards/addons/gdisp/board_ILI9481_firebullstm32f103.h
+++ b/boards/addons/gdisp/board_ILI9481_firebullstm32f103.h
@@ -6,9 +6,11 @@
*/
/**
- * @file drivers/gdisp/ILI9481/board_ILI9481_firebullstm32f103.h
- * @brief GDISP Graphics Driver subsystem low level driver source for
- * the ILI9481 and compatible HVGA display
+ * @file boards/addons/gdisp/board_ILI9481_firebullstm32f103.h
+ * @brief GDISP Graphics Driver subsystem low level driver source for the ILI9481 and compatible HVGA display
+ *
+ * @note This file contains a mix of hardware specific and operating system specific
+ * code. You will need to change it for your CPU and/or operating system.
*/
#ifndef _GDISP_LLD_BOARD_H
diff --git a/boards/addons/gdisp/board_S6D1121_olimex_e407.h b/boards/addons/gdisp/board_S6D1121_olimex_e407.h
index e0bb8e26..1e2b53f7 100644
--- a/boards/addons/gdisp/board_S6D1121_olimex_e407.h
+++ b/boards/addons/gdisp/board_S6D1121_olimex_e407.h
@@ -6,8 +6,11 @@
*/
/**
- * @file drivers/gdisp/S6D1121/board_S6D1121_olimex_e407.h
- * @brief GDISP Graphic Driver subsystem board interface for the S6D1121 display
+ * @file boards/addons/gdisp/board_S6D1121_olimex_e407.h
+ * @brief GDISP Graphic Driver subsystem board interface for the S6D1121 display.
+ *
+ * @note This file contains a mix of hardware specific and operating system specific
+ * code. You will need to change it for your CPU and/or operating system.
*/
#ifndef _GDISP_LLD_BOARD_H
diff --git a/boards/addons/gdisp/board_SSD1289_stm32f4discovery.h b/boards/addons/gdisp/board_SSD1289_stm32f4discovery.h
index 1d86a67e..acbe16c0 100644
--- a/boards/addons/gdisp/board_SSD1289_stm32f4discovery.h
+++ b/boards/addons/gdisp/board_SSD1289_stm32f4discovery.h
@@ -6,8 +6,11 @@
*/
/**
- * @file drivers/gdisp/SSD1289/board_SSD1289_stm32f4discovery.h
+ * @file boards/addons/gdisp/board_SSD1289_stm32f4discovery.h
* @brief GDISP Graphic Driver subsystem board interface for the SSD1289 display.
+ *
+ * @note This file contains a mix of hardware specific and operating system specific
+ * code. You will need to change it for your CPU and/or operating system.
*/
#ifndef _GDISP_LLD_BOARD_H
diff --git a/boards/addons/gdisp/board_SSD1306_i2c.h b/boards/addons/gdisp/board_SSD1306_i2c.h
index 3f755f26..e147a918 100644
--- a/boards/addons/gdisp/board_SSD1306_i2c.h
+++ b/boards/addons/gdisp/board_SSD1306_i2c.h
@@ -6,8 +6,11 @@
*/
/**
- * @file drivers/gdisp/SSD1306/board_SSD1306_i2c.h
+ * @file boards/addons/gdisp/board_SSD1306_i2c.h
* @brief GDISP Graphic Driver subsystem board interface for the SSD1306 display.
+ *
+ * @note This file contains a mix of hardware specific and operating system specific
+ * code. You will need to change it for your CPU and/or operating system.
*/
#ifndef _GDISP_LLD_BOARD_H
diff --git a/boards/addons/gdisp/board_SSD1306_spi.h b/boards/addons/gdisp/board_SSD1306_spi.h
index b476fec0..56e1abae 100644
--- a/boards/addons/gdisp/board_SSD1306_spi.h
+++ b/boards/addons/gdisp/board_SSD1306_spi.h
@@ -6,8 +6,11 @@
*/
/**
- * @file drivers/gdisp/SSD1306/board_SSD1306_spi.h
+ * @file boards/addons/gdisp/board_SSD1306_spi.h
* @brief GDISP Graphic Driver subsystem board interface for the SSD1306 display.
+ *
+ * @note This file contains a mix of hardware specific and operating system specific
+ * code. You will need to change it for your CPU and/or operating system.
*/
#ifndef _GDISP_LLD_BOARD_H
diff --git a/boards/addons/gdisp/board_SSD1963_fsmc.h b/boards/addons/gdisp/board_SSD1963_fsmc.h
index 6c7119a4..55fabacc 100644
--- a/boards/addons/gdisp/board_SSD1963_fsmc.h
+++ b/boards/addons/gdisp/board_SSD1963_fsmc.h
@@ -6,8 +6,11 @@
*/
/**
- * @file drivers/gdisp/SSD1963/board_SSD1963_fsmc.h
+ * @file boards/addons/gdisp/board_SSD1963_fsmc.h
* @brief GDISP Graphic Driver subsystem board interface for the SSD1963 display.
+ *
+ * @note This file contains a mix of hardware specific and operating system specific
+ * code. You will need to change it for your CPU and/or operating system.
*/
#ifndef _GDISP_LLD_BOARD_H
diff --git a/boards/addons/gdisp/board_SSD1963_gpio.h b/boards/addons/gdisp/board_SSD1963_gpio.h
index 0b9c0135..cc7d1579 100644
--- a/boards/addons/gdisp/board_SSD1963_gpio.h
+++ b/boards/addons/gdisp/board_SSD1963_gpio.h
@@ -6,8 +6,11 @@
*/
/**
- * @file drivers/gdisp/SSD1963/board_SSD1963_gpio.h
+ * @file boards/addons/gdisp/board_SSD1963_gpio.h
* @brief GDISP Graphic Driver subsystem board interface for the SSD1963 display.
+ *
+ * @note This file contains a mix of hardware specific and operating system specific
+ * code. You will need to change it for your CPU and/or operating system.
*/
#ifndef _GDISP_LLD_BOARD_H
diff --git a/boards/addons/ginput/touch/ADS7843/ginput_lld_mouse_board_olimex_stm32_e407.h b/boards/addons/ginput/touch/ADS7843/ginput_lld_mouse_board_olimex_stm32_e407.h
index 73507f10..f17d6e8e 100644
--- a/boards/addons/ginput/touch/ADS7843/ginput_lld_mouse_board_olimex_stm32_e407.h
+++ b/boards/addons/ginput/touch/ADS7843/ginput_lld_mouse_board_olimex_stm32_e407.h
@@ -6,12 +6,11 @@
*/
/**
- * @file drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_olimex_stm32_e407.h
+ * @file boards/addons/ginput/touch/ADS7843/ginput_lld_mouse_board_olimex_stm32_e407.h
* @brief GINPUT Touch low level driver source for the ADS7843 on an Olimex STM32E407.
*
- * @defgroup Mouse Mouse
- * @ingroup GINPUT
- * @{
+ * @note This file contains a mix of hardware specific and operating system specific
+ * code. You will need to change it for your CPU and/or operating system.
*/
#ifndef _GINPUT_LLD_MOUSE_BOARD_H
@@ -87,4 +86,4 @@ static inline uint16_t read_value(uint16_t port) {
}
#endif /* _GINPUT_LLD_MOUSE_BOARD_H */
-/** @} */
+
diff --git a/boards/addons/ginput/touch/ADS7843/ginput_lld_mouse_board_st_stm32f4_discovery.h b/boards/addons/ginput/touch/ADS7843/ginput_lld_mouse_board_st_stm32f4_discovery.h
index d4923c29..6c3e2124 100644
--- a/boards/addons/ginput/touch/ADS7843/ginput_lld_mouse_board_st_stm32f4_discovery.h
+++ b/boards/addons/ginput/touch/ADS7843/ginput_lld_mouse_board_st_stm32f4_discovery.h
@@ -5,6 +5,14 @@
* http://ugfx.org/license.html
*/
+/**
+ * @file boards/addons/ginput/touch/ADS7843/ginput_lld_mouse_board_st_stm32f4_discovery.h
+ * @brief GINPUT Touch low level driver source for the ADS7843 on an st_stm32f4_discovery.
+ *
+ * @note This file contains a mix of hardware specific and operating system specific
+ * code. You will need to change it for your CPU and/or operating system.
+ */
+
#ifndef _GINPUT_LLD_MOUSE_BOARD_H
#define _GINPUT_LLD_MOUSE_BOARD_H
diff --git a/boards/addons/ginput/touch/MCU/ginput_lld_mouse_board_olimex_pic32mx_lcd.h b/boards/addons/ginput/touch/MCU/ginput_lld_mouse_board_olimex_pic32mx_lcd.h
index a7435c95..87e2a93c 100644
--- a/boards/addons/ginput/touch/MCU/ginput_lld_mouse_board_olimex_pic32mx_lcd.h
+++ b/boards/addons/ginput/touch/MCU/ginput_lld_mouse_board_olimex_pic32mx_lcd.h
@@ -6,13 +6,11 @@
*/
/**
- * @file drivers/ginput/touch/MCU/ginput_lld_mouse_board_olimex_stm32_lcd.h
+ * @file boards/addons/ginput/touch/MCU/ginput_lld_mouse_board_olimex_stm32_lcd.h
* @brief GINPUT Touch low level driver source for the MCU on the example board.
*
- * @defgroup Mouse Mouse
- * @ingroup GINPUT
- *
- * @{
+ * @note This file contains a mix of hardware specific and operating system specific
+ * code. You will need to change it for your CPU and/or operating system.
*/
#ifndef _GINPUT_LLD_MOUSE_BOARD_H