Joel Bodenmann 3 years ago
parent
commit
6397a56e0b

+ 6 - 2
docs/src/containers.dox

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

+ 13 - 6
docs/src/main.dox

@@ -7,16 +7,23 @@
7 7
 
8 8
 /**
9 9
  * @mainpage uGFX
10
- * @author Joel Bodenmann (joel@unormal.org).
11 10
  *
12
- * <h2>uGFX</h2>
13
- * µGFX is a library to interface different displays and touchscreen
14
- * to your embedded application. Extreme low system requirements are our
15
- * goal. A complete GUI toolkit is provided.
11
+ * <h2>Authors</h2>
12
+ * - Joel Bodenmann<br>
13
+ * - Andrew Hannam<br>
16 14
  *
17
- * <h2>Documentation</h2>
15
+ * <h2>Website</h2>
18 16
  * - http://ugfx.org
19 17
  *
18
+ * <h2>Documentation</h2>
19
+ * - http://wiki.ugfx.org
20
+ *
21
+ * <h2>API-Reference</h2>
22
+ * - http://api.ugfx.org
23
+ *
24
+ * <h2>Forum</h2>
25
+ * - http://forum.ugfx.org
26
+ *
20 27
  * <h2>License</h2>
21 28
  * - http://ugfx.org/license.html
22 29
  */

+ 4 - 0
docs/src/widgets.dox

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

+ 4 - 0
docs/src/windows.dox

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

+ 4 - 1
src/gadc/gadc_driver.h

@@ -9,8 +9,11 @@
9 9
  * @file    src/gadc/gadc_driver.h
10 10
  * @brief   GADC - Periodic ADC driver header file.
11 11
  *
12
- * @defgroup Driver Driver
12
+ * @defgroup GADC_Driver Driver
13 13
  * @ingroup GADC
14
+ *
15
+ * @brief Driver interface for the GADC module.
16
+ *
14 17
  * @{
15 18
  */
16 19
 

+ 4 - 1
src/gaudio/gaudio_driver_play.h

@@ -9,8 +9,11 @@
9 9
  * @file    src/gaudio/gaudio_driver_play.h
10 10
  * @brief   GAUDIO - Audio play driver header file.
11 11
  *
12
- * @defgroup Driver Driver
12
+ * @defgroup GAUDIO_Driver_Playback Driver Playback
13 13
  * @ingroup GAUDIO
14
+ *
15
+ * @brief Playback driver interface for the GAUDIO module.
16
+ *
14 17
  * @{
15 18
  */
16 19
 

+ 4 - 1
src/gaudio/gaudio_driver_record.h

@@ -9,8 +9,11 @@
9 9
  * @file    src/gaudio/gaudio_driver_record.h
10 10
  * @brief   GAUDIO - Audio Recording driver header file.
11 11
  *
12
- * @defgroup Driver Driver
12
+ * @defgroup GAUDIO_Driver_Record Driver Recording
13 13
  * @ingroup GAUDIO
14
+ *
15
+ * @brief Recording driver interface for the GAUDIO module.
16
+ *
14 17
  * @{
15 18
  */
16 19
 

+ 3 - 3
src/gdisp/gdisp_colors.h

@@ -7,12 +7,12 @@
7 7
 
8 8
 /**
9 9
  * @file    src/gdisp/gdisp_colors.h
10
- * @brief   GDISP color definitions header file.
11
- *
12
- * @details	GDISP color definitions and macros
13 10
  *
14 11
  * @defgroup Colors Colors
15 12
  * @ingroup GDISP
13
+ *
14
+ * @brief   Sub-Module for color handling.
15
+ *
16 16
  * @{
17 17
  */
18 18
 

+ 3 - 1
src/gdisp/gdisp_image.h

@@ -7,10 +7,12 @@
7 7
 
8 8
 /**
9 9
  * @file    src/gdisp/gdisp_image.h
10
- * @brief   GDISP image header file.
11 10
  *
12 11
  * @defgroup Image Image
13 12
  * @ingroup GDISP
13
+ *
14
+ * @brief   Sub-Module for image handling.
15
+ *
14 16
  * @{
15 17
  */
16 18
 

+ 2 - 1
src/gdisp/gdisp_pixmap.h

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

+ 2 - 1
src/ginput/ginput_dial.h

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

+ 3 - 1
src/ginput/ginput_keyboard.h

@@ -7,10 +7,12 @@
7 7
 
8 8
 /**
9 9
  * @file    src/ginput/ginput_keyboard.h
10
- * @brief   GINPUT GFX User Input subsystem header file.
11 10
  *
12 11
  * @defgroup Keyboard Keyboard
13 12
  * @ingroup GINPUT
13
+ *
14
+ * @brief   Sub-Module to handle physical keyboards.
15
+ *
14 16
  * @{
15 17
  */
16 18
 

+ 3 - 3
src/ginput/ginput_mouse.h

@@ -7,13 +7,13 @@
7 7
 
8 8
 /**
9 9
  * @file    src/ginput/ginput_mouse.h
10
- * @brief   GINPUT GFX User Input subsystem header file for mouse and touch.
11 10
  *
12 11
  * @defgroup Mouse Mouse
13 12
  * @ingroup GINPUT
14 13
  *
15
- * @details GINPUT allows it to easily interface touchscreens and mices to
16
- *			your application.
14
+ * @brief   Sub-Module to handle touchscreens and mices.
15
+ *
16
+ * @details Both resistive and capacitive touchscreens are supported.
17 17
  *
18 18
  * @pre		GFX_USE_GINPUT must be set to TRUE in your gfxconf.h
19 19
  * @pre		GINPUT_NEED_MOUSE must be set to TRUE in your gfxconf.h

+ 2 - 1
src/ginput/ginput_toggle.h

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

+ 2 - 0
src/gwin/gwin.h

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

+ 2 - 0
src/gwin/gwin_button.h

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

+ 2 - 0
src/gwin/gwin_checkbox.h

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

+ 2 - 0
src/gwin/gwin_console.h

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

+ 4 - 2
src/gwin/gwin_container.h

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

+ 2 - 0
src/gwin/gwin_frame.h

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

+ 3 - 0
src/gwin/gwin_gl3d.h

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

+ 4 - 1
src/gwin/gwin_graph.h

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

+ 2 - 0
src/gwin/gwin_image.h

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

+ 2 - 0
src/gwin/gwin_keyboard.h

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

+ 1 - 2
src/gwin/gwin_label.h

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

+ 3 - 1
src/gwin/gwin_list.h

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

+ 1 - 1
src/gwin/gwin_progressbar.h

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

+ 4 - 1
src/gwin/gwin_radio.h

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

+ 3 - 1
src/gwin/gwin_slider.h

@@ -12,7 +12,9 @@
12 12
  * @defgroup Slider Slider
13 13
  * @ingroup Widgets
14 14
  *
15
- * @details		Create sliders with different styles
15
+ * @brief		Slider widget.
16
+ *
17
+ * @details		Extended events can be enabled using @p gwinSliderSendExtendedEvents().
16 18
  *
17 19
  * @pre			GFX_USE_GWIN must be set to TRUE in your gfxconf.h
18 20
  * @pre			GWIN_NEED_SLIDER must be set to TRUE in your gfxconf.h

+ 2 - 0
src/gwin/gwin_tabset.h

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

+ 4 - 1
src/gwin/gwin_textedit.h

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

+ 2 - 0
src/gwin/gwin_widget.h

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