Fix doxygen warnings

qgis · Jan 18, 2019 · eb256e9 · eb256e9
1 parent 2df5893
commit eb256e9
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/python/core/auto_generated/qgslegendsettings.sip.in b/python/core/auto_generated/qgslegendsettings.sip.in
@@ -199,11 +199,12 @@ The ``scale`` value indicates the scale denominator, e.g. 1000.0 for a 1:1000 ma
 
 
 
-    QStringList evaluateItemText( const QString &stringToSplt, const QgsExpressionContext &context ) const;
+    QStringList evaluateItemText( const QString &text, const QgsExpressionContext &context ) const;
 %Docstring
 Returns the actual text to render for a legend item, split into separate lines.
 
-:param ctx: Context for rendering - may be null if only doing layout without actual rendering
+The expression ``context`` argument is used to correctly evaluated expressions contained
+within legend item text.
 
 .. versionadded:: 3.6
 %End

diff --git a/src/core/qgslegendsettings.cpp b/src/core/qgslegendsettings.cpp
@@ -37,9 +37,9 @@ QgsLegendSettings::QgsLegendSettings()
   rstyle( QgsLegendStyle::SymbolLabel ).rfont().setPointSizeF( 12.0 );
 }
 
-QStringList QgsLegendSettings::evaluateItemText( const QString &stringToSplt, const QgsExpressionContext &context ) const
+QStringList QgsLegendSettings::evaluateItemText( const QString &text, const QgsExpressionContext &context ) const
 {
-  const QString textToRender = QgsExpression::replaceExpressionText( stringToSplt, &context );
+  const QString textToRender = QgsExpression::replaceExpressionText( text, &context );
   return splitStringForWrapping( textToRender );
 }
 

diff --git a/src/core/qgslegendsettings.h b/src/core/qgslegendsettings.h
@@ -191,11 +191,12 @@ class CORE_EXPORT QgsLegendSettings
     /**
      * Returns the actual text to render for a legend item, split into separate lines.
      *
-     * \param ctx Context for rendering - may be null if only doing layout without actual rendering
+     * The expression \a context argument is used to correctly evaluated expressions contained
+     * within legend item text.
      *
      * \since QGIS 3.6
      */
-    QStringList evaluateItemText( const QString &stringToSplt, const QgsExpressionContext &context ) const;
+    QStringList evaluateItemText( const QString &text, const QgsExpressionContext &context ) const;
 
     /**
      * Splits a string using the wrap char taking into account handling empty