Add better api docs on Property usage

mbernasocchi · nyalldawson · commit e29ccb7af8f5 · 2019-01-21T17:46:58.000+11:00
(cherry picked from commit 6dc537f)
diff --git a/src/core/layout/qgslayoutobject.h b/src/core/layout/qgslayoutobject.h
@@ -225,13 +225,15 @@ class CORE_EXPORT QgsLayoutObject: public QObject, public QgsExpressionContextGe
     /**
      * Returns a reference to the object's property collection, used for data defined overrides.
      * \see setDataDefinedProperties()
+     * \see DataDefinedProperty
      */
     const QgsPropertyCollection &dataDefinedProperties() const { return mDataDefinedProperties; } SIP_SKIP
 
     /**
      * Sets the objects's property collection, used for data defined overrides.
      * \param collection property collection. Existing properties will be replaced.
      * \see dataDefinedProperties()
+     * \see DataDefinedProperty
      */
     void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; }
 
diff --git a/src/core/qgsdiagramrenderer.h b/src/core/qgsdiagramrenderer.h
@@ -308,6 +308,7 @@ class CORE_EXPORT QgsDiagramLayerSettings
     /**
      * Returns a reference to the diagram's property collection, used for data defined overrides.
      * \see setDataDefinedProperties()
+     * \see Property
      * \note not available in Python bindings
      * \since QGIS 3.0
      */
@@ -317,6 +318,7 @@ class CORE_EXPORT QgsDiagramLayerSettings
      * Sets the diagram's property collection, used for data defined overrides.
      * \param collection property collection. Existing properties will be replaced.
      * \see dataDefinedProperties()
+     * \see Property
      * \since QGIS 3.0
      */
     void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; }
diff --git a/src/core/qgspallabeling.h b/src/core/qgspallabeling.h
@@ -793,6 +793,7 @@ class CORE_EXPORT QgsPalLayerSettings
     /**
      * Returns a reference to the label's property collection, used for data defined overrides.
      * \see setDataDefinedProperties()
+     * \see Property
      * \note not available in Python bindings
      * \since QGIS 3.0
      */
@@ -802,6 +803,7 @@ class CORE_EXPORT QgsPalLayerSettings
      * Sets the label's property collection, used for data defined overrides.
      * \param collection property collection. Existing properties will be replaced.
      * \see dataDefinedProperties()
+     * \see Property
      * \since QGIS 3.0
      */
     void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; }
diff --git a/src/core/qgspropertycollection.h b/src/core/qgspropertycollection.h
@@ -274,6 +274,14 @@ class CORE_EXPORT QgsAbstractPropertyCollection
  * Properties within a collection are referenced by an integer key. This is done to avoid the cost of
  * string creation and comparisons which would be required by a string key. The intended use case is that
  * a context specific enum is cast to int and used for the key value.
+ * Examples of such enums are :
+ * \see QgsLayoutObject::DataDefinedProperty
+ * \see QgsSymbolLayer::Property
+ * \see QgsPalLabeling::Property
+ * \see QgsAbstract3DSymbol::Property
+ * \see QgsDiagramLayerSettings::Property
+ * \see QgsPalLayerSettings::Property
+ * \see QgsWidgetWrapper::Property
  * \since QGIS 3.0
  */
 
diff --git a/src/gui/editorwidgets/core/qgswidgetwrapper.h b/src/gui/editorwidgets/core/qgswidgetwrapper.h
@@ -181,6 +181,7 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject
     /**
      * Returns a reference to the editor widget's property collection, used for data defined overrides.
      * \see setDataDefinedProperties()
+     * \see Property
      * \since QGIS 3.0
      */
     const QgsPropertyCollection &dataDefinedProperties() const { return mPropertyCollection; }
@@ -189,6 +190,7 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject
      * Sets the editor widget's property collection, used for data defined overrides.
      * \param collection property collection. Existing properties will be replaced.
      * \see dataDefinedProperties()
+     * \see Property
      * \since QGIS 3.0
      */
     void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mPropertyCollection = collection; }
