API documentation

Author: m-kuhn

python/core/symbology/qgsgraduatedsymbolrenderer.sip.in

@@ -442,7 +442,7 @@ Will return null if the functionality is disabled.
 
     QgsSymbol *symbolForValue( double value ) const;
 %Docstring
-attribute index (derived from attribute name in startRender)
+Get the symbol which is used to represent ``value``.
 %End
 
     QString legendKeyForValue( double value ) const;

python/core/symbology/qgsrenderer.sip.in

@@ -482,6 +482,12 @@ implementation does not use subrenderers and will always return null.
                                   int layer,
                                   bool selected,
                                   bool drawVertexMarker );
+%Docstring
+Render the ``feature`` with the ``symbol`` using ``context``.
+Use ``layer`` to specify the symbol layer, ``selected`` to
+specify if it should be rendered as selected and ``drawVertexMarker``
+to specify if vertex markers should be rendered.
+%End
 
     void renderVertexMarker( QPointF pt, QgsRenderContext &context );
 %Docstring

src/core/symbology/qgsgraduatedsymbolrenderer.h

@@ -408,6 +408,9 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer
 
     std::unique_ptr<QgsDataDefinedSizeLegend> mDataDefinedSizeLegend;
 
+    /**
+     * Get the symbol which is used to represent \a value.
+     */
     QgsSymbol *symbolForValue( double value ) const;
 
     /**

src/core/symbology/qgsrenderer.h

@@ -462,6 +462,12 @@ class CORE_EXPORT QgsFeatureRenderer
   protected:
     QgsFeatureRenderer( const QString &type );
 
+    /**
+     * Render the \a feature with the \a symbol using \a context.
+     * Use \a layer to specify the symbol layer, \a selected to
+     * specify if it should be rendered as selected and \a drawVertexMarker
+     * to specify if vertex markers should be rendered.
+     */
     void renderFeatureWithSymbol( const QgsFeature &feature,
                                   QgsSymbol *symbol,
                                   QgsRenderContext &context,