diff options
author | Martin Smith <martin.smith@qt.io> | 2019-09-13 13:53:21 +0200 |
---|---|---|
committer | Paul Wicking <paul.wicking@qt.io> | 2019-09-23 09:14:53 +0000 |
commit | d3817f4b0b42b180b36c3c5afb22eb592a7e2a91 (patch) | |
tree | a45404da749c301e77ca848d4e9cfa1ce46ebf6d | |
parent | 3fb574d01c106e786f9a43ef1e0d781e156d52fa (diff) |
doc: Fix several qdoc warnings
This update repares several "Can't link to...," "No such parameter...,"
and "Undocumented parameter..." warnings.
Change-Id: I3649cf35f766e5a87ca5df48301e8063a31d7904
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
-rw-r--r-- | src/qml/doc/src/qmlfunctions.qdoc | 2 | ||||
-rw-r--r-- | src/qml/qml/qqmlapplicationengine.cpp | 2 | ||||
-rw-r--r-- | src/qml/qml/qqmlcomponent.cpp | 7 | ||||
-rw-r--r-- | src/qml/qml/qqmlinfo.cpp | 6 |
4 files changed, 9 insertions, 8 deletions
diff --git a/src/qml/doc/src/qmlfunctions.qdoc b/src/qml/doc/src/qmlfunctions.qdoc index 81aa263fa6..b083012eab 100644 --- a/src/qml/doc/src/qmlfunctions.qdoc +++ b/src/qml/doc/src/qmlfunctions.qdoc @@ -458,7 +458,7 @@ */ /*! - \fn template<typename T> QObject *qmlAttachedPropertiesObject(const QObject *attachee, bool create = true) + \fn template<typename T> QObject *qmlAttachedPropertiesObject(const QObject *attachee, bool create) \relates QQmlEngine The form of this template function is: diff --git a/src/qml/qml/qqmlapplicationengine.cpp b/src/qml/qml/qqmlapplicationengine.cpp index d04a89b514..adb036e2d0 100644 --- a/src/qml/qml/qqmlapplicationengine.cpp +++ b/src/qml/qml/qqmlapplicationengine.cpp @@ -279,7 +279,7 @@ void QQmlApplicationEngine::load(const QString &filePath) } /*! - Sets the initial properties with which the QML component gets initialized after + Sets the \a initialProperties with which the QML component gets initialized after it gets loaded. diff --git a/src/qml/qml/qqmlcomponent.cpp b/src/qml/qml/qqmlcomponent.cpp index ed8c41a582..b26b90d2aa 100644 --- a/src/qml/qml/qqmlcomponent.cpp +++ b/src/qml/qml/qqmlcomponent.cpp @@ -813,8 +813,9 @@ QObject *QQmlComponent::create(QQmlContext *context) } /*! - Create an object instance of this component, and initialize its toplevel properties according to initalPropertyValues. - + Create an object instance of this component, and initialize its toplevel + properties with \a initialProperties. \a context specifies the context + where the object instance is to be created. \sa QQmlComponent::create \since 5.14 @@ -1104,7 +1105,7 @@ void QQmlComponent::create(QQmlIncubator &incubator, QQmlContext *context, } /*! - Set toplevel properties of the component. + Set toplevel \a properties of the \a component. This method provides advanced control over component instance creation. diff --git a/src/qml/qml/qqmlinfo.cpp b/src/qml/qml/qqmlinfo.cpp index 6322302422..2bfd2d5bb4 100644 --- a/src/qml/qml/qqmlinfo.cpp +++ b/src/qml/qml/qqmlinfo.cpp @@ -57,7 +57,7 @@ QT_BEGIN_NAMESPACE /*! \fn QQmlInfo QtQml::qmlDebug(const QObject *object) - \relates QQmlEngine + \relates QtQml \since 5.9 Prints debug messages that include the file and line number for the @@ -91,7 +91,7 @@ QT_BEGIN_NAMESPACE /*! \fn QQmlInfo QtQml::qmlInfo(const QObject *object) - \relates QQmlEngine + \relates QtQml Prints informational messages that include the file and line number for the specified QML \a object. @@ -119,7 +119,7 @@ QT_BEGIN_NAMESPACE /*! \fn QQmlInfo QtQml::qmlWarning(const QObject *object) - \relates QQmlEngine + \relates QtQml \since 5.9 Prints warning messages that include the file and line number for the |