aboutsummaryrefslogtreecommitdiffstats
path: root/src/geniviextras/doc
diff options
context:
space:
mode:
Diffstat (limited to 'src/geniviextras/doc')
-rw-r--r--src/geniviextras/doc/online/qtgeniviextras.qdocconf10
-rw-r--r--src/geniviextras/doc/qtgeniviextras-project.qdocconf51
-rw-r--r--src/geniviextras/doc/qtgeniviextras.qdocconf12
-rw-r--r--src/geniviextras/doc/src/external-resources.qdoc36
-rw-r--r--src/geniviextras/doc/src/qtgeniviextras.qdoc35
5 files changed, 134 insertions, 10 deletions
diff --git a/src/geniviextras/doc/online/qtgeniviextras.qdocconf b/src/geniviextras/doc/online/qtgeniviextras.qdocconf
new file mode 100644
index 0000000..7fdeef8
--- /dev/null
+++ b/src/geniviextras/doc/online/qtgeniviextras.qdocconf
@@ -0,0 +1,10 @@
+include($QT_INSTALL_DOCS/global/qt-module-defaults-online.qdocconf)
+
+# Add an .html file with sidebar content, used in the online style
+# HTML.stylesheets += style/qt5-sidebar.html
+
+# override defaults for Qt module documentation
+HTML.nosubdirs = "false"
+HTML.outputsubdir = "qtgeniviextras"
+
+include(../qtgeniviextras-project.qdocconf)
diff --git a/src/geniviextras/doc/qtgeniviextras-project.qdocconf b/src/geniviextras/doc/qtgeniviextras-project.qdocconf
new file mode 100644
index 0000000..89b2ccc
--- /dev/null
+++ b/src/geniviextras/doc/qtgeniviextras-project.qdocconf
@@ -0,0 +1,51 @@
+project = QtGeniviExtras
+description = QtGeniviExtras Reference Documentation
+version = $QT_VERSION
+url = http://doc.qt.io/QtGeniviExtras
+
+sourcedirs += .
+headerdirs += .
+headerdirs += ..
+sourcedirs += ..
+
+exampledirs += ../../../examples/geniviextras \
+ snippets
+
+examplesinstallpath = geniviextras
+
+imagedirs += images
+
+qhp.projects = QtGeniviExtras
+
+qhp.QtGeniviExtras.file = qtgeniviextras.qhp
+qhp.QtGeniviExtras.namespace = org.qt-project.qtgeniviextras.$QT_VERSION_TAG
+qhp.QtGeniviExtras.virtualFolder = qtgeniviextras
+qhp.QtGeniviExtras.indexTitle = Qt GENIVI Extras
+qhp.QtGeniviExtras.indexRoot =
+
+qhp.QtGeniviExtras.filterAttributes = qtgeniviextras $QT_VERSION qtrefdoc
+qhp.QtGeniviExtras.customFilters.Qt.name = QtGeniviExtras $QT_VERSION
+qhp.QtGeniviExtras.customFilters.Qt.filterAttributes = qtgeniviextras $QT_VERSION
+
+qhp.QtGeniviExtras.subprojects = classes qml examples
+
+qhp.QtGeniviExtras.subprojects.classes.title = C++ Classes
+qhp.QtGeniviExtras.subprojects.classes.indexTitle = Qt GENIVI Extras C++ Classes
+qhp.QtGeniviExtras.subprojects.classes.selectors = class fake:headerfile
+qhp.QtGeniviExtras.subprojects.classes.sortPages = true
+
+qhp.QtGeniviExtras.subprojects.examples.title = Examples
+qhp.QtGeniviExtras.subprojects.examples.indexTitle = Qt GENIVI Extras Examples
+qhp.QtGeniviExtras.subprojects.examples.selectors = fake:example
+qhp.QtGeniviExtras.subprojects.examples.sortPages = true
+
+tagfile = qtgeniviextras.tags
+
+depends += qtcore qtdoc qtautomotivesuite
+
+indexes += ../../../doc/qtautomotivesuite/qtautomotivesuite.index
+
+navigation.homepage = "Qt Automotive Suite"
+navigation.landingpage = "Qt GENIVI Extras"
+navigation.cppclassespage = "Qt GENIVI Extras C++ Classes"
+buildversion = "Qt GENIVI Extras"
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/geniviextras/doc/src/external-resources.qdoc b/src/geniviextras/doc/src/external-resources.qdoc
new file mode 100644
index 0000000..896fa13
--- /dev/null
+++ b/src/geniviextras/doc/src/external-resources.qdoc
@@ -0,0 +1,36 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 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$
+**
+****************************************************************************/
+
+/*!
+ \externalpage http://www.genivi.org/
+ \title GENIVI
+*/
+
+/*!
+ \externalpage https://doc.qt.io/QtAutomotiveSuite/index.html
+ \title Qt Automotive Suite
+*/
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