diff options
author | Dominik Holland <dominik.holland@pelagicore.com> | 2018-05-11 20:27:26 +0200 |
---|---|---|
committer | Robert Griebl <robert.griebl@pelagicore.com> | 2018-05-14 15:17:22 +0000 |
commit | dc88c208b36396f195305a2038d5a39d8e0ef2be (patch) | |
tree | 4b7e03a365cd2a18c62c911d63a8ca22e456f15f /src/geniviextras/doc/src/qtgeniviextras.qdoc | |
parent | 88773675135d61c47cece80c76e02b20de13e06f (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>
Diffstat (limited to 'src/geniviextras/doc/src/qtgeniviextras.qdoc')
-rw-r--r-- | src/geniviextras/doc/src/qtgeniviextras.qdoc | 35 |
1 files changed, 35 insertions, 0 deletions
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 |