Added notes to newly added methods

git-svn-id: http://svn.osgeo.org/qgis/trunk@13390 c8812cc2-4d05-0410-92ff-de0c093fc19c
qgis · Apr 25, 2010 · 313c107 · 313c107
1 parent 02df126
commit 313c107
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/python/core/symbology-ng-core.sip b/python/core/symbology-ng-core.sip
@@ -133,10 +133,14 @@ public:
   QgsSymbolV2* symbol() const;
   void setSymbol(QgsSymbolV2* s /Transfer/);
 
+  //! @note added in 1.5
   void setRotationField(QString fieldName);
+  //! @note added in 1.5
   QString rotationField() const;
 
+  //! @note added in 1.5
   void setSizeScaleField(QString fieldName);
+  //! @note added in 1.5
   QString sizeScaleField() const;
 
   virtual QString dump();
@@ -474,7 +478,9 @@ class QgsSymbolV2RenderContext
     bool selected() const;
     void setSelected( bool selected ) const;
 
+    //! @note added in 1.5
     int renderHints() const;
+    //! @note added in 1.5
     void setRenderHints( int hints );
 
     // Colour used for selections
@@ -521,6 +527,7 @@ public:
   	Fill
   };
 
+    //! @note added in 1.5
     enum RenderHint
     {
       DataDefinedSizeScale = 1,
@@ -576,7 +583,9 @@ public:
     qreal alpha() const;
     void setAlpha( qreal alpha );
 
+    //! @note added in 1.5
     int renderHints() const;
+    //! @note added in 1.5
     void setRenderHints( int hints );
 
 protected:

diff --git a/src/core/symbology-ng/qgssinglesymbolrendererv2.h b/src/core/symbology-ng/qgssinglesymbolrendererv2.h
@@ -22,10 +22,14 @@ class CORE_EXPORT QgsSingleSymbolRendererV2 : public QgsFeatureRendererV2
     QgsSymbolV2* symbol() const;
     void setSymbol( QgsSymbolV2* s );
 
+    //! @note added in 1.5
     void setRotationField( QString fieldName ) { mRotationField = fieldName; }
+    //! @note added in 1.5
     QString rotationField() const { return mRotationField; }
 
+    //! @note added in 1.5
     void setSizeScaleField( QString fieldName ) { mSizeScaleField = fieldName; }
+    //! @note added in 1.5
     QString sizeScaleField() const { return mSizeScaleField; }
 
     virtual QString dump();

diff --git a/src/core/symbology-ng/qgssymbolv2.h b/src/core/symbology-ng/qgssymbolv2.h
@@ -35,6 +35,7 @@ class CORE_EXPORT QgsSymbolV2
       Fill
     };
 
+    //! @note added in 1.5
     enum RenderHint
     {
       DataDefinedSizeScale = 1,
@@ -90,7 +91,9 @@ class CORE_EXPORT QgsSymbolV2
     qreal alpha() const { return mAlpha; }
     void setAlpha( qreal alpha ) { mAlpha = alpha; }
 
+    //! @note added in 1.5
     void setRenderHints( int hints ) { mRenderHints = hints; }
+    //! @note added in 1.5
     int renderHints() { return mRenderHints; }
 
   protected:
@@ -129,7 +132,9 @@ class CORE_EXPORT QgsSymbolV2RenderContext
     bool selected() const { return mSelected; }
     void setSelected( bool selected ) { mSelected = selected; }
 
+    //! @note added in 1.5
     int renderHints() const { return mRenderHints; }
+    //! @note added in 1.5
     void setRenderHints( int hints ) { mRenderHints = hints; }
 
     // Colour used for selections