Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Fix dox
  • Loading branch information
m-kuhn committed Oct 22, 2020
1 parent 245f354 commit 6ec342b
Show file tree
Hide file tree
Showing 10 changed files with 20 additions and 5 deletions.
Expand Up @@ -49,7 +49,7 @@ Adds break lines from a vector layer, return ``True`` if successful.

:param lineFeatureIterator: the feature iterator of break lines to insert
:param valueAttribute: the index of the attribute that represents the value of vertices, if -1 uses Z coordinate of vertices
:param transform: the coordinates transform used to transform coordinates
:param transformContext: the coordinates transform context used to transform coordinates
:param feedback: feedback argument may be specified to allow cancellation and progress reports
:param featureCount: the count of feature to allow progress report of the feedback

Expand Down
1 change: 1 addition & 0 deletions python/core/auto_generated/mesh/qgsmeshdataset.sip.in
Expand Up @@ -419,6 +419,7 @@ Constructs a valid metadata object
:param referenceTime: reference time of the dataset group
:param isTemporal: weither the dataset group is temporal (contains time-related dataset)
:param extraOptions: dataset's extra options stored by the provider. Usually contains the name, time value, time units, data file vendor, ...
:param uri: The uri of the dataset
%End

QString name() const;
Expand Down
1 change: 1 addition & 0 deletions python/core/auto_generated/qgsprovidermetadata.sip.in
Expand Up @@ -55,6 +55,7 @@ Constructs driver metadata with selected capabilities
:param name: name/key of the driver
:param description: short description of the driver
:param capabilities: driver's capabilities
:param writeDatasetOnFileSuffix: suffix used to write datasets on file
%End

MeshDriverCapabilities capabilities() const;
Expand Down
3 changes: 2 additions & 1 deletion python/gui/auto_generated/qgsdoublevalidator.sip.in
Expand Up @@ -14,7 +14,7 @@ class QgsDoubleValidator : QRegularExpressionValidator
%Docstring

QgsDoubleValidator is a QLineEdit Validator that combines QDoubleValidator
and QRegularExpressionValidator to allow user to enter double with both
and QRegularExpressionValidator to allow users to enter doubles with both
local and C interpretation as a fallback.

.. versionadded:: 3.14
Expand All @@ -37,6 +37,7 @@ Constructor for QgsDoubleValidator.
:param bottom: the minimal range limit accepted by the validator
:param top: the maximal range limit accepted by the validator
:param parent: parent object
:param expression: custom regular expression
%End

QgsDoubleValidator( double bottom, double top, QObject *parent );
Expand Down
2 changes: 1 addition & 1 deletion src/analysis/mesh/qgsmeshtriangulation.h
Expand Up @@ -64,7 +64,7 @@ class ANALYSIS_EXPORT QgsMeshTriangulation : public QObject
* Adds break lines from a vector layer, return TRUE if successful.
* \param lineFeatureIterator the feature iterator of break lines to insert
* \param valueAttribute the index of the attribute that represents the value of vertices, if -1 uses Z coordinate of vertices
* \param transform the coordinates transform used to transform coordinates
* \param transformContext the coordinates transform context used to transform coordinates
* \param feedback feedback argument may be specified to allow cancellation and progress reports
* \param featureCount the count of feature to allow progress report of the feedback
*
Expand Down
1 change: 1 addition & 0 deletions src/core/mesh/qgsmeshdataset.h
Expand Up @@ -374,6 +374,7 @@ class CORE_EXPORT QgsMeshDatasetGroupMetadata
* \param referenceTime reference time of the dataset group
* \param isTemporal weither the dataset group is temporal (contains time-related dataset)
* \param extraOptions dataset's extra options stored by the provider. Usually contains the name, time value, time units, data file vendor, ...
* \param uri The uri of the dataset
*/
QgsMeshDatasetGroupMetadata( const QString &name,
const QString uri,
Expand Down
1 change: 1 addition & 0 deletions src/core/qgsprovidermetadata.h
Expand Up @@ -81,6 +81,7 @@ class CORE_EXPORT QgsMeshDriverMetadata
* \param name name/key of the driver
* \param description short description of the driver
* \param capabilities driver's capabilities
* \param writeDatasetOnFileSuffix suffix used to write datasets on file
*/
QgsMeshDriverMetadata( const QString &name,
const QString &description,
Expand Down
3 changes: 2 additions & 1 deletion src/gui/qgsdoublevalidator.h
Expand Up @@ -30,7 +30,7 @@
* \ingroup gui
*
* QgsDoubleValidator is a QLineEdit Validator that combines QDoubleValidator
* and QRegularExpressionValidator to allow user to enter double with both
* and QRegularExpressionValidator to allow users to enter doubles with both
* local and C interpretation as a fallback.
*
* \since QGIS 3.14
Expand All @@ -52,6 +52,7 @@ class GUI_EXPORT QgsDoubleValidator : public QRegularExpressionValidator
* \param bottom the minimal range limit accepted by the validator
* \param top the maximal range limit accepted by the validator
* \param parent parent object
* \param expression custom regular expression
*/
QgsDoubleValidator( const QRegularExpression &expression, double bottom, double top, QObject *parent );

Expand Down
1 change: 1 addition & 0 deletions src/gui/qgsexpressiontreeview.h
Expand Up @@ -304,6 +304,7 @@ class GUI_EXPORT QgsExpressionTreeView : public QTreeView
* \param sortOrder sort ranking for item
* \param icon custom icon to show for item
* \param tags tags to find function
* \param name name of the item
*/
void registerItem( const QString &group, const QString &label, const QString &expressionText,
const QString &helpText = QString(),
Expand Down
10 changes: 9 additions & 1 deletion src/quickgui/qgsquickfeaturelayerpair.h
Expand Up @@ -86,7 +86,15 @@ class QUICK_EXPORT QgsQuickFeatureLayerPair
//! \copydoc QgsQuickFeatureLayerPair::feature
QgsFeature &featureRef();

//! \copydoc QgsQuickFeatureLayerPair::valid
/**
* Whether
*
* - layer is not NULLPTR
* - feature is valid
* - feature has geometry and the geometry is the same as geometry expected by layer
*
* This is a readonly property.
*/
bool isValid() const;

bool operator==( const QgsQuickFeatureLayerPair &other ) const;
Expand Down

0 comments on commit 6ec342b

Please sign in to comment.