From 4bb7f82fcb61c7a9e5260fa3b547f3f8656e7192 Mon Sep 17 00:00:00 2001 From: Nyall Dawson Date: Sat, 26 May 2018 16:51:58 +1000 Subject: [PATCH] Remove some incorrect 'not available in Python bindings' notes --- .../geometry/qgsabstractgeometry.sip.in | 4 ---- .../layertree/qgslayertreeutils.sip.in | 5 +--- .../layout/qgslayoutmanager.sip.in | 4 ---- .../core/auto_generated/qgsapplication.sip.in | 4 ---- .../core/auto_generated/qgscolorramp.sip.in | 4 ---- python/core/auto_generated/qgsrelation.sip.in | 4 ---- .../auto_generated/qgsrenderchecker.sip.in | 4 ---- .../symbology/qgsmarkersymbollayer.sip.in | 24 ------------------- .../qgsrelationwidgetwrapper.sip.in | 6 ----- src/core/geometry/qgsabstractgeometry.h | 1 - src/core/layertree/qgslayertreeutils.h | 4 +++- src/core/layout/qgslayoutmanager.h | 1 - src/core/qgsapplication.h | 1 - src/core/qgscolorramp.h | 1 - src/core/qgsrelation.h | 1 - src/core/qgsrenderchecker.h | 1 - src/core/symbology/qgsmarkersymbollayer.h | 6 ----- .../editorwidgets/qgsrelationwidgetwrapper.h | 1 - 18 files changed, 4 insertions(+), 72 deletions(-) diff --git a/python/core/auto_generated/geometry/qgsabstractgeometry.sip.in b/python/core/auto_generated/geometry/qgsabstractgeometry.sip.in index 04a20fe1f51..5cac2dba0af 100644 --- a/python/core/auto_generated/geometry/qgsabstractgeometry.sip.in +++ b/python/core/auto_generated/geometry/qgsabstractgeometry.sip.in @@ -624,10 +624,6 @@ To create it, the geometry is default constructed and then the WKB is changed. .. seealso:: :py:func:`clone` .. versionadded:: 3.0 - -.. note:: - - Not available in Python bindings %End protected: diff --git a/python/core/auto_generated/layertree/qgslayertreeutils.sip.in b/python/core/auto_generated/layertree/qgslayertreeutils.sip.in index 99319febcd8..a593793761d 100644 --- a/python/core/auto_generated/layertree/qgslayertreeutils.sip.in +++ b/python/core/auto_generated/layertree/qgslayertreeutils.sip.in @@ -66,10 +66,7 @@ Remove subtree of embedded groups and replaces it with a custom property embedde static void updateEmbeddedGroupsProjectPath( QgsLayerTreeGroup *group, const QgsProject *project ); %Docstring - -.. note:: - - not available in Python bindings +Updates an embedded ``group`` from a ``project``. %End static QStringList invisibleLayerList( QgsLayerTreeNode *node ); diff --git a/python/core/auto_generated/layout/qgslayoutmanager.sip.in b/python/core/auto_generated/layout/qgslayoutmanager.sip.in index 89c419c1679..2d46585da43 100644 --- a/python/core/auto_generated/layout/qgslayoutmanager.sip.in +++ b/python/core/auto_generated/layout/qgslayoutmanager.sip.in @@ -24,10 +24,6 @@ rather accessed through a QgsProject via :py:func:`QgsProject.layoutManager()` QgsLayoutManager retains ownership of all the layouts contained in the manager. - -.. note:: - - Not available in Python bindings %End %TypeHeaderCode diff --git a/python/core/auto_generated/qgsapplication.sip.in b/python/core/auto_generated/qgsapplication.sip.in index 3be1e554793..653723f6e8a 100644 --- a/python/core/auto_generated/qgsapplication.sip.in +++ b/python/core/auto_generated/qgsapplication.sip.in @@ -745,10 +745,6 @@ Get the registry of available field formatters. %Docstring Returns registry of available 3D renderers. -.. note:: - - not available in Python bindings - .. versionadded:: 3.0 %End diff --git a/python/core/auto_generated/qgscolorramp.sip.in b/python/core/auto_generated/qgscolorramp.sip.in index f558b0a3248..70779dc53aa 100644 --- a/python/core/auto_generated/qgscolorramp.sip.in +++ b/python/core/auto_generated/qgscolorramp.sip.in @@ -514,10 +514,6 @@ Constructor for QgsPresetSchemeColorRamp. Constructor for :py:class:`QgsPresetColorRamp`. :param colors: list of named colors in ramp - -.. note:: - - not available in Python bindings - use setColors instead %End static QgsColorRamp *create( const QgsStringMap &properties = QgsStringMap() ) /Factory/; diff --git a/python/core/auto_generated/qgsrelation.sip.in b/python/core/auto_generated/qgsrelation.sip.in index ae33fd7dcf3..6b58ebc3aa8 100644 --- a/python/core/auto_generated/qgsrelation.sip.in +++ b/python/core/auto_generated/qgsrelation.sip.in @@ -142,10 +142,6 @@ which is referenced by the provided feature. :param attributes: An attribute vector containing the foreign key :return: A request the referenced feature - -.. note:: - - not available in Python bindings %End QgsFeatureRequest getReferencedFeatureRequest( const QgsFeature &feature ) const; diff --git a/python/core/auto_generated/qgsrenderchecker.sip.in b/python/core/auto_generated/qgsrenderchecker.sip.in index ace030fc30f..261055678f2 100644 --- a/python/core/auto_generated/qgsrenderchecker.sip.in +++ b/python/core/auto_generated/qgsrenderchecker.sip.in @@ -164,10 +164,6 @@ Get access to buffered dash messages. Only will return something if you call enableDashBuffering( true ); before. :return: buffered dash messages - -.. note:: - - not available in Python bindings %End protected: diff --git a/python/core/auto_generated/symbology/qgsmarkersymbollayer.sip.in b/python/core/auto_generated/symbology/qgsmarkersymbollayer.sip.in index 7c3909aac59..ce8a57626fd 100644 --- a/python/core/auto_generated/symbology/qgsmarkersymbollayer.sip.in +++ b/python/core/auto_generated/symbology/qgsmarkersymbollayer.sip.in @@ -132,19 +132,11 @@ Encodes a shape to its string representation. bool prepareMarkerShape( Shape shape ); %Docstring Prepares the layer for drawing the specified shape (QPolygonF version) - -.. note:: - - not available in Python bindings %End bool prepareMarkerPath( Shape symbol ); %Docstring Prepares the layer for drawing the specified shape (QPainterPath version) - -.. note:: - - not available in Python bindings %End bool shapeToPolygon( Shape shape, QPolygonF &polygon ) const; @@ -155,10 +147,6 @@ Creates a polygon representing the specified shape. :param polygon: destination polygon for shape :return: true if shape was successfully stored in polygon - -.. note:: - - not available in Python bindings %End double calculateSize( QgsSymbolRenderContext &context, bool &hasDataDefinedSize ) const; @@ -169,10 +157,6 @@ Calculates the desired size of the marker, considering data defined size overrid :param hasDataDefinedSize: will be set to true if marker uses data defined sizes :return: marker size, in original size units - -.. note:: - - not available in Python bindings %End void calculateOffsetAndRotation( QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedRotation, QPointF &offset, double &angle ) const; @@ -184,10 +168,6 @@ Calculates the marker offset and rotation. :param hasDataDefinedRotation: will be set to true if marker has data defined rotation :param offset: will be set to calculated marker offset (in painter units) :param angle: will be set to calculated marker angle - -.. note:: - - not available in Python bindings %End @@ -708,10 +688,6 @@ Calculates the marker aspect ratio between width and height. :param context: symbol render context :param scaledSize: size of symbol to render :param hasDataDefinedAspectRatio: will be set to true if marker has data defined aspectRatio - -.. note:: - - not available in Python bindings %End diff --git a/python/gui/auto_generated/editorwidgets/qgsrelationwidgetwrapper.sip.in b/python/gui/auto_generated/editorwidgets/qgsrelationwidgetwrapper.sip.in index 87e0be15eab..265aceff53d 100644 --- a/python/gui/auto_generated/editorwidgets/qgsrelationwidgetwrapper.sip.in +++ b/python/gui/auto_generated/editorwidgets/qgsrelationwidgetwrapper.sip.in @@ -12,12 +12,6 @@ class QgsRelationWidgetWrapper : QgsWidgetWrapper { -%Docstring - -.. note:: - - not available in Python bindings -%End %TypeHeaderCode #include "qgsrelationwidgetwrapper.h" diff --git a/src/core/geometry/qgsabstractgeometry.h b/src/core/geometry/qgsabstractgeometry.h index 77eb8d10788..db31da79b23 100644 --- a/src/core/geometry/qgsabstractgeometry.h +++ b/src/core/geometry/qgsabstractgeometry.h @@ -650,7 +650,6 @@ class CORE_EXPORT QgsAbstractGeometry * To create it, the geometry is default constructed and then the WKB is changed. * \see clone() * \since 3.0 - * \note Not available in Python bindings */ virtual QgsAbstractGeometry *createEmptyWithSameType() const = 0 SIP_FACTORY; diff --git a/src/core/layertree/qgslayertreeutils.h b/src/core/layertree/qgslayertreeutils.h index 3967a4ea21a..1eebfe6f6e1 100644 --- a/src/core/layertree/qgslayertreeutils.h +++ b/src/core/layertree/qgslayertreeutils.h @@ -64,7 +64,9 @@ class CORE_EXPORT QgsLayerTreeUtils //! Remove subtree of embedded groups and replaces it with a custom property embedded-visible-layers static void replaceChildrenOfEmbeddedGroups( QgsLayerTreeGroup *group ); - //! \note not available in Python bindings + /** + * Updates an embedded \a group from a \a project. + */ static void updateEmbeddedGroupsProjectPath( QgsLayerTreeGroup *group, const QgsProject *project ); //! get invisible layers diff --git a/src/core/layout/qgslayoutmanager.h b/src/core/layout/qgslayoutmanager.h index fdb5451edea..5debb7b0a9e 100644 --- a/src/core/layout/qgslayoutmanager.h +++ b/src/core/layout/qgslayoutmanager.h @@ -37,7 +37,6 @@ class QgsPrintLayout; * * QgsLayoutManager retains ownership of all the layouts contained * in the manager. - * \note Not available in Python bindings */ class CORE_EXPORT QgsLayoutManager : public QObject diff --git a/src/core/qgsapplication.h b/src/core/qgsapplication.h index 880e5002726..42cc597a8cc 100644 --- a/src/core/qgsapplication.h +++ b/src/core/qgsapplication.h @@ -679,7 +679,6 @@ class CORE_EXPORT QgsApplication : public QApplication /** * Returns registry of available 3D renderers. - * \note not available in Python bindings * \since QGIS 3.0 */ static Qgs3DRendererRegistry *renderer3DRegistry(); diff --git a/src/core/qgscolorramp.h b/src/core/qgscolorramp.h index dc922278ad2..d894dffc1a4 100644 --- a/src/core/qgscolorramp.h +++ b/src/core/qgscolorramp.h @@ -481,7 +481,6 @@ class CORE_EXPORT QgsPresetSchemeColorRamp : public QgsColorRamp, public QgsColo /** * Constructor for QgsPresetColorRamp. * \param colors list of named colors in ramp - * \note not available in Python bindings - use setColors instead */ QgsPresetSchemeColorRamp( const QgsNamedColorList &colors ); diff --git a/src/core/qgsrelation.h b/src/core/qgsrelation.h index 1d7799ef347..fc75cc1f138 100644 --- a/src/core/qgsrelation.h +++ b/src/core/qgsrelation.h @@ -198,7 +198,6 @@ class CORE_EXPORT QgsRelation * \param attributes An attribute vector containing the foreign key * * \returns A request the referenced feature - * \note not available in Python bindings */ QgsFeatureRequest getReferencedFeatureRequest( const QgsAttributes &attributes ) const; diff --git a/src/core/qgsrenderchecker.h b/src/core/qgsrenderchecker.h index 74ce598cf38..dfe9ce26d1c 100644 --- a/src/core/qgsrenderchecker.h +++ b/src/core/qgsrenderchecker.h @@ -169,7 +169,6 @@ class CORE_EXPORT QgsRenderChecker * Only will return something if you call enableDashBuffering( true ); before. * * \returns buffered dash messages - * \note not available in Python bindings */ QVector dartMeasurements() const { return mDashMessages; } diff --git a/src/core/symbology/qgsmarkersymbollayer.h b/src/core/symbology/qgsmarkersymbollayer.h index 9c1e52f005f..2f79ec11dd4 100644 --- a/src/core/symbology/qgsmarkersymbollayer.h +++ b/src/core/symbology/qgsmarkersymbollayer.h @@ -135,13 +135,11 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer /** * Prepares the layer for drawing the specified shape (QPolygonF version) - * \note not available in Python bindings */ bool prepareMarkerShape( Shape shape ); /** * Prepares the layer for drawing the specified shape (QPainterPath version) - * \note not available in Python bindings */ bool prepareMarkerPath( Shape symbol ); @@ -150,7 +148,6 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer * \param shape shape to create * \param polygon destination polygon for shape * \returns true if shape was successfully stored in polygon - * \note not available in Python bindings */ bool shapeToPolygon( Shape shape, QPolygonF &polygon ) const; @@ -159,7 +156,6 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer * \param context symbol render context * \param hasDataDefinedSize will be set to true if marker uses data defined sizes * \returns marker size, in original size units - * \note not available in Python bindings */ double calculateSize( QgsSymbolRenderContext &context, bool &hasDataDefinedSize ) const; @@ -170,7 +166,6 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer * \param hasDataDefinedRotation will be set to true if marker has data defined rotation * \param offset will be set to calculated marker offset (in painter units) * \param angle will be set to calculated marker angle - * \note not available in Python bindings */ void calculateOffsetAndRotation( QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedRotation, QPointF &offset, double &angle ) const; @@ -618,7 +613,6 @@ class CORE_EXPORT QgsSvgMarkerSymbolLayer : public QgsMarkerSymbolLayer * \param context symbol render context * \param scaledSize size of symbol to render * \param hasDataDefinedAspectRatio will be set to true if marker has data defined aspectRatio - * \note not available in Python bindings */ double calculateAspectRatio( QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedAspectRatio ) const; diff --git a/src/gui/editorwidgets/qgsrelationwidgetwrapper.h b/src/gui/editorwidgets/qgsrelationwidgetwrapper.h index a3ec53a11cf..72394cdb753 100644 --- a/src/gui/editorwidgets/qgsrelationwidgetwrapper.h +++ b/src/gui/editorwidgets/qgsrelationwidgetwrapper.h @@ -25,7 +25,6 @@ class QgsRelationEditorWidget; /** * \ingroup gui * \class QgsRelationWidgetWrapper - * \note not available in Python bindings */ class GUI_EXPORT QgsRelationWidgetWrapper : public QgsWidgetWrapper