From 16f86ed2e6980fd0ddfa4cedb6bdaf51881f0e3c Mon Sep 17 00:00:00 2001 From: inmarket Date: Fri, 28 Mar 2014 08:52:30 +1000 Subject: [PATCH] Update incorrect file headers on demo board files --- boards/addons/gdisp/board_ED060SC4_example.h | 6 ++++-- boards/addons/gdisp/board_HX8347D_stm32f4discovery.h | 5 ++++- boards/addons/gdisp/board_ILI9320_olimex_pic32mx_lcd.h | 7 +++++-- boards/addons/gdisp/board_ILI9325_hy_stm32_100p.h | 7 +++++-- boards/addons/gdisp/board_ILI9481_firebullstm32f103.h | 8 +++++--- boards/addons/gdisp/board_S6D1121_olimex_e407.h | 7 +++++-- boards/addons/gdisp/board_SSD1289_stm32f4discovery.h | 5 ++++- boards/addons/gdisp/board_SSD1306_i2c.h | 5 ++++- boards/addons/gdisp/board_SSD1306_spi.h | 5 ++++- boards/addons/gdisp/board_SSD1963_fsmc.h | 5 ++++- boards/addons/gdisp/board_SSD1963_gpio.h | 5 ++++- .../ADS7843/ginput_lld_mouse_board_olimex_stm32_e407.h | 9 ++++----- .../ginput_lld_mouse_board_st_stm32f4_discovery.h | 8 ++++++++ .../MCU/ginput_lld_mouse_board_olimex_pic32mx_lcd.h | 8 +++----- 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