aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@nokia.com>2012-05-18 15:19:55 +0200
committerQt by Nokia <qt-info@nokia.com>2012-05-24 15:41:16 +0200
commit6112c0f57177ee813271da54200a2d9f3ef20238 (patch)
treeb0cb10f46fb8c6b2b13516ab8e0e97c675b506a3 /src/qml
parentb13827d77e9a3d64a728036b3804638da62bbe40 (diff)
Doc: Sanitized QML types
-modified \brief -checked QML modules -added qml directory to the qdocconf file -added particles directory to the qdocconf file Change-Id: I589e32d3106cda37c7fa4d55a941afd9876fc2b2 Reviewed-by: Geir Vattekar <geir.vattekar@nokia.com>
Diffstat (limited to 'src/qml')
-rw-r--r--src/qml/doc/src/types/qmldate.qdoc2
-rw-r--r--src/qml/qml/qqmlcomponent.cpp6
-rw-r--r--src/qml/qml/qqmlengine.cpp3
-rw-r--r--src/qml/qml/qqmllocale.cpp2
-rw-r--r--src/qml/qml/qquicklistmodel.cpp4
-rw-r--r--src/qml/qml/qquickworkerscript.cpp3
6 files changed, 12 insertions, 8 deletions
diff --git a/src/qml/doc/src/types/qmldate.qdoc b/src/qml/doc/src/types/qmldate.qdoc
index 3931aa6e45..802f977503 100644
--- a/src/qml/doc/src/types/qmldate.qdoc
+++ b/src/qml/doc/src/types/qmldate.qdoc
@@ -28,7 +28,7 @@
/*!
\qmlclass Date
\inqmlmodule QtQuick 2
- \brief The Date object provides date functions
+ \brief Provides date functions
The QML Date object extends the JS Date object with
locale aware functions.
diff --git a/src/qml/qml/qqmlcomponent.cpp b/src/qml/qml/qqmlcomponent.cpp
index f82f1d281e..1ade6988f7 100644
--- a/src/qml/qml/qqmlcomponent.cpp
+++ b/src/qml/qml/qqmlcomponent.cpp
@@ -112,10 +112,11 @@ static inline QString buildTypeNameForDebug(const QMetaObject *metaObject)
/*!
\class QQmlComponent
\since 5.0
- \brief The QQmlComponent class encapsulates a QML component definition.
\inmodule QtQml
\mainclass
+ \brief The QQmlComponent class encapsulates a QML component definition
+
Components are reusable, encapsulated QML elements with well-defined interfaces.
They are often defined in \l {qdeclarativedocuments.html}{Component Files}.
@@ -190,7 +191,8 @@ static inline QString buildTypeNameForDebug(const QMetaObject *metaObject)
\qmlclass Component QQmlComponent
\ingroup qml-utility-elements
\since 4.7
- \brief The Component element encapsulates a QML component definition.
+ \inqmlmodule QtQuick 2
+ \brief Encapsulates a QML component definition
Components are reusable, encapsulated QML elements with well-defined interfaces.
diff --git a/src/qml/qml/qqmlengine.cpp b/src/qml/qml/qqmlengine.cpp
index e3fc083914..4a3e30793c 100644
--- a/src/qml/qml/qqmlengine.cpp
+++ b/src/qml/qml/qqmlengine.cpp
@@ -109,9 +109,10 @@ void qmlRegisterBaseTypes(const char *uri, int versionMajor, int versionMinor)
/*!
\qmlclass QtObject QObject
+ \inqmlmodule QtQuick 2
\ingroup qml-utility-elements
\since 4.7
- \brief The QtObject element is the most basic element in QML.
+ \brief A basic QML type
The QtObject element is a non-visual element which contains only the
objectName property.
diff --git a/src/qml/qml/qqmllocale.cpp b/src/qml/qml/qqmllocale.cpp
index 0371d0ea0a..7d2dafe3b3 100644
--- a/src/qml/qml/qqmllocale.cpp
+++ b/src/qml/qml/qqmllocale.cpp
@@ -748,7 +748,7 @@ V8_DEFINE_EXTENSION(QV8LocaleDataDeletable, localeV8Data);
/*!
\qmlclass Locale QQmlLocale
\inqmlmodule QtQuick 2
- \brief The Locale object provides locale specific properties and formatted data.
+ \brief Provides locale specific properties and formatted data
The Locale object may only be created via the \l{QML:Qt::locale()}{Qt.locale()} function.
It cannot be created directly.
diff --git a/src/qml/qml/qquicklistmodel.cpp b/src/qml/qml/qquicklistmodel.cpp
index 15b39b2cb4..389394652a 100644
--- a/src/qml/qml/qquicklistmodel.cpp
+++ b/src/qml/qml/qquicklistmodel.cpp
@@ -1357,7 +1357,7 @@ QQuickListModelParser::ListInstruction *QQuickListModelParser::ListModelData::in
\qmlclass ListModel QQuickListModel
\inqmlmodule QtQuick 2
\ingroup qml-working-with-data
- \brief The ListModel element defines a free-form list data source.
+ \brief Defines a free-form list data source
The ListModel is a simple container of ListElement definitions, each containing data roles.
The contents can be defined dynamically, or explicitly in QML.
@@ -2428,7 +2428,7 @@ bool QQuickListModelParser::definesEmptyList(const QString &s)
\qmlclass ListElement QQuickListElement
\inqmlmodule QtQuick 2
\ingroup qml-working-with-data
- \brief The ListElement element defines a data item in a ListModel.
+ \brief Defines a data item in a ListModel
List elements are defined inside ListModel definitions, and represent items in a
list that will be displayed using ListView or \l Repeater items.
diff --git a/src/qml/qml/qquickworkerscript.cpp b/src/qml/qml/qquickworkerscript.cpp
index 03433124d0..81ebb1fed4 100644
--- a/src/qml/qml/qquickworkerscript.cpp
+++ b/src/qml/qml/qquickworkerscript.cpp
@@ -562,7 +562,8 @@ void QQuickWorkerScriptEngine::run()
/*!
\qmlclass WorkerScript QQuickWorkerScript
\ingroup qml-utility-elements
- \brief The WorkerScript element enables the use of threads in QML.
+ \inqmlmodule QtQuick 2
+ \brief Enables the use of threads in QML
Use WorkerScript to run operations in a new thread.
This is useful for running operations in the background so