diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2018-10-24 13:29:18 +0200 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@qt.io> | 2018-10-25 09:43:29 +0000 |
| commit | f9d223b03eb047c806ab4046318d9b76ff39136c (patch) | |
| tree | b2469f02669505d82e3bb24e2d7a544a60740a9e | |
| parent | 448b3a35cea27878a3123ec7e40f875032dd3267 (diff) | |
| download | qtlocation-f9d223b03eb047c806ab4046318d9b76ff39136c.tar.gz | |
Doc: Fix \code command usage
Since Qt 5.12, \code command accepts parameters, and in-line usage
no longer works (and was never documented to work).
Also, use \badcode for qmake snippets to make it appear as plain text.
Task-number: QTBUG-70980
Change-Id: I53cafdc912b4663d03c19b0a0003693330c94f15
Reviewed-by: Martin Smith <martin.smith@qt.io>
| -rw-r--r-- | src/location/doc/src/qtlocation.qdoc | 16 | ||||
| -rw-r--r-- | src/positioning/doc/src/qtpositioning.qdoc | 17 |
2 files changed, 24 insertions, 9 deletions
diff --git a/src/location/doc/src/qtlocation.qdoc b/src/location/doc/src/qtlocation.qdoc index 1f27a14a..77c2cd99 100644 --- a/src/location/doc/src/qtlocation.qdoc +++ b/src/location/doc/src/qtlocation.qdoc @@ -45,12 +45,16 @@ Include the appropriate header in your C++ code. For example, applications using routes can include: - \code #include <QGeoRoute> \endcode + \code + #include <QGeoRoute> + \endcode Add the \e location keyword in the project file to link against the Qt Location library: - \code QT += location \endcode + \badcode + QT += location + \endcode See more in the \l{Qt Location}{Qt Location Overview}. @@ -95,11 +99,15 @@ import the QtPositioning module as well. For C++ projects include the header appropriate for the current use case, for example applications using routes may use -\code #include <QGeoRoute> \endcode +\code +#include <QGeoRoute> +\endcode The .pro file should have the \e location keyword added -\code QT += location \endcode +\code +QT += location +\endcode \section2 Submodules diff --git a/src/positioning/doc/src/qtpositioning.qdoc b/src/positioning/doc/src/qtpositioning.qdoc index f0094ff0..7c30ef07 100644 --- a/src/positioning/doc/src/qtpositioning.qdoc +++ b/src/positioning/doc/src/qtpositioning.qdoc @@ -40,12 +40,15 @@ For C++ projects include the header appropriate for the current use case, for example applications using routes may use - \code #include <QGeoCoordinate> \endcode + \code + #include <QGeoCoordinate> + \endcode The .pro file should have the \e positioning keyword added - \code QT += positioning \endcode - + \badcode + QT += positioning + \endcode See more in the \l{Qt Positioning}{Qt Positioning Overview}. @@ -87,11 +90,15 @@ To load the Qt Positioning module, add the following statement to your .qml file For C++ projects include the header appropriate for the current use case, for example applications using routes may use -\code #include <QGeoCoordinate> \endcode +\code +#include <QGeoCoordinate> +\endcode The .pro file should have the \e positioning keyword added -\code QT += positioning \endcode +\badcode +QT += positioning +\endcode \section1 Licenses |