Skip to content

Commit

Permalink
Add note to QgsExpressionContext docs to point to QgsExpressionContex…
Browse files Browse the repository at this point in the history
…tUtils
  • Loading branch information
nyalldawson committed Apr 18, 2016
1 parent c24938e commit 33e7d1b
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
7 changes: 7 additions & 0 deletions python/core/qgsexpressioncontext.sip
Expand Up @@ -39,6 +39,9 @@ class QgsScopedExpressionFunction : QgsExpression::Function
* Examples include a project's scope, which could contain information about the current project such as
* the project file's location. QgsExpressionContextScope can encapsulate both variables (static values)
* and functions(which are calculated only when an expression is evaluated).
*
* See QgsExpressionContextUtils for helper methods for working with QgsExpressionContextScope objects.
*
* \note added in QGIS 2.12
*/

Expand Down Expand Up @@ -191,13 +194,17 @@ class QgsExpressionContextScope
void setFields( const QgsFields& fields );
};


/** \ingroup core
* \class QgsExpressionContext
* \brief Expression contexts are used to encapsulate the parameters around which a QgsExpression should
* be evaluated. QgsExpressions can then utilise the information stored within a context to contextualise
* their evaluated result. A QgsExpressionContext consists of a stack of QgsExpressionContextScope objects,
* where scopes added later to the stack will override conflicting variables and functions from scopes
* lower in the stack.
*
* See QgsExpressionContextUtils for helper methods for working with QgsExpressionContext objects.
*
* \note added in QGIS 2.12
*/

Expand Down
6 changes: 6 additions & 0 deletions src/core/qgsexpressioncontext.h
Expand Up @@ -70,6 +70,9 @@ class CORE_EXPORT QgsScopedExpressionFunction : public QgsExpression::Function
* Examples include a project's scope, which could contain information about the current project such as
* the project file's location. QgsExpressionContextScope can encapsulate both variables (static values)
* and functions(which are calculated only when an expression is evaluated).
*
* See QgsExpressionContextUtils for helper methods for working with QgsExpressionContextScope objects.
*
* \note added in QGIS 2.12
*/

Expand Down Expand Up @@ -235,6 +238,9 @@ class CORE_EXPORT QgsExpressionContextScope
* their evaluated result. A QgsExpressionContext consists of a stack of QgsExpressionContextScope objects,
* where scopes added later to the stack will override conflicting variables and functions from scopes
* lower in the stack.
*
* See QgsExpressionContextUtils for helper methods for working with QgsExpressionContext objects.
*
* \note added in QGIS 2.12
*/
class CORE_EXPORT QgsExpressionContext
Expand Down

0 comments on commit 33e7d1b

Please sign in to comment.