introduce SIP_SKIP in headers

based on the docstrings 'not available in Python bindings'

Author: 3nids

src/analysis/interpolation/DualEdgeTriangulation.h

@@ -18,6 +18,7 @@
 #define DUALEDGETRIANGULATION_H
 
 #include "Triangulation.h"
+#include "qgis_sip.h"
 #include "HalfEdge.h"
 #include <QVector>
 #include <QList>
@@ -60,7 +61,7 @@ class ANALYSIS_EXPORT DualEdgeTriangulation: public Triangulation
     int getOppositePoint( int p1, int p2 ) override;
     //! Finds out, in which triangle the point with coordinates x and y is and assigns the numbers of the vertices to 'n1', 'n2' and 'n3' and the vertices to 'p1', 'p2' and 'p3'
     //! \note not available in Python bindings
-    virtual bool getTriangle( double x, double y, Point3D *p1, int *n1, Point3D *p2, int *n2, Point3D *p3, int *n3 ) override;
+    virtual bool getTriangle( double x, double y, Point3D *p1, int *n1, Point3D *p2, int *n2, Point3D *p3, int *n3 ) override SIP_SKIP;
     //! Finds out, in which triangle the point with coordinates x and y is and assigns addresses to the points at the vertices to 'p1', 'p2' and 'p3
     virtual bool getTriangle( double x, double y, Point3D *p1, Point3D *p2, Point3D *p3 ) override;
     //! Returns a pointer to a value list with the information of the triangles surrounding (counterclockwise) a point. Four integer values describe a triangle, the first three are the number of the half edges of the triangle and the fourth is -10, if the third (and most counterclockwise) edge is a breakline, and -20 otherwise. The value list has to be deleted by the code which called the method

src/analysis/interpolation/NormVecDecorator.h

@@ -18,6 +18,7 @@
 #define NORMVECDECORATOR_H
 
 #include "TriDecorator.h"
+#include "qgis_sip.h"
 #include "qgis.h"
 #include <TriangleInterpolator.h>
 #include <MathUtils.h>
@@ -58,7 +59,7 @@ class ANALYSIS_EXPORT NormVecDecorator: public TriDecorator
     /** This function behaves similar to the one above. Additionally, the numbers of the points are returned (ptn1, ptn2, ptn3) as well as the PointStates of the triangle points (state1, state2, state3)
       * \note not available in Python bindings
      */
-    bool getTriangle( double x, double y, Point3D *p1, int *ptn1, Vector3D *v1, PointState *state1, Point3D *p2, int *ptn2, Vector3D *v2, PointState *state2, Point3D *p3, int *ptn3, Vector3D *v3, PointState *state3 );
+    bool getTriangle( double x, double y, Point3D *p1, int *ptn1, Vector3D *v1, PointState *state1, Point3D *p2, int *ptn2, Vector3D *v2, PointState *state2, Point3D *p3, int *ptn3, Vector3D *v3, PointState *state3 ) SIP_SKIP;
     //! Returns the state of the point with the number 'pointno'
     PointState getState( int pointno ) const;
     //! Sets an interpolator

src/analysis/interpolation/qgsinterpolator.h

@@ -19,6 +19,7 @@
 #define QGSINTERPOLATOR_H
 
 #include <QVector>
+#include "qgis_sip.h"
 #include "qgis_analysis.h"
 
 class QgsVectorLayer;
@@ -67,7 +68,7 @@ class ANALYSIS_EXPORT QgsInterpolator
     virtual int interpolatePoint( double x, double y, double &result ) = 0;
 
     //! \note not available in Python bindings
-    QList<LayerData> layerData() const { return mLayerData; }
+    QList<LayerData> layerData() const { return mLayerData; } SIP_SKIP
 
   protected:
 

src/analysis/openstreetmap/qgsosmdatabase.h

@@ -17,6 +17,7 @@
 #define OSMDATABASE_H
 
 #include <QString>
+#include "qgis_sip.h"
 #include <QStringList>
 
 #include "qgsosmbase.h"
@@ -70,10 +71,10 @@ class ANALYSIS_EXPORT QgsOSMDatabase
     int countWays() const;
 
     //! \note not available in Python bindings
-    QgsOSMNodeIterator listNodes() const;
+    QgsOSMNodeIterator listNodes() const SIP_SKIP;
 
     //! \note not available in Python bindings
-    QgsOSMWayIterator listWays() const;
+    QgsOSMWayIterator listWays() const SIP_SKIP;
 
     QgsOSMNode node( QgsOSMId id ) const;
     QgsOSMWay way( QgsOSMId id ) const;
@@ -100,7 +101,7 @@ class ANALYSIS_EXPORT QgsOSMDatabase
     /**
      * \note not available in Python bindings
      */
-    void deleteStatement( sqlite3_stmt *&stmt );
+    void deleteStatement( sqlite3_stmt *&stmt ) SIP_SKIP;
 
     void exportSpatiaLiteNodes( const QString &tableName, const QStringList &tagKeys, const QStringList &notNullTagKeys = QStringList() );
     void exportSpatiaLiteWays( bool closed, const QString &tableName, const QStringList &tagKeys, const QStringList &notNullTagKeys = QStringList() );
@@ -145,7 +146,7 @@ class ANALYSIS_EXPORT QgsOSMNodeIterator // clazy:exclude=rule-of-three
 
     /** \note not available in Python bindings
      */
-    QgsOSMNodeIterator( sqlite3 *handle );
+    QgsOSMNodeIterator( sqlite3 *handle ) SIP_SKIP;
 
     sqlite3_stmt *mStmt = nullptr;
 
@@ -171,7 +172,7 @@ class ANALYSIS_EXPORT QgsOSMWayIterator // clazy:exclude=rule-of-three
 
     /** \note not available in Python bindings
      */
-    QgsOSMWayIterator( sqlite3 *handle );
+    QgsOSMWayIterator( sqlite3 *handle ) SIP_SKIP;
 
     sqlite3_stmt *mStmt = nullptr;
 

src/analysis/openstreetmap/qgsosmimport.h

@@ -17,6 +17,7 @@
 #define OSMIMPORT_H
 
 #include <QFile>
+#include "qgis_sip.h"
 #include <QObject>
 
 #include "qgsosmbase.h"
@@ -72,7 +73,7 @@ class ANALYSIS_EXPORT QgsOSMXmlImport : public QObject
     bool closeDatabase();
 
     //! \note not available in Python bindings
-    void deleteStatement( sqlite3_stmt *&stmt );
+    void deleteStatement( sqlite3_stmt *&stmt ) SIP_SKIP;
 
     bool createIndexes();
 

src/analysis/raster/qgsrastercalcnode.h

@@ -20,6 +20,7 @@
 #define QGSRASTERCALCNODE_H
 
 #include <QMap>
+#include "qgis_sip.h"
 #include "qgis.h"
 #include <QString>
 #include "qgis_analysis.h"
@@ -97,7 +98,7 @@ class ANALYSIS_EXPORT QgsRasterCalcNode
      * \since QGIS 2.10
      * \note not available in Python bindings
      */
-    bool calculate( QMap<QString, QgsRasterBlock * > &rasterData, QgsRasterMatrix &result, int row = -1 ) const;
+    bool calculate( QMap<QString, QgsRasterBlock * > &rasterData, QgsRasterMatrix &result, int row = -1 ) const SIP_SKIP;
 
     static QgsRasterCalcNode *parseRasterCalcString( const QString &str, QString &parserErrorMsg ) SIP_FACTORY;
 

src/analysis/raster/qgsrastermatrix.h

@@ -19,6 +19,7 @@
 #define QGSRASTERMATRIX_H
 
 #include "qgis_analysis.h"
+#include "qgis_sip.h"
 
 /** \ingroup analysis
  * \class QgsRasterMatrix
@@ -71,10 +72,10 @@ class ANALYSIS_EXPORT QgsRasterMatrix
 
     //! Returns data array (but not ownership)
     //! \note not available in Python bindings
-    double *data() { return mData; }
+    double *data() { return mData; } SIP_SKIP
     //! Returns data and ownership. Sets data and nrows, ncols of this matrix to 0
     //! \note not available in Python bindings
-    double *takeData();
+    double *takeData() SIP_SKIP;
 
     void setData( int cols, int rows, double *data, double nodataValue );
 

src/core/auth/qgsauthcertutils.h

@@ -19,6 +19,7 @@
 #define QGSAUTHCERTUTILS_H
 
 #include <QFile>
+#include "qgis_sip.h"
 #include <QtCrypto>
 #include <QSslCertificate>
 #include <QSslError>
@@ -88,7 +89,7 @@ class CORE_EXPORT QgsAuthCertUtils
     /** Map certificates to their oraganization.
      * \note not available in Python bindings
      */
-    static QMap< QString, QList<QSslCertificate> > certsGroupedByOrg( const QList<QSslCertificate> &certs );
+    static QMap< QString, QList<QSslCertificate> > certsGroupedByOrg( const QList<QSslCertificate> &certs ) SIP_SKIP;
 
     /** Map SSL custom configs' certificate sha1 to custom config as simple cache
      */
@@ -97,7 +98,7 @@ class CORE_EXPORT QgsAuthCertUtils
     /** Map SSL custom configs' certificates to their oraganization.
      * \note not available in Python bindings
      */
-    static QMap< QString, QList<QgsAuthConfigSslServer> > sslConfigsGroupedByOrg( const QList<QgsAuthConfigSslServer> &configs );
+    static QMap< QString, QList<QgsAuthConfigSslServer> > sslConfigsGroupedByOrg( const QList<QgsAuthConfigSslServer> &configs ) SIP_SKIP;
 
     //! Return list of concatenated certs from a PEM or DER formatted file
     static QList<QSslCertificate> certsFromFile( const QString &certspath );
@@ -163,7 +164,7 @@ class CORE_EXPORT QgsAuthCertUtils
      */
     static QString getCertDistinguishedName( const QSslCertificate &qcert,
         const QCA::Certificate &acert = QCA::Certificate(),
-        bool issuer = false );
+        bool issuer = false ) SIP_SKIP;
 
     //! Get the general name for certificate trust
     static QString getCertTrustName( QgsAuthCertUtils::CertTrustPolicy trust );
@@ -180,37 +181,37 @@ class CORE_EXPORT QgsAuthCertUtils
     /** Convert a QSslCertificate to a QCA::Certificate.
      * \note not available in Python bindings
      */
-    static QCA::Certificate qtCertToQcaCert( const QSslCertificate &cert );
+    static QCA::Certificate qtCertToQcaCert( const QSslCertificate &cert ) SIP_SKIP;
 
     /** Convert a QList of QSslCertificate to a QCA::CertificateCollection.
      * \note not available in Python bindings
      */
-    static QCA::CertificateCollection qtCertsToQcaCollection( const QList<QSslCertificate> &certs );
+    static QCA::CertificateCollection qtCertsToQcaCollection( const QList<QSslCertificate> &certs ) SIP_SKIP;
 
     /** PKI key/cert bundle from file path, e.g. from .p12 or pfx files.
      * \note not available in Python bindings
      */
-    static QCA::KeyBundle qcaKeyBundle( const QString &path, const QString &pass );
+    static QCA::KeyBundle qcaKeyBundle( const QString &path, const QString &pass ) SIP_SKIP;
 
     /** Certificate validity check messages per enum.
      * \note not available in Python bindings
      */
-    static QString qcaValidityMessage( QCA::Validity validity );
+    static QString qcaValidityMessage( QCA::Validity validity ) SIP_SKIP;
 
     /** Certificate signature algorithm strings per enum.
      * \note not available in Python bindings
      */
-    static QString qcaSignatureAlgorithm( QCA::SignatureAlgorithm algorithm );
+    static QString qcaSignatureAlgorithm( QCA::SignatureAlgorithm algorithm ) SIP_SKIP;
 
     /** Certificate well-known constraint strings per enum.
      * \note not available in Python bindings
      */
-    static QString qcaKnownConstraint( QCA::ConstraintTypeKnown constraint );
+    static QString qcaKnownConstraint( QCA::ConstraintTypeKnown constraint ) SIP_SKIP;
 
     /** Certificate usage type strings per enum
      * \note not available in Python bindings
      */
-    static QString certificateUsageTypeString( QgsAuthCertUtils::CertUsageType usagetype );
+    static QString certificateUsageTypeString( QgsAuthCertUtils::CertUsageType usagetype ) SIP_SKIP;
 
     //! Try to determine the certificates usage types
     static QList<QgsAuthCertUtils::CertUsageType> certificateUsageTypes( const QSslCertificate &cert );
@@ -236,7 +237,7 @@ class CORE_EXPORT QgsAuthCertUtils
     /** Get short strings describing SSL errors.
      * \note not available in Python bindings
      */
-    static QList<QPair<QSslError::SslError, QString> > sslErrorEnumStrings();
+    static QList<QPair<QSslError::SslError, QString> > sslErrorEnumStrings() SIP_SKIP;
 
   private:
     static void appendDirSegment_( QStringList &dirname, const QString &segment, QString value );

src/core/auth/qgsauthmanager.h

@@ -18,6 +18,7 @@
 #define QGSAUTHMANAGER_H
 
 #include "qgis_core.h"
+#include "qgis_sip.h"
 #include <QObject>
 #include <QMutex>
 #include <QNetworkReply>
@@ -146,7 +147,7 @@ class CORE_EXPORT QgsAuthManager : public QObject
     /** Whether there is a scheduled opitonal erase of authentication database.
      * \note not available in Python bindings
      */
-    bool scheduledAuthDatabaseErase() { return mScheduledDbErase; }
+    bool scheduledAuthDatabaseErase() { return mScheduledDbErase; } SIP_SKIP
 
     /** Schedule an optional erase of authentication database, starting when mutex is lockable.
      * \note When an erase is scheduled, any attempt to set the master password,
@@ -159,7 +160,7 @@ class CORE_EXPORT QgsAuthManager : public QObject
      * if no access to user interaction occurs wihtin 90 seconds, it cancels the schedule.
      * \note not available in Python bindings
      */
-    void setScheduledAuthDatabaseErase( bool scheduleErase );
+    void setScheduledAuthDatabaseErase( bool scheduleErase ) SIP_SKIP;
 
     /** Re-emit a signal to schedule an optional erase of authentication database.
      * \note This can be called from the slot connected to a previously emitted scheduling signal,
@@ -210,7 +211,7 @@ class CORE_EXPORT QgsAuthManager : public QObject
      * \param dataprovider Provider key filter, returning only methods that support a particular provider
      * \note not available in Python bindings
      */
-    QgsAuthMethodsMap authMethodsMap( const QString &dataprovider = QString() );
+    QgsAuthMethodsMap authMethodsMap( const QString &dataprovider = QString() ) SIP_SKIP;
 
     /**
      * Get authentication method edit widget via its key
@@ -358,7 +359,7 @@ class CORE_EXPORT QgsAuthManager : public QObject
     /** Get a certificate identity bundle by id (sha hash).
      * \note not available in Python bindings
      */
-    const QPair<QSslCertificate, QSslKey> getCertIdentityBundle( const QString &id );
+    const QPair<QSslCertificate, QSslKey> getCertIdentityBundle( const QString &id ) SIP_SKIP;
 
     //! Get a certificate identity bundle by id (sha hash) returned as PEM text
     const QStringList getCertIdentityBundleToPem( const QString &id );
@@ -397,7 +398,7 @@ class CORE_EXPORT QgsAuthManager : public QObject
     /** Get ignored SSL error cache, keyed with cert/connection's sha:host:port.
      * \note not available in Python bindings
      */
-    QHash<QString, QSet<QSslError::SslError> > getIgnoredSslErrorCache() { return mIgnoredSslErrorsCache; }
+    QHash<QString, QSet<QSslError::SslError> > getIgnoredSslErrorCache() { return mIgnoredSslErrorsCache; } SIP_SKIP
 
     //! Utility function to dump the cache for debug purposes
     void dumpIgnoredSslErrorsCache_();
@@ -442,7 +443,7 @@ class CORE_EXPORT QgsAuthManager : public QObject
     /** Get all CA certs mapped to their sha1 from cache.
      * \note not available in Python bindings
      */
-    const QMap<QString, QPair<QgsAuthCertUtils::CaCertSource, QSslCertificate> > getCaCertsCache()
+    const QMap<QString, QPair<QgsAuthCertUtils::CaCertSource, QSslCertificate> > getCaCertsCache() SIP_SKIP
     {
       return mCaCertsCache;
     }
@@ -501,31 +502,31 @@ class CORE_EXPORT QgsAuthManager : public QObject
 
     //! Error message getter
     //! @note not available in Python bindings
-    const QString passwordHelperErrorMessage() { return mPasswordHelperErrorMessage; }
+    const QString passwordHelperErrorMessage() { return mPasswordHelperErrorMessage; } SIP_SKIP
 
     //! Delete master password from wallet
     //! @note not available in Python bindings
-    bool passwordHelperDelete();
+    bool passwordHelperDelete() SIP_SKIP;
 
     //! Password helper enabled getter
     //! @note not available in Python bindings
-    bool passwordHelperEnabled() const;
+    bool passwordHelperEnabled() const SIP_SKIP;
 
     //! Password helper enabled setter
     //! @note not available in Python bindings
-    void setPasswordHelperEnabled( const bool enabled );
+    void setPasswordHelperEnabled( const bool enabled ) SIP_SKIP;
 
     //! Password helper logging enabled getter
     //! @note not available in Python bindings
-    bool passwordHelperLoggingEnabled() const;
+    bool passwordHelperLoggingEnabled() const SIP_SKIP;
 
     //! Password helper logging enabled setter
     //! @note not available in Python bindings
-    void setPasswordHelperLoggingEnabled( const bool enabled );
+    void setPasswordHelperLoggingEnabled( const bool enabled ) SIP_SKIP;
 
     //! Store the password manager into the wallet
     //! @note not available in Python bindings
-    bool passwordHelperSync( );
+    bool passwordHelperSync( ) SIP_SKIP;
 
     //! The display name of the password helper (platform dependent)
     static const QString AUTH_PASSWORD_HELPER_DISPLAY_NAME;

src/core/composer/qgscomposerattributetablev2.h

@@ -19,6 +19,7 @@
 #define QGSCOMPOSERATTRIBUTETABLEV2_H
 
 #include "qgis_core.h"
+#include "qgis_sip.h"
 #include "qgis.h"
 #include "qgscomposertablev2.h"
 #include "qgsvectorlayerref.h"
@@ -273,7 +274,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
      * if false, the attribute is sorted in descending order.
      * \note not available in Python bindings
      */
-    QList<QPair<int, bool> > sortAttributes() const;
+    QList<QPair<int, bool> > sortAttributes() const SIP_SKIP;
 
     /** Sets a string to wrap the contents of the table cells by. Occurrences of this string will
      * be replaced by a line break.
@@ -296,7 +297,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
      * \returns true if attributes were successfully fetched
      * \note not available in Python bindings
      */
-    bool getTableContents( QgsComposerTableContents &contents ) override;
+    bool getTableContents( QgsComposerTableContents &contents ) override SIP_SKIP;
 
     virtual QgsExpressionContext createExpressionContext() const override;