aboutsummaryrefslogtreecommitdiffstats
path: root/src/gwin
diff options
context:
space:
mode:
Diffstat (limited to 'src/gwin')
-rw-r--r--src/gwin/gwin.h2
-rw-r--r--src/gwin/gwin_button.h2
-rw-r--r--src/gwin/gwin_checkbox.h2
-rw-r--r--src/gwin/gwin_console.h2
-rw-r--r--src/gwin/gwin_container.h6
-rw-r--r--src/gwin/gwin_frame.h2
-rw-r--r--src/gwin/gwin_gl3d.h3
-rw-r--r--src/gwin/gwin_graph.h5
-rw-r--r--src/gwin/gwin_image.h2
-rw-r--r--src/gwin/gwin_keyboard.h2
-rw-r--r--src/gwin/gwin_label.h3
-rw-r--r--src/gwin/gwin_list.h4
-rw-r--r--src/gwin/gwin_progressbar.h2
-rw-r--r--src/gwin/gwin_radio.h5
-rw-r--r--src/gwin/gwin_slider.h4
-rw-r--r--src/gwin/gwin_tabset.h2
-rw-r--r--src/gwin/gwin_textedit.h5
-rw-r--r--src/gwin/gwin_widget.h2
18 files changed, 45 insertions, 10 deletions
diff --git a/src/gwin/gwin.h b/src/gwin/gwin.h
index cc0d44f1..a9fc4ca3 100644
--- a/src/gwin/gwin.h
+++ b/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
diff --git a/src/gwin/gwin_button.h b/src/gwin/gwin_button.h
index 9ab4d475..dcbab682 100644
--- a/src/gwin/gwin_button.h
+++ b/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.
diff --git a/src/gwin/gwin_checkbox.h b/src/gwin/gwin_checkbox.h
index cd66428a..10401624 100644
--- a/src/gwin/gwin_checkbox.h
+++ b/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
diff --git a/src/gwin/gwin_console.h b/src/gwin/gwin_console.h
index a21642aa..3da9df12 100644
--- a/src/gwin/gwin_console.h
+++ b/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.
*
diff --git a/src/gwin/gwin_container.h b/src/gwin/gwin_container.h
index ff97a51e..ce2ab4bd 100644
--- a/src/gwin/gwin_container.h
+++ b/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
* @{
diff --git a/src/gwin/gwin_frame.h b/src/gwin/gwin_frame.h
index 0824787b..18af2e50 100644
--- a/src/gwin/gwin_frame.h
+++ b/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.
*
diff --git a/src/gwin/gwin_gl3d.h b/src/gwin/gwin_gl3d.h
index 84ead5d9..b04d49a6 100644
--- a/src/gwin/gwin_gl3d.h
+++ b/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
*
diff --git a/src/gwin/gwin_graph.h b/src/gwin/gwin_graph.h
index 8355f494..3f4c3181 100644
--- a/src/gwin/gwin_graph.h
+++ b/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
*
diff --git a/src/gwin/gwin_image.h b/src/gwin/gwin_image.h
index 5def4037..d3874f65 100644
--- a/src/gwin/gwin_image.h
+++ b/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.
*
diff --git a/src/gwin/gwin_keyboard.h b/src/gwin/gwin_keyboard.h
index c10567e1..347b4bb4 100644
--- a/src/gwin/gwin_keyboard.h
+++ b/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.
diff --git a/src/gwin/gwin_label.h b/src/gwin/gwin_label.h
index d9abe0e0..c08eb85d 100644
--- a/src/gwin/gwin_label.h
+++ b/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
diff --git a/src/gwin/gwin_list.h b/src/gwin/gwin_list.h
index 43c7d2e2..2ab06960 100644
--- a/src/gwin/gwin_list.h
+++ b/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
diff --git a/src/gwin/gwin_progressbar.h b/src/gwin/gwin_progressbar.h
index 166cabca..1824a4e9 100644
--- a/src/gwin/gwin_progressbar.h
+++ b/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
diff --git a/src/gwin/gwin_radio.h b/src/gwin/gwin_radio.h
index 051e0739..17d64d8b 100644
--- a/src/gwin/gwin_radio.h
+++ b/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
diff --git a/src/gwin/gwin_slider.h b/src/gwin/gwin_slider.h
index 6f988410..d42aa67b 100644
--- a/src/gwin/gwin_slider.h
+++ b/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
diff --git a/src/gwin/gwin_tabset.h b/src/gwin/gwin_tabset.h
index 7d970c5d..6eaeb014 100644
--- a/src/gwin/gwin_tabset.h
+++ b/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.
diff --git a/src/gwin/gwin_textedit.h b/src/gwin/gwin_textedit.h
index cffe8fb7..ed2f634d 100644
--- a/src/gwin/gwin_textedit.h
+++ b/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
diff --git a/src/gwin/gwin_widget.h b/src/gwin/gwin_widget.h
index 732d7d1c..ceba235b 100644
--- a/src/gwin/gwin_widget.h
+++ b/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.
generated by cgit v1.2.3 (git 2.25.1) at 2024-09-05 20:18:21 +0000