Added some comments explaining how alpha works

timlinux · timlinux · commit c1b268c2d50f · 2012-02-24T12:22:42.000+02:00
diff --git a/python/core/symbology-ng-core.sip b/python/core/symbology-ng-core.sip
@@ -624,7 +624,9 @@ class QgsSymbolV2RenderContext
     QgsSymbolV2::OutputUnit outputUnit() const;
     void setOutputUnit( QgsSymbolV2::OutputUnit u );
 
+    //! Get alpha transparency 1 for opaque, 0 for invisible
     qreal alpha() const;
+    //! Set alpha transparency 1 for opaque, 0 for invisible
     void setAlpha( qreal alpha );
 
     bool selected() const;
diff --git a/src/core/symbology-ng/qgssymbolv2.h b/src/core/symbology-ng/qgssymbolv2.h
@@ -92,7 +92,9 @@ class CORE_EXPORT QgsSymbolV2
     OutputUnit outputUnit() const { return mOutputUnit; }
     void setOutputUnit( OutputUnit u ) { mOutputUnit = u; }
 
+    //! Get alpha transparency 1 for opaque, 0 for invisible
     qreal alpha() const { return mAlpha; }
+    //! Set alpha transparency 1 for opaque, 0 for invisible
     void setAlpha( qreal alpha ) { mAlpha = alpha; }
 
     //! @note added in 1.5
@@ -137,7 +139,9 @@ class CORE_EXPORT QgsSymbolV2RenderContext
     QgsSymbolV2::OutputUnit outputUnit() const { return mOutputUnit; }
     void setOutputUnit( QgsSymbolV2::OutputUnit u ) { mOutputUnit = u; }
 
+    //! Get alpha transparency 1 for opaque, 0 for invisible
     qreal alpha() const { return mAlpha; }
+    //! Set alpha transparency 1 for opaque, 0 for invisible
     void setAlpha( qreal alpha ) { mAlpha = alpha; }
 
     bool selected() const { return mSelected; }
