Skip to content

Commit

Permalink
Doxymentation
Browse files Browse the repository at this point in the history
  • Loading branch information
m-kuhn committed May 15, 2017
1 parent d4edbc0 commit 5c2deb4
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 19 deletions.
4 changes: 4 additions & 0 deletions python/core/qgsdartmeasurement.sip
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ class QgsDartMeasurement

static const QString typeToString( QgsDartMeasurement::Type type );
%Docstring
Convert a QgsDartMeasurement.Type enum to a string that is understood
by the system.

.. versionadded:: 2.
:rtype: str
%End

Expand Down
66 changes: 47 additions & 19 deletions python/core/qgsoptionalexpression.sip
Original file line number Diff line number Diff line change
@@ -1,14 +1,3 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsoptionalexpression.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/




class QgsOptionalExpression
{
%Docstring
Expand Down Expand Up @@ -44,6 +33,53 @@ class QgsOptionalExpression
Construct an optional expression with the provided expression and enabled state.
%End


/**
* Compare this QgsOptionalExpression to another one.
*
* This will compare the enabled flag and call the == operator
* of the contained class.
*
* @note Added in QGIS 3.0
*/
int operator== ( const QgsOptionalExpression &other ) const;
%MethodCode
sipRes = *sipCpp == *a0;
%End %End

int __bool__() const; + QgsOptionalExpression( const QgsExpression &expression, bool enabled );
%MethodCode +%Docstring
sipRes = sipCpp->enabled(); + Construct an optional expression with the provided expression and enabled state.
%End %End

/**
* Check if this optional is enabled
*
* @note Added in QGIS 3.0
*/
bool enabled() const;

/**
* Set if this optional is enabled
*
* @note Added in QGIS 3.0
*/
void setEnabled( bool enabled );

/**
* Access the payload data
*
* @note Added in QGIS 3.0
*/
QgsExpression data() const;

/**
* Set the payload data
*
* @note Added in QGIS 3.0
*/
void setData( const QgsExpression &data );

void writeXml( QDomElement &element );
%Docstring
Save the optional expression to the provided QDomElement.
Expand All @@ -61,11 +97,3 @@ class QgsOptionalExpression
.. versionadded:: 2.18
%End
};

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsoptionalexpression.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
6 changes: 6 additions & 0 deletions src/core/qgsdartmeasurement.h
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,12 @@ class CORE_EXPORT QgsDartMeasurement

void send() const;

/**
* Convert a QgsDartMeasurement::Type enum to a string that is understood
* by the system.
*
* \since QGIS 2.something
*/
static const QString typeToString( QgsDartMeasurement::Type type );

private:
Expand Down

0 comments on commit 5c2deb4

Please sign in to comment.