aboutsummaryrefslogtreecommitdiffstats
path: root/src/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
parent03a0773b1001728ca52d6cd5429e73445274ae81 (diff)
Fix some documentation errors.
Change-Id: I5d4b3e26742202c4b634d0001fd3658c7263c50a Reviewed-by: Alan Alpert <aalpert@blackberry.com>
Diffstat (limited to 'src/qml')
-rw-r--r--src/qml/debugger/qqmlabstractprofileradapter.cpp3
-rw-r--r--src/qml/debugger/qqmlprofiler.cpp6
-rw-r--r--src/qml/doc/src/qmllanguageref/modules/cppplugins.qdoc10
-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
8 files changed, 22 insertions, 22 deletions
diff --git a/src/qml/debugger/qqmlabstractprofileradapter.cpp b/src/qml/debugger/qqmlabstractprofileradapter.cpp
index d7168428f6..01d1fcc4fe 100644
--- a/src/qml/debugger/qqmlabstractprofileradapter.cpp
+++ b/src/qml/debugger/qqmlabstractprofileradapter.cpp
@@ -45,6 +45,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QQmlAbstractProfilerAdapter
+ * \inmodule QtQml
* Abstract base class for all adapters between profilers and the QQmlProfilerService. Adapters have
* to retrieve profiler-specific data and convert it to the format sent over the wire. Adapters must
* live in the QDebugServer thread but the actual profilers can live in different threads. The
@@ -101,7 +102,7 @@ void QQmlAbstractProfilerAdapter::stopProfiling() {
}
/*!
- * \fn bool QQmlAbstractProfilerAdapter::isRunning()
+ * \fn bool QQmlAbstractProfilerAdapter::isRunning() const
* Returns if the profiler is currently running. The profiler is considered to be running after
* \c startProfiling() has been called until \c stopProfiling() is called. That is independent of
* \c waiting. The profiler may be running and waiting at the same time.
diff --git a/src/qml/debugger/qqmlprofiler.cpp b/src/qml/debugger/qqmlprofiler.cpp
index f25c931d63..a0b39744a0 100644
--- a/src/qml/debugger/qqmlprofiler.cpp
+++ b/src/qml/debugger/qqmlprofiler.cpp
@@ -165,7 +165,7 @@ void QQmlProfiler::reportData()
* If profiling is enabled clears the current range data, then stops the
* profiler previously running in the foreground if any, then starts a new one
* in the foreground, setting the given location. \a url is the URL of
- * file being executed, \line line is the current line in in that file, and
+ * file being executed, \a line is the current line in in that file, and
* \a column is the current column in that file.
*/
@@ -183,7 +183,7 @@ void QQmlProfiler::reportData()
*/
/*!
- * \fn void QQmlVmeProfiler::clear()
+ * \fn void QQmlVmeProfiler::clear(bool stopProfiling = false)
* Stops the currently running (foreground and background) profilers and removes all saved
* data about paused profilers.
*/
@@ -198,7 +198,7 @@ void QQmlProfiler::reportData()
* Stops the profiler currently running in the foreground, if any and puts the
* next profiler from the background in its place if there are any profilers in
* the background. Additionally the rangeLocation is set. \a url is the URL of
- * file being executed, \line line is the current line in in that file, and
+ * file being executed, \a line is the current line in in that file, and
* \a column is the current column in that file.
*/
diff --git a/src/qml/doc/src/qmllanguageref/modules/cppplugins.qdoc b/src/qml/doc/src/qmllanguageref/modules/cppplugins.qdoc
index b5fe941f9f..8bfe309144 100644
--- a/src/qml/doc/src/qmllanguageref/modules/cppplugins.qdoc
+++ b/src/qml/doc/src/qmllanguageref/modules/cppplugins.qdoc
@@ -69,7 +69,7 @@
as a new QML type. It provides the current time through \c hour and \c minute
properties.
- \snippet plugins/plugin.cpp 0
+ \snippet qmlextensionplugins/plugin.cpp 0
\dots
To make this type available, we create a plugin class named \c QExampleQmlPlugin
@@ -79,7 +79,7 @@
definition to register the plugin with the Qt meta object system using a unique
identifier for the plugin.
- \snippet plugins/plugin.cpp plugin
+ \snippet qmlextensionplugins/plugin.cpp plugin
The \c TimeModel class receives a \c{1.0} version of this plugin library, as
a QML type called \c Time. The Q_ASSERT() macro can ensure the type namespace is
@@ -112,15 +112,15 @@
that is built by the project (as shown above in the \c .pro file) so both of these
need 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 component is
accessible 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}.
\section1 Reference
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()).
*/