summaryrefslogtreecommitdiffstats
path: root/tools/qdoc3/doc
diff options
context:
space:
mode:
authorMartin Smith <martin.smith@nokia.com>2011-02-28 11:54:30 (GMT)
committerMartin Smith <martin.smith@nokia.com>2011-02-28 11:54:30 (GMT)
commit710678400b28cf49ffa228e335b8d2c02b5c25a1 (patch)
tree404fa7c31c19b98f8f6392c8f5da54e0841c2dcc /tools/qdoc3/doc
parent80b9af0e3dd0a5a7fbc63e9dbe31502172f87af2 (diff)
downloadQt-710678400b28cf49ffa228e335b8d2c02b5c25a1.zip
Qt-710678400b28cf49ffa228e335b8d2c02b5c25a1.tar.gz
Qt-710678400b28cf49ffa228e335b8d2c02b5c25a1.tar.bz2
qdoc: Added more descriptions for QML commands.
Diffstat (limited to 'tools/qdoc3/doc')
-rw-r--r--tools/qdoc3/doc/qdoc-manual.qdoc258
1 files changed, 126 insertions, 132 deletions
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index a564425..fd0ca57 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -5407,6 +5407,103 @@
\endquotation
+ \target qmlattachedproperty-command
+ \section1 \\qmlattachedproperty \span {class="newStuff"} {(new)}
+
+ The \\qmlattachedproperty command is for documenting a QML
+ property that will be attached to some QML element type. See
+ \l{http://doc.trolltech.com/4.7/qdeclarativeintroduction.html#attached-properties}
+ {Attached Properties}. The argument is the rest of the line. The
+ argument text should be the property type, followed by the QML
+ element name where the property is being declared, the \c{::}
+ qualifier, and finally the property name. If we have a QML
+ attached property named \c isCurrentItem in QML element \c ListView,
+ and the property has type \c {bool}, the \\qmlattachedproperty for
+ it would look like this:
+
+ \code
+ / *!
+ \qmlattachedproperty bool ListView::isCurrentItem
+ This attached property is true if this delegate is the current
+ item; otherwise false.
+
+ It is attached to each instance of the delegate.
+
+ This property may be used to adjust the appearance of the current
+ item, for example:
+
+ \snippet doc/src/snippets/declarative/listview/listview.qml isCurrentItem
+ * /
+ \endcode
+
+ QDoc includes this attached property on the QML reference page for the
+ \l{http://doc.trolltech.com/4.7/qml-listview.html#isCurrentItem-prop}
+ {ListView} element.
+
+ \target qmlattachedsignal-command
+ \section1 \\qmlattachedsignal \span {class="newStuff"} {(new)}
+
+ The \\qmlattachedsignal command is for documenting an attachable
+ \l{http://doc.trolltech.com/4.7/qdeclarativeintroduction.html#signal-handlers}
+ {signal handler}. The \\qmlattachedsignal command is used just like
+ the \l{qmlsignal-command} {\\qmlsignal} command.
+
+ The argument is the rest of the line. It should be the name of the
+ QML element where the signal handler is declared, the \c{::}
+ qualifier, and finally the signal handler name. If we have a QML
+ attached signal handler named \c onAdd() in the \c GridView
+ element, the \\qmlattachedsignal for it would look like this:
+
+ \code
+ / *!
+ \qmlattachedsignal GridView::onAdd()
+ This attached handler is called immediately after an item is
+ added to the view.
+ * /
+ \endcode
+
+ QDoc includes this documentation on the QML reference page for the
+ \l{http://doc.trolltech.com/4.7/qml-gridview.html#onAdd-signal}
+ {GridView} element.
+
+ \target qmlbasictype-command
+ \section1 \\qmlbasictype \span {class="newStuff"} {(new)}
+
+ The \\qmlbasictype command is for documenting a basic type for QML.
+ The argument is the type name. The type must be included in the
+ QML basic types group using the \l{ingroup-command}{\\ingroup}
+ command as shown below. This will cause QDoc to include the
+ documentation for the type on the
+ \l{http://doc.trolltech.com/4.7/qdeclarativebasictypes.html}
+ {QML Basic Types} page. The \l{brief-command} {\\brief} command
+ is also required, because it appears on the
+ \l{http://doc.trolltech.com/4.7/qdeclarativebasictypes.html}
+ {QML Basic Types} page as well.
+
+ \code
+ / *!
+ \qmlbasictype int
+ \ingroup qmlbasictypes
+
+ \brief An integer is a whole number, e.g. 0, 10, or -20.
+
+ An integer is a whole number, e.g. 0, 10, or -20. The possible
+ \c int values range from around -2000000000 to around
+ 2000000000, although most elements will only accept a reduced
+ range (which they mention in their documentation).
+
+ Example:
+ \qml
+ Item { width: 100; height: 200 }
+ \endqml
+
+ \sa {QML Basic Types}
+ * /
+ \endcode
+
+ QDoc outputs this as \l{http://doc.trolltech.com/4.7/qml-int.html}
+ {qml-int.html}.
+
\target qmlclass-command
\section1 \\qmlclass \span {class="newStuff"} {(new)}
@@ -5452,6 +5549,33 @@
elements, it should also include one or more \l{ingroup-command}
{\\ingroup} commands.
+ \target qmlmethod-command
+ \section1 \\qmlmethod \span {class="newStuff"} {(new)}
+
+ The \\qmlmethod command is for documenting a QML method. The
+ argument is the complete method signature, including return
+ type and parameter names and types.
+
+ \code
+ / *!
+ \qmlmethod void TextInput::select(int start, int end)
+
+ Causes the text from \a start to \a end to be selected.
+
+ If either start or end is out of range, the selection is not changed.
+
+ After calling this, selectionStart will become the lesser and
+ selectionEnd will become the greater (regardless of the order
+ passed to this method).
+
+ \sa selectionStart, selectionEnd
+ * /
+ \endcode
+
+ QDoc includes this documentation on the element refence page for the
+ \l{http://doc.trolltech.com/4.7/qml-textinput.html#select-method}
+ {TextInput} element.
+
\target qmlproperty-command
\section1 \\qmlproperty \span {class="newStuff"} {(new)}
@@ -5474,42 +5598,6 @@
\l {http://doc.trolltech.com/4.7/qml-translate.html} {Translate}
element.
- \target qmlattachedproperty-command
- \section1 \\qmlattachedproperty \span {class="newStuff"} {(new)}
-
- The \\qmlattachedproperty command is for documenting a QML
- property that will be attached to some QML element type. See
- \l{http://doc.trolltech.com/4.7/qdeclarativeintroduction.html#attached-properties}
- {Attached Properties}. The argument is the rest of the line. The
- argument text should be the property type, followed by the QML
- element name where the property is being declared, the \c{::}
- qualifier, and finally the property name. If we have a QML
- attached property named \c isCurrentItem in QML element \c ListView,
- and the property has type \c {bool}, the \\qmlattachedproperty for
- it would look like this:
-
- \code
- / *!
- \qmlattachedproperty bool ListView::isCurrentItem
- This attached property is true if this delegate is the current
- item; otherwise false.
-
- It is attached to each instance of the delegate.
-
- This property may be used to adjust the appearance of the current
- item, for example:
-
- \snippet doc/src/snippets/declarative/listview/listview.qml isCurrentItem
- * /
- \endcode
-
- QDoc includes this attached property on the QML reference page for the
- \l{http://doc.trolltech.com/4.7/qml-listview.html#isCurrentItem-prop}
- {ListView} element.
-
- \target inherits-command
- \section1 \\inherits \span {class="newStuff"} {(new)}
-
\target qmlsignal-command
\section1 \\qmlsignal \span {class="newStuff"} {(new)}
@@ -5539,106 +5627,12 @@
\l{http://doc.trolltech.com/4.7/qml-mousearea.html#onEntered-signal}
{MouseArea} element.
- \target qmlattachedsignal-command
- \section1 \\qmlattachedsignal \span {class="newStuff"} {(new)}
-
- The \\qmlattachedsignal command is for documenting an attachable
- \l{http://doc.trolltech.com/4.7/qdeclarativeintroduction.html#signal-handlers}
- {signal handler}. The \\qmlattachedsignal command is used just like
- the \l{qmlsignal-command} {\\qmlsignal} command.
-
- The argument is the rest of the line. It should be the name of the
- QML element where the signal handler is declared, the \c{::}
- qualifier, and finally the signal handler name. If we have a QML
- attached signal handler named \c onAdd() in the \c GridView
- element, the \\qmlattachedsignal for it would look like this:
-
- \code
- / *!
- \qmlattachedsignal GridView::onAdd()
- This attached handler is called immediately after an item is
- added to the view.
- * /
- \endcode
-
- QDoc includes this documentation on the QML reference page for the
- \l{http://doc.trolltech.com/4.7/qml-gridview.html#onAdd-signal}
- {GridView} element.
-
- \target qmlmethod-command
- \section1 \\qmlmethod \span {class="newStuff"} {(new)}
-
- The \\qmlmethod command is for documenting a QML method. The
- argument is the complete method signature, including return
- type and parameter names and types.
-
- \code
- / *!
- \qmlmethod void TextInput::select(int start, int end)
-
- Causes the text from \a start to \a end to be selected.
-
- If either start or end is out of range, the selection is not changed.
-
- After calling this, selectionStart will become the lesser and
- selectionEnd will become the greater (regardless of the order
- passed to this method).
-
- \sa selectionStart, selectionEnd
- * /
- \endcode
-
- QDoc includes this documentation on the element refence page for the
- \l{http://doc.trolltech.com/4.7/qml-textinput.html#select-method}
- {TextInput} element.
-
- \target qmlattachedmethod-command
- \section1 \\qmlattachedmethod \span {class="newStuff"} {(new but not used)}
-
- The \\qmlattachedmethod command was included in QDoc for symmetery
- with the \\qmlattachedsignal command, but it hasn't been used so far,
- so maybe that means there is no such thing as an attached method.
-
\target default-command
\section1 \\default \span {class="newStuff"} {(new)}
- \target qmlbasictype-command
- \section1 \\qmlbasictype \span {class="newStuff"} {(new)}
-
- The \\qmlbasictype command is for documenting a basic type for QML.
- The argument is the type name. The type must be included in the
- QML basic types group using the \l{ingroup-command}{\\ingroup}
- command as shown below. This will cause QDoc to include the
- documentation for the type on the
- \l{http://doc.trolltech.com/4.7/qdeclarativebasictypes.html}
- {QML Basic Types} page. The \l{brief-command} {\\brief} command
- is also required, because it appears on the
- \l{http://doc.trolltech.com/4.7/qdeclarativebasictypes.html}
- {QML Basic Types} page as well.
-
- \code
- / *!
- \qmlbasictype int
- \ingroup qmlbasictypes
-
- \brief An integer is a whole number, e.g. 0, 10, or -20.
-
- An integer is a whole number, e.g. 0, 10, or -20. The possible
- \c int values range from around -2000000000 to around
- 2000000000, although most elements will only accept a reduced
- range (which they mention in their documentation).
-
- Example:
- \qml
- Item { width: 100; height: 200 }
- \endqml
-
- \sa {QML Basic Types}
- * /
- \endcode
+ \target inherits-command
+ \section1 \\inherits \span {class="newStuff"} {(new)}
- QDoc outputs this as \l{http://doc.trolltech.com/4.7/qml-int.html}
- {qml-int.html}.
*/
/*!