aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/qml
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@digia.com>2014-03-24 17:34:04 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-03-24 20:34:21 +0100
commitdab18e6f5f58be5717b8efb4759d0e0712eb036d (patch)
tree9d2105a2b3f3274ad40655cc05114ee827fe6787 /src/qml/qml
parent03a0773b1001728ca52d6cd5429e73445274ae81 (diff)
Fix some documentation errors.
Change-Id: I5d4b3e26742202c4b634d0001fd3658c7263c50a Reviewed-by: Alan Alpert <aalpert@blackberry.com>
Diffstat (limited to 'src/qml/qml')
-rw-r--r--src/qml/qml/qqmlabstracturlinterceptor.cpp4
-rw-r--r--src/qml/qml/qqmlextensionplugin.cpp10
-rw-r--r--src/qml/qml/qqmlfileselector.cpp6
-rw-r--r--src/qml/qml/qqmlincubator.cpp4
-rw-r--r--src/qml/qml/qqmljavascriptexpression.cpp1
5 files changed, 12 insertions, 13 deletions
diff --git a/src/qml/qml/qqmlabstracturlinterceptor.cpp b/src/qml/qml/qqmlabstracturlinterceptor.cpp
index 127dad86ce..3aea9c83cc 100644
--- a/src/qml/qml/qqmlabstracturlinterceptor.cpp
+++ b/src/qml/qml/qqmlabstracturlinterceptor.cpp
@@ -84,8 +84,8 @@
/*!
\fn QUrl QQmlAbstractUrlInterceptor::intercept(const QUrl& url, DataType type)
- A pure virtual function where you can intercept the url. The returned value is taken as the
- new value for the url. The type of url being intercepted is given by the type variable.
+ A pure virtual function where you can intercept the \a url. The returned value is taken as the
+ new value for the url. The type of url being intercepted is given by the \a type variable.
Your implementation of this function must be thread-safe, as it can be called from multiple threads
at the same time.
diff --git a/src/qml/qml/qqmlextensionplugin.cpp b/src/qml/qml/qqmlextensionplugin.cpp
index 76de2dfe34..f3d1ba9d41 100644
--- a/src/qml/qml/qqmlextensionplugin.cpp
+++ b/src/qml/qml/qqmlextensionplugin.cpp
@@ -77,7 +77,7 @@ QT_BEGIN_NAMESPACE
as a new QML element. It provides the current time through \c hour and \c minute
properties, like this:
- \snippet plugins/plugin.cpp 0
+ \snippet qmlextensionplugins/plugin.cpp 0
\dots
To make this class available as a QML type, create a plugin that registers
@@ -85,7 +85,7 @@ QT_BEGIN_NAMESPACE
module will be named \c TimeExample (as defined in the project
file further below).
- \snippet plugins/plugin.cpp plugin
+ \snippet qmlextensionplugins/plugin.cpp plugin
This registers the \c TimeModel class with the 1.0 version of this
plugin library, as a QML type called \c Time. The Q_ASSERT statement
@@ -109,14 +109,14 @@ QT_BEGIN_NAMESPACE
should be bundled with the plugin, so it needs to be specified in the \c qmldir
file:
- \quotefile plugins/imports/TimeExample/qmldir
+ \quotefile qmlextensionplugins/imports/TimeExample/qmldir
Once the project is built and installed, the new \c Time element can be
used by any QML component that imports the \c TimeExample module:
- \snippet plugins/plugins.qml 0
+ \snippet qmlextensionplugins/plugins.qml 0
- The full source code is available in the \l {qml/plugins}{plugins example}.
+ The full source code is available in the \l {qml/qmlextensionplugins}{plugins example}.
The \l {Writing QML Extensions with C++} tutorial also contains a chapter
on creating QML plugins.
diff --git a/src/qml/qml/qqmlfileselector.cpp b/src/qml/qml/qqmlfileselector.cpp
index a18b8327b1..187c3656c6 100644
--- a/src/qml/qml/qqmlfileselector.cpp
+++ b/src/qml/qml/qqmlfileselector.cpp
@@ -152,8 +152,8 @@ void QQmlFileSelector::setSelector(QFileSelector *selector)
}
/*!
- Adds extra selectors to the current QFileSelector being used. Use this when
- extra selectors are all you need to avoid having to create your own
+ Adds extra selectors contained in \a strings to the current QFileSelector being used.
+ Use this when extra selectors are all you need to avoid having to create your own
QFileSelector instance.
*/
void QQmlFileSelector::setExtraSelectors(QStringList &strings)
@@ -163,7 +163,7 @@ void QQmlFileSelector::setExtraSelectors(QStringList &strings)
}
/*!
- Gets the QQmlFileSelector currently active on the target engine.
+ Gets the QQmlFileSelector currently active on the target \a engine.
*/
QQmlFileSelector* QQmlFileSelector::get(QQmlEngine* engine)
{
diff --git a/src/qml/qml/qqmlincubator.cpp b/src/qml/qml/qqmlincubator.cpp
index 480e61b0f4..4cdeb19719 100644
--- a/src/qml/qml/qqmlincubator.cpp
+++ b/src/qml/qml/qqmlincubator.cpp
@@ -407,7 +407,7 @@ void QQmlIncubationController::incubateFor(int msecs)
/*!
Incubate objects while the bool pointed to by \a flag is true, or until there are no
-more objects to incubate, or up to msecs if msecs is not zero.
+more objects to incubate, or up to \a msecs if \a msecs is not zero.
Generally this method is used in conjunction with a thread or a UNIX signal that sets
the bool pointed to by \a flag to false when it wants incubation to be interrupted.
@@ -687,7 +687,7 @@ void QQmlIncubator::statusChanged(Status status)
}
/*!
-Called after the object is first created, but before property bindings are
+Called after the \a object is first created, but before property bindings are
evaluated and, if applicable, QQmlParserStatus::componentComplete() is
called. This is equivalent to the point between QQmlComponent::beginCreate()
and QQmlComponent::endCreate(), and can be used to assign initial values
diff --git a/src/qml/qml/qqmljavascriptexpression.cpp b/src/qml/qml/qqmljavascriptexpression.cpp
index b233b6e98c..560a4c8afd 100644
--- a/src/qml/qml/qqmljavascriptexpression.cpp
+++ b/src/qml/qml/qqmljavascriptexpression.cpp
@@ -218,7 +218,6 @@ void QQmlJavaScriptExpression::GuardCapture::captureProperty(QQmlNotifier *n)
}
/*! \internal
- \reimp
\a n is in the signal index range (see QObjectPrivate::signalIndex()).
*/