aboutsummaryrefslogtreecommitdiffstats
path: root/src/geniviextras/doc/src
diff options
context:
space:
mode:
Diffstat (limited to 'src/geniviextras/doc/src')
-rw-r--r--src/geniviextras/doc/src/external-resources.qdoc36
-rw-r--r--src/geniviextras/doc/src/qtgeniviextras.qdoc35
2 files changed, 71 insertions, 0 deletions
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