Expand documentation

qgis · Oct 9, 2017 · cbd7973 · cbd7973
1 parent 328eabf
commit cbd7973
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/python/core/qgsproperty.sip b/python/core/qgsproperty.sip
@@ -107,13 +107,17 @@ class QgsPropertyDefinition
 
     QString origin() const;
 %Docstring
- Returns the origin of the property
+ Returns the origin of the property. For example, a PAL property has an
+ origin set to "labeling" while a diagram property has an origin set to
+ "diagram".
  :rtype: str
 %End
 
     void setOrigin( const QString &origin );
 %Docstring
- Sets origin of the property
+ Sets the origin of the property. For example, a PAL property has an
+ origin set to "labeling" while a diagram property has an origin set to
+ "diagram".
 %End
 
     QString description() const;

diff --git a/src/core/qgsproperty.h b/src/core/qgsproperty.h
@@ -143,12 +143,16 @@ class CORE_EXPORT QgsPropertyDefinition
     void setName( const QString &name ) { mName = name; }
 
     /**
-     * Returns the origin of the property
+     * Returns the origin of the property. For example, a PAL property has an
+     * origin set to "labeling" while a diagram property has an origin set to
+     * "diagram".
      */
     QString origin() const { return mOrigin; }
 
     /**
-     * Sets origin of the property
+     * Sets the origin of the property. For example, a PAL property has an
+     * origin set to "labeling" while a diagram property has an origin set to
+     * "diagram".
      */
     void setOrigin( const QString &origin ) { mOrigin = origin; }