diff options
| author | Joel Bodenmann <joel@unormal.org> | 2014-05-20 18:05:38 +0200 |
|---|---|---|
| committer | Joel Bodenmann <joel@unormal.org> | 2014-05-20 18:05:38 +0200 |
| commit | 0b204ed8e39d900c22f11e02c47de970648dbb31 (patch) | |
| tree | fa224cd16e999518a80339a9c1d6c70e3d04972e /docs/src/containers.dox | |
| parent | 9781c31f3b2923b2dc397adf2dd12235f039ce56 (diff) | |
| download | uGFX-0b204ed8e39d900c22f11e02c47de970648dbb31.tar.gz uGFX-0b204ed8e39d900c22f11e02c47de970648dbb31.tar.bz2 uGFX-0b204ed8e39d900c22f11e02c47de970648dbb31.zip | |
Reworking the GWIN doxygen documentation.
Diffstat (limited to 'docs/src/containers.dox')
| -rw-r--r-- | docs/src/containers.dox | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/src/containers.dox b/docs/src/containers.dox new file mode 100644 index 00000000..3d0a6368 --- /dev/null +++ b/docs/src/containers.dox @@ -0,0 +1,21 @@ +/* + * This file is subject to the terms of the GFX License. If a copy of + * the license was not distributed with this file, you can obtain one at: + * + * http://ugfx.com/license.html + */ + +/** + * @file src/gwin/sys_defs.h + * + * @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 + * 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. + * + * @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h + */ |