summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Jones <martin.jones@nokia.com>2010-07-06 03:37:29 (GMT)
committerMartin Jones <martin.jones@nokia.com>2010-07-06 03:37:29 (GMT)
commit3384a5bedabbbb406026b31ecfa4266ac3205bcc (patch)
treef344b7e16552b541d9af85c494c3581ea37c9472
parent8274fdc7ee8ecc03bb879ea79e9b3b3b4ca9ab37 (diff)
downloadQt-3384a5bedabbbb406026b31ecfa4266ac3205bcc.zip
Qt-3384a5bedabbbb406026b31ecfa4266ac3205bcc.tar.gz
Qt-3384a5bedabbbb406026b31ecfa4266ac3205bcc.tar.bz2
Document the QML enumeration basic type
-rw-r--r--doc/src/declarative/basictypes.qdoc23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/src/declarative/basictypes.qdoc b/doc/src/declarative/basictypes.qdoc
index 159f40d..109e6d5 100644
--- a/doc/src/declarative/basictypes.qdoc
+++ b/doc/src/declarative/basictypes.qdoc
@@ -400,3 +400,26 @@
\sa {QML Basic Types}
*/
+
+/*!
+ \qmlbasictype enumeration
+ \ingroup qmlbasictypes
+
+ \brief An enumeration type consists of a set of named values.
+
+ An enumeration type consists of a set of named values.
+
+ An enumeration value may be specifed as either a string:
+ \qml
+ Text { horizontalAlignment: "AlignRight" }
+ \endqml
+
+ or as \c {<Element>.<value>}:
+ \qml
+ Text { horizontalAlignment: Text.AlignRight }
+ \endqml
+
+ The second form is preferred.
+
+ \sa {QML Basic Types}
+*/