Reinsertion of doxygen headers
Reinsertion of doxygen headers that got lost in license changeugfx_release_2.6
Andrew Hannam
parent
bbfeec2dd7
commit
3374aa25c6
|
|
@ -5,6 +5,15 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file drivers/gadc/AT91SAM7/gadc_lld.c
|
||||
* @brief GADC - Periodic ADC driver source file for the AT91SAM7 cpu.
|
||||
*
|
||||
* @defgroup Driver Driver
|
||||
* @ingroup GADC
|
||||
* @{
|
||||
*/
|
||||
|
||||
#include "ch.h"
|
||||
#include "hal.h"
|
||||
#include "gfx.h"
|
||||
|
|
|
|||
|
|
@ -4,6 +4,15 @@
|
|||
*
|
||||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file drivers/gaudin/gadc/gaudin_lld.c
|
||||
* @brief GAUDIN - Driver file for using the cpu ADC (via GADC).
|
||||
*
|
||||
* @addtogroup GAUDIN
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
#include "ch.h"
|
||||
#include "hal.h"
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,16 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file drivers/ginput/touch/ADS7843/ginput_lld_mouse_config.h
|
||||
* @brief GINPUT LLD header file for mouse/touch driver.
|
||||
*
|
||||
* @defgroup Mouse Mouse
|
||||
* @ingroup GINPUT
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _LLD_GINPUT_MOUSE_CONFIG_H
|
||||
#define _LLD_GINPUT_MOUSE_CONFIG_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,16 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file drivers/ginput/touch/MCU/ginput_lld_mouse_config.h
|
||||
* @brief GINPUT LLD header file for touch driver.
|
||||
*
|
||||
* @defgroup Mouse Mouse
|
||||
* @ingroup GINPUT
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _LLD_GINPUT_MOUSE_CONFIG_H
|
||||
#define _LLD_GINPUT_MOUSE_CONFIG_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,16 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file drivers/ginput/touch/STMPE811/ginput_lld_mouse_config.h
|
||||
* @brief GINPUT LLD header file for mouse/touch driver.
|
||||
*
|
||||
* @defgroup Mouse Mouse
|
||||
* @ingroup GINPUT
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _LLD_GINPUT_MOUSE_CONFIG_H
|
||||
#define _LLD_GINPUT_MOUSE_CONFIG_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,16 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file drivers/multiple/Win32/ginput_lld_mouse_config.h
|
||||
* @brief GINPUT LLD header file for mouse/touch driver.
|
||||
*
|
||||
* @defgroup Mouse Mouse
|
||||
* @ingroup GINPUT
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _LLD_GINPUT_MOUSE_CONFIG_H
|
||||
#define _LLD_GINPUT_MOUSE_CONFIG_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,35 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/gadc/gadc.h
|
||||
* @brief GADC - Periodic ADC subsystem header file.
|
||||
*
|
||||
* @addtogroup GADC
|
||||
*
|
||||
* @details The reason why ChibiOS/GFX has it's own ADC abstraction is because
|
||||
* the Chibi-OS drivers are very CPU specific and do not
|
||||
* provide a way across all hardware platforms to create periodic
|
||||
* ADC conversions. There are also issues with devices with different
|
||||
* characteristics or periodic requirements on the same ADC
|
||||
* device (but different channels). This layer attempts to solve these
|
||||
* problems to provide a architecture neutral API. It also provides extra
|
||||
* features such as multi-buffer chaining for high speed ADC sources.
|
||||
* It provides one high speed virtual ADC device (eg a microphone) and
|
||||
* numerous low speed (less than 100Hz) virtual ADC devices (eg dials,
|
||||
* temperature sensors etc). The high speed device has timer based polling
|
||||
* to ensure exact conversion periods and a buffer management system.
|
||||
* The low speed devices are assumed to be non-critical timing devices
|
||||
* and do not have any buffer management.
|
||||
* Note that while only one high speed device has been provided it can
|
||||
* be used to read multiple physical ADC channels on the one physical
|
||||
* ADC device.
|
||||
* All callback routines are thread based unlike the Chibi-OS interrupt based
|
||||
* routines.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _GADC_H
|
||||
#define _GADC_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,15 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/gadc/lld/gadc_lld.h
|
||||
* @brief GADC - Periodic ADC driver header file.
|
||||
*
|
||||
* @defgroup Driver Driver
|
||||
* @ingroup GADC
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _GADC_LLD_H
|
||||
#define _GADC_LLD_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,15 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/gaudin/gaudin.h
|
||||
* @brief GAUDIN - Audio Input subsystem header file.
|
||||
*
|
||||
* @addtogroup GAUDIN
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _GAUDIN_H
|
||||
#define _GAUDIN_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,15 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/gaudin/lld/gaudin_lld.h
|
||||
* @brief GAUDIN - Audio Input driver header file.
|
||||
*
|
||||
* @defgroup Driver Driver
|
||||
* @ingroup GAUDIN
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _GAUDIN_LLD_H
|
||||
#define _GAUDIN_LLD_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,15 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/gaudout/gaudout.h
|
||||
* @brief GAUDOUT - Audio Output subsystem header file.
|
||||
*
|
||||
* @addtogroup GAUDOUT
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _GAUDOUT_H
|
||||
#define _GAUDOUT_H
|
||||
|
||||
|
|
|
|||
|
|
@ -4,6 +4,20 @@
|
|||
*
|
||||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/gevent/gevent.h
|
||||
* @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
|
||||
#define _GEVENT_H
|
||||
|
||||
|
|
|
|||
|
|
@ -4,6 +4,22 @@
|
|||
*
|
||||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/ginput/dial.h
|
||||
* @brief GINPUT GFX User Input subsystem header file.
|
||||
*
|
||||
* @defgroup Dial Dial
|
||||
* @ingroup GINPUT
|
||||
*
|
||||
* @details A dial provides a powerful way to navigate through menus
|
||||
* on a display.
|
||||
*
|
||||
* @pre GFX_USE_GINPUT must be set to TRUE in your gfxconf.h
|
||||
* @pre GINPUT_NEED_DIAL must be set to TRUE in your gfxconf.h
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
#ifndef _GINPUT_DIAL_H
|
||||
#define _GINPUT_DIAL_H
|
||||
|
||||
|
|
|
|||
|
|
@ -4,6 +4,20 @@
|
|||
*
|
||||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/ginput/ginput.h
|
||||
* @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
|
||||
#define _GINPUT_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,15 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/ginput/keyboard.h
|
||||
* @brief GINPUT GFX User Input subsystem header file.
|
||||
*
|
||||
* @defgroup Keyboard Keyboard
|
||||
* @ingroup GINPUT
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _GINPUT_KEYBOARD_H
|
||||
#define _GINPUT_KEYBOARD_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,15 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/ginput/lld/dial.h
|
||||
* @brief GINPUT header file for dial drivers.
|
||||
*
|
||||
* @defgroup Dial Dial
|
||||
* @ingroup GINPUT
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _LLD_GINPUT_DIAL_H
|
||||
#define _LLD_GINPUT_DIAL_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,15 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/ginput/lld/mouse.h
|
||||
* @brief GINPUT LLD header file for mouse/touch drivers.
|
||||
*
|
||||
* @defgroup Mouse Mouse
|
||||
* @ingroup GINPUT
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _LLD_GINPUT_MOUSE_H
|
||||
#define _LLD_GINPUT_MOUSE_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,15 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/ginput/lld/toggle.h
|
||||
* @brief GINPUT header file for toggle drivers.
|
||||
*
|
||||
* @defgroup Toggle Toggle
|
||||
* @ingroup GINPUT
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _LLD_GINPUT_TOGGLE_H
|
||||
#define _LLD_GINPUT_TOGGLE_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,22 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/ginput/mouse.h
|
||||
* @brief GINPUT GFX User Input subsystem header file for mouse and touch.
|
||||
*
|
||||
* @defgroup Mouse Mouse
|
||||
* @ingroup GINPUT
|
||||
*
|
||||
* @details GINPUT allows it to easily interface touchscreens and mices to
|
||||
* your application.
|
||||
*
|
||||
* @pre GFX_USE_GINPUT must be set to TRUE in your gfxconf.h
|
||||
* @pre GINPUT_NEED_MOUSE must be set to TRUE in your gfxconf.h
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _GINPUT_MOUSE_H
|
||||
#define _GINPUT_MOUSE_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,22 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/ginput/toggle.h
|
||||
* @brief GINPUT GFX User Input subsystem header file.
|
||||
*
|
||||
* @defgroup Toggle Toggle
|
||||
* @ingroup GINPUT
|
||||
*
|
||||
* @details GINPUT allows it to interface toggle buttons easily to your
|
||||
* application.
|
||||
*
|
||||
* @pre GFX_USE_GINPUT must be set to TRUE in your gfxconf.h
|
||||
* @pre GINPUT_NEED_TOGGLE must be set to TRUE in your gfxconf.h
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _GINPUT_TOGGLE_H
|
||||
#define _GINPUT_TOGGLE_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,15 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/gmisc/gmisc.h
|
||||
* @brief GMISC - Miscellaneous Routines header file.
|
||||
*
|
||||
* @addtogroup GAUDIN
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _GMISC_H
|
||||
#define _GMISC_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,26 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/gtimer/gtimer.h
|
||||
* @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
|
||||
#define _GTIMER_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,22 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/gwin/button.h
|
||||
* @brief GWIN Graphic window subsystem header file.
|
||||
*
|
||||
* @defgroup Button Button
|
||||
* @ingroup GWIN
|
||||
*
|
||||
* @details GWIN allows it to easily create buttons with different styles
|
||||
* and check for different meta states such as: PRESSED, CLICKED,
|
||||
* RELEASED etc.
|
||||
*
|
||||
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
|
||||
* @pre GWIN_NEED_BUTTON must be set to TRUE in your gfxconf.h
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _GWIN_BUTTON_H
|
||||
#define _GWIN_BUTTON_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,22 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/gwin/console.h
|
||||
* @brief GWIN Graphic window subsystem header file.
|
||||
*
|
||||
* @defgroup Console Console
|
||||
* @ingroup GWIN
|
||||
*
|
||||
* @details GWIN allows it to create a console/terminal like window.
|
||||
* You can simply use chprintf() to print to the terminal.
|
||||
*
|
||||
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
|
||||
* @pre GWIN_NEED_CONSOLE must be set to TRUE in your gfxconf.h
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _GWIN_CONSOLE_H
|
||||
#define _GWIN_CONSOLE_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,24 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/gwin/gwin.h
|
||||
* @brief GWIN Graphic window subsystem header file.
|
||||
*
|
||||
* @defgroup Window Window
|
||||
* @ingroup GWIN
|
||||
*
|
||||
* @details GWIN provides a basic window manager which allows it to easily
|
||||
* create and destroy different windows on runtime. Each window
|
||||
* will have it's own properties such as colors, brushes as well as
|
||||
* it's own drawing origin.
|
||||
* Moving the windows around is not supported yet.
|
||||
*
|
||||
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _GWIN_H
|
||||
#define _GWIN_H
|
||||
|
||||
|
|
|
|||
|
|
@ -4,6 +4,14 @@
|
|||
*
|
||||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/gwin/internal.h
|
||||
* @brief GWIN Graphic window subsystem header file.
|
||||
*
|
||||
* @addtogroup GWIN
|
||||
* @{
|
||||
*/
|
||||
#ifndef _GWIN_INTERNAL_H
|
||||
#define _GWIN_INTERNAL_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,20 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file include/gwin/slider.h
|
||||
* @brief GWIN Graphic window subsystem header file.
|
||||
*
|
||||
* @defgroup Slider Slider
|
||||
* @ingroup GWIN
|
||||
*
|
||||
* @details Create sliders with different styles
|
||||
*
|
||||
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
|
||||
* @pre GWIN_NEED_SLIDER must be set to TRUE in your gfxconf.h
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _GWIN_SLIDER_H
|
||||
#define _GWIN_SLIDER_H
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,16 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file src/gwin/button.c
|
||||
* @brief GWIN sub-system button code.
|
||||
*
|
||||
* @defgroup Button Button
|
||||
* @ingroup GWIN
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#include "ch.h"
|
||||
#include "hal.h"
|
||||
#include "gfx.h"
|
||||
|
|
|
|||
|
|
@ -5,6 +5,16 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file src/gwin/console.c
|
||||
* @brief GWIN sub-system console code.
|
||||
*
|
||||
* @defgroup Console Console
|
||||
* @ingroup GWIN
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#include "ch.h"
|
||||
#include "hal.h"
|
||||
#include "gfx.h"
|
||||
|
|
|
|||
|
|
@ -5,6 +5,16 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file src/gwin/graph.c
|
||||
* @brief GWIN sub-system button code.
|
||||
*
|
||||
* @defgroup Graph Graph
|
||||
* @ingroup GWIN
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#include "ch.h"
|
||||
#include "hal.h"
|
||||
#include "gfx.h"
|
||||
|
|
|
|||
|
|
@ -5,6 +5,16 @@
|
|||
* http://chibios-gfx.com/license.html
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file src/gwin/slider.c
|
||||
* @brief GWIN sub-system slider code.
|
||||
*
|
||||
* @defgroup Slider Slider
|
||||
* @ingroup GWIN
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#include "ch.h"
|
||||
#include "hal.h"
|
||||
#include "gfx.h"
|
||||
|
|
|
|||
Loading…
Reference in New Issue