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 | |
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')
-rw-r--r-- | src/qml/jsapi/qjsengine.cpp | 6 | ||||
-rw-r--r-- | src/qml/jsapi/qjsvalue.cpp | 2 | ||||
-rw-r--r-- | src/qml/jsruntime/qv4qobjectwrapper.cpp | 6 | ||||
-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 | ||||
-rw-r--r-- | src/qml/util/qqmlpropertymap.cpp | 2 |
7 files changed, 17 insertions, 16 deletions
diff --git a/src/qml/jsapi/qjsengine.cpp b/src/qml/jsapi/qjsengine.cpp index 020a83f837..d83d9c7927 100644 --- a/src/qml/jsapi/qjsengine.cpp +++ b/src/qml/jsapi/qjsengine.cpp @@ -552,7 +552,7 @@ QJSValue QJSEngine::newQMetaObject(const QMetaObject* metaObject) { return QJSValue(v4, v->asReturnedValue()); } -/*! \fn QJSValue QJSEngine::newQMetaObject<T>() +/*! \fn template <typename T> QJSValue QJSEngine::newQMetaObject() \since 5.8 Creates a JavaScript object that wraps the static QMetaObject associated @@ -710,14 +710,14 @@ bool QJSEngine::convertV2(const QJSValue &value, int type, void *ptr) } } -/*! \fn QJSValue QJSEngine::toScriptValue(const T &value) +/*! \fn template <typename T> QJSValue QJSEngine::toScriptValue(const T &value) Creates a QJSValue with the given \a value. \sa fromScriptValue() */ -/*! \fn T QJSEngine::fromScriptValue(const QJSValue &value) +/*! \fn template <typename T> T QJSEngine::fromScriptValue(const QJSValue &value) Returns the given \a value converted to the template type \c{T}. diff --git a/src/qml/jsapi/qjsvalue.cpp b/src/qml/jsapi/qjsvalue.cpp index c1a135c835..adfa98bd46 100644 --- a/src/qml/jsapi/qjsvalue.cpp +++ b/src/qml/jsapi/qjsvalue.cpp @@ -232,7 +232,7 @@ QJSValue::QJSValue(const QJSValue& other) */ /*! - \fn QJSValue &operator=(QJSValue && other) + \fn QJSValue &QJSValue::operator=(QJSValue && other) Move-assigns \a other to this QJSValue object. */ diff --git a/src/qml/jsruntime/qv4qobjectwrapper.cpp b/src/qml/jsruntime/qv4qobjectwrapper.cpp index 948dcdb24d..9ee357eca5 100644 --- a/src/qml/jsruntime/qv4qobjectwrapper.cpp +++ b/src/qml/jsruntime/qv4qobjectwrapper.cpp @@ -1188,7 +1188,7 @@ static QV4::ReturnedValue CallMethod(const QQmlObjectOrGadget &object, int index } } -/*! +/* Returns the match score for converting \a actual to be of type \a conversionType. A zero score means "perfect match" whereas a higher score is worse. @@ -1345,7 +1345,7 @@ static inline int QMetaObject_methods(const QMetaObject *metaObject) return reinterpret_cast<const Private *>(metaObject->d.data)->methodCount; } -/*! +/* Returns the next related method, if one, or 0. */ static const QQmlPropertyData * RelatedMethod(const QQmlObjectOrGadget &object, @@ -1435,7 +1435,7 @@ static QV4::ReturnedValue CallPrecise(const QQmlObjectOrGadget &object, const QQ } } -/*! +/* Resolve the overloaded method to call. The algorithm works conceptually like this: 1. Resolve the set of overloads it is *possible* to call. Impossible overloads include those that have too many parameters or have parameters 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. */ diff --git a/src/qml/util/qqmlpropertymap.cpp b/src/qml/util/qqmlpropertymap.cpp index b54e8d901a..578c05086f 100644 --- a/src/qml/util/qqmlpropertymap.cpp +++ b/src/qml/util/qqmlpropertymap.cpp @@ -355,7 +355,7 @@ QQmlPropertyMap::QQmlPropertyMap(const QMetaObject *staticMetaObject, QObject *p */ /*! - \fn QQmlPropertyMap::QQmlPropertyMap(DerivedType *derived, QObject *parent) + \fn template<class DerivedType> QQmlPropertyMap::QQmlPropertyMap(DerivedType *derived, QObject *parent) Constructs a bindable map with parent object \a parent. Use this constructor in classes derived from QQmlPropertyMap. |