From fedb2eea6b1e42c9c6a21f772e5c50ef0747f2ba Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Fri, 24 Jul 2015 15:43:11 +0200 Subject: 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 --- src/controls/doc/qtquickcontrols.qdocconf | 26 +++++++++++++--------- .../doc/src/qtquickcontrols-tableview.qdoc | 1 + src/controls/doc/src/qtquickcontrols-treeview.qdoc | 1 + .../doc/src/qtquickcontrolsstyles-index.qdoc | 11 --------- .../src/qtquickcontrolsstyles-tableviewstyle.qdoc | 1 + .../src/qtquickcontrolsstyles-treeviewstyle.qdoc | 1 + 6 files changed, 20 insertions(+), 21 deletions(-) (limited to 'src/controls/doc') diff --git a/src/controls/doc/qtquickcontrols.qdocconf b/src/controls/doc/qtquickcontrols.qdocconf index e8aa0422..33df123f 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 15b99c18..a9c6d22a 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 a9d41b70..6cce13bb 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 94eb6fb4..792f064c 100644 --- a/src/controls/doc/src/qtquickcontrolsstyles-index.qdoc +++ b/src/controls/doc/src/qtquickcontrolsstyles-index.qdoc @@ -124,17 +124,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 diff --git a/src/controls/doc/src/qtquickcontrolsstyles-tableviewstyle.qdoc b/src/controls/doc/src/qtquickcontrolsstyles-tableviewstyle.qdoc index 0b5012f1..c781f903 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 3f4508f4..e98b6cae 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 */ -- cgit v1.2.1