diff options
author | Topi Reinio <topi.reinio@qt.io> | 2018-11-02 12:35:57 +0100 |
---|---|---|
committer | Jani Heikkinen <jani.heikkinen@qt.io> | 2018-11-02 16:43:47 +0000 |
commit | f20839aed0f2e4fe9134a239adda4853d7bd204a (patch) | |
tree | c8edd991ac1bc190e767e105176dcbe078054da2 /src/qml/qml/qqmlinfo.cpp | |
parent | 6746417e719cee389a37513f830d5cff1b4b9c25 (diff) |
Doc: Qt QML: Fix documentation warnings
Add \namespace for for namespace QtQml, as it has logging functions
that previously saw no generated documentation.
Fix \qmltype name of DelegateChooser, as well as a number of related
typos and linking problems.
Task-number: QTBUG-71502
Change-Id: I5a9c635853ef73c99a1b1f55cd1c0a1a87fdf6ec
Reviewed-by: Martin Smith <martin.smith@qt.io>
Diffstat (limited to 'src/qml/qml/qqmlinfo.cpp')
-rw-r--r-- | src/qml/qml/qqmlinfo.cpp | 63 |
1 files changed, 43 insertions, 20 deletions
diff --git a/src/qml/qml/qqmlinfo.cpp b/src/qml/qml/qqmlinfo.cpp index c8f5ba506f..6322302422 100644 --- a/src/qml/qml/qqmlinfo.cpp +++ b/src/qml/qml/qqmlinfo.cpp @@ -50,6 +50,12 @@ QT_BEGIN_NAMESPACE /*! + \namespace QtQml + \inmodule QtQml + \brief Provides functions for producing logging messages for QML types. +*/ + +/*! \fn QQmlInfo QtQml::qmlDebug(const QObject *object) \relates QQmlEngine \since 5.9 @@ -57,6 +63,7 @@ QT_BEGIN_NAMESPACE Prints debug messages that include the file and line number for the specified QML \a object. +//! [qqmlinfo-desc] When QML types produce logging messages, it improves traceability if they include the QML file and line number on which the particular instance was instantiated. @@ -65,6 +72,7 @@ QT_BEGIN_NAMESPACE the file and line number is not available for that instance (either it was not instantiated by the QML engine or location information is disabled), "unknown location" will be used instead. +//! [qqmlinfo-desc] For example, @@ -74,7 +82,7 @@ QT_BEGIN_NAMESPACE prints - \code + \badcode QML MyCustomType (unknown location): Internal state: 42 \endcode @@ -88,14 +96,7 @@ QT_BEGIN_NAMESPACE Prints informational messages that include the file and line number for the specified QML \a object. - When QML types produce logging messages, it improves traceability - if they include the QML file and line number on which the - particular instance was instantiated. - - To include the file and line number, an object must be passed. If - the file and line number is not available for that instance - (either it was not instantiated by the QML engine or location - information is disabled), "unknown location" will be used instead. + \include qqmlinfo.cpp qqmlinfo-desc For example, @@ -105,7 +106,7 @@ QT_BEGIN_NAMESPACE prints - \code + \badcode QML MyCustomType (unknown location): component property is a write-once property \endcode @@ -116,7 +117,6 @@ QT_BEGIN_NAMESPACE \sa QtQml::qmlDebug, QtQml::qmlWarning */ - /*! \fn QQmlInfo QtQml::qmlWarning(const QObject *object) \relates QQmlEngine @@ -125,14 +125,7 @@ QT_BEGIN_NAMESPACE Prints warning messages that include the file and line number for the specified QML \a object. - When QML types produce logging messages, it improves traceability - if they include the QML file and line number on which the - particular instance was instantiated. - - To include the file and line number, an object must be passed. If - the file and line number is not available for that instance - (either it was not instantiated by the QML engine or location - information is disabled), "unknown location" will be used instead. + \include qqmlinfo.cpp qqmlinfo-desc For example, @@ -142,13 +135,43 @@ QT_BEGIN_NAMESPACE prints - \code + \badcode QML MyCustomType (unknown location): property cannot be set to 0 \endcode \sa QtQml::qmlDebug, QtQml::qmlInfo */ +/*! + \fn QQmlInfo QtQml::qmlDebug(const QObject *object, const QQmlError &error) + \internal +*/ + +/*! + \fn QQmlInfo QtQml::qmlDebug(const QObject *object, const QList<QQmlError> &errors) + \internal +*/ + +/*! + \fn QQmlInfo QtQml::qmlInfo(const QObject *object, const QQmlError &error) + \internal +*/ + +/*! + \fn QQmlInfo QtQml::qmlInfo(const QObject *object, const QList<QQmlError> &errors) + \internal +*/ + +/*! + \fn QQmlInfo QtQml::qmlWarning(const QObject *object, const QQmlError &error) + \internal +*/ + +/*! + \fn QQmlInfo QtQml::qmlWarning(const QObject *object, const QList<QQmlError> &errors) + \internal +*/ + class QQmlInfoPrivate { public: |