More documentation compliance

Use Qt style "returns .." tense instead of "return ..", and lock
this in with a documentation compliance unit test

Author: nyalldawson

python/analysis/auto_generated/raster/qgsalignraster.sip.in

@@ -46,36 +46,36 @@ Check whether the given path is a valid raster
 
         QString crs() const;
 %Docstring
-Return CRS in WKT format
+Returns the CRS in WKT format
 %End
         QSize rasterSize() const;
 %Docstring
-Return size of the raster grid in pixels
+Returns the size of the raster grid in pixels
 %End
         int bandCount() const;
 %Docstring
-Return number of raster bands in the file
+Returns the number of raster bands in the file
 %End
         QSizeF cellSize() const;
 %Docstring
-Return cell size in map units
+Returns the cell size in map units
 %End
         QPointF gridOffset() const;
 %Docstring
-Return grid offset
+Returns the grid offset
 %End
         QgsRectangle extent() const;
 %Docstring
-Return extent of the raster
+Returns the extent of the raster
 %End
         QPointF origin() const;
 %Docstring
-Return origin of the raster
+Returns the origin of the raster
 %End
 
         void dump() const;
 %Docstring
-write contents of the object to standard error stream - for debugging
+Write contents of the object to standard error stream - for debugging
 %End
 
         double identify( double mx, double my );
@@ -146,7 +146,7 @@ Get associated progress handler. May be None (default)
 
     void setRasters( const List &list );
 %Docstring
-Set list of rasters that will be aligned
+Sets list of rasters that will be aligned
 %End
     List rasters() const;
 %Docstring
@@ -158,11 +158,11 @@ Get list of rasters that will be aligned
 
     void setCellSize( double x, double y );
 %Docstring
-Set output cell size
+Sets output cell size
 %End
     void setCellSize( QSizeF size );
 %Docstring
-Set output cell size
+Sets output cell size
 %End
     QSizeF cellSize() const;
 %Docstring
@@ -171,7 +171,7 @@ Get output cell size
 
     void setDestinationCrs( const QString &crsWkt );
 %Docstring
-Set the output CRS in WKT format
+Sets the output CRS in WKT format
 %End
     QString destinationCrs() const;
 %Docstring
@@ -224,7 +224,7 @@ Determine destination extent from the input rasters and calculate derived values
 
     QSize alignedRasterSize() const;
 %Docstring
-Return expected size of the resulting aligned raster
+Returns the expected size of the resulting aligned raster
 
 .. note::
 
@@ -233,7 +233,7 @@ Return expected size of the resulting aligned raster
 
     QgsRectangle alignedRasterExtent() const;
 %Docstring
-Return expected extent of the resulting aligned raster
+Returns the expected extent of the resulting aligned raster
 
 .. note::
 
@@ -249,7 +249,7 @@ Run the alignment process
 
     QString errorMessage() const;
 %Docstring
-Return error from a previous run() call.
+Returns the error from a previous run() call.
 Error message is empty if run() succeeded (returned true)
 %End
 
@@ -260,7 +260,7 @@ write contents of the object to standard error stream - for debugging
 
     int suggestedReferenceLayer() const;
 %Docstring
-Return index of the layer which has smallest cell size (returns -1 on error)
+Returns the index of the layer which has smallest cell size (returns -1 on error)
 %End
 
   protected:

python/core/auto_generated/auth/qgsauthcertutils.sip.in

@@ -80,7 +80,7 @@ Map SSL custom configs' certificate sha1 to custom config as simple cache
 
     static QByteArray fileData( const QString &path );
 %Docstring
-Return data from a local file via a read-only operation
+Returns data from a local file via a read-only operation
 
 :param path: Path to file to read
 
@@ -89,17 +89,17 @@ Return data from a local file via a read-only operation
 
     static QList<QSslCertificate> certsFromFile( const QString &certspath );
 %Docstring
-Return list of concatenated certs from a PEM or DER formatted file
+Returns a list of concatenated certs from a PEM or DER formatted file
 %End
 
     static QList<QSslCertificate> casFromFile( const QString &certspath );
 %Docstring
-Return list of concatenated CAs from a PEM or DER formatted file
+Returns a list of concatenated CAs from a PEM or DER formatted file
 %End
 
     static QSslCertificate certFromFile( const QString &certpath );
 %Docstring
-Return first cert from a PEM or DER formatted file
+Returns the first cert from a PEM or DER formatted file
 %End
 
     static QList<QSslCertificate> casMerge( const QList<QSslCertificate> &bundle1,
@@ -118,7 +118,7 @@ from the ``bundle2`` are appended to ``bundle1`` if not already there
                                 const QString &keypass = QString(),
                                 QString *algtype = 0 );
 %Docstring
-Return non-encrypted key from a PEM or DER formatted file
+Returns non-encrypted key from a PEM or DER formatted file
 
 :param keypath: File path to private key
 :param keypass: Passphrase for private key
@@ -127,7 +127,7 @@ Return non-encrypted key from a PEM or DER formatted file
 
     static QList<QSslCertificate> certsFromString( const QString &pemtext );
 %Docstring
-Return list of concatenated certs from a PEM Base64 text block
+Returns a list of concatenated certs from a PEM Base64 text block
 %End
 
 
@@ -145,7 +145,7 @@ Return list of concatenated certs from a PEM Base64 text block
                                            const QString &keypass = QString(),
                                            bool reencrypt = true );
 %Docstring
-Return list of certificate, private key and algorithm (as PEM text) from file path components
+Returns list of certificate, private key and algorithm (as PEM text) from file path components
 
 :param certpath: File path to certificate
 :param keypath: File path to private key
@@ -170,7 +170,7 @@ Determine if the PEM-encoded text of a key is PKCS#8 format
                                           const QString &bundlepass = QString(),
                                           bool reencrypt = true );
 %Docstring
-Return list of certificate, private key and algorithm (as PEM text) for a PKCS#12 bundle
+Returns list of certificate, private key and algorithm (as PEM text) for a PKCS#12 bundle
 
 :param bundlepath: File path to the PKCS bundle
 :param bundlepass: Passphrase for bundle
@@ -182,7 +182,7 @@ Return list of certificate, private key and algorithm (as PEM text) for a PKCS#1
     static QList<QSslCertificate> pkcs12BundleCas( const QString &bundlepath,
         const QString &bundlepass = QString() );
 %Docstring
-Return list of CA certificates (as QSslCertificate) for a PKCS#12 bundle
+Returns list of CA certificates (as QSslCertificate) for a PKCS#12 bundle
 
 :param bundlepath: File path to the PKCS bundle
 :param bundlepass: Passphrase for bundle

python/core/auto_generated/auth/qgsauthconfig.sip.in

@@ -44,7 +44,7 @@ Get 'authcfg' 7-character alphanumeric ID of the config
 %End
     void setId( const QString &id );
 %Docstring
-Set auth config ID
+Sets auth config ID
 %End
 
     const QString name() const;
@@ -53,7 +53,7 @@ Get name of configuration
 %End
     void setName( const QString &name );
 %Docstring
-Set name of configuration
+Sets name of configuration
 %End
 
     const QString uri() const;
@@ -74,7 +74,7 @@ Get version of the configuration
 %End
     void setVersion( int version );
 %Docstring
-Set version of the configuration
+Sets version of the configuration
 %End
 
     bool isValid( bool validateid = false ) const;
@@ -147,15 +147,15 @@ Remove a config from map
 
     QString config( const QString &key, const QString &defaultvalue = QString() ) const;
 %Docstring
-Return a config's value
+Returns a config's value
 
 :param key: Config key
 :param defaultvalue: Default value, if key not found
 %End
 
     QStringList configList( const QString &key ) const;
 %Docstring
-Return a config's list of values
+Returns a config's list of values
 
 :param key:
 %End
@@ -261,7 +261,7 @@ Client certificate object
 %End
     void setClientCert( const QSslCertificate &cert );
 %Docstring
-Set client certificate object
+Sets client certificate object
 %End
 
     const QSslKey clientKey() const;
@@ -270,7 +270,7 @@ Private key object
 %End
     void setClientKey( const QSslKey &certkey );
 %Docstring
-Set private key object
+Sets private key object
 %End
 
     const QList<QSslCertificate> caChain() const;
@@ -279,7 +279,7 @@ Chain of Certificate Authorities for client certificate
 %End
     void setCaChain( const QList<QSslCertificate> &cachain );
 %Docstring
-Set chain of Certificate Authorities for client certificate
+Sets chain of Certificate Authorities for client certificate
 %End
 
 };
@@ -321,7 +321,7 @@ Authentication method configuration
 
     void setConfig( const QgsAuthMethodConfig &config );
 %Docstring
-Set authentication method configuration
+Sets authentication method configuration
 %End
 
     const QSslCertificate clientCert() const;
@@ -331,7 +331,7 @@ Client certificate object
 
     void setClientCert( const QSslCertificate &cert );
 %Docstring
-Set client certificate object
+Sets client certificate object
 %End
 
     const QSslKey clientCertKey() const;
@@ -341,7 +341,7 @@ Private key object
 
     void setClientCertKey( const QSslKey &certkey );
 %Docstring
-Set private key object
+Sets private key object
 %End
 
     QList<QSslCertificate> caChain() const;
@@ -432,7 +432,7 @@ Server certificate object
 %End
     void setSslCertificate( const QSslCertificate &cert );
 %Docstring
-Set server certificate object
+Sets server certificate object
 %End
 
     const QString sslHostPort() const;
@@ -441,7 +441,7 @@ Server host:port string
 %End
     void setSslHostPort( const QString &hostport );
 %Docstring
-Set server host:port string
+Sets server host:port string
 %End
 
     QSsl::SslProtocol sslProtocol() const;
@@ -450,7 +450,7 @@ SSL server protocol to use in connections
 %End
     void setSslProtocol( QSsl::SslProtocol protocol );
 %Docstring
-Set SSL server protocol to use in connections
+Sets SSL server protocol to use in connections
 %End
 
     const QList<QSslError> sslIgnoredErrors() const;
@@ -463,7 +463,7 @@ SSL server errors (as enum list) to ignore in connections
 %End
     void setSslIgnoredErrorEnums( const QList<QSslError::SslError> &errors );
 %Docstring
-Set SSL server errors (as enum list) to ignore in connections
+Sets SSL server errors (as enum list) to ignore in connections
 %End
 
     QSslSocket::PeerVerifyMode sslPeerVerifyMode() const;
@@ -472,7 +472,7 @@ SSL client's peer verify mode to use in connections
 %End
     void setSslPeerVerifyMode( QSslSocket::PeerVerifyMode mode );
 %Docstring
-Set SSL client's peer verify mode to use in connections
+Sets SSL client's peer verify mode to use in connections
 %End
 
     int sslPeerVerifyDepth() const;
@@ -499,7 +499,7 @@ Version of the configuration (used for future upgrading)
 %End
     void setVersion( int version );
 %Docstring
-Set version of the configuration (used for future upgrading)
+Sets version of the configuration (used for future upgrading)
 %End
 
     int qtVersion() const;
@@ -508,7 +508,7 @@ Qt version when the configuration was made (SSL protocols may differ)
 %End
     void setQtVersion( int version );
 %Docstring
-Set Qt version when the configuration was made (SSL protocols may differ)
+Sets Qt version when the configuration was made (SSL protocols may differ)
 %End
 
     const QString configString() const;

python/core/auto_generated/auth/qgsauthmanager.sip.in

@@ -50,7 +50,7 @@ and to utilize configurations through various authentication method plugins
 
     QSqlDatabase authDatabaseConnection() const;
 %Docstring
-Set up the application instance of the authentication database connection
+Sets up the application instance of the authentication database connection
 %End
 
     const QString authDatabaseConfigTable() const;
@@ -244,14 +244,14 @@ Verify if provided authentication id is unique
 
     bool hasConfigId( const QString &txt ) const;
 %Docstring
-Return whether a string includes an authcfg ID token
+Returns whether a string includes an authcfg ID token
 
 :param txt: String to check
 %End
 
     QString configIdRegex() const;
 %Docstring
-Return regular expression for authcfg=.{7} key/value token for authentication ids
+Returns the regular expression for authcfg=.{7} key/value token for authentication ids
 %End
 
     QStringList configIds() const;
@@ -646,7 +646,7 @@ Remove a certificate authority
 
     bool setDefaultCertTrustPolicy( QgsAuthCertUtils::CertTrustPolicy policy );
 %Docstring
-Set the default certificate trust policy perferred by user
+Sets the default certificate trust policy perferred by user
 %End
 
     QgsAuthCertUtils::CertTrustPolicy defaultCertTrustPolicy();