diff options
| author | Topi Reinio <topi.reinio@digia.com> | 2015-07-24 15:43:11 +0200 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@digia.com> | 2015-08-05 09:52:15 +0000 |
| commit | fedb2eea6b1e42c9c6a21f772e5c50ef0747f2ba (patch) | |
| tree | 81a56fa2b493eacd5668dd183b01b08ade4dcfdf | |
| parent | c717082c098bbfc96848457436ca83db7b83e4c8 (diff) | |
Doc: Create proper QHP TOC entries for QML types, examples and tutorials
QDoc now supports using a \group name as a selector for QHP
subprojects. Use this to have the correct division of
Qt Quick Controls and Controls Styles QML types, as well as
a TOC entry for examples and tutorials.
Change-Id: I8e4b44c8876fd6bb3b2baebd956d6dc5d5223715
Reviewed-by: Mitch Curtis <mitch.curtis@theqtcompany.com>
24 files changed, 38 insertions, 22 deletions
diff --git a/src/controls/ApplicationWindow.qml b/src/controls/ApplicationWindow.qml index 542cfe4e2..40334f887 100644 --- a/src/controls/ApplicationWindow.qml +++ b/src/controls/ApplicationWindow.qml @@ -45,6 +45,7 @@ import QtQuick.Controls.Private 1.0 \since 5.1 \inqmlmodule QtQuick.Controls \ingroup applicationwindow + \ingroup controls \brief Provides a top-level application window. \image applicationwindow.png diff --git a/src/controls/Menu.qml b/src/controls/Menu.qml index 7334c28cd..95378670a 100644 --- a/src/controls/Menu.qml +++ b/src/controls/Menu.qml @@ -44,6 +44,7 @@ import QtQuick.Controls.Private 1.0 \inqmlmodule QtQuick.Controls \since 5.1 \ingroup menus + \ingroup controls \brief Provides a menu component for use as a context menu, popup menu, or as part of a menu bar. diff --git a/src/controls/MenuBar.qml b/src/controls/MenuBar.qml index 0d9f8ee84..26533574c 100644 --- a/src/controls/MenuBar.qml +++ b/src/controls/MenuBar.qml @@ -44,6 +44,7 @@ import QtQuick.Controls.Private 1.0 \inqmlmodule QtQuick.Controls \since 5.1 \ingroup applicationwindow + \ingroup controls \brief Provides a horizontal menu bar. \image menubar.png diff --git a/src/controls/Private/AbstractCheckable.qml b/src/controls/Private/AbstractCheckable.qml index 42abebe58..bca626e09 100644 --- a/src/controls/Private/AbstractCheckable.qml +++ b/src/controls/Private/AbstractCheckable.qml @@ -41,7 +41,6 @@ import QtQuick.Controls.Private 1.0 /*! \qmltype AbstractCheckable \inqmlmodule QtQuick.Controls - \ingroup controls \brief An abstract representation of a checkable control with a label \qmlabstract \internal diff --git a/src/controls/ScrollView.qml b/src/controls/ScrollView.qml index 5c21848ff..74d5ee7dd 100644 --- a/src/controls/ScrollView.qml +++ b/src/controls/ScrollView.qml @@ -44,6 +44,7 @@ import QtQuick.Controls.Styles 1.1 \inqmlmodule QtQuick.Controls \since 5.1 \ingroup views + \ingroup controls \brief Provides a scrolling view within another Item. \image scrollview.png diff --git a/src/controls/SplitView.qml b/src/controls/SplitView.qml index 41c50329a..c2e361acd 100644 --- a/src/controls/SplitView.qml +++ b/src/controls/SplitView.qml @@ -45,6 +45,7 @@ import QtQuick.Window 2.1 \inqmlmodule QtQuick.Controls \since 5.1 \ingroup views + \ingroup controls \brief Lays out items with a draggable splitter between each item. \image splitview.png diff --git a/src/controls/StackView.qml b/src/controls/StackView.qml index 5f774969b..7e4c0f666 100644 --- a/src/controls/StackView.qml +++ b/src/controls/StackView.qml @@ -42,6 +42,7 @@ import QtQuick.Controls.Private 1.0 \qmltype StackView \inherits Item \ingroup views + \ingroup controls \inqmlmodule QtQuick.Controls \since 5.1 diff --git a/src/controls/StackViewDelegate.qml b/src/controls/StackViewDelegate.qml index c837c2815..a1dacb215 100644 --- a/src/controls/StackViewDelegate.qml +++ b/src/controls/StackViewDelegate.qml @@ -39,6 +39,7 @@ import QtQuick 2.2 /*! \qmltype StackViewDelegate \inqmlmodule QtQuick.Controls + \ingroup controls \since 5.1 \brief A delegate used by StackView for loading transitions. diff --git a/src/controls/StatusBar.qml b/src/controls/StatusBar.qml index f151a3ac4..468d35872 100644 --- a/src/controls/StatusBar.qml +++ b/src/controls/StatusBar.qml @@ -43,6 +43,7 @@ import QtQuick.Controls.Private 1.0 \inqmlmodule QtQuick.Controls \since 5.1 \ingroup applicationwindow + \ingroup controls \brief Contains status information in your app. The common way of using StatusBar is in relation to \l ApplicationWindow. diff --git a/src/controls/Styles/Base/ScrollViewStyle.qml b/src/controls/Styles/Base/ScrollViewStyle.qml index f34786469..1a626423e 100644 --- a/src/controls/Styles/Base/ScrollViewStyle.qml +++ b/src/controls/Styles/Base/ScrollViewStyle.qml @@ -43,6 +43,7 @@ import QtQuick.Controls.Private 1.0 \inqmlmodule QtQuick.Controls.Styles \since 5.1 \ingroup viewsstyling + \ingroup controlsstyling \brief Provides custom styling for ScrollView */ Style { diff --git a/src/controls/Styles/Base/TabViewStyle.qml b/src/controls/Styles/Base/TabViewStyle.qml index 4842c39a3..94cc1240e 100644 --- a/src/controls/Styles/Base/TabViewStyle.qml +++ b/src/controls/Styles/Base/TabViewStyle.qml @@ -43,6 +43,7 @@ import QtQuick.Controls.Private 1.0 \inqmlmodule QtQuick.Controls.Styles \since 5.1 \ingroup viewsstyling + \ingroup controlsstyling \brief Provides custom styling for TabView \qml diff --git a/src/controls/Tab.qml b/src/controls/Tab.qml index f5d02cf3a..07a4cd9e4 100644 --- a/src/controls/Tab.qml +++ b/src/controls/Tab.qml @@ -41,6 +41,7 @@ import QtQuick 2.2 \inqmlmodule QtQuick.Controls \since 5.1 \ingroup viewaddons + \ingroup controls \brief Tab represents the content of a tab in a TabView. A Tab item inherits from Loader and provides a similar diff --git a/src/controls/TabView.qml b/src/controls/TabView.qml index bd043be9f..f7a8324a5 100644 --- a/src/controls/TabView.qml +++ b/src/controls/TabView.qml @@ -43,6 +43,7 @@ import QtQuick.Controls.Private 1.0 \inqmlmodule QtQuick.Controls \since 5.1 \ingroup views + \ingroup controls \brief A control that allows the user to select one of multiple stacked items. \image tabview.png diff --git a/src/controls/TableViewColumn.qml b/src/controls/TableViewColumn.qml index 9bcdfe6d5..3f5a84681 100644 --- a/src/controls/TableViewColumn.qml +++ b/src/controls/TableViewColumn.qml @@ -41,6 +41,7 @@ import QtQuick 2.2 \inqmlmodule QtQuick.Controls \since 5.1 \ingroup viewitems + \ingroup controls \brief Used to define columns in a \l TableView or in a \l TreeView. \image tableview.png diff --git a/src/controls/ToolBar.qml b/src/controls/ToolBar.qml index 48f62f167..f5d0a994a 100644 --- a/src/controls/ToolBar.qml +++ b/src/controls/ToolBar.qml @@ -43,6 +43,7 @@ import QtQuick.Controls.Private 1.0 \inqmlmodule QtQuick.Controls \since 5.1 \ingroup applicationwindow + \ingroup controls \brief Contains ToolButton and related controls. \image toolbar.png diff --git a/src/controls/doc/qtquickcontrols.qdocconf b/src/controls/doc/qtquickcontrols.qdocconf index e8aa04226..33df123fc 100644 --- a/src/controls/doc/qtquickcontrols.qdocconf +++ b/src/controls/doc/qtquickcontrols.qdocconf @@ -17,16 +17,22 @@ qhp.QtQuickControls.filterAttributes = qtquickcontrols $QT_VERSION qtrefdoc qhp.QtQuickControls.customFilters.Qt.name = QtQuickControls $QT_VERSION qhp.QtQuickControls.customFilters.Qt.filterAttributes = qtquickcontrols $QT_VERSION -qhp.QtQuickControls.subprojects = qtquickcontrolsqmltypes qtquickcontrolsstyles - -qhp.QtQuickControls.subprojects.qtquickcontrolsqmltypes.title = Controls QML Types -qhp.QtQuickControls.subprojects.qtquickcontrolsqmltypes.indexTitle = Qt Quick Controls QML Types -qhp.QtQuickControls.subprojects.qtquickcontrolsqmltypes.selectors = qmlclass # cannot choose qmltypes from a specific group QTBUG-32985 -qhp.QtQuickControls.subprojects.qtquickcontrolsqmltypes.sortPages = true - -qhp.QtQuickControls.subprojects.qtquickcontrolsstyles.title = Qt Quick Controls Styles Structure -qhp.QtQuickControls.subprojects.qtquickcontrolsstyles.indexTitle = Qt Quick Controls Styles Structure -qhp.QtQuickControls.subprojects.qtquickcontrolsstyles.type = manual +qhp.QtQuickControls.subprojects = qqcqmltypes qqcstylesqmltypes qqcexamples + +qhp.QtQuickControls.subprojects.qqcqmltypes.title = Controls QML Types +qhp.QtQuickControls.subprojects.qqcqmltypes.indexTitle = Qt Quick Controls QML Types +qhp.QtQuickControls.subprojects.qqcqmltypes.selectors = group:controls +qhp.QtQuickControls.subprojects.qqcqmltypes.sortPages = true + +qhp.QtQuickControls.subprojects.qqcstylesqmltypes.title = Controls Styles QML Types +qhp.QtQuickControls.subprojects.qqcstylesqmltypes.indexTitle = Qt Quick Controls Styles QML Types +qhp.QtQuickControls.subprojects.qqcstylesqmltypes.selectors = group:controlsstyling +qhp.QtQuickControls.subprojects.qqcstylesqmltypes.sortPages = true + +qhp.QtQuickControls.subprojects.qqcexamples.title = Examples and Tutorials +qhp.QtQuickControls.subprojects.qqcexamples.indexTitle = Qt Quick Controls Examples +qhp.QtQuickControls.subprojects.qqcexamples.selectors = doc:example group:stylingtutorials +qhp.QtQuickControls.subprojects.qqcexamples.sortpages = true depends = qtcore qtdoc qtgui qtwidgets qtqml qtquick qtquicklayouts qtquickdialogs qtquickextras diff --git a/src/controls/doc/src/qtquickcontrols-tableview.qdoc b/src/controls/doc/src/qtquickcontrols-tableview.qdoc index 15b99c18a..a9c6d22a9 100644 --- a/src/controls/doc/src/qtquickcontrols-tableview.qdoc +++ b/src/controls/doc/src/qtquickcontrols-tableview.qdoc @@ -31,6 +31,7 @@ \inherits BasicTableView \since 5.1 \ingroup views + \ingroup controls \brief Provides a list view with scroll bars, styling and header sections. \image tableview.png diff --git a/src/controls/doc/src/qtquickcontrols-treeview.qdoc b/src/controls/doc/src/qtquickcontrols-treeview.qdoc index a9d41b706..6cce13bb6 100644 --- a/src/controls/doc/src/qtquickcontrols-treeview.qdoc +++ b/src/controls/doc/src/qtquickcontrols-treeview.qdoc @@ -31,6 +31,7 @@ \inherits BasicTableView \since 5.5 \ingroup views + \ingroup controls \brief Provides a tree view with scroll bars, styling and header sections. \image treeview.png diff --git a/src/controls/doc/src/qtquickcontrolsstyles-index.qdoc b/src/controls/doc/src/qtquickcontrolsstyles-index.qdoc index 94eb6fb49..792f064ca 100644 --- a/src/controls/doc/src/qtquickcontrolsstyles-index.qdoc +++ b/src/controls/doc/src/qtquickcontrolsstyles-index.qdoc @@ -125,17 +125,6 @@ */ /*! - \page qtquickcontrolsstyles-structure.html - \title Qt Quick Controls Styles Structure - \list - \li \l{Qt Quick Controls Styles} - \list - \li \l{Qt Quick Controls Styles QML Types}{Styles QMl Types} - \endlist - \endlist -*/ - -/*! \qmlmodule QtQuick.Controls.Styles 1.4 \title Qt Quick Controls Styles QML Types \ingroup qmlmodules diff --git a/src/controls/doc/src/qtquickcontrolsstyles-tableviewstyle.qdoc b/src/controls/doc/src/qtquickcontrolsstyles-tableviewstyle.qdoc index 0b5012f1d..c781f9036 100644 --- a/src/controls/doc/src/qtquickcontrolsstyles-tableviewstyle.qdoc +++ b/src/controls/doc/src/qtquickcontrolsstyles-tableviewstyle.qdoc @@ -31,6 +31,7 @@ \inherits BasicTableViewStyle \since 5.1 \ingroup viewsstyling + \ingroup controlsstyling \brief Provides custom styling for TableView */ diff --git a/src/controls/doc/src/qtquickcontrolsstyles-treeviewstyle.qdoc b/src/controls/doc/src/qtquickcontrolsstyles-treeviewstyle.qdoc index 3f4508f4e..e98b6cae8 100644 --- a/src/controls/doc/src/qtquickcontrolsstyles-treeviewstyle.qdoc +++ b/src/controls/doc/src/qtquickcontrolsstyles-treeviewstyle.qdoc @@ -31,6 +31,7 @@ \inherits BasicTableViewStyle \since 5.5 \ingroup viewsstyling + \ingroup controlsstyling \brief Provides custom styling for TreeView */ diff --git a/src/controls/qquickaction.cpp b/src/controls/qquickaction.cpp index 90a1fd67b..6add916de 100644 --- a/src/controls/qquickaction.cpp +++ b/src/controls/qquickaction.cpp @@ -50,6 +50,7 @@ QT_BEGIN_NAMESPACE \qmltype Action \instantiates QQuickAction \ingroup applicationwindow + \ingroup controls \inqmlmodule QtQuick.Controls \brief Action provides an abstract user interface action that can be bound to items diff --git a/src/controls/qquickmenuitem.cpp b/src/controls/qquickmenuitem.cpp index 8093c5fe5..5fd1c6c54 100644 --- a/src/controls/qquickmenuitem.cpp +++ b/src/controls/qquickmenuitem.cpp @@ -135,6 +135,7 @@ void QQuickMenuBase::setVisualItem(QQuickItem *item) \instantiates QQuickMenuSeparator \inqmlmodule QtQuick.Controls \ingroup menus + \ingroup controls \brief MenuSeparator provides a separator for items inside a menu. \image menu.png @@ -284,6 +285,7 @@ void QQuickMenuText::updateIcon() \qmltype MenuItem \instantiates QQuickMenuItem \ingroup menus + \ingroup controls \inqmlmodule QtQuick.Controls \brief MenuItem provides an item to add in a menu or a menu bar. diff --git a/src/controls/qquickstack.cpp b/src/controls/qquickstack.cpp index 160316562..3524b9ef5 100644 --- a/src/controls/qquickstack.cpp +++ b/src/controls/qquickstack.cpp @@ -42,6 +42,7 @@ QT_BEGIN_NAMESPACE \qmltype Stack \instantiates QQuickStack \inqmlmodule QtQuick.Controls + \ingroup controls \brief Provides attached properties for items pushed onto a StackView. The Stack type provides attached properties for items pushed onto a \l StackView. |