diff options
author | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2019-11-14 08:27:10 +0100 |
---|---|---|
committer | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2019-11-26 13:51:32 +0100 |
commit | 8ee511bcd9f1376e9995ab3f30f6415ad60b7c05 (patch) | |
tree | e5e64bceeb7082297346411bbee492895e96dc92 /src/imports/platform/qquickplatformstandardpaths.cpp | |
parent | f9877da406ad96d82becb15b6eef9b723b8807e3 (diff) |
Doc: Fix qdoc warnings
The warnings were about:
- Undocumented function parameters
- Instances of \instantiates that us an internal class
- A few link issues
Task-number: QTBUG-79827
Change-Id: I60094279c7da6bc446b5c63b7b4924b71cee4672
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/imports/platform/qquickplatformstandardpaths.cpp')
-rw-r--r-- | src/imports/platform/qquickplatformstandardpaths.cpp | 20 |
1 files changed, 17 insertions, 3 deletions
diff --git a/src/imports/platform/qquickplatformstandardpaths.cpp b/src/imports/platform/qquickplatformstandardpaths.cpp index 4687ba69..a6fff1c0 100644 --- a/src/imports/platform/qquickplatformstandardpaths.cpp +++ b/src/imports/platform/qquickplatformstandardpaths.cpp @@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype StandardPaths \inherits QtObject - \instantiates QQuickPlatformStandardPaths +//! \instantiates QQuickPlatformStandardPaths \inqmlmodule Qt.labs.platform \since 5.8 \brief Provides access to the standard system paths. @@ -89,6 +89,8 @@ QObject *QQuickPlatformStandardPaths::create(QQmlEngine *engine, QJSEngine *scri /*! \qmlmethod string Qt.labs.platform::StandardPaths::displayName(StandardLocation type) + \include standardpath/functiondocs.qdocinc displayName + \sa QStandardPaths::displayName() */ QString QQuickPlatformStandardPaths::displayName(QStandardPaths::StandardLocation type) @@ -99,6 +101,8 @@ QString QQuickPlatformStandardPaths::displayName(QStandardPaths::StandardLocatio /*! \qmlmethod url Qt.labs.platform::StandardPaths::findExecutable(string executableName, list<string> paths) + \include standardpath/functiondocs.qdocinc findExecutable + \sa QStandardPaths::findExecutable() */ QUrl QQuickPlatformStandardPaths::findExecutable(const QString &executableName, const QStringList &paths) @@ -107,7 +111,9 @@ QUrl QQuickPlatformStandardPaths::findExecutable(const QString &executableName, } /*! - \qmlmethod url Qt.labs.platform::StandardPaths::locate(StandardLocation type, string fileName, LocateOptions options = LocateFile) + \qmlmethod url Qt.labs.platform::StandardPaths::locate(StandardLocation type, string fileName, LocateOptions options) + + \include standardpath/functiondocs.qdocinc locate \sa QStandardPaths::locate() */ @@ -117,7 +123,9 @@ QUrl QQuickPlatformStandardPaths::locate(QStandardPaths::StandardLocation type, } /*! - \qmlmethod list<url> Qt.labs.platform::StandardPaths::locateAll(StandardLocation type, string fileName, LocateOptions options = LocateFile) + \qmlmethod list<url> Qt.labs.platform::StandardPaths::locateAll(StandardLocation type, string fileName, LocateOptions options) + + \include standardpath/functiondocs.qdocinc locateAll \sa QStandardPaths::locateAll() */ @@ -129,6 +137,8 @@ QList<QUrl> QQuickPlatformStandardPaths::locateAll(QStandardPaths::StandardLocat /*! \qmlmethod void Qt.labs.platform::StandardPaths::setTestModeEnabled(bool testMode) + \include standardpath/functiondocs.qdocinc setTestModeEnabled + \sa QStandardPaths::setTestModeEnabled() */ void QQuickPlatformStandardPaths::setTestModeEnabled(bool testMode) @@ -139,6 +149,8 @@ void QQuickPlatformStandardPaths::setTestModeEnabled(bool testMode) /*! \qmlmethod list<url> Qt.labs.platform::StandardPaths::standardLocations(StandardLocation type) + \include standardpath/functiondocs.qdocinc standardLocations + \sa QStandardPaths::standardLocations() */ QList<QUrl> QQuickPlatformStandardPaths::standardLocations(QStandardPaths::StandardLocation type) @@ -149,6 +161,8 @@ QList<QUrl> QQuickPlatformStandardPaths::standardLocations(QStandardPaths::Stand /*! \qmlmethod url Qt.labs.platform::StandardPaths::writableLocation(StandardLocation type) + \include standardpath/functiondocs.qdocinc writableLocation + \sa QStandardPaths::writableLocation() */ QUrl QQuickPlatformStandardPaths::writableLocation(QStandardPaths::StandardLocation type) |