diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2018-03-26 09:40:56 +0200 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@qt.io> | 2018-03-27 10:16:26 +0000 |
| commit | acc8bc079cda6a31a9d19dca860a1a2db378addf (patch) | |
| tree | ba4062a266431d7724d528c89364e9c1dc2f2be2 /src/location/declarativemaps/qdeclarativegeomaptype.cpp | |
| parent | 0af62cbe7ddf6a6ef858daa63b0ab02426d3aad9 (diff) | |
| download | qtlocation-acc8bc079cda6a31a9d19dca860a1a2db378addf.tar.gz | |
Doc: Fix all documentation warnings
Fix multiple warnings caused by invalid documentation configuration,
missing QML module specifiers, wrong QML type names, incorrect
arguments for the \fn command, and missing documentation.
Remove incorrect statement from the example usage of the Waypoint
QML type.
Use 'QtLocation' as the name for the module throughout the docs.
Clang (used as the parser for QDoc in Qt 5.11) was unable to
resolve the path for qlocation.h, causing QDoc to omit the
QLocation namespace documentation. Fix this by including the
file explicitly from qlocationglobal.h for documentation
builds.
Change-Id: I2bd790db1ff5ad96f0cdb415a682b97593b3a6dc
Reviewed-by: Martin Smith <martin.smith@qt.io>
Diffstat (limited to 'src/location/declarativemaps/qdeclarativegeomaptype.cpp')
| -rw-r--r-- | src/location/declarativemaps/qdeclarativegeomaptype.cpp | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/location/declarativemaps/qdeclarativegeomaptype.cpp b/src/location/declarativemaps/qdeclarativegeomaptype.cpp index 7e40d414..66ceaac0 100644 --- a/src/location/declarativemaps/qdeclarativegeomaptype.cpp +++ b/src/location/declarativemaps/qdeclarativegeomaptype.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE \inherits QObject \inqmlmodule QtLocation \ingroup qml-QtLocation5-maps - \since Qt Location 5.5 + \since QtLocation 5.5 \brief The MapType type holds information about a map type. @@ -121,7 +121,7 @@ bool QDeclarativeGeoMapType::mobile() const /*! \qmlproperty bool MapType::night - \since Qt Location 5.4 + \since QtLocation 5.4 \brief Whether the map type is optimized for use at night. @@ -134,7 +134,7 @@ bool QDeclarativeGeoMapType::night() const /*! \qmlproperty CameraCapabilities MapType::cameraCapabilities - \since Qt Location 5.10 + \since QtLocation 5.10 This property holds the camera capabilities for this map type. */ @@ -145,7 +145,7 @@ QDeclarativeGeoCameraCapabilities *QDeclarativeGeoMapType::cameraCapabilities() /*! \qmlproperty VariantMap MapType::metadata - \since Qt Location 5.10 + \since QtLocation 5.10 This property holds optional, extra metadata related to a specific map type. The content of this property is entirely plugin-specific. @@ -165,7 +165,7 @@ QVariantMap QDeclarativeGeoMapType::metadata() const \inherits QObject \inqmlmodule QtLocation \ingroup qml-QtLocation5-maps - \since Qt Location 5.10 + \since QtLocation 5.10 \brief The CameraCapabilities type holds information about the camera capabilities for a specific map type. |