diff options
author | Dominik Holland <dominik.holland@pelagicore.com> | 2019-02-12 11:29:14 +0100 |
---|---|---|
committer | Bramastyo Harimukti Santoso <bramastyo.harimukti.santoso@pelagicore.com> | 2019-02-14 12:28:48 +0000 |
commit | 0f592f5f67af4e664beb850d16deabf4796fcf63 (patch) | |
tree | 199d17b673ca257be90e254feec4c06e17fc8de9 | |
parent | fa4c64bb16fa0adfb7741c2184c4286d22f9e344 (diff) |
[doc] Correctly outline the docs in the generated qhp files
When opening the qhp in assistant or in QtCreator (Contents view) the
Neptune3 content had a lot of broken links and mixed general documentation
with QML type documentation.
This change makes sure to use the same TOC for the "contents" view than
what is used in the index.html and groups the QML type documentation
into a "QML Types" group similar to all other modules.
Change-Id: I129d2e0146312bc929c3bc918ecac7d40ec96ba2
Reviewed-by: Bramastyo Harimukti Santoso <bramastyo.harimukti.santoso@pelagicore.com>
-rw-r--r-- | doc/doc.pro | 3 | ||||
-rw-r--r-- | doc/neptune3ui-project.qdocconf | 11 | ||||
-rw-r--r-- | doc/src/neptune3ui-index.qdoc | 37 | ||||
-rw-r--r-- | doc/src/neptune3ui-toc.qdoc | 6 | ||||
-rw-r--r-- | doc/src/neptune3ui-topics.qdocinc | 65 |
5 files changed, 80 insertions, 42 deletions
diff --git a/doc/doc.pro b/doc/doc.pro index 0d8b598a..1739a2e7 100644 --- a/doc/doc.pro +++ b/doc/doc.pro @@ -1,2 +1,5 @@ TEMPLATE = aux include(doc.pri) + +DISTFILES += \ + src/neptune3ui-topics.qdocinc diff --git a/doc/neptune3ui-project.qdocconf b/doc/neptune3ui-project.qdocconf index 2ba82653..4dc4ccbd 100644 --- a/doc/neptune3ui-project.qdocconf +++ b/doc/neptune3ui-project.qdocconf @@ -18,10 +18,15 @@ qhp.Neptune3UI.filterAttributes = Neptune3UI $QT_VERSION qhp.Neptune3UI.customFilters.Neptune3UI.name = Neptune 3 UI $QT_VERSION qhp.Neptune3UI.customFilters.Neptune3UI.filterAttributes = Neptune3UI $QT_VERSION -qhp.Neptune3UI.subprojects = manual components interfaces -qhp.Neptune3UI.subprojects.manual.title = Neptune 3 UI +qhp.Neptune3UI.subprojects = manual qml +qhp.Neptune3UI.subprojects.manual.title = Topics qhp.Neptune3UI.subprojects.manual.indexTitle = Neptune 3 UI TOC -qhp.Neptune3UI.subprojects.manual.selectors = manual +qhp.Neptune3UI.subprojects.manual.type = manual + +qhp.Neptune3UI.subprojects.qml.title = QML Types +qhp.Neptune3UI.subprojects.qml.indexTitle = Neptune3 QML Types +qhp.Neptune3UI.subprojects.qml.selectors = qmlclass +qhp.Neptune3UI.subprojects.qml.sortPages = true navigation.landingpage = "Neptune 3 UI" navigation.homepage = "Qt Automotive Suite" diff --git a/doc/src/neptune3ui-index.qdoc b/doc/src/neptune3ui-index.qdoc index bdd5b77a..c85d4484 100644 --- a/doc/src/neptune3ui-index.qdoc +++ b/doc/src/neptune3ui-index.qdoc @@ -42,41 +42,6 @@ \section1 Topics - \section2 General - - \list - \li \l {Neptune 3 UI - Overview}{Overview} - \li \l {Neptune 3 UI - Run}{Run} - \li \l {Neptune 3 UI - Configuring Screens on Embedded Linux}{Configuring Screens on Embedded Linux} - \endlist - - \section2 UI Insights - - \list - \li \l {Neptune 3 UI - System UI}{System UI} - \li \l {Neptune 3 UI - System Dialog}{System Dialog} - \li \l {Neptune 3 UI - Remote Settings Server}{Remote Settings Server} - \endlist - - \section2 Application Insights - - \list - \li \l {Neptune 3 UI - Application Architecture}{Application Architecture} - \li \l {Neptune 3 UI - Application Anatomy}{Application Anatomy} - \li \l {Neptune 3 UI - Application Development}{Application Development} - \li \l {Neptune 3 UI - Application Popups}{Application Popups} - \li \l {Neptune 3 UI - Application Requests}{Application Requests} - \li \l {Neptune 3 UI - 3D Integration}{3D Integration} - \li \l {Neptune 3 UI - Map Application}{Map Application} - \li \l {Neptune 3 UI - General Settings Application}{General Settings Application} - \endlist - - \section1 Reference - - \list - \li \l {Neptune 3 UI - Components and Interfaces}{Components and Interfaces} - \endlist - - + \include neptune3ui-topics.qdocinc content */ diff --git a/doc/src/neptune3ui-toc.qdoc b/doc/src/neptune3ui-toc.qdoc index 0ae10f14..eb5d36a5 100644 --- a/doc/src/neptune3ui-toc.qdoc +++ b/doc/src/neptune3ui-toc.qdoc @@ -32,10 +32,10 @@ \title Neptune 3 UI TOC + \omit This file is used only for generating the TOC for the help file to be displayed in the Qt Creator Help mode Contents view. + \endomit - \list - \li \l{Neptune 3 UI} - \endlist + \include neptune3ui-topics.qdocinc content */ diff --git a/doc/src/neptune3ui-topics.qdocinc b/doc/src/neptune3ui-topics.qdocinc new file mode 100644 index 00000000..f84e219e --- /dev/null +++ b/doc/src/neptune3ui-topics.qdocinc @@ -0,0 +1,65 @@ +/**************************************************************************** +** +** Copyright (C) 2019 Luxoft Sweden AB +** Copyright (C) 2018 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Automotive Suite. +** +** $QT_BEGIN_LICENSE:FDL-QTAS$ +** Commercial License Usage +** Licensees holding valid commercial Qt Automotive Suite licenses may use +** this file in accordance with the commercial license agreement provided +** with the Software or, alternatively, in accordance with the terms +** contained in a written agreement between you and The Qt Company. For +** licensing terms and conditions see https://www.qt.io/terms-conditions. +** For further information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ +/*! +//! [content] +\section2 General + +\list +\li \l {Neptune 3 UI - Overview}{Overview} +\li \l {Neptune 3 UI - Run}{Run} +\li \l {Neptune 3 UI - Configuring Screens on Embedded Linux}{Configuring Screens on Embedded Linux} +\endlist + +\section2 UI Insights + +\list + \li \l {Neptune 3 UI - System UI}{System UI} + \li \l {Neptune 3 UI - System Dialog}{System Dialog} + \li \l {Neptune 3 UI - Remote Settings Server}{Remote Settings Server} +\endlist + +\section2 Application Insights + +\list + \li \l {Neptune 3 UI - Application Architecture}{Application Architecture} + \li \l {Neptune 3 UI - Application Anatomy}{Application Anatomy} + \li \l {Neptune 3 UI - Application Development}{Application Development} + \li \l {Neptune 3 UI - Application Popups}{Application Popups} + \li \l {Neptune 3 UI - Application Requests}{Application Requests} + \li \l {Neptune 3 UI - 3D Integration}{3D Integration} + \li \l {Neptune 3 UI - Map Application}{Map Application} + \li \l {Neptune 3 UI - General Settings Application}{General Settings Application} +\endlist + +\section1 Reference + +\list + \li \l {Neptune 3 UI - Components and Interfaces}{Components and Interfaces} +\endlist +//! [content] +*/ |