From a520a32209cc6057b985bde5d0ad21a8f4186bf2 Mon Sep 17 00:00:00 2001 From: Joel Bodenmann Date: Tue, 18 Dec 2012 23:15:47 +0100 Subject: [PATCH] more doxygen --- docs/src/gdisp.dox | 26 -------------- docs/src/ginput.dox | 27 -------------- docs/src/gtimer.dox | 36 ------------------- docs/src/gwin.dox | 29 --------------- drivers/ginput/toggle/Pal/ginput_lld_toggle.c | 2 +- .../Pal/ginput_lld_toggle_board_example.h | 2 +- .../ginput_lld_toggle_board_olimexsam7ex256.h | 2 +- .../toggle/Pal/ginput_lld_toggle_config.h | 2 +- .../ginput/touch/ADS7843/ginput_lld_mouse.c | 2 +- .../ADS7843/ginput_lld_mouse_board_example.h | 2 +- ...input_lld_mouse_board_firebull_stm32f103.h | 2 +- ...ginput_lld_mouse_board_olimex_stm32_e407.h | 2 +- .../touch/ADS7843/ginput_lld_mouse_config.h | 5 +-- drivers/ginput/touch/MCU/ginput_lld_mouse.c | 2 +- .../MCU/ginput_lld_mouse_board_example.h | 2 +- .../ginput_lld_mouse_board_olimex_stm32_lcd.h | 2 +- .../touch/MCU/ginput_lld_mouse_config.h | 2 +- .../multiple/Win32/ginput_lld_mouse_config.h | 3 +- .../multiple/Win32/ginput_lld_toggle_config.h | 3 +- include/gdisp/gdisp.h | 5 +++ include/gevent/gevent.h | 6 ++++ include/ginput/dial.h | 2 +- include/ginput/ginput.h | 6 ++++ include/ginput/keyboard.h | 3 +- include/ginput/lld/mouse.h | 4 ++- include/ginput/lld/toggle.h | 4 ++- include/ginput/mouse.h | 3 +- include/ginput/toggle.h | 2 +- include/gtimer/gtimer.h | 12 +++++++ include/gwin/button.h | 2 +- include/gwin/console.h | 2 +- include/gwin/graph.h | 2 +- include/gwin/gwin.h | 2 +- src/ginput/dial.c | 2 +- src/ginput/keyboard.c | 6 ++-- src/ginput/mouse.c | 2 +- src/ginput/toggle.c | 2 +- src/gwin/button.c | 2 +- src/gwin/console.c | 2 +- src/gwin/graph.c | 2 +- src/gwin/gwin.c | 2 +- 41 files changed, 75 insertions(+), 153 deletions(-) delete mode 100644 docs/src/gdisp.dox delete mode 100644 docs/src/ginput.dox delete mode 100644 docs/src/gtimer.dox delete mode 100644 docs/src/gwin.dox diff --git a/docs/src/gdisp.dox b/docs/src/gdisp.dox deleted file mode 100644 index 0fdeae34..00000000 --- a/docs/src/gdisp.dox +++ /dev/null @@ -1,26 +0,0 @@ -/* - ChibiOS/GFX - Copyright (C) 2012 - Joel Bodenmann aka Tectu - - This file is part of ChibiOS/GFX. - - ChibiOS/GFX is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. - - ChibiOS/GFX is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . -*/ - -/** - * @addtogroup GDISP - * @details The GDISP module provides high level abstraction to interface - * pixel oriented graphic displays. - */ - diff --git a/docs/src/ginput.dox b/docs/src/ginput.dox deleted file mode 100644 index 73fbe157..00000000 --- a/docs/src/ginput.dox +++ /dev/null @@ -1,27 +0,0 @@ -/* - ChibiOS/GFX - Copyright (C) 2012 - Joel Bodenmann aka Tectu - - This file is part of ChibiOS/GFX. - - ChibiOS/GFX is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. - - ChibiOS/GFX is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . -*/ - -/** - * @addtogroup GINPUT - * - * @details GINPUT provides an easy and common interface to use different - * input devices such as touchscreens and mices. - */ - diff --git a/docs/src/gtimer.dox b/docs/src/gtimer.dox deleted file mode 100644 index 65dca871..00000000 --- a/docs/src/gtimer.dox +++ /dev/null @@ -1,36 +0,0 @@ -/* - ChibiOS/GFX - Copyright (C) 2012 - Joel Bodenmann aka Tectu - - This file is part of ChibiOS/GFX. - - ChibiOS/GFX is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. - - ChibiOS/GFX is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . -*/ - -/** - * @addtogroup GTIMER - * @details The GTIMER module provides high level, simple and hardware - * independend timers. The timers are meant to be used in different - * ChibiOS/GFX modules and are not very accurate. - * - * @details The reason why ChibiOS/GFX has it's own timer abstraction is because - * virtual timers provided by ChibiOS/RT are interrupt context only. - * While great for what they are designed for, they make coding of the input - * drivers much more complex. - * For non-performance critical drivers like these input drivers, it would also - * hog an in-ordinate amount of critical (interrupt locked) system time. - * This contrary to the goals of a real-time operating system. So a user-land - * (thread based) timer mechanism is also required. - */ - diff --git a/docs/src/gwin.dox b/docs/src/gwin.dox deleted file mode 100644 index 7f5b4115..00000000 --- a/docs/src/gwin.dox +++ /dev/null @@ -1,29 +0,0 @@ -/* - ChibiOS/GFX - Copyright (C) 2012 - Joel Bodenmann aka Tectu - - This file is part of ChibiOS/GFX. - - ChibiOS/GFX is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. - - ChibiOS/GFX is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . -*/ - -/** - * @addtogroup GWIN - * @details The GWIN module does not only provides simple window manager, but also - * different widgets such as a console/terminal, buttons and a module - * to draw graphs. - * @details Please note that GWIN is a module ontop of GDISP. Therefore, GDISP - * has to be set up correctly. - */ - diff --git a/drivers/ginput/toggle/Pal/ginput_lld_toggle.c b/drivers/ginput/toggle/Pal/ginput_lld_toggle.c index 947f77e0..e2ecc116 100644 --- a/drivers/ginput/toggle/Pal/ginput_lld_toggle.c +++ b/drivers/ginput/toggle/Pal/ginput_lld_toggle.c @@ -22,7 +22,7 @@ * @file drivers/ginput/toggle/Pal/ginput_lld_toggle.c * @brief GINPUT Toggle low level driver source for the ChibiOS PAL hardware. * - * @defgroup Toggle + * @defgroup Toggle 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 a8c7ad1c..20fc44b5 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,7 @@ * @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. * - * @defgroup Toggle + * @defgroup Toggle 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 fb607028..4f3d6800 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,7 @@ * @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. * - * @defgroup Toggle + * @defgroup Toggle 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 45f992d5..162d35df 100644 --- a/drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h +++ b/drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h @@ -22,7 +22,7 @@ * @file drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h * @brief GINPUT Toggle Driver configuration header. * - * @defgroup Toggle + * @defgroup Toggle Toggle * @ingroup GINPUT * @{ */ diff --git a/drivers/ginput/touch/ADS7843/ginput_lld_mouse.c b/drivers/ginput/touch/ADS7843/ginput_lld_mouse.c index 604a91fb..65065176 100644 --- a/drivers/ginput/touch/ADS7843/ginput_lld_mouse.c +++ b/drivers/ginput/touch/ADS7843/ginput_lld_mouse.c @@ -22,7 +22,7 @@ * @file drivers/ginput/touch/ADS7843/ginput_lld_mouse.c * @brief GINPUT Touch low level driver source for the ADS7843. * - * @defgroup Mouse + * @defgroup Mouse 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 754b4667..9f4f2dc1 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,7 @@ * @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. * - * @defgroup Mouse + * @defgroup Mouse 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 cc5105bd..04d77be6 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,7 @@ * @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. * - * @defgroup Mouse + * @defgroup Mouse 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 9a1bb781..6c5f7e37 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,7 @@ * @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. * - * @defgroup Mouse + * @defgroup Mouse 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 7f77112c..30a13841 100644 --- a/drivers/ginput/touch/ADS7843/ginput_lld_mouse_config.h +++ b/drivers/ginput/touch/ADS7843/ginput_lld_mouse_config.h @@ -21,11 +21,12 @@ * @file drivers/ginput/touch/ADS7843/ginput_lld_mouse_config.h * @brief GINPUT LLD header file for mouse/touch driver. * - * @defgroup Mouse - * @ingroup GINPUT + * @defgroup Mouse Mouse + * @ingroup GINPUT * * @{ */ + #ifndef _LLD_GINPUT_MOUSE_CONFIG_H #define _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 376767c7..b43a14e7 100644 --- a/drivers/ginput/touch/MCU/ginput_lld_mouse.c +++ b/drivers/ginput/touch/MCU/ginput_lld_mouse.c @@ -22,7 +22,7 @@ * @file drivers/ginput/touch/MCU/ginput_lld_mouse.c * @brief GINPUT Touch low level driver source for the MCU. * - * @defgroup Mouse + * @defgroup Mouse 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 ac195735..913d50c9 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,7 @@ * @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. * - * @defgroup Mouse + * @defgroup Mouse 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 d1940d5b..510e8e81 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,7 @@ * @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. * - * @defgroup Mouse + * @defgroup Mouse 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 07106e05..1b5c7b6b 100644 --- a/drivers/ginput/touch/MCU/ginput_lld_mouse_config.h +++ b/drivers/ginput/touch/MCU/ginput_lld_mouse_config.h @@ -21,7 +21,7 @@ * @file drivers/ginput/touch/MCU/ginput_lld_mouse_config.h * @brief GINPUT LLD header file for touch driver. * - * @defgroup Mouse + * @defgroup Mouse Mouse * @ingroup GINPUT * * @{ diff --git a/drivers/multiple/Win32/ginput_lld_mouse_config.h b/drivers/multiple/Win32/ginput_lld_mouse_config.h index e3fe5d6e..ceeedcb9 100644 --- a/drivers/multiple/Win32/ginput_lld_mouse_config.h +++ b/drivers/multiple/Win32/ginput_lld_mouse_config.h @@ -21,7 +21,7 @@ * @file drivers/multiple/Win32/ginput_lld_mouse_config.h * @brief GINPUT LLD header file for mouse/touch driver. * - * @defgroup Mouse + * @defgroup Mouse Mouse * @ingroup GINPUT * * @{ @@ -59,3 +59,4 @@ #endif /* _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 477a531a..84ebaaa2 100644 --- a/drivers/multiple/Win32/ginput_lld_toggle_config.h +++ b/drivers/multiple/Win32/ginput_lld_toggle_config.h @@ -22,7 +22,7 @@ * @file drivers/multiple/Win32/ginput_lld_toggle_config.h * @brief GINPUT Toggle Driver configuration header. * - * @defgroup Toggle + * @defgroup Toggle Toggle * @ingroup GINPUT * * @{ @@ -51,3 +51,4 @@ #endif /* _GINPUT_LLD_TOGGLE_CONFIG_H */ /** @} */ + diff --git a/include/gdisp/gdisp.h b/include/gdisp/gdisp.h index 117f865a..f8d5745f 100644 --- a/include/gdisp/gdisp.h +++ b/include/gdisp/gdisp.h @@ -23,6 +23,11 @@ * @brief GDISP Graphic Driver subsystem header file. * * @addtogroup GDISP + * + * @details The GDISP module provides high level abstraction to interface pixel oriented graphic displays. + * + * @pre GFX_USE_GDISP must be set to TRUE in gfxconf.h + * * @{ */ diff --git a/include/gevent/gevent.h b/include/gevent/gevent.h index a68a5fc0..6acfac01 100644 --- a/include/gevent/gevent.h +++ b/include/gevent/gevent.h @@ -22,6 +22,12 @@ * @brief GEVENT GFX User Event subsystem header file. * * @addtogroup GEVENT + * + * @details GEVENT provides a simple to use but yet powerful event + * system. + * + * @pre GFX_USE_GEVENT must be set to TRUE in your gfxconf.h + * * @{ */ #ifndef _GEVENT_H diff --git a/include/ginput/dial.h b/include/ginput/dial.h index a765f7f2..5679685e 100644 --- a/include/ginput/dial.h +++ b/include/ginput/dial.h @@ -21,7 +21,7 @@ * @file include/ginput/dial.h * @brief GINPUT GFX User Input subsystem header file. * - * @defgroup Dial + * @defgroup Dial Dial * @ingroup GINPUT * * @details A dial provides a powerful way to navigate through menus diff --git a/include/ginput/ginput.h b/include/ginput/ginput.h index ec8acca7..59f7640c 100644 --- a/include/ginput/ginput.h +++ b/include/ginput/ginput.h @@ -22,6 +22,12 @@ * @brief GINPUT GFX User Input subsystem header file. * * @addtogroup GINPUT + * + * @details GINPUT provides an easy and common interface to use different input devices + * such as touchscreens and mices. + * + * @pre GFX_USE_GINPUT must be set to TRUE in your gfxconf.h + * * @{ */ #ifndef _GINPUT_H diff --git a/include/ginput/keyboard.h b/include/ginput/keyboard.h index 756b78e4..9f5df32e 100644 --- a/include/ginput/keyboard.h +++ b/include/ginput/keyboard.h @@ -21,10 +21,11 @@ * @file include/ginput/keyboard.h * @brief GINPUT GFX User Input subsystem header file. * - * @defgroup Keyboard + * @defgroup Keyboard Keyboard * @ingroup GINPUT * @{ */ + #ifndef _GINPUT_KEYBOARD_H #define _GINPUT_KEYBOARD_H diff --git a/include/ginput/lld/mouse.h b/include/ginput/lld/mouse.h index 1b956c78..5f4ba52c 100644 --- a/include/ginput/lld/mouse.h +++ b/include/ginput/lld/mouse.h @@ -21,10 +21,11 @@ * @file include/ginput/lld/mouse.h * @brief GINPUT LLD header file for mouse/touch drivers. * - * @defgroup Mouse + * @defgroup Mouse Mouse * @ingroup GINPUT * @{ */ + #ifndef _LLD_GINPUT_MOUSE_H #define _LLD_GINPUT_MOUSE_H @@ -117,3 +118,4 @@ extern "C" { #endif /* _LLD_GINPUT_MOUSE_H */ /** @} */ + diff --git a/include/ginput/lld/toggle.h b/include/ginput/lld/toggle.h index 77f6b346..a75a670f 100644 --- a/include/ginput/lld/toggle.h +++ b/include/ginput/lld/toggle.h @@ -21,10 +21,11 @@ * @file include/ginput/lld/toggle.h * @brief GINPUT header file for toggle drivers. * - * @defgroup Toggle + * @defgroup Toggle Toggle * @ingroup GINPUT * @{ */ + #ifndef _LLD_GINPUT_TOGGLE_H #define _LLD_GINPUT_TOGGLE_H @@ -69,3 +70,4 @@ extern "C" { #endif /* _LLD_GINPUT_TOGGLE_H */ /** @} */ + diff --git a/include/ginput/mouse.h b/include/ginput/mouse.h index bb4bb547..5385ff17 100644 --- a/include/ginput/mouse.h +++ b/include/ginput/mouse.h @@ -21,7 +21,7 @@ * @file include/ginput/mouse.h * @brief GINPUT GFX User Input subsystem header file for mouse and touch. * - * @defgroup Mouse + * @defgroup Mouse Mouse * @ingroup GINPUT * * @details GINPUT allows it to easily interface touchscreens and mices to @@ -32,6 +32,7 @@ * * @{ */ + #ifndef _GINPUT_MOUSE_H #define _GINPUT_MOUSE_H diff --git a/include/ginput/toggle.h b/include/ginput/toggle.h index 078aa92a..bec4ed32 100644 --- a/include/ginput/toggle.h +++ b/include/ginput/toggle.h @@ -21,7 +21,7 @@ * @file include/ginput/toggle.h * @brief GINPUT GFX User Input subsystem header file. * - * @defgroup Toggle + * @defgroup Toggle Toggle * @ingroup GINPUT * * @details GINPUT allows it to interface toggle buttons easily to your diff --git a/include/gtimer/gtimer.h b/include/gtimer/gtimer.h index 623120dc..b286d84e 100644 --- a/include/gtimer/gtimer.h +++ b/include/gtimer/gtimer.h @@ -22,6 +22,18 @@ * @brief GTIMER GFX User Timer subsystem header file. * * @addtogroup GTIMER + * + * @details The reason why ChibiOS/GFX has it's own timer abstraction is because + * virtual timers provided by ChibiOS/RT are interrupt context only. + * While great for what they are designed for, they make coding of the input + * drivers much more complex. + * For non-performance critical drivers like these input drivers, it would also + * hog an in-ordinate amount of critical (interrupt locked) system time. + * This contrary to the goals of a real-time operating system. So a user-land + * (thread based) timer mechanism is also required. + * + * @pre GFX_USE_GTIMER must be set to TRUE in your gfxconf.h + * * @{ */ #ifndef _GTIMER_H diff --git a/include/gwin/button.h b/include/gwin/button.h index 6bab6b25..698c840a 100644 --- a/include/gwin/button.h +++ b/include/gwin/button.h @@ -21,7 +21,7 @@ * @file include/gwin/button.h * @brief GWIN Graphic window subsystem header file. * - * @defgroup Button + * @defgroup Button Button * @ingroup GWIN * * @details GWIN allows it to easily create buttons with different styles diff --git a/include/gwin/console.h b/include/gwin/console.h index 99c9232c..9fa867c8 100644 --- a/include/gwin/console.h +++ b/include/gwin/console.h @@ -21,7 +21,7 @@ * @file include/gwin/console.h * @brief GWIN Graphic window subsystem header file. * - * @defgroup Console + * @defgroup Console Console * @ingroup GWIN * * @details GWIN allows it to create a console/terminal like window. diff --git a/include/gwin/graph.h b/include/gwin/graph.h index e7f86d58..155fd9a9 100644 --- a/include/gwin/graph.h +++ b/include/gwin/graph.h @@ -22,7 +22,7 @@ * @file include/gwin/graph.h * @brief GWIN GRAPH module header file. * - * @defgroup Graph + * @defgroup Graph Graph * @ingroup GWIN * * @details GWIN allows it to easily draw graphs. diff --git a/include/gwin/gwin.h b/include/gwin/gwin.h index b71796d3..e109dd83 100644 --- a/include/gwin/gwin.h +++ b/include/gwin/gwin.h @@ -21,7 +21,7 @@ * @file include/gwin/gwin.h * @brief GWIN Graphic window subsystem header file. * - * @defgroup Window + * @defgroup Window Window * @ingroup GWIN * * @details GWIN provides a basic window manager which allows it to easily diff --git a/src/ginput/dial.c b/src/ginput/dial.c index 756861f8..a447d8bc 100644 --- a/src/ginput/dial.c +++ b/src/ginput/dial.c @@ -22,7 +22,7 @@ * @file src/ginput/dial.c * @brief GINPUT dial code. * - * @defgroup Dial + * @defgroup Dial Dial * @ingroup GINPUT * @{ */ diff --git a/src/ginput/keyboard.c b/src/ginput/keyboard.c index c2d84e9a..56ff5e8a 100644 --- a/src/ginput/keyboard.c +++ b/src/ginput/keyboard.c @@ -22,10 +22,12 @@ * @file src/ginput/keyboard.c * @brief GINPUT keyboard code. * - * @defgroup Keyboard - * @intogroup GINPUT + * @defgroup Keyboard Keyboard + * @ingroup GINPUT + * * @{ */ + #include "ch.h" #include "hal.h" #include "gfx.h" diff --git a/src/ginput/mouse.c b/src/ginput/mouse.c index 1b2fe897..35a55bc5 100644 --- a/src/ginput/mouse.c +++ b/src/ginput/mouse.c @@ -22,7 +22,7 @@ * @file src/ginput/mouse.c * @brief GINPUT mouse/touch code. * - * @defgroup Mouse + * @defgroup Mouse Mouse * @ingroup GINPUT * @{ */ diff --git a/src/ginput/toggle.c b/src/ginput/toggle.c index 447605a1..66021cd0 100644 --- a/src/ginput/toggle.c +++ b/src/ginput/toggle.c @@ -22,7 +22,7 @@ * @file src/ginput/toggle.c * @brief GINPUT toggle code. * - * @defgroup Toggle + * @defgroup Toggle Toggle * @ingroup GINPUT * @{ */ diff --git a/src/gwin/button.c b/src/gwin/button.c index 3c1e4799..9a06f4fe 100644 --- a/src/gwin/button.c +++ b/src/gwin/button.c @@ -21,7 +21,7 @@ * @file src/gwin/button.c * @brief GWIN sub-system button code. * - * @defgroup Button + * @defgroup Button Button * @ingroup GWIN * * @{ diff --git a/src/gwin/console.c b/src/gwin/console.c index 10fa4257..0297da30 100644 --- a/src/gwin/console.c +++ b/src/gwin/console.c @@ -21,7 +21,7 @@ * @file src/gwin/console.c * @brief GWIN sub-system console code. * - * @defgroup Console + * @defgroup Console Console * @ingroup GWIN * * @{ diff --git a/src/gwin/graph.c b/src/gwin/graph.c index bc2af1e9..39628047 100644 --- a/src/gwin/graph.c +++ b/src/gwin/graph.c @@ -21,7 +21,7 @@ * @file src/gwin/button.c * @brief GWIN sub-system button code. * - * @defgroup Button + * @defgroup Button Button * @ingroup GWIN * * @{ diff --git a/src/gwin/gwin.c b/src/gwin/gwin.c index 720f355c..4eef79ad 100644 --- a/src/gwin/gwin.c +++ b/src/gwin/gwin.c @@ -21,7 +21,7 @@ * @file src/gwin/gwin.c * @brief GWIN sub-system code. * - * @defgroup Window + * @defgroup Window Window * @ingroup GWIN * * @{