diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2019-07-18 15:18:31 +0200 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2019-08-29 13:04:58 +0200 |
| commit | 1dc3f4c24583e14dee3c5fa650a8ac239b953458 (patch) | |
| tree | bae8b90629c3215ec254221388aad85813237b32 /src/imports | |
| parent | da04b1d716617fbe4a2d93dc5a51f38dbd03a5b8 (diff) | |
Doc: Fix documentation warnings for qtdeclarative
After recent changes to QDoc, it now correctly warns about missing
documentation for QML method parameters - fix all of these and also
do some minor language editing.
Remove duplicated entries for
- \qmlmodule Qt.labs.qmlmodels
- \group qtjavascript
as they were causing issues.
Change-Id: I55cd670cc8a0cc6427cdb7945dbd7c28ea94f796
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Diffstat (limited to 'src/imports')
| -rw-r--r-- | src/imports/folderlistmodel/qquickfolderlistmodel.cpp | 8 | ||||
| -rw-r--r-- | src/imports/settings/qqmlsettings.cpp | 2 |
2 files changed, 5 insertions, 5 deletions
diff --git a/src/imports/folderlistmodel/qquickfolderlistmodel.cpp b/src/imports/folderlistmodel/qquickfolderlistmodel.cpp index affb1e9fe2..2040fb5f0c 100644 --- a/src/imports/folderlistmodel/qquickfolderlistmodel.cpp +++ b/src/imports/folderlistmodel/qquickfolderlistmodel.cpp @@ -852,7 +852,7 @@ QQuickFolderListModel::Status QQuickFolderListModel::status() const \qmlproperty bool FolderListModel::sortCaseSensitive \since 5.12 - If set to true, the sort is case sensitive. This property is true by default. + If set to \c true, the sort is case sensitive. This property is \c true by default. */ bool QQuickFolderListModel::sortCaseSensitive() const @@ -874,8 +874,8 @@ void QQuickFolderListModel::setSortCaseSensitive(bool on) /*! \qmlmethod var FolderListModel::get(int index, string property) - Get the folder property for the given index. The following properties - are available. + Returns the folder \a property for the given \a index. The following properties + are available: \list \li \c fileName @@ -902,7 +902,7 @@ QVariant QQuickFolderListModel::get(int idx, const QString &property) const \qmlmethod int FolderListModel::indexOf(url file) \since 5.6 - Get the index of the given file URL if the model contains it, + Returns the index of the given \a file URL if the model contains it, or -1 if not. */ int QQuickFolderListModel::indexOf(const QUrl &file) const diff --git a/src/imports/settings/qqmlsettings.cpp b/src/imports/settings/qqmlsettings.cpp index 287a70363a..d43f9bafb7 100644 --- a/src/imports/settings/qqmlsettings.cpp +++ b/src/imports/settings/qqmlsettings.cpp @@ -473,7 +473,7 @@ QVariant QQmlSettings::value(const QString &key, const QVariant &defaultValue) c /*! \qmlmethod Settings::setValue(string key, var value) - Sets the value of setting key to value. If the key already exists, + Sets the value of setting \a key to \a value. If the key already exists, the previous value is overwritten. \since Qt 5.12 |