diff options
author | Martin Smith <martin.smith@qt.io> | 2018-02-05 11:21:32 +0100 |
---|---|---|
committer | Martin Smith <martin.smith@qt.io> | 2018-02-09 17:12:12 +0000 |
commit | 47cd9da96371ccd495f6caabe1c6853258210ebb (patch) | |
tree | 13d01990443b72fbb7d0e7ee5f8493aa25802cee /src/qml/qml | |
parent | 11fca802e342d2331391fd314018cb7ee208dfb7 (diff) |
doc: Fix qdoc warnings for templates and statics
Several \fn commands needed template parameters added, and several
static functions that were not accessible were documented but should
not have been documented. The template texts were added and the qdoc
comments of the static functions were changed to non-qdoc comments.
Change-Id: Icc44e243fbec2023865f47b7c73dc15d241d5b4d
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src/qml/qml')
-rw-r--r-- | src/qml/qml/qqmlcontext.cpp | 1 | ||||
-rw-r--r-- | src/qml/qml/qqmlimport.cpp | 6 | ||||
-rw-r--r-- | src/qml/qml/qqmllist.cpp | 10 |
3 files changed, 9 insertions, 8 deletions
diff --git a/src/qml/qml/qqmlcontext.cpp b/src/qml/qml/qqmlcontext.cpp index e6e2be91f6..de43108312 100644 --- a/src/qml/qml/qqmlcontext.cpp +++ b/src/qml/qml/qqmlcontext.cpp @@ -365,6 +365,7 @@ void QQmlContext::setContextProperties(const QVector<PropertyPair> &properties) \since 5.11 \class QQmlContext::PropertyPair + \inmodule QtQml This struct contains a property name and a property value. It is used as a parameter for the \c setContextProperties function. diff --git a/src/qml/qml/qqmlimport.cpp b/src/qml/qml/qqmlimport.cpp index 8b0bd9d6ec..f2757c34be 100644 --- a/src/qml/qml/qqmlimport.cpp +++ b/src/qml/qml/qqmlimport.cpp @@ -981,7 +981,7 @@ QQmlImportNamespace *QQmlImportsPrivate::findQualifiedNamespace(const QHashedStr return 0; } -/*! +/* Returns the list of possible versioned URI combinations. For example, if \a uri is QtQml.Models, \a vmaj is 2, and \a vmin is 0, this method returns the following: [QtQml.Models.2.0, QtQml.2.0.Models, QtQml.Models.2, QtQml.2.Models, QtQml.Models] @@ -1017,7 +1017,7 @@ static QVector<QStaticPlugin> makePlugins() return plugins; } -/*! +/* Get all static plugins that are QML plugins and has a meta data URI that matches with one of \a versionUris, which is a list of all possible versioned URI combinations - see versionUriList() above. @@ -1059,7 +1059,7 @@ static inline QString msgCannotLoadPlugin(const QString &uri, const QString &why } #endif -/*! +/* Import an extension defined by a qmldir file. \a qmldirFilePath is a raw file path. diff --git a/src/qml/qml/qqmllist.cpp b/src/qml/qml/qqmllist.cpp index 71be2e82a3..9bfdd3da35 100644 --- a/src/qml/qml/qqmllist.cpp +++ b/src/qml/qml/qqmllist.cpp @@ -374,12 +374,12 @@ The \l {Qt Quick 1} version of this class is named QDeclarativeListProperty. */ /*! -\fn QQmlListProperty::QQmlListProperty() +\fn template<typename T> QQmlListProperty<T>::QQmlListProperty() \internal */ /*! -\fn QQmlListProperty::QQmlListProperty(QObject *object, QList<T *> &list) +\fn template<typename T> QQmlListProperty<T>::QQmlListProperty(QObject *object, QList<T *> &list) Convenience constructor for making a QQmlListProperty value from an existing QList \a list. The \a list reference must remain valid for as long as \a object @@ -391,7 +391,7 @@ can be very useful while prototyping. */ /*! -\fn QQmlListProperty::QQmlListProperty(QObject *object, void *data, +\fn template<typename T> QQmlListProperty<T>::QQmlListProperty(QObject *object, void *data, CountFunction count, AtFunction at) Construct a readonly QQmlListProperty from a set of operation functions @@ -401,7 +401,7 @@ remains valid while \a object exists. */ /*! -\fn QQmlListProperty::QQmlListProperty(QObject *object, void *data, AppendFunction append, +\fn template<typename T> QQmlListProperty<T>::QQmlListProperty(QObject *object, void *data, AppendFunction append, CountFunction count, AtFunction at, ClearFunction clear) @@ -432,7 +432,7 @@ Return the number of elements in the list \a property. */ /*! -\fn bool QQmlListProperty::operator==(const QQmlListProperty &other) const +\fn template<typename T> bool QQmlListProperty<T>::operator==(const QQmlListProperty &other) const Returns true if this QQmlListProperty is equal to \a other, otherwise false. */ |