Browse Source

Doxygen

remotes/origin_old/ugfx_release_2.6
Joel Bodenmann 6 years ago
parent
commit
6397a56e0b
  1. 8
      docs/src/containers.dox
  2. 19
      docs/src/main.dox
  3. 4
      docs/src/widgets.dox
  4. 4
      docs/src/windows.dox
  5. 5
      src/gadc/gadc_driver.h
  6. 5
      src/gaudio/gaudio_driver_play.h
  7. 5
      src/gaudio/gaudio_driver_record.h
  8. 6
      src/gdisp/gdisp_colors.h
  9. 4
      src/gdisp/gdisp_image.h
  10. 3
      src/gdisp/gdisp_pixmap.h
  11. 3
      src/ginput/ginput_dial.h
  12. 4
      src/ginput/ginput_keyboard.h
  13. 6
      src/ginput/ginput_mouse.h
  14. 3
      src/ginput/ginput_toggle.h
  15. 2
      src/gwin/gwin.h
  16. 2
      src/gwin/gwin_button.h
  17. 2
      src/gwin/gwin_checkbox.h
  18. 2
      src/gwin/gwin_console.h
  19. 6
      src/gwin/gwin_container.h
  20. 2
      src/gwin/gwin_frame.h
  21. 3
      src/gwin/gwin_gl3d.h
  22. 5
      src/gwin/gwin_graph.h
  23. 2
      src/gwin/gwin_image.h
  24. 2
      src/gwin/gwin_keyboard.h
  25. 3
      src/gwin/gwin_label.h
  26. 4
      src/gwin/gwin_list.h
  27. 2
      src/gwin/gwin_progressbar.h
  28. 5
      src/gwin/gwin_radio.h
  29. 4
      src/gwin/gwin_slider.h
  30. 2
      src/gwin/gwin_tabset.h
  31. 5
      src/gwin/gwin_textedit.h
  32. 2
      src/gwin/gwin_widget.h

8
docs/src/containers.dox

@ -11,11 +11,15 @@
* @defgroup Containers Containers
* @ingroup GWIN
*
* @details Containers are a "super-class" of a widget. Containers can have
* children windows which they can place within their borders. Containers
* @brief Containers are used to group together other windows and widgets.
*
* @details Containers are a "super-class" of @ref Widgets. Containers can have
* children @ref Windows which they can place within their borders. Containers
* control the visibility and enabled state of their children. By making
* a container invisible you make all its children invisible. Similiarly
* with the enabled state.
*
* For the common window API, please see @ref Container.
*
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
*/

19
docs/src/main.dox

@ -7,16 +7,23 @@
/**
* @mainpage uGFX
* @author Joel Bodenmann (joel@unormal.org).
*
* <h2>uGFX</h2>
* µGFX is a library to interface different displays and touchscreen
* to your embedded application. Extreme low system requirements are our
* goal. A complete GUI toolkit is provided.
* <h2>Authors</h2>
* - Joel Bodenmann<br>
* - Andrew Hannam<br>
*
* <h2>Documentation</h2>
* <h2>Website</h2>
* - http://ugfx.org
*
* <h2>Documentation</h2>
* - http://wiki.ugfx.org
*
* <h2>API-Reference</h2>
* - http://api.ugfx.org
*
* <h2>Forum</h2>
* - http://forum.ugfx.org
*
* <h2>License</h2>
* - http://ugfx.org/license.html
*/

4
docs/src/widgets.dox

@ -11,6 +11,8 @@
* @defgroup Widgets Widgets
* @ingroup GWIN
*
* @brief Widgets extend the @ref Windows adding capabilities such as user input.
*
* @details Widgets are a "super-class" of a window that provides the
* following extra features:
* <ul>
@ -24,5 +26,7 @@
* in Windows and Linux.
* </ul>
*
* For the common window API, please see @ref Widget.
*
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
*/

4
docs/src/windows.dox

@ -11,6 +11,8 @@
* @defgroup Windows Windows
* @ingroup GWIN
*
* @brief Windows are the most basic element in the @p GWIN module.
*
* @details The window is the most basic GWIN element. All the other windows,
* widgets and containers are based on this class.
*
@ -27,5 +29,7 @@
* types such as graphs, consoles, buttons, containers etc. This is done
* through "super-classing" basic windows to provide the extended capabilities.
*
* For the common window API, please see @ref Window.
*
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
*/

5
src/gadc/gadc_driver.h

@ -9,8 +9,11 @@
* @file src/gadc/gadc_driver.h
* @brief GADC - Periodic ADC driver header file.
*
* @defgroup Driver Driver
* @defgroup GADC_Driver Driver
* @ingroup GADC
*
* @brief Driver interface for the GADC module.
*
* @{
*/

5
src/gaudio/gaudio_driver_play.h

@ -9,8 +9,11 @@
* @file src/gaudio/gaudio_driver_play.h
* @brief GAUDIO - Audio play driver header file.
*
* @defgroup Driver Driver
* @defgroup GAUDIO_Driver_Playback Driver Playback
* @ingroup GAUDIO
*
* @brief Playback driver interface for the GAUDIO module.
*
* @{
*/

5
src/gaudio/gaudio_driver_record.h

@ -9,8 +9,11 @@
* @file src/gaudio/gaudio_driver_record.h
* @brief GAUDIO - Audio Recording driver header file.
*
* @defgroup Driver Driver
* @defgroup GAUDIO_Driver_Record Driver Recording
* @ingroup GAUDIO
*
* @brief Recording driver interface for the GAUDIO module.
*
* @{
*/

6
src/gdisp/gdisp_colors.h

@ -7,12 +7,12 @@
/**
* @file src/gdisp/gdisp_colors.h
* @brief GDISP color definitions header file.
*
* @details GDISP color definitions and macros
*
* @defgroup Colors Colors
* @ingroup GDISP
*
* @brief Sub-Module for color handling.
*
* @{
*/

4
src/gdisp/gdisp_image.h

@ -7,10 +7,12 @@
/**
* @file src/gdisp/gdisp_image.h
* @brief GDISP image header file.
*
* @defgroup Image Image
* @ingroup GDISP
*
* @brief Sub-Module for image handling.
*
* @{
*/

3
src/gdisp/gdisp_pixmap.h

@ -7,11 +7,12 @@
/**
* @file src/gdisp/gdisp_pixmap.h
* @brief GDISP image header file.
*
* @defgroup Pixmap Pixmap
* @ingroup GDISP
*
* @brief Sub-Module for dynamic framebuffers.
*
* @note A Pixmap is an off-screen virtual display that can be drawn to just like any other
* display. It can then be copied to a real display using the standard gdispGBlitArea() call.
* @pre GDISP_NEED_PIXMAP must be TRUE in your gfxconf.h

3
src/ginput/ginput_dial.h

@ -7,11 +7,12 @@
/**
* @file src/ginput/ginput_dial.h
* @brief GINPUT GFX User Input subsystem header file.
*
* @defgroup Dial Dial
* @ingroup GINPUT
*
* @brief Sub-Module to handle physical controls that provide a range value (eg. potentiometers and rotary encoders).
*
* @details A dial provides a powerful way to navigate through menus
* on a display.
*

4
src/ginput/ginput_keyboard.h

@ -7,10 +7,12 @@
/**
* @file src/ginput/ginput_keyboard.h
* @brief GINPUT GFX User Input subsystem header file.
*
* @defgroup Keyboard Keyboard
* @ingroup GINPUT
*
* @brief Sub-Module to handle physical keyboards.
*
* @{
*/

6
src/ginput/ginput_mouse.h

@ -7,13 +7,13 @@
/**
* @file src/ginput/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.
* @brief Sub-Module to handle touchscreens and mices.
*
* @details Both resistive and capacitive touchscreens are supported.
*
* @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

3
src/ginput/ginput_toggle.h

@ -7,11 +7,12 @@
/**
* @file src/ginput/ginput_toggle.h
* @brief GINPUT GFX User Input subsystem header file.
*
* @defgroup Toggle Toggle
* @ingroup GINPUT
*
* @brief Sub-Module to handle physical controls that provide provide a digital value (on/off, pressed/released, 1/0, ...).
*
* @details GINPUT allows it to interface toggle buttons easily to your
* application.
*

2
src/gwin/gwin.h

@ -11,6 +11,8 @@
* @defgroup Window Window
* @ingroup Windows
*
* @brief The basic window implementation (base class).
*
* @details GWIN provides a basic window manager which allows it to easily
* create and destroy different windows at runtime. Each window
* will have it's own properties such as colors as well as

2
src/gwin/gwin_button.h

@ -12,6 +12,8 @@
* @defgroup Button Button
* @ingroup Widgets
*
* @brief PushButton widget.
*
* @details GWIN allows it to easily create buttons with different styles
* and check for different meta states such as: PRESSED, CLICKED,
* RELEASED etc.

2
src/gwin/gwin_checkbox.h

@ -12,6 +12,8 @@
* @defgroup Checkbox Checkbox
* @ingroup Widgets
*
* @brief CheckBox widget.
*
* @details GWIN allows it to easily create a group of checkbox buttons.
*
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h

2
src/gwin/gwin_console.h

@ -12,6 +12,8 @@
* @defgroup Console Console
* @ingroup Windows
*
* @brief Console widget that can be used similar a terminal on a computer.
*
* @details GWIN allows it to create a console/terminal like window.
* You can simply use chprintf() to print to the terminal.
*

6
src/gwin/gwin_container.h

@ -11,8 +11,10 @@
* @defgroup Container Container
* @ingroup Containers
*
* @details A Container is a GWindow that supports child windows. It is also
* a widget in its own right and therefore can accept user input directly.
* @brief Basic container.
*
* @details A Container is a GWindow that supports child windows. It is also
* a widget in its own right and therefore can accept user input directly.
*
* @pre GFX_USE_GWIN and GWIN_NEED_CONTAINERS must be set to TRUE in your gfxconf.h
* @{

2
src/gwin/gwin_frame.h

@ -12,6 +12,8 @@
* @defgroup Frame Frame
* @ingroup Containers
*
* @brief Container with window decoration.
*
* @details A frame is a rectangular window that can have optional border as well as buttons to
* close, maximize and minimize it. The main purpose of this widget is to contain children.
*

3
src/gwin/gwin_gl3d.h

@ -12,7 +12,10 @@
* @defgroup 3D 3D
* @ingroup Windows
*
* @brief Widget that can be used to render OpenGL.
*
* @details 3D GWIN window based on OpenGL (or more exactly Tiny GL)
*
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
* @pre GWIN_NEED_GL3D must be set to TRUE in your gfxconf.h
*

5
src/gwin/gwin_graph.h

@ -12,7 +12,10 @@
* @defgroup Graph Graph
* @ingroup Windows
*
* @details GWIN allows it to easily draw graphs
* @brief Graph window. Used to display highly customizable graphs.
*
* @details GWIN allows it to easily draw graphs.
*
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
* @pre GWIN_NEED_GRAPH must be set to TRUE in your gfxconf.h
*

2
src/gwin/gwin_image.h

@ -12,6 +12,8 @@
* @defgroup ImageBox ImageBox
* @ingroup Widgets
*
* @brief ImageBox widget. Used to display images within the @p GWIN widget system.
*
* @details GWIN allos it to create an image widget. The widget
* takes no user input.
*

2
src/gwin/gwin_keyboard.h

@ -12,6 +12,8 @@
* @defgroup VirtualKeyboard VirtualKeyboard
* @ingroup Widgets
*
* @brief Keyboard widget. Used to provide a virtual on-screen keyboard.
*
* @details GWIN allows it to easily create buttons with different styles
* and check for different meta states such as: PRESSED, CLICKED,
* RELEASED etc.

3
src/gwin/gwin_label.h

@ -12,8 +12,7 @@
* @defgroup Label Label
* @ingroup Widgets
*
* @details GWIN allos it to create an label widget. The widget
* takes no user input.
* @brief Simple label widget.
*
* @details Setting the dimensions of the widget to 0 will automatically
* set the labels dimensions to fit the entire text. Note that the

4
src/gwin/gwin_list.h

@ -12,7 +12,9 @@
* @defgroup List List
* @ingroup Widgets
*
* @details GWIN allows it to create a list widget.
* @brief List Widget. Used to display lists of items.
*
* @details Provides advanced features such as multi-selection, smooth scrolling and item icons.
*
* @pre GFX_USE_GDISP must be set to TRUE in your gfxconf.h
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h

2
src/gwin/gwin_progressbar.h

@ -12,7 +12,7 @@
* @defgroup Progressbar Progressbar
* @ingroup Widgets
*
* @details Create progressbars with different styles
* @brief ProgressBar widget.
*
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
* @pre GWIN_NEED_PROGRESSBAR must be set to TRUE in your gfxconf.h

5
src/gwin/gwin_radio.h

@ -12,7 +12,10 @@
* @defgroup RadioButton RadioButton
* @ingroup Widgets
*
* @details GWIN allows it to easily create radio buttons with different styles.
* @brief RadioButton widget.
*
* @details RadioButtons need to be grouped together. This is archived by passing a group parameter through
* @p gwinRadioCreate().
*
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
* @pre GWIN_NEED_RADIO must be set to TRUE in your gfxconf.h

4
src/gwin/gwin_slider.h

@ -12,7 +12,9 @@
* @defgroup Slider Slider
* @ingroup Widgets
*
* @details Create sliders with different styles
* @brief Slider widget.
*
* @details Extended events can be enabled using @p gwinSliderSendExtendedEvents().
*
* @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

2
src/gwin/gwin_tabset.h

@ -12,6 +12,8 @@
* @defgroup Tabset Tabset
* @ingroup Containers
*
* @brief Tabwidget to implement different "Tabs" or "Pages". Used to structure menus.
*
* @details A tabset is a set of tabs that control visibility of a number of pages of widgets.
* Note: Although the tabset is implemented as a container - you don't put your controls
* directly on the tabset. Instead you create a page and put your widgets on the page.

5
src/gwin/gwin_textedit.h

@ -12,7 +12,10 @@
* @defgroup TextEdit TextEdit
* @ingroup Widgets
*
* @details A GWIN TextEdit widget allows user input.
* @brief Widget that accepts text input.
*
* @note Due to the modularity of the @p GINPUT module, the text input can either come from a real physical
* keyboard or from a vritual on-screen keyboard such as the @p KeyboardWidget.
*
* @pre GFX_USE_GDISP must be set to TRUE in your gfxconf.h
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h

2
src/gwin/gwin_widget.h

@ -12,6 +12,8 @@
* @defgroup Widget Widget
* @ingroup Widgets
*
* @brief The basic widget implementation (base class).
*
* @details A widget is a Window that supports interacting with the user
* via an input device such as a mouse or toggle buttons. It is the
* base class for widgets such as buttons and sliders.

Loading…
Cancel
Save