Skip to content

Commit

Permalink
Fix doxygen warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
nyalldawson committed Jan 18, 2019
1 parent 2df5893 commit eb256e9
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
5 changes: 3 additions & 2 deletions python/core/auto_generated/qgslegendsettings.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/core/qgslegendsettings.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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 );
}

Expand Down
5 changes: 3 additions & 2 deletions src/core/qgslegendsettings.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit eb256e9

Please sign in to comment.