aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDominik Holland <dominik.holland@pelagicore.com>2018-05-11 20:27:26 +0200
committerRobert Griebl <robert.griebl@pelagicore.com>2018-05-14 15:17:22 +0000
commitdc88c208b36396f195305a2038d5a39d8e0ef2be (patch)
tree4b7e03a365cd2a18c62c911d63a8ca22e456f15f
parent88773675135d61c47cece80c76e02b20de13e06f (diff)
Fix documentation for 5.11
Moved the qtivi doc into the ivicore source folder and the qtgeniviextras in the geniviextras source folder. This is more in line with the rest of qt and also only builds the documentation for the module when the module is actually enabled through the configure system. Also fixed all remaining qdoc errors and moved to the new syntax needed for documenting templates with the new clang-based qdoc. Change-Id: I187bd5848dc79e2231c6c49c9b7a9845edb61817 Reviewed-by: Robert Griebl <robert.griebl@pelagicore.com>
-rw-r--r--src/doc/doc.pro6
-rw-r--r--src/doc/qtgeniviextras/qtgeniviextras.pro10
-rw-r--r--src/doc/qtgeniviextras/qtgeniviextras.qdocconf2
-rw-r--r--src/doc/qtgeniviextras/src/qtgeniviextras.qdoc61
-rw-r--r--src/doc/qtivi/qtivi.pro14
-rw-r--r--src/doc/shared.qdocconf1
-rw-r--r--src/geniviextras/doc/online/qtgeniviextras.qdocconf (renamed from src/doc/qtgeniviextras/online/qtgeniviextras.qdocconf)0
-rw-r--r--src/geniviextras/doc/qtgeniviextras-project.qdocconf (renamed from src/doc/qtgeniviextras/qtgeniviextras-project.qdocconf)10
-rw-r--r--src/geniviextras/doc/qtgeniviextras.qdocconf12
-rw-r--r--src/geniviextras/doc/src/external-resources.qdoc (renamed from src/doc/qtgeniviextras/src/external-resources.qdoc)0
-rw-r--r--src/geniviextras/doc/src/qtgeniviextras.qdoc35
-rw-r--r--src/geniviextras/geniviextras.pro14
-rw-r--r--src/ivicore/doc/QtIviDoc3
-rw-r--r--src/ivicore/doc/images/backendtypes.jpg (renamed from src/doc/qtivi/images/backendtypes.jpg)bin19752 -> 19752 bytes
-rw-r--r--src/ivicore/doc/images/feature_backend.jpg (renamed from src/doc/qtivi/images/feature_backend.jpg)bin18496 -> 18496 bytes
-rw-r--r--src/ivicore/doc/images/qtivi-codesample.png (renamed from src/doc/qtivi/images/qtivi-codesample.png)bin2532 -> 2532 bytes
-rw-r--r--src/ivicore/doc/online/qtivi.qdocconf (renamed from src/doc/qtivi/online/qtivi.qdocconf)0
-rw-r--r--src/ivicore/doc/qtivi-project.qdocconf (renamed from src/doc/qtivi/qtivi-project.qdocconf)22
-rw-r--r--src/ivicore/doc/qtivi.qdocconf (renamed from src/doc/qtivi/qtivi.qdocconf)0
-rw-r--r--src/ivicore/doc/qtivicore.qdocconf11
-rw-r--r--src/ivicore/doc/src/JINJA_LICENSE (renamed from src/doc/qtivi/src/JINJA_LICENSE)0
-rw-r--r--src/ivicore/doc/src/attribute-system.qdoc (renamed from src/doc/qtivi/src/attribute-system.qdoc)0
-rw-r--r--src/ivicore/doc/src/backend-system.qdoc (renamed from src/doc/qtivi/src/backend-system.qdoc)0
-rw-r--r--src/ivicore/doc/src/concepts.qdoc (renamed from src/doc/qtivi/src/concepts.qdoc)0
-rw-r--r--src/ivicore/doc/src/configuration.qdoc (renamed from src/doc/qtivi/src/configuration.qdoc)0
-rw-r--r--src/ivicore/doc/src/extending-qtivi.qdoc (renamed from src/doc/qtivi/src/extending-qtivi.qdoc)6
-rw-r--r--src/ivicore/doc/src/external-resources.qdoc (renamed from src/doc/qtivi/src/external-resources.qdoc)0
-rw-r--r--src/ivicore/doc/src/ivigenerator/filter-reference.qdoc (renamed from src/doc/qtivi/src/ivigenerator/filter-reference.qdoc)0
-rw-r--r--src/ivicore/doc/src/ivigenerator/generator-usage.qdoc (renamed from src/doc/qtivi/src/ivigenerator/generator-usage.qdoc)0
-rw-r--r--src/ivicore/doc/src/ivigenerator/getting-started.qdoc (renamed from src/doc/qtivi/src/ivigenerator/getting-started.qdoc)0
-rw-r--r--src/ivicore/doc/src/ivigenerator/idl-syntax.qdoc (renamed from src/doc/qtivi/src/ivigenerator/idl-syntax.qdoc)0
-rw-r--r--src/ivicore/doc/src/ivigenerator/ivigenerator.qdoc (renamed from src/doc/qtivi/src/ivigenerator/ivigenerator.qdoc)0
-rw-r--r--src/ivicore/doc/src/ivigenerator/qmake-integration.qdoc (renamed from src/doc/qtivi/src/ivigenerator/qmake-integration.qdoc)0
-rw-r--r--src/ivicore/doc/src/ivigenerator/remotebackends.qdoc (renamed from src/doc/qtivi/src/ivigenerator/remotebackends.qdoc)0
-rw-r--r--src/ivicore/doc/src/ivigenerator/template-syntax.qdoc (renamed from src/doc/qtivi/src/ivigenerator/template-syntax.qdoc)0
-rw-r--r--src/ivicore/doc/src/models.qdoc (renamed from src/doc/qtivi/src/models.qdoc)0
-rw-r--r--src/ivicore/doc/src/qt_attribution.json (renamed from src/doc/qtivi/src/qt_attribution.json)0
-rw-r--r--src/ivicore/doc/src/qtivi-backends.qdoc (renamed from src/doc/qtivi/src/qtivi-backends.qdoc)0
-rw-r--r--src/ivicore/doc/src/qtivi-examples.qdoc (renamed from src/doc/qtivi/src/qtivi-examples.qdoc)0
-rw-r--r--src/ivicore/doc/src/qtivi-modules.qdoc (renamed from src/doc/qtivi/src/qtivi-modules.qdoc)0
-rw-r--r--src/ivicore/doc/src/qtivi.qdoc (renamed from src/doc/qtivi/src/qtivi.qdoc)0
-rw-r--r--src/ivicore/doc/src/query-language.qdoc (renamed from src/doc/qtivi/src/query-language.qdoc)0
-rw-r--r--src/ivicore/doc/src/reference-api.qdoc (renamed from src/doc/qtivi/src/reference-api.qdoc)0
-rw-r--r--src/ivicore/ivicore.pro15
-rw-r--r--src/ivicore/qiviabstractfeature.cpp2
-rw-r--r--src/ivicore/qivipendingreply.cpp12
-rw-r--r--src/ivicore/qivipropertyattribute.cpp24
-rw-r--r--src/ivicore/qivipropertyfactory.cpp18
-rw-r--r--src/ivicore/qivisearchandbrowsemodel.cpp2
-rw-r--r--src/ivicore/qivisearchandbrowsemodelinterface.cpp2
-rw-r--r--src/ivicore/qiviservicemanager.cpp11
-rw-r--r--src/ivivehiclefunctions/doc/qtivivehiclefunctions.qdocconf4
52 files changed, 129 insertions, 168 deletions
diff --git a/src/doc/doc.pro b/src/doc/doc.pro
index 24b3d43..f9ab135 100644
--- a/src/doc/doc.pro
+++ b/src/doc/doc.pro
@@ -1,7 +1,3 @@
TEMPLATE = subdirs
-SUBDIRS = qtivi \
- qtgeniviextras \
- qtautomotivesuite
-
-DISTFILES += $$PWD/shared.qdocconf
+SUBDIRS = qtautomotivesuite
diff --git a/src/doc/qtgeniviextras/qtgeniviextras.pro b/src/doc/qtgeniviextras/qtgeniviextras.pro
deleted file mode 100644
index dce04c5..0000000
--- a/src/doc/qtgeniviextras/qtgeniviextras.pro
+++ /dev/null
@@ -1,10 +0,0 @@
-TEMPLATE = aux
-build_online_docs: {
- QMAKE_DOCS = $$PWD/online/qtgeniviextras.qdocconf
-} else {
- QMAKE_DOCS = $$PWD/qtgeniviextras.qdocconf
-}
-
-OTHER_FILES += \
- $$PWD/*.qdocconf \
- $$PWD/src/*.qdoc
diff --git a/src/doc/qtgeniviextras/qtgeniviextras.qdocconf b/src/doc/qtgeniviextras/qtgeniviextras.qdocconf
deleted file mode 100644
index 1fa1f11..0000000
--- a/src/doc/qtgeniviextras/qtgeniviextras.qdocconf
+++ /dev/null
@@ -1,2 +0,0 @@
-include($QT_INSTALL_DOCS/global/qt-module-defaults-offline.qdocconf)
-include(qtgeniviextras-project.qdocconf)
diff --git a/src/doc/qtgeniviextras/src/qtgeniviextras.qdoc b/src/doc/qtgeniviextras/src/qtgeniviextras.qdoc
deleted file mode 100644
index 2946fc2..0000000
--- a/src/doc/qtgeniviextras/src/qtgeniviextras.qdoc
+++ /dev/null
@@ -1,61 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2018 Pelagicore AG
-** Contact: https://www.qt.io/licensing/
-**
-** This file is part of the documentation of the QtIvi module of the Qt Toolkit.
-**
-** $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$
-**
-****************************************************************************/
-/*!
- \page qtgeniviextras-index.html
- \title Qt GENIVI Extras
- \keyword QtGeniviExtras
-
- The Qt GENIVI Extras module provides C++ classes for interacting with
- services from the \l {https://www.genivi.org/}{GENIVI Automotive Alliance}.
- The module contains helper functions to interact with the
- Diagnostic Log and Trace (DLT) daemon. This daemon is used on many
- automotive systems to catch all logs from different application.
-
- \section1 Getting Started
-
- To include the definitions of the module's classes and functions, use the
- following directive:
-
- \code
- #include <QtGeniviExtras>
- \endcode
-
- To link against the module, add this line to your qmake \c .pro file:
-
- \badcode
- QT += geniviextras
- \endcode
-
- See \l {Qt DLT Declarations} for more information about how to use the DLT API.
-
- \section1 Reference
-
- \list
- \li \l {Qt GENIVI Extras C++ Classes}{C++ Classes}
- \li \l {Qt GENIVI Extras Examples}{Examples}
- \endlist
-*/
diff --git a/src/doc/qtivi/qtivi.pro b/src/doc/qtivi/qtivi.pro
deleted file mode 100644
index 6f9843b..0000000
--- a/src/doc/qtivi/qtivi.pro
+++ /dev/null
@@ -1,14 +0,0 @@
-TEMPLATE = aux
-build_online_docs: {
- QMAKE_DOCS = $$PWD/online/qtivi.qdocconf
-} else {
- QMAKE_DOCS = $$PWD/qtivi.qdocconf
-}
-
-DISTFILES += \
- $$PWD/*.qdocconf \
- $$PWD/online/*.qdocconf \
- $$PWD/src/*.qdoc \
- $$PWD/src/ivigenerator/*.qdoc \
- $$PWD/images/*.jpg \
- $$PWD/images/*.png
diff --git a/src/doc/shared.qdocconf b/src/doc/shared.qdocconf
deleted file mode 100644
index c46cc8d..0000000
--- a/src/doc/shared.qdocconf
+++ /dev/null
@@ -1 +0,0 @@
-manifestmeta.thumbnail.attributes = "imageUrl:qthelp\://org.qt-project.qtivi.$QT_VERSION_TAG/qtivi/images/qtivi-codesample.png"
diff --git a/src/doc/qtgeniviextras/online/qtgeniviextras.qdocconf b/src/geniviextras/doc/online/qtgeniviextras.qdocconf
index 7fdeef8..7fdeef8 100644
--- a/src/doc/qtgeniviextras/online/qtgeniviextras.qdocconf
+++ b/src/geniviextras/doc/online/qtgeniviextras.qdocconf
diff --git a/src/doc/qtgeniviextras/qtgeniviextras-project.qdocconf b/src/geniviextras/doc/qtgeniviextras-project.qdocconf
index 951537e..89b2ccc 100644
--- a/src/doc/qtgeniviextras/qtgeniviextras-project.qdocconf
+++ b/src/geniviextras/doc/qtgeniviextras-project.qdocconf
@@ -5,9 +5,15 @@ url = http://doc.qt.io/QtGeniviExtras
sourcedirs += .
headerdirs += .
+headerdirs += ..
+sourcedirs += ..
-# include sub-modules' sources and headers
-include(../../geniviextras/doc/qtgeniviextras.qdocconf)
+exampledirs += ../../../examples/geniviextras \
+ snippets
+
+examplesinstallpath = geniviextras
+
+imagedirs += images
qhp.projects = QtGeniviExtras
diff --git a/src/geniviextras/doc/qtgeniviextras.qdocconf b/src/geniviextras/doc/qtgeniviextras.qdocconf
index b94fa45..1fa1f11 100644
--- a/src/geniviextras/doc/qtgeniviextras.qdocconf
+++ b/src/geniviextras/doc/qtgeniviextras.qdocconf
@@ -1,10 +1,2 @@
-headerdirs += ..
-
-sourcedirs += ..
-
-exampledirs += ../../../examples/geniviextras \
- snippets
-
-examplesinstallpath = geniviextras
-
-imagedirs += images
+include($QT_INSTALL_DOCS/global/qt-module-defaults-offline.qdocconf)
+include(qtgeniviextras-project.qdocconf)
diff --git a/src/doc/qtgeniviextras/src/external-resources.qdoc b/src/geniviextras/doc/src/external-resources.qdoc
index 896fa13..896fa13 100644
--- a/src/doc/qtgeniviextras/src/external-resources.qdoc
+++ b/src/geniviextras/doc/src/external-resources.qdoc
diff --git a/src/geniviextras/doc/src/qtgeniviextras.qdoc b/src/geniviextras/doc/src/qtgeniviextras.qdoc
index 018c140..0abdec4 100644
--- a/src/geniviextras/doc/src/qtgeniviextras.qdoc
+++ b/src/geniviextras/doc/src/qtgeniviextras.qdoc
@@ -24,6 +24,41 @@
** $QT_END_LICENSE$
**
****************************************************************************/
+/*!
+ \page qtgeniviextras-index.html
+ \title Qt GENIVI Extras
+ \keyword QtGeniviExtras
+
+ The Qt GENIVI Extras module provides C++ classes for interacting with
+ services from the \l {https://www.genivi.org/}{GENIVI Automotive Alliance}.
+ The module contains helper functions to interact with the
+ Diagnostic Log and Trace (DLT) daemon. This daemon is used on many
+ automotive systems to catch all logs from different application.
+
+ \section1 Getting Started
+
+ To include the definitions of the module's classes and functions, use the
+ following directive:
+
+ \code
+ #include <QtGeniviExtras>
+ \endcode
+
+ To link against the module, add this line to your qmake \c .pro file:
+
+ \badcode
+ QT += geniviextras
+ \endcode
+
+ See \l {Qt DLT Declarations} for more information about how to use the DLT API.
+
+ \section1 Reference
+
+ \list
+ \li \l {Qt GENIVI Extras C++ Classes}{C++ Classes}
+ \li \l {Qt GENIVI Extras Examples}{Examples}
+ \endlist
+*/
/*!
\module QtGeniviExtras
diff --git a/src/geniviextras/geniviextras.pro b/src/geniviextras/geniviextras.pro
index 2e0175f..8bc10d9 100644
--- a/src/geniviextras/geniviextras.pro
+++ b/src/geniviextras/geniviextras.pro
@@ -5,9 +5,19 @@ CONFIG += c++11
CONFIG += link_pkgconfig
-OTHER_FILES += \
+build_online_docs: {
+ QMAKE_DOCS = $$PWD/doc/online/qtgeniviextras.qdocconf
+} else {
+ QMAKE_DOCS = $$PWD/doc/qtgeniviextras.qdocconf
+}
+
+DISTFILES += \
$$PWD/doc/*.qdocconf \
- $$PWD/doc/src/*.qdoc
+ $$PWD/doc/online/*.qdocconf \
+ $$PWD/doc/src/*.qdoc \
+ $$PWD/doc/src/ivigenerator/*.qdoc \
+ $$PWD/doc/images/*.jpg \
+ $$PWD/doc/images/*.png
QMAKE_USE += dlt
diff --git a/src/ivicore/doc/QtIviDoc b/src/ivicore/doc/QtIviDoc
new file mode 100644
index 0000000..aa17a4c
--- /dev/null
+++ b/src/ivicore/doc/QtIviDoc
@@ -0,0 +1,3 @@
+#include <QtIviCore/QtIviCore>
+#include <QtIviVehicleFunctions/QtIviVehicleFunctions>
+#include <QtIviMedia/QtIviMedia>
diff --git a/src/doc/qtivi/images/backendtypes.jpg b/src/ivicore/doc/images/backendtypes.jpg
index b06681d..b06681d 100644
--- a/src/doc/qtivi/images/backendtypes.jpg
+++ b/src/ivicore/doc/images/backendtypes.jpg
Binary files differ
diff --git a/src/doc/qtivi/images/feature_backend.jpg b/src/ivicore/doc/images/feature_backend.jpg
index 98e3fca..98e3fca 100644
--- a/src/doc/qtivi/images/feature_backend.jpg
+++ b/src/ivicore/doc/images/feature_backend.jpg
Binary files differ
diff --git a/src/doc/qtivi/images/qtivi-codesample.png b/src/ivicore/doc/images/qtivi-codesample.png
index cfecb6a..cfecb6a 100644
--- a/src/doc/qtivi/images/qtivi-codesample.png
+++ b/src/ivicore/doc/images/qtivi-codesample.png
Binary files differ
diff --git a/src/doc/qtivi/online/qtivi.qdocconf b/src/ivicore/doc/online/qtivi.qdocconf
index 9cc98ed..9cc98ed 100644
--- a/src/doc/qtivi/online/qtivi.qdocconf
+++ b/src/ivicore/doc/online/qtivi.qdocconf
diff --git a/src/doc/qtivi/qtivi-project.qdocconf b/src/ivicore/doc/qtivi-project.qdocconf
index 05d6ccf..3e84cdc 100644
--- a/src/doc/qtivi/qtivi-project.qdocconf
+++ b/src/ivicore/doc/qtivi-project.qdocconf
@@ -3,17 +3,20 @@ description = QtIvi Reference Documentation
version = $QT_VERSION
url = http://doc.qt.io/QtIVI
-sourcedirs += .
-headerdirs += .
+moduleheader = QtIviDoc
+includepaths = -I .
+
+headerdirs += . \
+ .. \
+ ../../imports/core
+
+sourcedirs += . \
+ .. \
+ ../../imports/core
imagedirs += images
exampledirs += ../../../examples
examples.fileextensions += *.qface *.yaml
-# geniviextras has its own documentation project, ignore the examples here
-excludedirs += ../../../examples/geniviextras
-
-# include sub-modules' sources and headers
-include(../../ivicore/doc/qtivicore.qdocconf)
include(../../ivivehiclefunctions/doc/qtivivehiclefunctions.qdocconf)
include(../../ivimedia/doc/qtivimedia.qdocconf)
@@ -21,9 +24,6 @@ include(../../ivimedia/doc/qtivimedia.qdocconf)
include(../../plugins/ivimedia/doc/qtivimedia_plugins.qdocconf)
include(../../plugins/ivivehiclefunctions/doc/qtivivehiclefunctions_plugins.qdocconf)
-# include definitions shared with all doc modules
-include(../shared.qdocconf)
-
# include extra image to qhp (referred to in the generated examples-manifest.xml)
HTML.extraimages += images/qtivi-codesample.png
qhp.QtIvi.extraFiles += images/qtivi-codesample.png
@@ -59,7 +59,7 @@ qhp.QtIvi.subprojects.examples.sortPages = true
tagfile = qtivi.tags
-depends += qtcore qtdoc qtquick qtqml qtautomotivesuite qtsimulator qtremoteobjects
+depends += qtcore qtwidgets qtdoc qtquick qtqml qtautomotivesuite qtsimulator qtremoteobjects
navigation.homepage = "Qt Automotive Suite"
navigation.landingpage = "Qt IVI"
diff --git a/src/doc/qtivi/qtivi.qdocconf b/src/ivicore/doc/qtivi.qdocconf
index 1a65d24..1a65d24 100644
--- a/src/doc/qtivi/qtivi.qdocconf
+++ b/src/ivicore/doc/qtivi.qdocconf
diff --git a/src/ivicore/doc/qtivicore.qdocconf b/src/ivicore/doc/qtivicore.qdocconf
deleted file mode 100644
index 4d84660..0000000
--- a/src/ivicore/doc/qtivicore.qdocconf
+++ /dev/null
@@ -1,11 +0,0 @@
-headerdirs += .. \
- ../../imports/core
-
-sourcedirs += .. \
- ../../imports/core
-
-imagedirs += images
-
-macro.qmlqtiviproperty = "\\qmlpropertygroup \2 \n\\qmlproperty bool \2.available\n \\qmlproperty \1 \2.maximumValue\n \\qmlproperty \1 \2.minimumValue\n \\qmlproperty list<\1> \2.availableValues\n \\qmlproperty \1 \2.value\n \\include src/qmlqtiviproperty.qdocinc"
-macro.qmlqtivipropertyBool = "\\qmlpropertygroup \1 \n\\qmlproperty bool \1.available\n \\qmlproperty bool \1.value\n \\include src/qmlqtiviproperty.qdocinc"
-macro.qmlqtivipropertyEnum = "\\qmlpropertygroup \1 \n\\qmlproperty bool \1.available\n \\qmlproperty list<enumeration> \1.availableValues\n \\qmlproperty enumeration \1.value\n \\include src/qmlqtiviproperty.qdocinc"
diff --git a/src/doc/qtivi/src/JINJA_LICENSE b/src/ivicore/doc/src/JINJA_LICENSE
index 31bf900..31bf900 100644
--- a/src/doc/qtivi/src/JINJA_LICENSE
+++ b/src/ivicore/doc/src/JINJA_LICENSE
diff --git a/src/doc/qtivi/src/attribute-system.qdoc b/src/ivicore/doc/src/attribute-system.qdoc
index f0aff4f..f0aff4f 100644
--- a/src/doc/qtivi/src/attribute-system.qdoc
+++ b/src/ivicore/doc/src/attribute-system.qdoc
diff --git a/src/doc/qtivi/src/backend-system.qdoc b/src/ivicore/doc/src/backend-system.qdoc
index 5ed6597..5ed6597 100644
--- a/src/doc/qtivi/src/backend-system.qdoc
+++ b/src/ivicore/doc/src/backend-system.qdoc
diff --git a/src/doc/qtivi/src/concepts.qdoc b/src/ivicore/doc/src/concepts.qdoc
index 94f6ebd..94f6ebd 100644
--- a/src/doc/qtivi/src/concepts.qdoc
+++ b/src/ivicore/doc/src/concepts.qdoc
diff --git a/src/doc/qtivi/src/configuration.qdoc b/src/ivicore/doc/src/configuration.qdoc
index c5d4425..c5d4425 100644
--- a/src/doc/qtivi/src/configuration.qdoc
+++ b/src/ivicore/doc/src/configuration.qdoc
diff --git a/src/doc/qtivi/src/extending-qtivi.qdoc b/src/ivicore/doc/src/extending-qtivi.qdoc
index ee51224..7dd82f8 100644
--- a/src/doc/qtivi/src/extending-qtivi.qdoc
+++ b/src/ivicore/doc/src/extending-qtivi.qdoc
@@ -133,9 +133,9 @@ Zones is a standard way to provide a single API for multiple points in the vehic
For instance, climate control commonly has a driver and passenger zones, and might also have
a rear seat zone. The same goes for wheels, doors, mirrors, windows and more.
-A common pattern is to combine zones with \l {Extending Qt IVI#property-attributes}
-{property attributes} to handle small differences in capabilities between zones; for example, no
-steering wheel heater for the passenger side of the car.
+A common pattern is to combine zones with property attributes to handle small differences in
+capabilities between zones; for example, no steering wheel heater for the passenger side of the
+car.
Technically, a zoned feature consists of two interfaces, one top level interface derived
from QIviAbstractZonedFeature, and one zone specific API derived from QObject.
diff --git a/src/doc/qtivi/src/external-resources.qdoc b/src/ivicore/doc/src/external-resources.qdoc
index c48930b..c48930b 100644
--- a/src/doc/qtivi/src/external-resources.qdoc
+++ b/src/ivicore/doc/src/external-resources.qdoc
diff --git a/src/doc/qtivi/src/ivigenerator/filter-reference.qdoc b/src/ivicore/doc/src/ivigenerator/filter-reference.qdoc
index c330fff..c330fff 100644
--- a/src/doc/qtivi/src/ivigenerator/filter-reference.qdoc
+++ b/src/ivicore/doc/src/ivigenerator/filter-reference.qdoc
diff --git a/src/doc/qtivi/src/ivigenerator/generator-usage.qdoc b/src/ivicore/doc/src/ivigenerator/generator-usage.qdoc
index 688633b..688633b 100644
--- a/src/doc/qtivi/src/ivigenerator/generator-usage.qdoc
+++ b/src/ivicore/doc/src/ivigenerator/generator-usage.qdoc
diff --git a/src/doc/qtivi/src/ivigenerator/getting-started.qdoc b/src/ivicore/doc/src/ivigenerator/getting-started.qdoc
index 0249f2c..0249f2c 100644
--- a/src/doc/qtivi/src/ivigenerator/getting-started.qdoc
+++ b/src/ivicore/doc/src/ivigenerator/getting-started.qdoc
diff --git a/src/doc/qtivi/src/ivigenerator/idl-syntax.qdoc b/src/ivicore/doc/src/ivigenerator/idl-syntax.qdoc
index f44eee1..f44eee1 100644
--- a/src/doc/qtivi/src/ivigenerator/idl-syntax.qdoc
+++ b/src/ivicore/doc/src/ivigenerator/idl-syntax.qdoc
diff --git a/src/doc/qtivi/src/ivigenerator/ivigenerator.qdoc b/src/ivicore/doc/src/ivigenerator/ivigenerator.qdoc
index 3a50a38..3a50a38 100644
--- a/src/doc/qtivi/src/ivigenerator/ivigenerator.qdoc
+++ b/src/ivicore/doc/src/ivigenerator/ivigenerator.qdoc
diff --git a/src/doc/qtivi/src/ivigenerator/qmake-integration.qdoc b/src/ivicore/doc/src/ivigenerator/qmake-integration.qdoc
index 3085efc..3085efc 100644
--- a/src/doc/qtivi/src/ivigenerator/qmake-integration.qdoc
+++ b/src/ivicore/doc/src/ivigenerator/qmake-integration.qdoc
diff --git a/src/doc/qtivi/src/ivigenerator/remotebackends.qdoc b/src/ivicore/doc/src/ivigenerator/remotebackends.qdoc
index 064a062..064a062 100644
--- a/src/doc/qtivi/src/ivigenerator/remotebackends.qdoc
+++ b/src/ivicore/doc/src/ivigenerator/remotebackends.qdoc
diff --git a/src/doc/qtivi/src/ivigenerator/template-syntax.qdoc b/src/ivicore/doc/src/ivigenerator/template-syntax.qdoc
index 96a4b78..96a4b78 100644
--- a/src/doc/qtivi/src/ivigenerator/template-syntax.qdoc
+++ b/src/ivicore/doc/src/ivigenerator/template-syntax.qdoc
diff --git a/src/doc/qtivi/src/models.qdoc b/src/ivicore/doc/src/models.qdoc
index ac9a366..ac9a366 100644
--- a/src/doc/qtivi/src/models.qdoc
+++ b/src/ivicore/doc/src/models.qdoc
diff --git a/src/doc/qtivi/src/qt_attribution.json b/src/ivicore/doc/src/qt_attribution.json
index ae70c34..ae70c34 100644
--- a/src/doc/qtivi/src/qt_attribution.json
+++ b/src/ivicore/doc/src/qt_attribution.json
diff --git a/src/doc/qtivi/src/qtivi-backends.qdoc b/src/ivicore/doc/src/qtivi-backends.qdoc
index 1345436..1345436 100644
--- a/src/doc/qtivi/src/qtivi-backends.qdoc
+++ b/src/ivicore/doc/src/qtivi-backends.qdoc
diff --git a/src/doc/qtivi/src/qtivi-examples.qdoc b/src/ivicore/doc/src/qtivi-examples.qdoc
index eef5a0c..eef5a0c 100644
--- a/src/doc/qtivi/src/qtivi-examples.qdoc
+++ b/src/ivicore/doc/src/qtivi-examples.qdoc
diff --git a/src/doc/qtivi/src/qtivi-modules.qdoc b/src/ivicore/doc/src/qtivi-modules.qdoc
index d40bfa7..d40bfa7 100644
--- a/src/doc/qtivi/src/qtivi-modules.qdoc
+++ b/src/ivicore/doc/src/qtivi-modules.qdoc
diff --git a/src/doc/qtivi/src/qtivi.qdoc b/src/ivicore/doc/src/qtivi.qdoc
index e399cdd..e399cdd 100644
--- a/src/doc/qtivi/src/qtivi.qdoc
+++ b/src/ivicore/doc/src/qtivi.qdoc
diff --git a/src/doc/qtivi/src/query-language.qdoc b/src/ivicore/doc/src/query-language.qdoc
index e704dde..e704dde 100644
--- a/src/doc/qtivi/src/query-language.qdoc
+++ b/src/ivicore/doc/src/query-language.qdoc
diff --git a/src/doc/qtivi/src/reference-api.qdoc b/src/ivicore/doc/src/reference-api.qdoc
index d1bab1d..d1bab1d 100644
--- a/src/doc/qtivi/src/reference-api.qdoc
+++ b/src/ivicore/doc/src/reference-api.qdoc
diff --git a/src/ivicore/ivicore.pro b/src/ivicore/ivicore.pro
index 80dc964..8bfcc09 100644
--- a/src/ivicore/ivicore.pro
+++ b/src/ivicore/ivicore.pro
@@ -3,9 +3,19 @@ TARGET = QtIviCore
QT = core core-private qml qml-private
CONFIG += c++11
-OTHER_FILES += \
+build_online_docs: {
+ QMAKE_DOCS = $$PWD/doc/online/qtivi.qdocconf
+} else {
+ QMAKE_DOCS = $$PWD/doc/qtivi.qdocconf
+}
+
+DISTFILES += \
$$PWD/doc/*.qdocconf \
- $$PWD/doc/src/*.qdoc
+ $$PWD/doc/online/*.qdocconf \
+ $$PWD/doc/src/*.qdoc \
+ $$PWD/doc/src/ivigenerator/*.qdoc \
+ $$PWD/doc/images/*.jpg \
+ $$PWD/doc/images/*.png
CMAKE_MODULE_TESTS = '-'
@@ -64,3 +74,4 @@ SOURCES += \
include(queryparser/queryparser.pri)
load(qt_module)
+QMAKE_DOCS_TARGETDIR = qtivi
diff --git a/src/ivicore/qiviabstractfeature.cpp b/src/ivicore/qiviabstractfeature.cpp
index 858b7f4..bdcba6f 100644
--- a/src/ivicore/qiviabstractfeature.cpp
+++ b/src/ivicore/qiviabstractfeature.cpp
@@ -130,7 +130,7 @@ void QIviAbstractFeaturePrivate::onInitializationDone()
QIviAbstractFeature is an abstract base class that needs to be subclassed to create an API for your
Feature.
- \chapter Subclassing
+ \section1 Subclassing
When subclassing QIviAbstractFeature, you must provide implementations of the following functions:
\list
diff --git a/src/ivicore/qivipendingreply.cpp b/src/ivicore/qivipendingreply.cpp
index 78e4559..e7bcde9 100644
--- a/src/ivicore/qivipendingreply.cpp
+++ b/src/ivicore/qivipendingreply.cpp
@@ -782,14 +782,14 @@ void QIviPendingReplyBase::setSuccessNoCheck(const QVariant &value)
\fn QIviPendingReplyWatcher::valueChanged(const QVariant &value)
Emitted when the result for the reply is ready. This signal is called when the reply is
- successful as well as when it is failed. The \value argument holds the result and is a default
+ successful as well as when it is failed. The \a value argument holds the result and is a default
constructed QVariant in the failed case.
\sa setSuccess setFailed
*/
/*!
- \fn QIviPendingReply::createFailedReply()
+ \fn template <class T> QIviPendingReply<T>::createFailedReply()
Creates a reply object which is marked as failed. This is convenient in error cases inside
functions returning a reply e.g.
@@ -810,7 +810,7 @@ void QIviPendingReplyBase::setSuccessNoCheck(const QVariant &value)
*/
/*!
- \fn QIviPendingReply::reply() const
+ \fn template <class T> QIviPendingReply<T>::reply() const
Returns the result of the reply. If no result has been set yet or when the reply is marked as
failed, a default constructed value is returned.
@@ -819,7 +819,7 @@ void QIviPendingReplyBase::setSuccessNoCheck(const QVariant &value)
*/
/*!
- \fn QIviPendingReply::setSuccess(const T &value)
+ \fn template <class T> QIviPendingReply<T>::setSuccess(const T &value)
Sets the result of the reply to \a value and marks the reply as succeeded.
@@ -829,10 +829,10 @@ void QIviPendingReplyBase::setSuccessNoCheck(const QVariant &value)
*/
/*!
- \fn qIviRegisterPendingReplyType(const char *typeName)
+ \fn qIviRegisterPendingReplyType(const char *name)
\relates QIviPendingReply
- Registers the type name \a typeName for the type \c{T} for usage inside a QIviPendingReply. Any
+ Registers the type name \a name for the type \c{T} for usage inside a QIviPendingReply. Any
class or struct that has a public default constructor, a public copy constructor and a public
destructor can be registered.
diff --git a/src/ivicore/qivipropertyattribute.cpp b/src/ivicore/qivipropertyattribute.cpp
index 0e16ed0..0423a03 100644
--- a/src/ivicore/qivipropertyattribute.cpp
+++ b/src/ivicore/qivipropertyattribute.cpp
@@ -93,7 +93,7 @@ void QIviPropertyAttributeBase::registerTypes()
*/
/*!
- \fn QIviPropertyAttribute::QIviPropertyAttribute()
+ \fn template <class T> QIviPropertyAttribute<T>::QIviPropertyAttribute()
Constructs an invalid QIviPropertyAttribute.
This constructor can be used to indicate that the property is not available.
@@ -101,67 +101,67 @@ void QIviPropertyAttributeBase::registerTypes()
*/
/*!
- \fn QIviPropertyAttribute::QIviPropertyAttribute(bool available)
+ \fn template <class T> QIviPropertyAttribute<T>::QIviPropertyAttribute(bool available)
Constructs an QIviPropertyAttribute of type NoAttributes.
The argument \a available defines whether the property is supported by the backend.
*/
/*!
- \fn QIviPropertyAttribute::QIviPropertyAttribute(const T &minValue, const T &maxValue)
+ \fn template <class T> QIviPropertyAttribute<T>::QIviPropertyAttribute(const T &minValue, const T &maxValue)
Constructs an QIviPropertyAttribute of type MinimumMaximum.
The arguments \a minValue and \a maxValue define the boundaries the value of the property.
*/
/*!
- \fn QIviPropertyAttribute::QIviPropertyAttribute(const QVector<T> &avValues)
+ \fn template <class T> QIviPropertyAttribute<T>::QIviPropertyAttribute(const QVector<T> &avValues)
Constructs an QIviPropertyAttribute of type AvailableValues.
The argument \a avValues defines the valid values for the property.
*/
/*!
- \fn AttributeType QIviPropertyAttribute::type() const
+ \fn template <class T> AttributeType QIviPropertyAttribute<T>::type() const
Returns the type of the attribute.
*/
/*!
- \fn bool QIviPropertyAttribute::isAvailable() const
+ \fn template <class T> bool QIviPropertyAttribute<T>::isAvailable() const
Returns true if the property is available for this backend.
*/
/*!
- \fn T QIviPropertyAttribute::minimumValue() const
+ \fn template <class T> T QIviPropertyAttribute<T>::minimumValue() const
Returns the minimum value of the property.
If the attributeType is not MinimumMaximum, a default constructed value is returned.
*/
/*!
- \fn T QIviPropertyAttribute::maximumValue() const
+ \fn template <class T> T QIviPropertyAttribute<T>::maximumValue() const
Returns the maximum value of the property.
If the attributeType is not MinimumMaximum, a default constructed value is returned.
*/
/*!
- \fn QList<T> QIviPropertyAttribute::availableValues() const
+ \fn template <class T> QList<T> QIviPropertyAttribute<T>::availableValues() const
Returns a list of valid values for this property.
If the attributeType is not AvailableValues an empty list is returned.
*/
/*!
- \fn QString QIviPropertyAttribute::toString() const
+ \fn template <class T> QString QIviPropertyAttribute<T>::toString() const
Returns a QString with a string representation of the attribute.
*/
/*!
- \fn bool QIviPropertyAttribute::operator==(const QIviPropertyAttribute& other) const
+ \fn template <class T> bool QIviPropertyAttribute<T>::operator==(const QIviPropertyAttribute& other) const
Returns \c true if this QIviPropertyAttribute is equal to the \a other QIviPropertyAttribute; otherwise returns \c false.
@@ -169,7 +169,7 @@ void QIviPropertyAttributeBase::registerTypes()
*/
/*!
- \fn bool QIviPropertyAttribute::operator!=(const QIviPropertyAttribute& other) const
+ \fn template <class T> bool QIviPropertyAttribute<T>::operator!=(const QIviPropertyAttribute& other) const
Returns \c true if this QIviPropertyAttribute is NOT equal to the \a other QIviPropertyAttribute; otherwise returns \c false.
diff --git a/src/ivicore/qivipropertyfactory.cpp b/src/ivicore/qivipropertyfactory.cpp
index 0dfafa0..72f320a 100644
--- a/src/ivicore/qivipropertyfactory.cpp
+++ b/src/ivicore/qivipropertyfactory.cpp
@@ -66,7 +66,7 @@ QT_BEGIN_NAMESPACE
*/
/*!
- \fn QIviPropertyFactory::create(const QtPrivate::FunctionPointer<attributeGetterFunc>::Object *sender, attributeGetterFunc attributeGetter, attributeSignalFunc attributeSignal, valueGetterFunc valueGetter, valueSignalFunc valueSignal, valueSlotFunc valueSlot)
+ \fn template <class T, typename attributeGetterFunc, typename attributeSignalFunc, typename valueGetterFunc, typename valueSignalFunc, typename valueSlotFunc> QIviPropertyFactory<T>::create(const typename QtPrivate::FunctionPointer<attributeGetterFunc>::Object *sender, attributeGetterFunc attributeGetter, attributeSignalFunc attributeSignal, valueGetterFunc valueGetter, valueSignalFunc valueSignal, valueSlotFunc valueSlot)
Returns an new QIviProperty instance for a attribute and value of type T.
@@ -75,12 +75,10 @@ QT_BEGIN_NAMESPACE
These arguments need to be of QIviPropertyAttribute<T>.
\a valueGetter, \a valueSignal, and \a valueSlot need to be function pointers to the getter, signal, and setter for the value that should be stored in this QIviQmlProperty instance.
The value functions need to have arguments and return values of type T.
-
- \sa QIviPropertyFactory::create(const QtPrivate::FunctionPointer<attributeGetterFunc>::Object *sender, attributeGetterFunc attributeGetter, attributeSignalFunc attributeSignal, valueGetterFunc valueGetter, valueSignalFunc valueSignal)
*/
/*!
- \fn QIviPropertyFactory::create(const QtPrivate::FunctionPointer<attributeGetterFunc>::Object *sender, attributeGetterFunc attributeGetter, attributeSignalFunc attributeSignal, valueGetterFunc valueGetter, valueSignalFunc valueSignal)
+ \fn template <class T, typename attributeGetterFunc, typename attributeSignalFunc, typename valueGetterFunc, typename valueSignalFunc> QIviPropertyFactory<T>::create(const typename QtPrivate::FunctionPointer<attributeGetterFunc>::Object *sender, attributeGetterFunc attributeGetter, attributeSignalFunc attributeSignal, valueGetterFunc valueGetter, valueSignalFunc valueSignal)
Returns a new QIviProperty instance for an attribute and value of type T.
@@ -91,36 +89,34 @@ QT_BEGIN_NAMESPACE
The value functions need to have arguments and return values of type T.
\note This factory function will create a readonly property as no value setter needs to be provided
-
- \sa QIviPropertyFactory::create(const QtPrivate::FunctionPointer<attributeGetterFunc>::Object *sender, attributeGetterFunc attributeGetter, attributeSignalFunc attributeSignal, valueGetterFunc valueGetter, valueSignalFunc valueSignal, valueSlotFunc valueSlot)
*/
/*!
- \fn bool QIviPropertyFactory::isAvailable() const
+ \fn template <class T> bool QIviPropertyFactory<T>::isAvailable() const
\reimp
*/
/*!
- \fn bool QIviPropertyFactory::minimumValue() const
+ \fn template <class T> bool QIviPropertyFactory<T>::minimumValue() const
\reimp
*/
/*!
- \fn bool QIviPropertyFactory::maximumValue() const
+ \fn template <class T> bool QIviPropertyFactory<T>::maximumValue() const
\reimp
*/
/*!
- \fn bool QIviPropertyFactory::availableValues() const
+ \fn template <class T> bool QIviPropertyFactory<T>::availableValues() const
\reimp
*/
/*!
- \fn bool QIviPropertyFactory::value() const
+ \fn template <class T> bool QIviPropertyFactory<T>::value() const
\reimp
*/
diff --git a/src/ivicore/qivisearchandbrowsemodel.cpp b/src/ivicore/qivisearchandbrowsemodel.cpp
index 637aecc..5c3b0b8 100644
--- a/src/ivicore/qivisearchandbrowsemodel.cpp
+++ b/src/ivicore/qivisearchandbrowsemodel.cpp
@@ -1300,7 +1300,7 @@ QIviPendingReply<void> QIviSearchAndBrowseModel::move(int cur_index, int new_ind
/*!
\fn void QIviSearchAndBrowseModel::indexOf(const QVariant &variant)
- Determines the index of \a item in this model.
+ Determines the index of \a variant in this model.
The result is returned as a QIviPendingReply.
*/
diff --git a/src/ivicore/qivisearchandbrowsemodelinterface.cpp b/src/ivicore/qivisearchandbrowsemodelinterface.cpp
index 7342f6a..a549409 100644
--- a/src/ivicore/qivisearchandbrowsemodelinterface.cpp
+++ b/src/ivicore/qivisearchandbrowsemodelinterface.cpp
@@ -103,7 +103,7 @@ QSet<QString> QIviSearchAndBrowseModelInterface::supportedIdentifiers(const QStr
/*!
- \fn registerContentType(const QString &contentType)
+ \fn template <class T> QIviSearchAndBrowseModelInterface::registerContentType(const QString &contentType)
Registers the type T with the name \a contentType.
In addition all properties of type T will be registered as identifiers for the \l {Qt IVI Query Language}
diff --git a/src/ivicore/qiviservicemanager.cpp b/src/ivicore/qiviservicemanager.cpp
index ff6af67..b5de5c2 100644
--- a/src/ivicore/qiviservicemanager.cpp
+++ b/src/ivicore/qiviservicemanager.cpp
@@ -418,6 +418,17 @@ QIviServiceInterface *QIviServiceManagerPrivate::loadServiceBackendInterface(str
*/
/*!
+ \enum QIviServiceManager::Roles
+ \value NameRole
+ The name of the backend e.g. MediaPlugin
+ \value ServiceObjectRole
+ The actual QIviServiceObject, which can be used to connect a frontend API to this backend.
+ \note When using this role in the data() function, the backend plugin will be loaded and instantiated.
+ \value InterfacesRole
+ A list of interefaces the backend implements.
+*/
+
+/*!
\enum QIviServiceManager::SearchFlag
\value IncludeProductionBackends
diff --git a/src/ivivehiclefunctions/doc/qtivivehiclefunctions.qdocconf b/src/ivivehiclefunctions/doc/qtivivehiclefunctions.qdocconf
index f7285e8..6ce8486 100644
--- a/src/ivivehiclefunctions/doc/qtivivehiclefunctions.qdocconf
+++ b/src/ivivehiclefunctions/doc/qtivivehiclefunctions.qdocconf
@@ -1,10 +1,10 @@
headerdirs += .. \
../../imports/vehiclefunctions \
- $$BUILDDIR/../../ivivehiclefunctions \
+ $$BUILDDIR/../ivivehiclefunctions \
sourcedirs += .. \
../../imports/vehiclefunctions \
- $$BUILDDIR/../../ivivehiclefunctions \
+ $$BUILDDIR/../ivivehiclefunctions \
exampledirs += snippets