Skip to content
Permalink
Browse files

Add "get ..." to doxygen compliance blacklist

Should be "gets ..." for consistent tense, or better yet
"returns ..." for consistency.
  • Loading branch information
nyalldawson committed May 26, 2018
1 parent 17500c4 commit c864d22d1fb340debbe13645c07fa566735acdca
Showing 334 changed files with 1,084 additions and 1,003 deletions.
@@ -80,7 +80,7 @@ Write contents of the object to standard error stream - for debugging

double identify( double mx, double my );
%Docstring
Get raster value at the given coordinates (from the first band)
Gets raster value at the given coordinates (from the first band)
%End

protected:
@@ -141,7 +141,7 @@ Assign a progress handler instance. Does not take ownership. None can be passed.
%End
ProgressHandler *progressHandler() const;
%Docstring
Get associated progress handler. May be None (default)
Gets associated progress handler. May be None (default)
%End

void setRasters( const List &list );
@@ -150,7 +150,7 @@ Sets list of rasters that will be aligned
%End
List rasters() const;
%Docstring
Get list of rasters that will be aligned
Gets list of rasters that will be aligned
%End

void setGridOffset( QPointF offset );
@@ -166,7 +166,7 @@ Sets output cell size
%End
QSizeF cellSize() const;
%Docstring
Get output cell size
Gets output cell size
%End

void setDestinationCrs( const QString &crsWkt );
@@ -175,7 +175,7 @@ Sets the output CRS in WKT format
%End
QString destinationCrs() const;
%Docstring
Get the output CRS in WKT format
Gets the output CRS in WKT format
%End

void setClipExtent( double xmin, double ymin, double xmax, double ymax );
@@ -192,7 +192,7 @@ No extra clipping is done if the rectangle is null

QgsRectangle clipExtent() const;
%Docstring
Get clipping extent (region of interest).
Gets clipping extent (region of interest).
No extra clipping is done if the rectangle is null
%End

@@ -212,31 +212,31 @@ Write a temporary file for a PEM text of cert/key/CAs bundle component

static QString getCaSourceName( QgsAuthCertUtils::CaCertSource source, bool single = false );
%Docstring
Get the general name for CA source enum type
Gets the general name for CA source enum type

:param source: The enum source type for the CA
:param single: Whether to return singular or plural description
%End

static QString resolvedCertName( const QSslCertificate &cert, bool issuer = false );
%Docstring
Get the general name via RFC 5280 resolution
Gets the general name via RFC 5280 resolution
%End


static QString getCertTrustName( QgsAuthCertUtils::CertTrustPolicy trust );
%Docstring
Get the general name for certificate trust
Gets the general name for certificate trust
%End

static QString getColonDelimited( const QString &txt );
%Docstring
Get string with colon delimiters every 2 characters
Gets string with colon delimiters every 2 characters
%End

static QString shaHexForCert( const QSslCertificate &cert, bool formatted = false );
%Docstring
Get the sha1 hash for certificate
Gets the sha1 hash for certificate

:param cert: Qt SSL certificate to generate hash from
:param formatted: Whether to colon-delimit the hash
@@ -256,32 +256,32 @@ Try to determine the certificates usage types

static bool certificateIsAuthority( const QSslCertificate &cert );
%Docstring
Get whether a certificate is an Authority
Gets whether a certificate is an Authority
%End

static bool certificateIsIssuer( const QSslCertificate &cert );
%Docstring
Get whether a certificate can sign other certificates
Gets whether a certificate can sign other certificates
%End

static bool certificateIsAuthorityOrIssuer( const QSslCertificate &cert );
%Docstring
Get whether a certificate is an Authority or can at least sign other certificates
Gets whether a certificate is an Authority or can at least sign other certificates
%End

static bool certificateIsSslServer( const QSslCertificate &cert );
%Docstring
Get whether a certificate is probably used for a SSL server
Gets whether a certificate is probably used for a SSL server
%End

static bool certificateIsSslClient( const QSslCertificate &cert );
%Docstring
Get whether a certificate is probably used for a client identity
Gets whether a certificate is probably used for a client identity
%End

static QString sslErrorEnumString( QSslError::SslError errenum );
%Docstring
Get short strings describing an SSL error
Gets short strings describing an SSL error
%End


@@ -36,7 +36,7 @@ Construct a configuration for an authentication method

const QString id() const;
%Docstring
Get 'authcfg' 7-character alphanumeric ID of the config
Gets 'authcfg' 7-character alphanumeric ID of the config

.. note::

@@ -49,7 +49,7 @@ Sets auth config ID

const QString name() const;
%Docstring
Get name of configuration
Gets name of configuration
%End
void setName( const QString &name );
%Docstring
@@ -70,7 +70,7 @@ Textual key of the associated authentication method

int version() const;
%Docstring
Get version of the configuration
Gets version of the configuration
%End
void setVersion( int version );
%Docstring
@@ -102,7 +102,7 @@ Load existing extended configuration

QgsStringMap configMap() const;
%Docstring
Get extended configuration, mapped to key/value pairs of QStrings
Gets extended configuration, mapped to key/value pairs of QStrings
%End

void setConfigMap( const QgsStringMap &map );
@@ -180,7 +180,7 @@ Instantiate and register existing C++ core authentication methods from plugins

QgsAuthMethodConfigsMap availableAuthMethodConfigs( const QString &dataprovider = QString() );
%Docstring
Get mapping of authentication config ids and their base configs (not decrypted data)
Gets mapping of authentication config ids and their base configs (not decrypted data)
%End

void updateConfigAuthMethods();
@@ -190,49 +190,49 @@ Sync the confg/authentication method cache with what is in database

QgsAuthMethod *configAuthMethod( const QString &authcfg );
%Docstring
Get authentication method from the config/provider cache
Gets authentication method from the config/provider cache

:param authcfg: Authentication config id
%End

QString configAuthMethodKey( const QString &authcfg ) const;
%Docstring
Get key of authentication method associated with config ID
Gets key of authentication method associated with config ID

:param authcfg:
%End

QStringList authMethodsKeys( const QString &dataprovider = QString() );
%Docstring
Get keys of supported authentication methods
Gets keys of supported authentication methods
%End

QgsAuthMethod *authMethod( const QString &authMethodKey );
%Docstring
Get authentication method from the config/provider cache via its key
Gets authentication method from the config/provider cache via its key

:param authMethodKey: Authentication method key
%End


QWidget *authMethodEditWidget( const QString &authMethodKey, QWidget *parent );
%Docstring
Get authentication method edit widget via its key
Gets authentication method edit widget via its key

:param authMethodKey: Authentication method key
:param parent: Parent widget
%End

QgsAuthMethod::Expansions supportedAuthMethodExpansions( const QString &authcfg );
%Docstring
Get supported authentication method expansion(s), e.g. NetworkRequest | DataSourceURI, as flags
Gets supported authentication method expansion(s), e.g. NetworkRequest | DataSourceURI, as flags

:param authcfg:
%End

const QString uniqueConfigId() const;
%Docstring
Get a unique generated 7-character string to assign to as config id
Gets a unique generated 7-character string to assign to as config id
%End

bool configIdUnique( const QString &id ) const;
@@ -256,7 +256,7 @@ Returns the regular expression for authcfg=.{7} key/value token for authenticati

QStringList configIds() const;
%Docstring
Get list of authentication ids from database
Gets list of authentication ids from database
%End

bool storeAuthenticationConfig( QgsAuthMethodConfig &mconfig /In,Out/ );
@@ -651,7 +651,7 @@ Sets the default certificate trust policy preferred by user

QgsAuthCertUtils::CertTrustPolicy defaultCertTrustPolicy();
%Docstring
Get the default certificate trust policy preferred by user
Gets the default certificate trust policy preferred by user
%End

const QMap<QgsAuthCertUtils::CertTrustPolicy, QStringList > certTrustCache();
@@ -48,7 +48,7 @@ Draws the diagram at the given position (in pixel coordinates)

virtual QString diagramName() const = 0;
%Docstring
Get a descriptive name for this diagram type.
Gets a descriptive name for this diagram type.
%End
virtual QSizeF diagramSize( const QgsAttributes &attributes, const QgsRenderContext &c, const QgsDiagramSettings &s ) = 0;
%Docstring
@@ -147,7 +147,7 @@ Set symbology export mode

QgsDxfExport::SymbologyExport symbologyExport() const;
%Docstring
Get symbology export mode
Gets symbology export mode

:return: mode

@@ -163,7 +163,7 @@ Set extent of area to export

QgsRectangle extent() const;
%Docstring
Get extent of area to export
Gets extent of area to export

:return: area to export

@@ -209,14 +209,14 @@ Retrieve whether the output should be forced to 2d

static int closestColorMatch( QRgb color );
%Docstring
Get DXF palette index of nearest entry for given color
Gets DXF palette index of nearest entry for given color

:param color:
%End

QString layerName( const QString &id, const QgsFeature &f ) const;
%Docstring
Get layer name for feature
Gets layer name for feature

:param id: layer id of layer
:param f: feature of layer
@@ -226,7 +226,7 @@ Get layer name for feature

QString layerName( QgsVectorLayer *vl ) const;
%Docstring
Get name for layer respecting the use layer title as layer name mode
Gets name for layer respecting the use layer title as layer name mode

:param vl: the vector layer

@@ -149,7 +149,7 @@ Returns root node of the expression. Root node is null is parsing has failed

bool prepare( const QgsExpressionContext *context );
%Docstring
Get the expression ready for evaluation - find out column indexes.
Gets the expression ready for evaluation - find out column indexes.

:param context: context for preparing expression

@@ -158,7 +158,7 @@ Get the expression ready for evaluation - find out column indexes.

QSet<QString> referencedColumns() const;
%Docstring
Get list of columns referenced by the expression.
Gets list of columns referenced by the expression.

.. note::

@@ -118,12 +118,12 @@ Returns true if list contains any named nodes

QList<QgsExpressionNode *> list();
%Docstring
Get a list of all the nodes.
Gets a list of all the nodes.
%End

QgsExpressionNode *at( int i );
%Docstring
Get the node at position i in the list.
Gets the node at position i in the list.

.. versionadded:: 3.0
%End
@@ -152,7 +152,7 @@ Returns a string dump of the expression node.

virtual QgsExpressionNode::NodeType nodeType() const = 0;
%Docstring
Get the type of this node.
Gets the type of this node.

:return: The type of this node
%End
@@ -414,7 +414,7 @@ A combination of when and then. Simple as that.

QgsExpressionNodeCondition::WhenThen *clone() const /Factory/;
%Docstring
Get a deep copy of this WhenThen combination.
Gets a deep copy of this WhenThen combination.
%End

QgsExpressionNode *whenExp() const;
@@ -40,7 +40,7 @@ Default constructor of field formatter for a date time field.

static QString defaultFormat( QVariant::Type type );
%Docstring
Get the default format in function of the type.
Gets the default format in function of the type.
The type is expected to be one of

- QVariant.DateTime
@@ -196,7 +196,7 @@ Updates the rectangle to include the specified point.

QgsRectangle buffered( double width ) const;
%Docstring
Get rectangle enlarged by buffer.
Gets rectangle enlarged by buffer.

.. note::

@@ -20,7 +20,7 @@ class QgsSurface: QgsAbstractGeometry

virtual QgsPolygon *surfaceToPolygon() const = 0 /Factory/;
%Docstring
Get a polygon representation of this surface.
Gets a polygon representation of this surface.
Ownership is transferred to the caller.
%End

0 comments on commit c864d22

Please sign in to comment.
You can’t perform that action at this time.