diff options
| author | Joel Bodenmann <joel@seriouslyembedded.com> | 2015-11-07 16:33:28 +0100 |
|---|---|---|
| committer | Joel Bodenmann <joel@seriouslyembedded.com> | 2015-11-07 16:33:28 +0100 |
| commit | 6397a56e0beddf179786e093b08bcf0cbe71fea1 (patch) | |
| tree | 12a15acf8c2c69db37abad2165b621b5bc244382 /docs | |
| parent | 778b23bdfdb6805e8aa4f9a0cea3a5b99c50cd46 (diff) | |
| download | uGFX-6397a56e0beddf179786e093b08bcf0cbe71fea1.tar.gz uGFX-6397a56e0beddf179786e093b08bcf0cbe71fea1.tar.bz2 uGFX-6397a56e0beddf179786e093b08bcf0cbe71fea1.zip | |
Doxygen
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/src/containers.dox | 8 | ||||
| -rw-r--r-- | docs/src/main.dox | 19 | ||||
| -rw-r--r-- | docs/src/widgets.dox | 4 | ||||
| -rw-r--r-- | docs/src/windows.dox | 4 |
4 files changed, 27 insertions, 8 deletions
diff --git a/docs/src/containers.dox b/docs/src/containers.dox index e8d6452c..5a397420 100644 --- a/docs/src/containers.dox +++ b/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 */ diff --git a/docs/src/main.dox b/docs/src/main.dox index 2de3df90..7a84941e 100644 --- a/docs/src/main.dox +++ b/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
*/
diff --git a/docs/src/widgets.dox b/docs/src/widgets.dox index 4626508c..b3e827e5 100644 --- a/docs/src/widgets.dox +++ b/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 */ diff --git a/docs/src/windows.dox b/docs/src/windows.dox index c5acc31f..63c25f3a 100644 --- a/docs/src/windows.dox +++ b/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 */ |