From 8ee511bcd9f1376e9995ab3f30f6415ad60b7c05 Mon Sep 17 00:00:00 2001 From: Venugopal Shivashankar Date: Thu, 14 Nov 2019 08:27:10 +0100 Subject: 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 --- src/imports/calendar/qquickcalendar.cpp | 2 +- src/imports/calendar/qquickcalendarmodel.cpp | 2 +- src/imports/calendar/qquickdayofweekrow.cpp | 2 +- src/imports/calendar/qquickmonthgrid.cpp | 2 +- src/imports/calendar/qquickweeknumbercolumn.cpp | 2 +- src/imports/controls/doc/qtquickcontrols.qdocconf | 2 +- .../controls/doc/src/qtquickcontrols2-customize.qdoc | 5 +++-- .../controls/doc/src/qtquickcontrols2-imagine.qdoc | 2 +- .../controls/doc/src/qtquickcontrols2-styles.qdoc | 14 ++++++++------ src/imports/platform/qquickplatformcolordialog.cpp | 2 +- src/imports/platform/qquickplatformdialog.cpp | 2 +- src/imports/platform/qquickplatformfiledialog.cpp | 2 +- src/imports/platform/qquickplatformfolderdialog.cpp | 2 +- src/imports/platform/qquickplatformfontdialog.cpp | 2 +- src/imports/platform/qquickplatformmenu.cpp | 4 ++-- src/imports/platform/qquickplatformmenubar.cpp | 2 +- src/imports/platform/qquickplatformmenuitem.cpp | 2 +- src/imports/platform/qquickplatformmenuitemgroup.cpp | 2 +- src/imports/platform/qquickplatformmenuseparator.cpp | 2 +- src/imports/platform/qquickplatformmessagedialog.cpp | 2 +- src/imports/platform/qquickplatformstandardpaths.cpp | 20 +++++++++++++++++--- .../platform/qquickplatformsystemtrayicon.cpp | 2 +- 22 files changed, 48 insertions(+), 31 deletions(-) (limited to 'src/imports') diff --git a/src/imports/calendar/qquickcalendar.cpp b/src/imports/calendar/qquickcalendar.cpp index 2ad449f1..3b16d7f9 100644 --- a/src/imports/calendar/qquickcalendar.cpp +++ b/src/imports/calendar/qquickcalendar.cpp @@ -41,7 +41,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype Calendar \inherits QObject - \instantiates QQuickCalendar +//! \instantiates QQuickCalendar \inqmlmodule Qt.labs.calendar \brief A calendar namespace. diff --git a/src/imports/calendar/qquickcalendarmodel.cpp b/src/imports/calendar/qquickcalendarmodel.cpp index 053a4a5f..ee5e0bd3 100644 --- a/src/imports/calendar/qquickcalendarmodel.cpp +++ b/src/imports/calendar/qquickcalendarmodel.cpp @@ -43,7 +43,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype CalendarModel \inherits QAbstractListModel - \instantiates QQuickCalendarModel +//! \instantiates QQuickCalendarModel \inqmlmodule Qt.labs.calendar \brief A calendar model. diff --git a/src/imports/calendar/qquickdayofweekrow.cpp b/src/imports/calendar/qquickdayofweekrow.cpp index da3264f9..d5432f8e 100644 --- a/src/imports/calendar/qquickdayofweekrow.cpp +++ b/src/imports/calendar/qquickdayofweekrow.cpp @@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype DayOfWeekRow \inherits Control - \instantiates QQuickDayOfWeekRow +//! \instantiates QQuickDayOfWeekRow \inqmlmodule Qt.labs.calendar \brief A row of names for the days in a week. diff --git a/src/imports/calendar/qquickmonthgrid.cpp b/src/imports/calendar/qquickmonthgrid.cpp index 46b18db6..966b0c60 100644 --- a/src/imports/calendar/qquickmonthgrid.cpp +++ b/src/imports/calendar/qquickmonthgrid.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype MonthGrid \inherits Control - \instantiates QQuickMonthGrid +//! \instantiates QQuickMonthGrid \inqmlmodule Qt.labs.calendar \brief A grid of days for a calendar month. diff --git a/src/imports/calendar/qquickweeknumbercolumn.cpp b/src/imports/calendar/qquickweeknumbercolumn.cpp index c1179879..6c661274 100644 --- a/src/imports/calendar/qquickweeknumbercolumn.cpp +++ b/src/imports/calendar/qquickweeknumbercolumn.cpp @@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype WeekNumberColumn \inherits Control - \instantiates QQuickWeekNumberColumn +//! \instantiates QQuickWeekNumberColumn \inqmlmodule Qt.labs.calendar \brief A column of week numbers. diff --git a/src/imports/controls/doc/qtquickcontrols.qdocconf b/src/imports/controls/doc/qtquickcontrols.qdocconf index f6798f1f..d52aceb8 100644 --- a/src/imports/controls/doc/qtquickcontrols.qdocconf +++ b/src/imports/controls/doc/qtquickcontrols.qdocconf @@ -33,7 +33,7 @@ qhp.QtQuickControls.subprojects.examples.title = Examples qhp.QtQuickControls.subprojects.examples.indexTitle = Qt Quick Controls Examples qhp.QtQuickControls.subprojects.examples.selectors = fake:example -depends = qtcore qtgui qtdoc qtqml qtquick qtquickdialogs qtquickcontrols1 qtquickextras qmake qtsql qtwidgets qtlabscalendar qtlabsplatform qtgraphicaleffects +depends = qtcore qtgui qtdoc qtqml qtqmlmodels qtquick qtquickdialogs qtquickcontrols1 qtquickextras qmake qtsql qtwidgets qtlabscalendar qtlabsplatform qtgraphicaleffects # Specify the install path under QT_INSTALL_EXAMPLES # Note: paths passed to \example command must contain the parent directory, e.g. diff --git a/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc index cd06a456..ca1ecf48 100644 --- a/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc +++ b/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc @@ -166,7 +166,8 @@ By default, the styling system uses the Default style as a fallback for controls that aren't implemented. To customize or extend any other built-in - style, it is possible to specify a different fallback style using \l QQuickStyle. + style, it is possible to specify a different fallback style using + \l[QtQuickControls2]{QQuickStyle}. What this means is that you can implement as many controls as you like for your custom style, and place them almost anywhere. It also allows users to @@ -175,7 +176,7 @@ \section3 Previewing Custom Styles in Qt Quick Designer Using the approach above, it is possible to preview a custom style - in \l {Using Qt Quick Designer}{Qt Quick Designer}. In order to do so, + in Qt Quick Designer. In order to do so, ensure that the project has a \l {Qt Quick Controls Configuration File}{qtquickcontrols2.conf} file, and that the following entry exists: diff --git a/src/imports/controls/doc/src/qtquickcontrols2-imagine.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-imagine.qdoc index 6e15762d..ac2e9cc1 100644 --- a/src/imports/controls/doc/src/qtquickcontrols2-imagine.qdoc +++ b/src/imports/controls/doc/src/qtquickcontrols2-imagine.qdoc @@ -2478,7 +2478,7 @@ The Imagine style supports palette customization via the \l {Control::}{palette} property and the \l {Palette Configuration}{qtquickcontrols2.conf} file. - As with other styles, the exact \l {palette QML Basic Type}{palette roles} + As with other styles, the exact \l[QML]{palette}{palette roles} that the Imagine style uses are style-dependent. However, as most of the visual appearance of controls (for example: backgrounds) are managed through image assets, only the roles that are typically used for text will have an effect. diff --git a/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc index 75e59f42..ddf41771 100644 --- a/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc +++ b/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc @@ -70,15 +70,15 @@ \section1 Using Styles in Qt Quick Controls In order to run an application with a specific style, either configure the - style using \l QQuickStyle in C++, pass a command line argument, or set an + style using \l[CPP]{QQuickStyle} in C++, pass a command line argument, or set an environment variable. Alternatively, the preferred style and style-specific attributes can be specified in a configuration file. The priority of these approaches follows the order they are listed below, - from highest to lowest. That is, using QQuickStyle to set the style will + from highest to lowest. That is, using \c QQuickStyle to set the style will always take priority over using the command line argument, for example. - \warning When resolving a given style name to an absolute path, QQuickStyle + \warning When resolving a given style name to an absolute path, \c QQuickStyle may search the root resource directory (\c {:}). Consequently, make sure that your resource directories are named differently than the names of the styles that your application supports. Otherwise, the styles may not load. @@ -87,14 +87,16 @@ \section2 Using QQuickStyle in C++ - \l QQuickStyle provides C++ API for configuring a specific style. The following - example runs a Qt Quick Controls application with the Material style: + \l[CPP]{QQuickStyle} provides C++ API for configuring a specific + style. The following example runs a Qt Quick Controls application + with the Material style: \code QQuickStyle::setStyle("Material"); \endcode - See the detailed description of \l QQuickStyle for more details. + See the detailed description of \l[CPP]{QQuickStyle} for more + details. \section2 Command line argument diff --git a/src/imports/platform/qquickplatformcolordialog.cpp b/src/imports/platform/qquickplatformcolordialog.cpp index 0b8cfd97..04a5e079 100644 --- a/src/imports/platform/qquickplatformcolordialog.cpp +++ b/src/imports/platform/qquickplatformcolordialog.cpp @@ -41,7 +41,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype ColorDialog \inherits Dialog - \instantiates QQuickPlatformColorDialog +//! \instantiates QQuickPlatformColorDialog \inqmlmodule Qt.labs.platform \since 5.8 \brief A native color dialog. diff --git a/src/imports/platform/qquickplatformdialog.cpp b/src/imports/platform/qquickplatformdialog.cpp index 41fc1316..fc3c0429 100644 --- a/src/imports/platform/qquickplatformdialog.cpp +++ b/src/imports/platform/qquickplatformdialog.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype Dialog \inherits QtObject - \instantiates QQuickPlatformDialog +//! \instantiates QQuickPlatformDialog \inqmlmodule Qt.labs.platform \since 5.8 \brief The base class of native dialogs. diff --git a/src/imports/platform/qquickplatformfiledialog.cpp b/src/imports/platform/qquickplatformfiledialog.cpp index 9c1eb684..6f212bef 100644 --- a/src/imports/platform/qquickplatformfiledialog.cpp +++ b/src/imports/platform/qquickplatformfiledialog.cpp @@ -43,7 +43,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype FileDialog \inherits Dialog - \instantiates QQuickPlatformFileDialog +//! \instantiates QQuickPlatformFileDialog \inqmlmodule Qt.labs.platform \since 5.8 \brief A native file dialog. diff --git a/src/imports/platform/qquickplatformfolderdialog.cpp b/src/imports/platform/qquickplatformfolderdialog.cpp index 512dce52..b9ea0184 100644 --- a/src/imports/platform/qquickplatformfolderdialog.cpp +++ b/src/imports/platform/qquickplatformfolderdialog.cpp @@ -41,7 +41,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype FolderDialog \inherits Dialog - \instantiates QQuickPlatformFolderDialog +//! \instantiates QQuickPlatformFolderDialog \inqmlmodule Qt.labs.platform \since 5.8 \brief A native folder dialog. diff --git a/src/imports/platform/qquickplatformfontdialog.cpp b/src/imports/platform/qquickplatformfontdialog.cpp index ecd6ba4a..f3eca2c3 100644 --- a/src/imports/platform/qquickplatformfontdialog.cpp +++ b/src/imports/platform/qquickplatformfontdialog.cpp @@ -41,7 +41,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype FontDialog \inherits Dialog - \instantiates QQuickPlatformFontDialog +//! \instantiates QQuickPlatformFontDialog \inqmlmodule Qt.labs.platform \since 5.8 \brief A native font dialog. diff --git a/src/imports/platform/qquickplatformmenu.cpp b/src/imports/platform/qquickplatformmenu.cpp index 844fbbd9..1f5f52d7 100644 --- a/src/imports/platform/qquickplatformmenu.cpp +++ b/src/imports/platform/qquickplatformmenu.cpp @@ -63,7 +63,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype Menu \inherits QtObject - \instantiates QQuickPlatformMenu +//! \instantiates QQuickPlatformMenu \inqmlmodule Qt.labs.platform \since 5.8 \brief A native menu. @@ -127,7 +127,7 @@ QT_BEGIN_NAMESPACE \section2 Dynamically Generating Menu Items It is possible to dynamically generate menu items. One of the easiest ways - to do so is with \l Instantiator. For example, to implement a + to do so is with \l[QtQml]{Instantiator}. For example, to implement a "Recent Files" submenu, where the items are based on a list of files stored in settings, the following code could be used: diff --git a/src/imports/platform/qquickplatformmenubar.cpp b/src/imports/platform/qquickplatformmenubar.cpp index 4487b9a7..99757829 100644 --- a/src/imports/platform/qquickplatformmenubar.cpp +++ b/src/imports/platform/qquickplatformmenubar.cpp @@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype MenuBar \inherits QtObject - \instantiates QQuickPlatformMenuBar +//! \instantiates QQuickPlatformMenuBar \inqmlmodule Qt.labs.platform \since 5.8 \brief A native menubar. diff --git a/src/imports/platform/qquickplatformmenuitem.cpp b/src/imports/platform/qquickplatformmenuitem.cpp index d657fd12..fa3fdafb 100644 --- a/src/imports/platform/qquickplatformmenuitem.cpp +++ b/src/imports/platform/qquickplatformmenuitem.cpp @@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype MenuItem \inherits QtObject - \instantiates QQuickPlatformMenuItem +//! \instantiates QQuickPlatformMenuItem \inqmlmodule Qt.labs.platform \since 5.8 \brief A native menu item. diff --git a/src/imports/platform/qquickplatformmenuitemgroup.cpp b/src/imports/platform/qquickplatformmenuitemgroup.cpp index f07d0a1b..7e091881 100644 --- a/src/imports/platform/qquickplatformmenuitemgroup.cpp +++ b/src/imports/platform/qquickplatformmenuitemgroup.cpp @@ -42,7 +42,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype MenuItemGroup \inherits QtObject - \instantiates QQuickPlatformMenuItemGroup +//! \instantiates QQuickPlatformMenuItemGroup \inqmlmodule Qt.labs.platform \since 5.8 \brief A group for managing native menu items. diff --git a/src/imports/platform/qquickplatformmenuseparator.cpp b/src/imports/platform/qquickplatformmenuseparator.cpp index 34767ff6..f29d5b9e 100644 --- a/src/imports/platform/qquickplatformmenuseparator.cpp +++ b/src/imports/platform/qquickplatformmenuseparator.cpp @@ -41,7 +41,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype MenuSeparator \inherits MenuItem - \instantiates QQuickPlatformMenuSeparator +//! \instantiates QQuickPlatformMenuSeparator \inqmlmodule Qt.labs.platform \since 5.8 \brief A native menu separator. diff --git a/src/imports/platform/qquickplatformmessagedialog.cpp b/src/imports/platform/qquickplatformmessagedialog.cpp index ffc4b296..075b4d62 100644 --- a/src/imports/platform/qquickplatformmessagedialog.cpp +++ b/src/imports/platform/qquickplatformmessagedialog.cpp @@ -43,7 +43,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype MessageDialog \inherits Dialog - \instantiates QQuickPlatformMessageDialog +//! \instantiates QQuickPlatformMessageDialog \inqmlmodule Qt.labs.platform \since 5.8 \brief A native message dialog. 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 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 Qt.labs.platform::StandardPaths::locateAll(StandardLocation type, string fileName, LocateOptions options = LocateFile) + \qmlmethod list Qt.labs.platform::StandardPaths::locateAll(StandardLocation type, string fileName, LocateOptions options) + + \include standardpath/functiondocs.qdocinc locateAll \sa QStandardPaths::locateAll() */ @@ -129,6 +137,8 @@ QList 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 Qt.labs.platform::StandardPaths::standardLocations(StandardLocation type) + \include standardpath/functiondocs.qdocinc standardLocations + \sa QStandardPaths::standardLocations() */ QList QQuickPlatformStandardPaths::standardLocations(QStandardPaths::StandardLocation type) @@ -149,6 +161,8 @@ QList 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) diff --git a/src/imports/platform/qquickplatformsystemtrayicon.cpp b/src/imports/platform/qquickplatformsystemtrayicon.cpp index 202bc3bf..da483822 100644 --- a/src/imports/platform/qquickplatformsystemtrayicon.cpp +++ b/src/imports/platform/qquickplatformsystemtrayicon.cpp @@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype SystemTrayIcon \inherits QtObject - \instantiates QQuickPlatformSystemTrayIcon +//! \instantiates QQuickPlatformSystemTrayIcon \inqmlmodule Qt.labs.platform \since 5.8 \brief A system tray icon. -- cgit v1.2.3