uGFX/ugfx
2
0
Fork 0
Code Issues 2 Pull Requests Projects Releases Wiki Activity

more doxygen

Browse Source
This commit is contained in:
Joel Bodenmann 2012-12-18 23:15:47 +01:00
parent a75653f7a1
commit a520a32209
41 changed files with 75 additions and 153 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/src/gdisp.dox
View File

@ -1,26 +0,0 @@
/*
ChibiOS/GFX - Copyright (C) 2012
Joel Bodenmann aka Tectu <joel@unormal.org>
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 <http://www.gnu.org/licenses/>.
*/
/**
* @addtogroup GDISP
* @details The GDISP module provides high level abstraction to interface
* pixel oriented graphic displays.
*/

27
docs/src/ginput.dox
View File

@ -1,27 +0,0 @@
/*
ChibiOS/GFX - Copyright (C) 2012
Joel Bodenmann aka Tectu <joel@unormal.org>
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 <http://www.gnu.org/licenses/>.
*/
/**
* @addtogroup GINPUT
*
* @details GINPUT provides an easy and common interface to use different
* input devices such as touchscreens and mices.
*/

36
docs/src/gtimer.dox
View File

@ -1,36 +0,0 @@
/*
ChibiOS/GFX - Copyright (C) 2012
Joel Bodenmann aka Tectu <joel@unormal.org>
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 <http://www.gnu.org/licenses/>.
*/
/**
* @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.
*/

29
docs/src/gwin.dox
View File

@ -1,29 +0,0 @@
/*
ChibiOS/GFX - Copyright (C) 2012
Joel Bodenmann aka Tectu <joel@unormal.org>
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 <http://www.gnu.org/licenses/>.
*/
/**
* @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.
*/

2
drivers/ginput/toggle/Pal/ginput_lld_toggle.c
View File

@ -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
* @{
*/

2
drivers/ginput/toggle/Pal/ginput_lld_toggle_board_example.h
View File

@ -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
* @{
*/

2
drivers/ginput/toggle/Pal/ginput_lld_toggle_board_olimexsam7ex256.h
View File

@ -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
* @{
*/

2
drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h
View File

@ -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
* @{
*/

2
drivers/ginput/touch/ADS7843/ginput_lld_mouse.c
View File

@ -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
* @{
*/

2
drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_example.h
View File

@ -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
* @{
*/

2
drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_firebull_stm32f103.h
View File

@ -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
* @{
*/

2
drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_olimex_stm32_e407.h
View File

@ -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
* @{
*/

5
drivers/ginput/touch/ADS7843/ginput_lld_mouse_config.h
View File

@ -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

2
drivers/ginput/touch/MCU/ginput_lld_mouse.c
View File

@ -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
*
* @{

2
drivers/ginput/touch/MCU/ginput_lld_mouse_board_example.h
View File

@ -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
*
* @{

2
drivers/ginput/touch/MCU/ginput_lld_mouse_board_olimex_stm32_lcd.h
View File

@ -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
*
* @{

2
drivers/ginput/touch/MCU/ginput_lld_mouse_config.h
View File

@ -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
*
* @{

3
drivers/multiple/Win32/ginput_lld_mouse_config.h
View File

@ -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 */
/** @} */

3
drivers/multiple/Win32/ginput_lld_toggle_config.h
View File

@ -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 */
/** @} */

5
include/gdisp/gdisp.h
View File

@ -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
*
* @{
*/

6
include/gevent/gevent.h
View File

@ -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

2
include/ginput/dial.h
View File

@ -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

6
include/ginput/ginput.h
View File

@ -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

3
include/ginput/keyboard.h
View File

@ -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

4
include/ginput/lld/mouse.h
View File

@ -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 */
/** @} */

4
include/ginput/lld/toggle.h
View File

@ -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 */
/** @} */

3
include/ginput/mouse.h
View File

@ -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

2
include/ginput/toggle.h
View File

@ -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

12
include/gtimer/gtimer.h
View File

@ -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

2
include/gwin/button.h
View File

@ -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

2
include/gwin/console.h
View File

@ -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.

2
include/gwin/graph.h
View File

@ -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.

2
include/gwin/gwin.h
View File

@ -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

2
src/ginput/dial.c
View File

@ -22,7 +22,7 @@
* @file src/ginput/dial.c
* @brief GINPUT dial code.
*
* @defgroup Dial
* @defgroup Dial Dial
* @ingroup GINPUT
* @{
*/

6
src/ginput/keyboard.c
View File

@ -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"

2
src/ginput/mouse.c
View File

@ -22,7 +22,7 @@
* @file src/ginput/mouse.c
* @brief GINPUT mouse/touch code.
*
* @defgroup Mouse
* @defgroup Mouse Mouse
* @ingroup GINPUT
* @{
*/

2
src/ginput/toggle.c
View File

@ -22,7 +22,7 @@
* @file src/ginput/toggle.c
* @brief GINPUT toggle code.
*
* @defgroup Toggle
* @defgroup Toggle Toggle
* @ingroup GINPUT
* @{
*/

2
src/gwin/button.c
View File

@ -21,7 +21,7 @@
* @file src/gwin/button.c
* @brief GWIN sub-system button code.
*
* @defgroup Button
* @defgroup Button Button
* @ingroup GWIN
*
* @{

2
src/gwin/console.c
View File

@ -21,7 +21,7 @@
* @file src/gwin/console.c
* @brief GWIN sub-system console code.
*
* @defgroup Console
* @defgroup Console Console
* @ingroup GWIN
*
* @{

2
src/gwin/graph.c
View File

@ -21,7 +21,7 @@
* @file src/gwin/button.c
* @brief GWIN sub-system button code.
*
* @defgroup Button
* @defgroup Button Button
* @ingroup GWIN
*
* @{

2
src/gwin/gwin.c
View File

@ -21,7 +21,7 @@
* @file src/gwin/gwin.c
* @brief GWIN sub-system code.
*
* @defgroup Window
* @defgroup Window Window
* @ingroup GWIN
*
* @{