summaryrefslogtreecommitdiff
path: root/src/ivicore
diff options
context:
space:
mode:
authorDominik Holland <dominik.holland@qt.io>2020-01-22 16:48:08 +0100
committerDominik Holland <dominik.holland@qt.io>2020-01-22 17:04:10 +0100
commit5f1e1e9eb6861480259913b4be59735df267e3ce (patch)
tree6fafc0362ec8268112b38bab33dd237d98a6a795 /src/ivicore
parent533c842385c2275ba02e0343fb90edb3759490be (diff)
downloadqtivi-5f1e1e9eb6861480259913b4be59735df267e3ce.tar.gz
doc: Fix doc warnings
Change-Id: I45bda8e81022f09ff612b0dcabe9e47b75ece238 Reviewed-by: Robert Griebl <robert.griebl@qt.io>
Diffstat (limited to 'src/ivicore')
-rw-r--r--src/ivicore/doc/qtivi-project.qdocconf4
-rw-r--r--src/ivicore/doc/src/configuration.qdoc12
-rw-r--r--src/ivicore/doc/src/examples-qface-ivi-climate.qdoc4
-rw-r--r--src/ivicore/doc/src/ivigenerator/qmake-integration.qdoc2
4 files changed, 13 insertions, 9 deletions
diff --git a/src/ivicore/doc/qtivi-project.qdocconf b/src/ivicore/doc/qtivi-project.qdocconf
index c25fc04..0881745 100644
--- a/src/ivicore/doc/qtivi-project.qdocconf
+++ b/src/ivicore/doc/qtivi-project.qdocconf
@@ -63,10 +63,12 @@ qhp.QtIvi.subprojects.examples.sortPages = true
tagfile = qtivi.tags
-depends += qtcore qtwidgets qtdoc qtquick qtqml qtautomotivesuite qtremoteobjects
+depends += qtcore qtdbus qtwidgets qtdoc qtquick qtqml qtautomotivesuite qtremoteobjects
navigation.homepage = "Qt Automotive Suite"
navigation.landingpage = "Qt IVI"
navigation.cppclassespage = "Qt IVI C++ Classes"
navigation.qmltypespage = "Qt IVI QML Types"
buildversion = "Qt IVI $QT_VERSION"
+
+macro.fileLink = "\\l {https://code.qt.io/cgit/qt/qtivi.git/tree/\1?h=$QT_VER}{\2}"
diff --git a/src/ivicore/doc/src/configuration.qdoc b/src/ivicore/doc/src/configuration.qdoc
index d61cdf3..4e5bd2d 100644
--- a/src/ivicore/doc/src/configuration.qdoc
+++ b/src/ivicore/doc/src/configuration.qdoc
@@ -38,11 +38,13 @@ The following environment variables are supported for runtime configurations:
\li Environment Variable
\li Description
\row
- \li SIMULATOR_HOSTNAME
- \li Specifies where the QtSimulator server is running, such as, the autogenerated control
- panel binaries.
- \note This is only available when the \l {feature-qtsimulator} {QtSimulator Support} is
- enabled.
+ \li QTIVI_SIMULATION_OVERRIDE
+ \li Overrides the simulation file used by a specific simulation engine.
+ See \l {Runtime Override}{QIviSimulationEngine} for more information.
+ \row
+ \li QTIVI_SIMULATION_DATA_OVERRIDE
+ \li Overrides the simulation data used by a specific simulation engine.
+ See \l {Runtime Override}{QIviSimulationEngine} for more information.
\endtable
For more runtime configuration options, see \l{QtIvi Backends}{backend plugins}.
diff --git a/src/ivicore/doc/src/examples-qface-ivi-climate.qdoc b/src/ivicore/doc/src/examples-qface-ivi-climate.qdoc
index 214e172..b42236c 100644
--- a/src/ivicore/doc/src/examples-qface-ivi-climate.qdoc
+++ b/src/ivicore/doc/src/examples-qface-ivi-climate.qdoc
@@ -118,8 +118,8 @@ of each individual item. The second definition is similar, but using the \c flag
\section2 Comments and Annotations
-Compared to the minimal IDL we saw in the previous section,the full
-\l {ivicore/qface-ivi-climate/example-ivi-climate.qface} {IDL file} contains a lot of comments
+Compared to the minimal IDL we saw in the previous section, the full
+\fileLink {examples/ivicore/qface-ivi-climate/example-ivi-climate.qface}{IDL file} contains a lot of comments
and annotations.
Comments starting with \c /** define documentation statements and can be converted into
diff --git a/src/ivicore/doc/src/ivigenerator/qmake-integration.qdoc b/src/ivicore/doc/src/ivigenerator/qmake-integration.qdoc
index f4f2d16..d56459f 100644
--- a/src/ivicore/doc/src/ivigenerator/qmake-integration.qdoc
+++ b/src/ivicore/doc/src/ivigenerator/qmake-integration.qdoc
@@ -74,7 +74,7 @@ The following qmake variables are available:
\row
\li QFACE_IMPORT_PATH
\li A list of import paths, which are considered when an IDL file uses an import statement.
- For more information, see the \l{imports-option}{Import Option}.
+ For more information, see the \l{import-option}{Import Option}.
\endtable
For more details on the generator's command line arguments, see \l {Use the Generator}.