Fix doxygen warnings

This commit is contained in:
Nyall Dawson 2019-01-18 15:46:12 +10:00
parent 2df58932e6
commit eb256e9498
3 changed files with 8 additions and 6 deletions

View File

@ -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 %Docstring
Returns the actual text to render for a legend item, split into separate lines. 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 .. versionadded:: 3.6
%End %End

View File

@ -37,9 +37,9 @@ QgsLegendSettings::QgsLegendSettings()
rstyle( QgsLegendStyle::SymbolLabel ).rfont().setPointSizeF( 12.0 ); 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 ); return splitStringForWrapping( textToRender );
} }

View File

@ -191,11 +191,12 @@ class CORE_EXPORT QgsLegendSettings
/** /**
* Returns the actual text to render for a legend item, split into separate lines. * 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 * \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 * Splits a string using the wrap char taking into account handling empty