diff options
author | Paolo Angelelli <paolo.angelelli@qt.io> | 2019-09-24 10:49:13 +0200 |
---|---|---|
committer | paolo <paolo.angelelli@qt.io> | 2019-10-31 11:17:34 +0100 |
commit | 6b3878c8d2894d4c7bb704e35d41c3430a1749d2 (patch) | |
tree | b61fd338d811305f4d42f55e2d48aef86fe14f1a /src/location/declarativemaps | |
parent | 32b6b1c8266876cae07839529ebae0b5f5047ba7 (diff) | |
download | qtlocation-6b3878c8d2894d4c7bb704e35d41c3430a1749d2.tar.gz |
Improve DynamicParameter documentation
Change-Id: I2900e1ccc5291148fdc7801c1b6af43ea611db28
Fixes: QTBUG-78712
(cherry picked from commit 9ac4e00e21f5fd7a1a53343d1cf9f4fcaeff01a5)
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
Diffstat (limited to 'src/location/declarativemaps')
-rw-r--r-- | src/location/declarativemaps/qdeclarativegeomapparameter.cpp | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/src/location/declarativemaps/qdeclarativegeomapparameter.cpp b/src/location/declarativemaps/qdeclarativegeomapparameter.cpp index c1361d5d..8829e88d 100644 --- a/src/location/declarativemaps/qdeclarativegeomapparameter.cpp +++ b/src/location/declarativemaps/qdeclarativegeomapparameter.cpp @@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE \since QtLocation 5.9 \deprecated - Use \l DynamicParameter instead. + This type is deprecated and has been remamed into \l DynamicParameter. */ /*! @@ -60,9 +60,11 @@ QT_BEGIN_NAMESPACE \ingroup qml-QtLocation5-maps \since Qt Location 5.11 - \brief The DynamicParameter type represents a parameter for a Map element. - This type provides a mean to specify plugin-dependent optional parameters - for a map. + \brief The DynamicParameter (previously \l MapParameter ) type represents a parameter for a Map element, + or other elements used in a Map (such as map items, etc.). + This type provides a mean to specify plugin-dependent optional dynamic parameters that allow a plugin to + extend the runtime API of the module. + DynamicParameters by default contain only the \l type property, and are highly plugin-dependent. @@ -71,8 +73,8 @@ QT_BEGIN_NAMESPACE What properties have to be put inside a particular DynamicParameter type for a particular plugin can be found in the documentation of the plugin. - Note that DynamicParameters are \b optional. - By not specifying any of them, the Map will have the default behavior. + \note DynamicParameters are \b optional. + By not specifying any of them, the Map, or other container elements, will have the default behavior. */ /*! |