diff --git a/docs/src/graph.dox b/docs/src/ginput.dox similarity index 75% rename from docs/src/graph.dox rename to docs/src/ginput.dox index b9ca456d..73fbe157 100644 --- a/docs/src/graph.dox +++ b/docs/src/ginput.dox @@ -19,10 +19,9 @@ */ /** - * @addtogroup GRAPH - * @details The GRAPH module provides high level HAL independed routines - * to draw graphs on a graphic display. The graph is highly - * configurable. There are many options to controll the look - * of the graph. + * @addtogroup GINPUT + * + * @details GINPUT provides an easy and common interface to use different + * input devices such as touchscreens and mices. */ diff --git a/drivers/ginput/toggle/Pal/ginput_lld_toggle.c b/drivers/ginput/toggle/Pal/ginput_lld_toggle.c index a3a360d8..947f77e0 100644 --- a/drivers/ginput/toggle/Pal/ginput_lld_toggle.c +++ b/drivers/ginput/toggle/Pal/ginput_lld_toggle.c @@ -22,7 +22,8 @@ * @file drivers/ginput/toggle/Pal/ginput_lld_toggle.c * @brief GINPUT Toggle low level driver source for the ChibiOS PAL hardware. * - * @addtogroup GINPUT_TOGGLE + * @defgroup Toggle + * @ingroup GINPUT * @{ */ diff --git a/drivers/ginput/toggle/Pal/ginput_lld_toggle_board_example.h b/drivers/ginput/toggle/Pal/ginput_lld_toggle_board_example.h index a96178b0..a8c7ad1c 100644 --- a/drivers/ginput/toggle/Pal/ginput_lld_toggle_board_example.h +++ b/drivers/ginput/toggle/Pal/ginput_lld_toggle_board_example.h @@ -22,7 +22,8 @@ * @file drivers/ginput/toggle/Pal/ginput_lld_toggle_board_example.h * @brief GINPUT Toggle low level driver source for the ChibiOS PAL hardware on the example board. * - * @addtogroup GINPUT_TOGGLE + * @defgroup Toggle + * @ingroup GINPUT * @{ */ diff --git a/drivers/ginput/toggle/Pal/ginput_lld_toggle_board_olimexsam7ex256.h b/drivers/ginput/toggle/Pal/ginput_lld_toggle_board_olimexsam7ex256.h index 3ba5858d..fb607028 100644 --- a/drivers/ginput/toggle/Pal/ginput_lld_toggle_board_olimexsam7ex256.h +++ b/drivers/ginput/toggle/Pal/ginput_lld_toggle_board_olimexsam7ex256.h @@ -22,7 +22,8 @@ * @file drivers/ginput/toggle/Pal/ginput_lld_toggle_board_olimexsam7ex256.h * @brief GINPUT Toggle low level driver source for the ChibiOS PAL hardware on the Olimex SAM7EX256 board. * - * @addtogroup GINPUT_TOGGLE + * @defgroup Toggle + * @ingroup GINPUT * @{ */ diff --git a/drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h b/drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h index 774be200..45f992d5 100644 --- a/drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h +++ b/drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h @@ -22,7 +22,8 @@ * @file drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h * @brief GINPUT Toggle Driver configuration header. * - * @addtogroup GDISP + * @defgroup Toggle + * @ingroup GINPUT * @{ */ diff --git a/drivers/ginput/touch/ADS7843/ginput_lld_mouse.c b/drivers/ginput/touch/ADS7843/ginput_lld_mouse.c index 71f7653b..604a91fb 100644 --- a/drivers/ginput/touch/ADS7843/ginput_lld_mouse.c +++ b/drivers/ginput/touch/ADS7843/ginput_lld_mouse.c @@ -22,7 +22,8 @@ * @file drivers/ginput/touch/ADS7843/ginput_lld_mouse.c * @brief GINPUT Touch low level driver source for the ADS7843. * - * @addtogroup GINPUT_MOUSE + * @defgroup Mouse + * @ingroup GINPUT * @{ */ diff --git a/drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_example.h b/drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_example.h index 9fbbaa56..754b4667 100644 --- a/drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_example.h +++ b/drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_example.h @@ -22,7 +22,8 @@ * @file drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_example.h * @brief GINPUT Touch low level driver source for the ADS7843 on the example board. * - * @addtogroup GINPUT_MOUSE + * @defgroup Mouse + * @ingroup GINPUT * @{ */ diff --git a/drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_firebull_stm32f103.h b/drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_firebull_stm32f103.h index 9df301a4..cc5105bd 100644 --- a/drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_firebull_stm32f103.h +++ b/drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_firebull_stm32f103.h @@ -22,7 +22,8 @@ * @file drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_example.h * @brief GINPUT Touch low level driver source for the ADS7843 on the example board. * - * @addtogroup GINPUT_MOUSE + * @defgroup Mouse + * @ingroup GINPUT * @{ */ diff --git a/drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_olimex_stm32_e407.h b/drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_olimex_stm32_e407.h index 343c5bf5..9a1bb781 100644 --- a/drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_olimex_stm32_e407.h +++ b/drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_olimex_stm32_e407.h @@ -22,7 +22,8 @@ * @file drivers/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. * - * @addtogroup GINPUT_MOUSE + * @defgroup Mouse + * @ingroup GINPUT * @{ */ diff --git a/drivers/ginput/touch/ADS7843/ginput_lld_mouse_config.h b/drivers/ginput/touch/ADS7843/ginput_lld_mouse_config.h index 688f3486..7f77112c 100644 --- a/drivers/ginput/touch/ADS7843/ginput_lld_mouse_config.h +++ b/drivers/ginput/touch/ADS7843/ginput_lld_mouse_config.h @@ -21,7 +21,9 @@ * @file drivers/ginput/touch/ADS7843/ginput_lld_mouse_config.h * @brief GINPUT LLD header file for mouse/touch driver. * - * @addtogroup GINPUT_LLD_MOUSE + * @defgroup Mouse + * @ingroup GINPUT + * * @{ */ #ifndef _LLD_GINPUT_MOUSE_CONFIG_H diff --git a/drivers/ginput/touch/MCU/ginput_lld_mouse.c b/drivers/ginput/touch/MCU/ginput_lld_mouse.c index 61b512cd..376767c7 100644 --- a/drivers/ginput/touch/MCU/ginput_lld_mouse.c +++ b/drivers/ginput/touch/MCU/ginput_lld_mouse.c @@ -22,7 +22,9 @@ * @file drivers/ginput/touch/MCU/ginput_lld_mouse.c * @brief GINPUT Touch low level driver source for the MCU. * - * @addtogroup GINPUT_MOUSE + * @defgroup Mouse + * @ingroup GINPUT + * * @{ */ diff --git a/drivers/ginput/touch/MCU/ginput_lld_mouse_board_example.h b/drivers/ginput/touch/MCU/ginput_lld_mouse_board_example.h index 5a09b274..ac195735 100644 --- a/drivers/ginput/touch/MCU/ginput_lld_mouse_board_example.h +++ b/drivers/ginput/touch/MCU/ginput_lld_mouse_board_example.h @@ -22,7 +22,9 @@ * @file drivers/ginput/touch/MCU/ginput_lld_mouse_board_example.h * @brief GINPUT Touch low level driver source for the MCU on the example board. * - * @addtogroup GINPUT_MOUSE + * @defgroup Mouse + * @ingroup GINPUT + * * @{ */ diff --git a/drivers/ginput/touch/MCU/ginput_lld_mouse_board_olimex_stm32_lcd.h b/drivers/ginput/touch/MCU/ginput_lld_mouse_board_olimex_stm32_lcd.h index 2fa6fe44..d1940d5b 100644 --- a/drivers/ginput/touch/MCU/ginput_lld_mouse_board_olimex_stm32_lcd.h +++ b/drivers/ginput/touch/MCU/ginput_lld_mouse_board_olimex_stm32_lcd.h @@ -22,7 +22,9 @@ * @file drivers/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. * - * @addtogroup GINPUT_MOUSE + * @defgroup Mouse + * @ingroup GINPUT + * * @{ */ diff --git a/drivers/ginput/touch/MCU/ginput_lld_mouse_config.h b/drivers/ginput/touch/MCU/ginput_lld_mouse_config.h index b1d754f0..07106e05 100644 --- a/drivers/ginput/touch/MCU/ginput_lld_mouse_config.h +++ b/drivers/ginput/touch/MCU/ginput_lld_mouse_config.h @@ -21,9 +21,12 @@ * @file drivers/ginput/touch/MCU/ginput_lld_mouse_config.h * @brief GINPUT LLD header file for touch driver. * - * @addtogroup GINPUT_LLD_MOUSE + * @defgroup Mouse + * @ingroup GINPUT + * * @{ */ + #ifndef _LLD_GINPUT_MOUSE_CONFIG_H #define _LLD_GINPUT_MOUSE_CONFIG_H diff --git a/drivers/ginput/touch/XPT2046/ginput_lld_mouse.c b/drivers/ginput/touch/XPT2046/ginput_lld_mouse.c index 9fb35c9b..57af5469 100644 --- a/drivers/ginput/touch/XPT2046/ginput_lld_mouse.c +++ b/drivers/ginput/touch/XPT2046/ginput_lld_mouse.c @@ -22,7 +22,9 @@ * @file drivers/ginput/touch/XPT2046/ginput_lld_mouse.c * @brief GINPUT Touch low level driver source for the XPT2046. * - * @addtogroup GINPUT_MOUSE + * @defgroup Mouse + * @ingroup GINPUT + * * @{ */ diff --git a/drivers/ginput/touch/XPT2046/ginput_lld_mouse_board_example.h b/drivers/ginput/touch/XPT2046/ginput_lld_mouse_board_example.h index 8c11c96e..aa32b8af 100644 --- a/drivers/ginput/touch/XPT2046/ginput_lld_mouse_board_example.h +++ b/drivers/ginput/touch/XPT2046/ginput_lld_mouse_board_example.h @@ -22,7 +22,9 @@ * @file drivers/ginput/touch/XPT2046/ginput_lld_mouse_board_example.h * @brief GINPUT Touch low level driver source for the XPT2046 on the example board. * - * @addtogroup GINPUT_MOUSE + * @defgroup Mouse + * @ingroup GINPUT + * * @{ */ diff --git a/drivers/ginput/touch/XPT2046/ginput_lld_mouse_board_firebull_stm32f103.h b/drivers/ginput/touch/XPT2046/ginput_lld_mouse_board_firebull_stm32f103.h index 893ec865..a6f772eb 100644 --- a/drivers/ginput/touch/XPT2046/ginput_lld_mouse_board_firebull_stm32f103.h +++ b/drivers/ginput/touch/XPT2046/ginput_lld_mouse_board_firebull_stm32f103.h @@ -22,7 +22,9 @@ * @file drivers/ginput/touch/XPT2046/ginput_lld_mouse_board_example.h * @brief GINPUT Touch low level driver source for the XPT2046 on the example board. * - * @addtogroup GINPUT_MOUSE + * @defgroup Mouse + * @ingroup GINPUT + * * @{ */ diff --git a/drivers/ginput/touch/XPT2046/ginput_lld_mouse_config.h b/drivers/ginput/touch/XPT2046/ginput_lld_mouse_config.h index 880c6a60..77dba401 100644 --- a/drivers/ginput/touch/XPT2046/ginput_lld_mouse_config.h +++ b/drivers/ginput/touch/XPT2046/ginput_lld_mouse_config.h @@ -21,7 +21,9 @@ * @file drivers/ginput/touch/XPT2046/ginput_lld_mouse_config.h * @brief GINPUT LLD header file for mouse/touch driver. * - * @addtogroup GINPUT_LLD_MOUSE + * @defgroup Mouse + * @ingroup GINPUT + * * @{ */ #ifndef _LLD_GINPUT_MOUSE_CONFIG_H diff --git a/drivers/multiple/Win32/ginput_lld_mouse_config.h b/drivers/multiple/Win32/ginput_lld_mouse_config.h index 2e740af8..e3fe5d6e 100644 --- a/drivers/multiple/Win32/ginput_lld_mouse_config.h +++ b/drivers/multiple/Win32/ginput_lld_mouse_config.h @@ -21,9 +21,12 @@ * @file drivers/multiple/Win32/ginput_lld_mouse_config.h * @brief GINPUT LLD header file for mouse/touch driver. * - * @addtogroup GINPUT_LLD_MOUSE + * @defgroup Mouse + * @ingroup GINPUT + * * @{ */ + #ifndef _LLD_GINPUT_MOUSE_CONFIG_H #define _LLD_GINPUT_MOUSE_CONFIG_H diff --git a/drivers/multiple/Win32/ginput_lld_toggle_config.h b/drivers/multiple/Win32/ginput_lld_toggle_config.h index 58e47260..477a531a 100644 --- a/drivers/multiple/Win32/ginput_lld_toggle_config.h +++ b/drivers/multiple/Win32/ginput_lld_toggle_config.h @@ -22,7 +22,9 @@ * @file drivers/multiple/Win32/ginput_lld_toggle_config.h * @brief GINPUT Toggle Driver configuration header. * - * @addtogroup GINPUT_TOGGLE + * @defgroup Toggle + * @ingroup GINPUT + * * @{ */ diff --git a/include/ginput/dial.h b/include/ginput/dial.h index 1021b298..80855b54 100644 --- a/include/ginput/dial.h +++ b/include/ginput/dial.h @@ -21,7 +21,8 @@ * @file include/ginput/dial.h * @brief GINPUT GFX User Input subsystem header file. * - * @addtogroup GINPUT + * @defgroup Dial + * @ingroup GINPUT * @{ */ #ifndef _GINPUT_DIAL_H diff --git a/include/ginput/keyboard.h b/include/ginput/keyboard.h index 086d7f71..756b78e4 100644 --- a/include/ginput/keyboard.h +++ b/include/ginput/keyboard.h @@ -21,7 +21,8 @@ * @file include/ginput/keyboard.h * @brief GINPUT GFX User Input subsystem header file. * - * @addtogroup GINPUT + * @defgroup Keyboard + * @ingroup GINPUT * @{ */ #ifndef _GINPUT_KEYBOARD_H diff --git a/include/ginput/lld/mouse.h b/include/ginput/lld/mouse.h index 09a0fb6a..1b956c78 100644 --- a/include/ginput/lld/mouse.h +++ b/include/ginput/lld/mouse.h @@ -21,7 +21,8 @@ * @file include/ginput/lld/mouse.h * @brief GINPUT LLD header file for mouse/touch drivers. * - * @addtogroup GINPUT_MOUSE + * @defgroup Mouse + * @ingroup GINPUT * @{ */ #ifndef _LLD_GINPUT_MOUSE_H diff --git a/include/ginput/lld/toggle.h b/include/ginput/lld/toggle.h index 2b437ed9..77f6b346 100644 --- a/include/ginput/lld/toggle.h +++ b/include/ginput/lld/toggle.h @@ -21,7 +21,8 @@ * @file include/ginput/lld/toggle.h * @brief GINPUT header file for toggle drivers. * - * @addtogroup GINPUT_TOGGLE + * @defgroup Toggle + * @ingroup GINPUT * @{ */ #ifndef _LLD_GINPUT_TOGGLE_H diff --git a/include/ginput/mouse.h b/include/ginput/mouse.h index 09bfa050..ef268be4 100644 --- a/include/ginput/mouse.h +++ b/include/ginput/mouse.h @@ -21,7 +21,8 @@ * @file include/ginput/mouse.h * @brief GINPUT GFX User Input subsystem header file for mouse and touch. * - * @addtogroup GINPUT + * @defgroup Mouse + * @ingroup GINPUT * @{ */ #ifndef _GINPUT_MOUSE_H diff --git a/include/ginput/toggle.h b/include/ginput/toggle.h index eaf5bafe..889b9596 100644 --- a/include/ginput/toggle.h +++ b/include/ginput/toggle.h @@ -21,7 +21,8 @@ * @file include/ginput/toggle.h * @brief GINPUT GFX User Input subsystem header file. * - * @addtogroup GINPUT + * @defgroup Toggle + * @ingroup GINPUT * @{ */ #ifndef _GINPUT_TOGGLE_H diff --git a/include/gwin/button.h b/include/gwin/button.h index 6fc564c7..6d6e27db 100644 --- a/include/gwin/button.h +++ b/include/gwin/button.h @@ -21,9 +21,12 @@ * @file include/gwin/button.h * @brief GWIN Graphic window subsystem header file. * - * @addtogroup GWIN + * @defgroup Button + * @ingroup GWIN + * * @{ */ + #ifndef _GWIN_BUTTON_H #define _GWIN_BUTTON_H diff --git a/include/gwin/console.h b/include/gwin/console.h index 4e78d747..fba27584 100644 --- a/include/gwin/console.h +++ b/include/gwin/console.h @@ -21,9 +21,12 @@ * @file include/gwin/console.h * @brief GWIN Graphic window subsystem header file. * - * @addtogroup GWIN + * @defgroup Console + * @ingroup GWIN + * * @{ */ + #ifndef _GWIN_CONSOLE_H #define _GWIN_CONSOLE_H diff --git a/include/gwin/graph.h b/include/gwin/graph.h index 58c5fdee..a8a84a1d 100644 --- a/include/gwin/graph.h +++ b/include/gwin/graph.h @@ -22,7 +22,9 @@ * @file include/gwin/graph.h * @brief GWIN GRAPH module header file. * - * @addtogroup GWIN_GRAPH + * @defgroup Graph + * @ingroup GWIN + * * @{ */ diff --git a/src/ginput/dial.c b/src/ginput/dial.c index 233daa08..756861f8 100644 --- a/src/ginput/dial.c +++ b/src/ginput/dial.c @@ -22,7 +22,8 @@ * @file src/ginput/dial.c * @brief GINPUT dial code. * - * @addtogroup GINPUT + * @defgroup Dial + * @ingroup GINPUT * @{ */ #include "ch.h" diff --git a/src/ginput/keyboard.c b/src/ginput/keyboard.c index bd443e77..c2d84e9a 100644 --- a/src/ginput/keyboard.c +++ b/src/ginput/keyboard.c @@ -22,7 +22,8 @@ * @file src/ginput/keyboard.c * @brief GINPUT keyboard code. * - * @addtogroup GINPUT + * @defgroup Keyboard + * @intogroup GINPUT * @{ */ #include "ch.h" diff --git a/src/ginput/mouse.c b/src/ginput/mouse.c index f11e2c82..1b2fe897 100644 --- a/src/ginput/mouse.c +++ b/src/ginput/mouse.c @@ -22,7 +22,8 @@ * @file src/ginput/mouse.c * @brief GINPUT mouse/touch code. * - * @addtogroup GINPUT_MOUSE + * @defgroup Mouse + * @ingroup GINPUT * @{ */ #include "ch.h" diff --git a/src/ginput/toggle.c b/src/ginput/toggle.c index 3b2e98bf..447605a1 100644 --- a/src/ginput/toggle.c +++ b/src/ginput/toggle.c @@ -22,7 +22,8 @@ * @file src/ginput/toggle.c * @brief GINPUT toggle code. * - * @addtogroup GINPUT_TOGGLE + * @defgroup Toggle + * @ingroup GINPUT * @{ */ #include "ch.h" diff --git a/src/gwin/button.c b/src/gwin/button.c index 0c2c1ab3..3c1e4799 100644 --- a/src/gwin/button.c +++ b/src/gwin/button.c @@ -17,14 +17,16 @@ You should have received a copy of the GNU General Public License along with this program. If not, see . */ - /** * @file src/gwin/button.c * @brief GWIN sub-system button code. * - * @addtogroup GWIN_BUTTON + * @defgroup Button + * @ingroup GWIN + * * @{ */ + #include "ch.h" #include "hal.h" #include "gfx.h" diff --git a/src/gwin/console.c b/src/gwin/console.c index 7854b658..10fa4257 100644 --- a/src/gwin/console.c +++ b/src/gwin/console.c @@ -17,14 +17,16 @@ You should have received a copy of the GNU General Public License along with this program. If not, see . */ - /** * @file src/gwin/console.c * @brief GWIN sub-system console code. * - * @addtogroup GWIN_CONSOLE + * @defgroup Console + * @ingroup GWIN + * * @{ */ + #include "ch.h" #include "hal.h" #include "gfx.h" diff --git a/src/gwin/graph.c b/src/gwin/graph.c index cc457d7d..bc2af1e9 100644 --- a/src/gwin/graph.c +++ b/src/gwin/graph.c @@ -17,14 +17,16 @@ You should have received a copy of the GNU General Public License along with this program. If not, see . */ - /** * @file src/gwin/button.c * @brief GWIN sub-system button code. * - * @addtogroup GWIN_BUTTON + * @defgroup Button + * @ingroup GWIN + * * @{ */ + #include "ch.h" #include "hal.h" #include "gfx.h"