diff --git a/doc/api_break.dox b/doc/api_break.dox index eab13ee8f4b2..abb8b4046572 100644 --- a/doc/api_break.dox +++ b/doc/api_break.dox @@ -374,6 +374,16 @@ from a project, the new QgsProject.instance().layoutManager() class should be us Additionally, the new interface methods work with QgsComposerInterface objects instead of QgsComposerView objects. +CharacterWidget {#qgis_api_break_3_0_CharacterWidget} +------------------- + +- getColumns() was renamed to columns() +- getSquareSize() was renamed to squareSize() +- updateFont() was renamed to setFont() +- updateSize() was renamed to setFontSize() +- updateStyle() was renamed to setFontStyle() +- updateColumns() was renamed to setColumns() + QgsAbstractGeometry {#qgis_api_break_3_0_QgsAbstractGeometry} ------------------- diff --git a/python/auto_sip.blacklist b/python/auto_sip.blacklist index c7c4da07a6bf..7cff64d4dcc0 100644 --- a/python/auto_sip.blacklist +++ b/python/auto_sip.blacklist @@ -527,7 +527,6 @@ gui/raster/qgssinglebandpseudocolorrendererwidget.sip gui/raster/qgsrendererrasterpropertieswidget.sip gui/raster/qgsrastertransparencywidget.sip gui/raster/qgshillshaderendererwidget.sip -gui/symbology-ng/characterwidget.sip gui/symbology-ng/qgs25drendererwidget.sip gui/symbology-ng/qgsarrowsymbollayerwidget.sip gui/symbology-ng/qgsbrushstylecombobox.sip diff --git a/python/core/annotations/qgsannotationmanager.sip b/python/core/annotations/qgsannotationmanager.sip index 03d144e6a97e..8e57a2308f2b 100644 --- a/python/core/annotations/qgsannotationmanager.sip +++ b/python/core/annotations/qgsannotationmanager.sip @@ -43,8 +43,8 @@ class QgsAnnotationManager : QObject %Docstring Adds an annotation to the manager. Ownership of the annotation is transferred to the manager. Returns true if the addition was successful, or false if the annotation could not be added. - @see removeAnnotation() - @see annotationAdded() + \see removeAnnotation() + \see annotationAdded() %End bool removeAnnotation( QgsAnnotation *annotation ); @@ -52,16 +52,16 @@ class QgsAnnotationManager : QObject Removes an annotation from the manager. The annotation is deleted. Returns true if the removal was successful, or false if the removal failed (eg as a result of removing an annotation which is not contained in the manager). - @see addAnnotation() - @see compositionRemoved() - @see compositionAboutToBeRemoved() - @see clear() + \see addAnnotation() + \see compositionRemoved() + \see compositionAboutToBeRemoved() + \see clear() %End void clear(); %Docstring Removes and deletes all annotations from the manager. - @see removeAnnotation() + \see removeAnnotation() %End QList< QgsAnnotation * > annotations() const; @@ -73,13 +73,13 @@ class QgsAnnotationManager : QObject %Docstring Reads the manager's state from a DOM element, restoring all annotations present in the XML document. - @see writeXml() + \see writeXml() %End QDomElement writeXml( QDomDocument &doc ) const; %Docstring Returns a DOM element representing the state of the manager. - @see readXml() + \see readXml() %End signals: diff --git a/python/core/annotations/qgshtmlannotation.sip b/python/core/annotations/qgshtmlannotation.sip index 2814c51f139c..908e21a5d457 100644 --- a/python/core/annotations/qgshtmlannotation.sip +++ b/python/core/annotations/qgshtmlannotation.sip @@ -32,13 +32,13 @@ class QgsHtmlAnnotation: QgsAnnotation void setSourceFile( const QString &htmlFile ); %Docstring Sets the file path for the source HTML file. - @see sourceFile() + \see sourceFile() %End QString sourceFile() const; %Docstring Returns the file path for the source HTML file. - @see setSourceFile() + \see setSourceFile() %End virtual void writeXml( QDomElement &elem, QDomDocument &doc ) const; diff --git a/python/core/annotations/qgssvgannotation.sip b/python/core/annotations/qgssvgannotation.sip index ceef2abd83bd..4592c5b4f122 100644 --- a/python/core/annotations/qgssvgannotation.sip +++ b/python/core/annotations/qgssvgannotation.sip @@ -33,13 +33,13 @@ class QgsSvgAnnotation: QgsAnnotation void setFilePath( const QString &file ); %Docstring Sets the file path for the source SVG file. - @see filePath() + \see filePath() %End QString filePath() const; %Docstring Returns the file path for the source SVG file. - @see setFilePath() + \see setFilePath() %End static QgsSvgAnnotation *create() /Factory/; diff --git a/python/core/annotations/qgstextannotation.sip b/python/core/annotations/qgstextannotation.sip index ccef464b89f0..9909f8952bd7 100644 --- a/python/core/annotations/qgstextannotation.sip +++ b/python/core/annotations/qgstextannotation.sip @@ -31,14 +31,14 @@ class QgsTextAnnotation: QgsAnnotation %Docstring Returns the text document which will be rendered within the annotation. - @see setDocument() + \see setDocument() %End void setDocument( const QTextDocument *doc ); %Docstring Sets the text document which will be rendered within the annotation. Ownership is not transferred. - @see document() + \see document() %End virtual void writeXml( QDomElement &elem, QDomDocument &doc ) const; diff --git a/python/core/processing/qgsprocessingfeedback.sip b/python/core/processing/qgsprocessingfeedback.sip index c39e1c8071a6..b87ee29ad118 100644 --- a/python/core/processing/qgsprocessingfeedback.sip +++ b/python/core/processing/qgsprocessingfeedback.sip @@ -31,7 +31,7 @@ class QgsProcessingFeedback : QgsFeedback Sets a progress report text string. This can be used in conjunction with setProgress() to provide detailed progress reports, such as "Transformed 4 of 5 layers". - @see setProgress() + \see setProgress() %End virtual void reportError( const QString &error ); @@ -45,9 +45,9 @@ class QgsProcessingFeedback : QgsFeedback Pushes a general informational message from the algorithm. This can be used to report feedback which is neither a status report or an error, such as "Found 47 matching features". - @see pushCommandInfo() - @see pushDebugInfo() - @see pushConsoleInfo() + \see pushCommandInfo() + \see pushDebugInfo() + \see pushConsoleInfo() %End virtual void pushCommandInfo( const QString &info ); @@ -55,27 +55,27 @@ class QgsProcessingFeedback : QgsFeedback Pushes an informational message containing a command from the algorithm. This is usually used to report commands which are executed in an external application or as subprocesses. - @see pushInfo() - @see pushDebugInfo() - @see pushConsoleInfo() + \see pushInfo() + \see pushDebugInfo() + \see pushConsoleInfo() %End virtual void pushDebugInfo( const QString &info ); %Docstring Pushes an informational message containing debugging helpers from the algorithm. - @see pushInfo() - @see pushCommandInfo() - @see pushConsoleInfo() + \see pushInfo() + \see pushCommandInfo() + \see pushConsoleInfo() %End virtual void pushConsoleInfo( const QString &info ); %Docstring Pushes a console feedback message from the algorithm. This is used to report the output from executing an external command or subprocess. - @see pushInfo() - @see pushDebugInfo() - @see pushCommandInfo() + \see pushInfo() + \see pushDebugInfo() + \see pushCommandInfo() %End }; diff --git a/python/core/processing/qgsprocessingprovider.sip b/python/core/processing/qgsprocessingprovider.sip index 390d2464748c..9f5d0c8aee84 100644 --- a/python/core/processing/qgsprocessingprovider.sip +++ b/python/core/processing/qgsprocessingprovider.sip @@ -36,13 +36,13 @@ class QgsProcessingProvider virtual QIcon icon() const; %Docstring Returns an icon for the provider. - @see svgIconPath() + \see svgIconPath() %End virtual QString svgIconPath() const; %Docstring Returns a path to an SVG version of the provider's icon. - @see icon() + \see icon() %End virtual QString id() const = 0; @@ -50,14 +50,14 @@ class QgsProcessingProvider Returns the unique provider id, used for identifying the provider. This string should be a unique, short, character only string, eg "qgis" or "gdal". This string should not be localised. - @see name() + \see name() %End virtual QString name() const = 0; %Docstring Returns the full provider name, which is used to describe the provider within the GUI. This string should be localised. - @see id() + \see id() %End virtual bool canBeActivated() const; diff --git a/python/core/processing/qgsprocessingregistry.sip b/python/core/processing/qgsprocessingregistry.sip index fed08944438b..9f3af3b758be 100644 --- a/python/core/processing/qgsprocessingregistry.sip +++ b/python/core/processing/qgsprocessingregistry.sip @@ -45,21 +45,21 @@ class QgsProcessingRegistry : QObject Add a processing provider to the registry. Ownership of the provider is transferred to the registry. Returns false if the provider could not be added (eg if a provider with a duplicate ID already exists in the registry). - @see removeProvider() + \see removeProvider() %End bool removeProvider( QgsProcessingProvider *provider ); %Docstring Removes a provider implementation from the registry (the provider object is deleted). Returns false if the provider could not be removed (eg provider does not exist in the registry). - @see addProvider() + \see addProvider() %End bool removeProvider( const QString &providerId ); %Docstring Removes a provider implementation from the registry (the provider object is deleted). Returns false if the provider could not be removed (eg provider does not exist in the registry). - @see addProvider() + \see addProvider() %End QgsProcessingProvider *providerById( const QString &id ); diff --git a/python/core/qgsaction.sip b/python/core/qgsaction.sip index 9ad36d6a64e2..6d8ec0f4800e 100644 --- a/python/core/qgsaction.sip +++ b/python/core/qgsaction.sip @@ -38,23 +38,23 @@ class QgsAction %Docstring Create a new QgsAction - @param type The type of this action - @param description A human readable description string - @param command The action text. Its interpretation depends on the type - @param capture If this is set to true, the output will be captured when an action is run + \param type The type of this action + \param description A human readable description string + \param command The action text. Its interpretation depends on the type + \param capture If this is set to true, the output will be captured when an action is run %End QgsAction( ActionType type, const QString &description, const QString &action, const QString &icon, bool capture, const QString &shortTitle = QString(), const QSet &actionScopes = QSet() ); %Docstring Create a new QgsAction - @param type The type of this action - @param description A human readable description string - @param action The action text. Its interpretation depends on the type - @param icon Path to an icon for this action - @param capture If this is set to true, the output will be captured when an action is run - @param shortTitle A short string used to label user interface elements like buttons - @param actionScopes A set of scopes in which this action will be available + \param type The type of this action + \param description A human readable description string + \param action The action text. Its interpretation depends on the type + \param icon Path to an icon for this action + \param capture If this is set to true, the output will be captured when an action is run + \param shortTitle A short string used to label user interface elements like buttons + \param actionScopes A set of scopes in which this action will be available %End QString name() const; @@ -135,7 +135,7 @@ Checks if the action is runable on the current platform Action scopes may offer additional variables like the clicked coordinate. - @see QgsActionScope + \see QgsActionScope .. versionadded:: 3.0 %End diff --git a/python/core/qgsactionmanager.sip b/python/core/qgsactionmanager.sip index 2d574316a042..2e0c5f349b8d 100644 --- a/python/core/qgsactionmanager.sip +++ b/python/core/qgsactionmanager.sip @@ -67,9 +67,9 @@ Constructor %Docstring Does the action using the expression engine to replace any embedded expressions in the action definition. - @param actionId action id - @param feature feature to run action for - @param context expression context to evaluate expressions under + \param actionId action id + \param feature feature to run action for + \param context expression context to evaluate expressions under %End void clearActions(); diff --git a/python/core/qgsanimatedicon.sip b/python/core/qgsanimatedicon.sip index 9844abf41717..dfd1446e8cf8 100644 --- a/python/core/qgsanimatedicon.sip +++ b/python/core/qgsanimatedicon.sip @@ -21,7 +21,7 @@ class QgsAnimatedIcon : QObject QgsAnimatedIcon( const QString &iconPath = QString(), QObject *parent = 0 ); %Docstring - Create a new animated icon. Optionally, the \a iconPath can already be specified. + Create a new animated icon. Optionally, the iconPath can already be specified. %End QString iconPath() const; @@ -83,7 +83,7 @@ class QgsAnimatedIcon : QObject to this signal directly. Connecting to this signal directly will cause the animation not to be started. - @see connectFrameChanged + \see connectFrameChanged %End }; diff --git a/python/core/qgsclipper.sip b/python/core/qgsclipper.sip index ed1d9c4ea21c..cdc2088fe152 100644 --- a/python/core/qgsclipper.sip +++ b/python/core/qgsclipper.sip @@ -67,9 +67,9 @@ class QgsClipper static QPolygonF clippedLine( const QgsCurve &curve, const QgsRectangle &clipExtent ); %Docstring Takes a linestring and clips it to clipExtent - @param curve the linestring - @param clipExtent clipping bounds - @return clipped line coordinates + \param curve the linestring + \param clipExtent clipping bounds + \returns clipped line coordinates %End }; diff --git a/python/core/qgsconditionalstyle.sip b/python/core/qgsconditionalstyle.sip index e18bc908e440..184f574af864 100644 --- a/python/core/qgsconditionalstyle.sip +++ b/python/core/qgsconditionalstyle.sip @@ -31,21 +31,21 @@ class QgsConditionalLayerStyles %Docstring Set the conditional styles that apply to full rows of data in the attribute table. Each row will check be checked against each rule. - @param styles The styles to assign to all the rows + \param styles The styles to assign to all the rows .. versionadded:: 2.12 %End void setFieldStyles( const QString &fieldName, const QList &styles ); %Docstring Set the conditional styles for the field UI properties. - @param fieldName name of field - @param styles + \param fieldName name of field + \param styles %End QList fieldStyles( const QString &fieldName ); %Docstring Returns the conditional styles set for the field UI properties - @return A list of conditional styles that have been set. + \returns A list of conditional styles that have been set. %End bool readXml( const QDomNode &node ); @@ -79,122 +79,122 @@ class QgsConditionalStyle bool matches( const QVariant &value, QgsExpressionContext &context ) const; %Docstring Check if the rule matches using the given value and feature - @param value The current value being checked. The "value" variable from the context is replaced with this value. - @param context Expression context for evaluating rule expression - @return True of the rule matches against the given feature + \param value The current value being checked. The "value" variable from the context is replaced with this value. + \param context Expression context for evaluating rule expression + \returns True of the rule matches against the given feature %End QPixmap renderPreview() const; %Docstring Render a preview icon of the rule. - @return QPixmap preview of the style + \returns QPixmap preview of the style %End void setName( const QString &value ); %Docstring Set the name of the style. Names are optional but handy for display - @param value The name given to the style + \param value The name given to the style %End void setRule( const QString &value ); %Docstring Set the rule for the style. Rules should be of QgsExpression syntax. Special value of \@value is replaced at run time with the check value - @param value The QgsExpression style rule to use for this style + \param value The QgsExpression style rule to use for this style %End void setBackgroundColor( const QColor &value ); %Docstring Set the background color for the style - @param value QColor for background color + \param value QColor for background color %End void setTextColor( const QColor &value ); %Docstring Set the text color for the style - @param value QColor for text color + \param value QColor for text color %End void setFont( const QFont &value ); %Docstring Set the font for the the style - @param value QFont to be used for text + \param value QFont to be used for text %End void setSymbol( QgsSymbol *value ); %Docstring Set the icon for the style. Icons are generated from symbols - @param value QgsSymbol to be used when generating the icon + \param value QgsSymbol to be used when generating the icon %End QString displayText() const; %Docstring The name of the style. - @return The name of the style. Names are optional so might be empty. + \returns The name of the style. Names are optional so might be empty. %End QString name() const; %Docstring The name of the style. - @return The name of the style. Names are optional so might be empty. + \returns The name of the style. Names are optional so might be empty. %End QPixmap icon() const; %Docstring The icon set for style generated from the set symbol - @return A QPixmap that was set for the icon using the symbol + \returns A QPixmap that was set for the icon using the symbol %End QgsSymbol *symbol() const; %Docstring The symbol used to generate the icon for the style - @return The QgsSymbol used for the icon + \returns The QgsSymbol used for the icon %End QColor textColor() const; %Docstring The text color set for style - @return QColor for text color + \returns QColor for text color %End bool validTextColor() const; %Docstring Check if the text color is valid for render. Valid colors are non invalid QColors and a color with a > 0 alpha - @return True of the color set for text is valid. + \returns True of the color set for text is valid. %End QColor backgroundColor() const; %Docstring The background color for style - @return QColor for background color + \returns QColor for background color %End bool validBackgroundColor() const; %Docstring Check if the background color is valid for render. Valid colors are non invalid QColors and a color with a > 0 alpha - @return True of the color set for background is valid. + \returns True of the color set for background is valid. %End QFont font() const; %Docstring The font for the style - @return QFont for the style + \returns QFont for the style %End QString rule() const; %Docstring The condition rule set for the style. Rule may contain variable \@value to represent the current value - @return QString of the current set rule + \returns QString of the current set rule %End bool isValid() const; %Docstring isValid Check if this rule is valid. A valid rule has one or more properties set. - @return True if the rule is valid. + \returns True if the rule is valid. %End static QList matchingConditionalStyles( const QList &styles, const QVariant &value, QgsExpressionContext &context ); @@ -202,7 +202,7 @@ class QgsConditionalStyle Find and return the matching styles for the value and feature. If no match is found a invalid QgsConditionalStyle is return. - @return A condtional style that matches the value and feature. + \returns A condtional style that matches the value and feature. Check with QgsConditionalStyle::isValid() %End @@ -211,7 +211,7 @@ class QgsConditionalStyle Find and return the matching style for the value and feature. If no match is found a invalid QgsConditionalStyle is return. - @return A condtional style that matches the value and feature. + \returns A condtional style that matches the value and feature. Check with QgsConditionalStyle::isValid() %End @@ -219,8 +219,8 @@ class QgsConditionalStyle %Docstring Compress a list of styles into a single style. This can be used to stack the elements of the styles. The font of the last style is used in the output. - @param styles The list of styles to compress down - @return A single style generated from joining each style property. + \param styles The list of styles to compress down + \returns A single style generated from joining each style property. %End bool readXml( const QDomNode &node ); diff --git a/python/core/qgsfeature.sip b/python/core/qgsfeature.sip index 189bf10bed69..9822c238f975 100644 --- a/python/core/qgsfeature.sip +++ b/python/core/qgsfeature.sip @@ -25,7 +25,6 @@ class QgsFeature .. note:: QgsFeature objects are implicitly shared. - @author Gary E.Sherman %End %TypeHeaderCode @@ -142,14 +141,14 @@ class QgsFeature QgsFeature( qint64 id = 0 ); %Docstring Constructor for QgsFeature - @param id feature id + \param id feature id %End QgsFeature( const QgsFields &fields, qint64 id = 0 ); %Docstring Constructor for QgsFeature - @param fields feature's fields - @param id feature id + \param fields feature's fields + \param id feature id %End QgsFeature( const QgsFeature &rhs ); @@ -165,23 +164,22 @@ class QgsFeature QgsFeatureId id() const; %Docstring Get the feature ID for this feature. - @returns feature ID - @see setId() + \returns feature ID + \see setId() %End void setId( QgsFeatureId id ); %Docstring Sets the feature ID for this feature. - @param id feature id - @see id + \param id feature id + \see id %End QgsAttributes attributes() const; %Docstring Returns the feature's attributes. - @link attributes @endlink method. - @returns list of feature's attributes - @see setAttributes + \returns list of feature's attributes + \see setAttributes .. versionadded:: 2.9 .. note:: @@ -192,25 +190,25 @@ class QgsFeature %Docstring Sets the feature's attributes. The feature will be valid after. - @param attrs attribute list - @see setAttribute - @see attributes + \param attrs attribute list + \see setAttribute + \see attributes %End bool setAttribute( int field, const QVariant &attr /GetWrapper/ ); %Docstring Set an attribute's value by field index. The feature will be valid if it was successful. - @param field the index of the field to set - @param attr the value of the attribute - @return false, if the field index does not exist + \param field the index of the field to set + \param attr the value of the attribute + \returns false, if the field index does not exist .. note:: For Python: raises a KeyError exception instead of returning false .. note:: Alternatively in Python: @code feature[field] = attr @endcode - @see setAttributes + \see setAttributes %End %MethodCode bool rv; @@ -236,14 +234,14 @@ class QgsFeature void initAttributes( int fieldCount ); %Docstring Initialize this feature with the given number of fields. Discard any previously set attribute data. - @param fieldCount Number of fields to initialize + \param fieldCount Number of fields to initialize %End void deleteAttribute( int field ); %Docstring Deletes an attribute and its value. - @param field the index of the field - @see setAttribute + \param field the index of the field + \see setAttribute .. note:: For Python: raises a KeyError exception if the field is not found @@ -266,20 +264,20 @@ class QgsFeature Returns the validity of this feature. This is normally set by the provider to indicate some problem that makes the feature invalid or to indicate a null feature. - @see setValid + \see setValid %End void setValid( bool validity ); %Docstring Sets the validity of the feature. - @param validity set to true if feature is valid - @see isValid + \param validity set to true if feature is valid + \see isValid %End bool hasGeometry() const; %Docstring Returns true if the feature has an associated geometry. - @see geometry() + \see geometry() .. versionadded:: 3.0. %End @@ -287,58 +285,58 @@ class QgsFeature %Docstring Returns the geometry associated with this feature. If the feature has no geometry, an empty QgsGeometry object will be returned. - @see hasGeometry() - @see setGeometry() + \see hasGeometry() + \see setGeometry() %End void setGeometry( const QgsGeometry &geometry ); %Docstring Set the feature's geometry. The feature will be valid after. - @param geometry new feature geometry - @see geometry() - @see clearGeometry() + \param geometry new feature geometry + \see geometry() + \see clearGeometry() %End void clearGeometry(); %Docstring Removes any geometry associated with the feature. - @see setGeometry() - @see hasGeometry() + \see setGeometry() + \see hasGeometry() .. versionadded:: 3.0 %End void setFields( const QgsFields &fields, bool initAttributes = true ); %Docstring Assign a field map with the feature to allow attribute access by attribute name. - @param fields The attribute fields which this feature holds - @param initAttributes If true, attributes are initialized. Clears any data previously assigned. + \param fields The attribute fields which this feature holds + \param initAttributes If true, attributes are initialized. Clears any data previously assigned. C++: Defaults to false Python: Defaults to true .. versionadded:: 2.9 - @see fields + \see fields %End QgsFields fields() const; %Docstring Returns the field map associated with the feature. - @see setFields + \see setFields %End void setAttribute( const QString &name, const QVariant &value /GetWrapper/ ); %Docstring Insert a value into attribute. Returns false if attribute name could not be converted to index. - Field map must be associated using @link setFields @endlink before this method can be used. + Field map must be associated using setFields() before this method can be used. The feature will be valid if it was successful - @param name The name of the field to set - @param value The value to set - @return false if attribute name could not be converted to index (C++ only) + \param name The name of the field to set + \param value The value to set + \returns false if attribute name could not be converted to index (C++ only) .. note:: For Python: raises a KeyError exception instead of returning false .. note:: Alternatively in Python: @code feature[name] = attr @endcode - @see setFields + \see setFields %End %MethodCode int fieldIdx = sipCpp->fieldNameIndex( *a0 ); @@ -362,17 +360,17 @@ class QgsFeature bool deleteAttribute( const QString &name ); %Docstring - Removes an attribute value by field name. Field map must be associated using @link setFields @endlink + Removes an attribute value by field name. Field map must be associated using setFields() before this method can be used. - @param name The name of the field to delete - @return false if attribute name could not be converted to index (C++ only) + \param name The name of the field to delete + \returns false if attribute name could not be converted to index (C++ only) .. note:: For Python: raises a KeyError exception instead of returning false .. note:: Alternatively in Python: @code del feature[name] @endcode - @see setFields + \see setFields %End %MethodCode int fieldIdx = sipCpp->fieldNameIndex( *a0 ); @@ -391,17 +389,17 @@ class QgsFeature SIP_PYOBJECT attribute( const QString &name ) const; %Docstring - Lookup attribute value from attribute name. Field map must be associated using @link setFields @endlink + Lookup attribute value from attribute name. Field map must be associated using setFields() before this method can be used. - @param name The name of the attribute to get - @return The value of the attribute (C++: Invalid variant if no such name exists ) + \param name The name of the attribute to get + \returns The value of the attribute (C++: Invalid variant if no such name exists ) .. note:: For Python: raises a KeyError exception if the field is not found .. note:: Alternatively in Python: @code feature[name] @endcode - @see setFields + \see setFields %End %MethodCode int fieldIdx = sipCpp->fieldNameIndex( *a0 ); @@ -419,17 +417,17 @@ class QgsFeature SIP_PYOBJECT attribute( int fieldIdx ) const; %Docstring - Lookup attribute value from its index. Field map must be associated using @link setFields @endlink + Lookup attribute value from its index. Field map must be associated using setFields() before this method can be used. - @param fieldIdx The index of the attribute to get - @return The value of the attribute (C++: Invalid variant if no such index exists ) + \param fieldIdx The index of the attribute to get + \returns The value of the attribute (C++: Invalid variant if no such index exists ) .. note:: For Python: raises a KeyError exception if the field is not found .. note:: Alternatively in Python: @code feature[fieldIdx] @endcode - @see setFields + \see setFields %End %MethodCode { @@ -448,11 +446,11 @@ class QgsFeature int fieldNameIndex( const QString &fieldName ) const; %Docstring - Utility method to get attribute index from name. Field map must be associated using @link setFields @endlink + Utility method to get attribute index from name. Field map must be associated using setFields() before this method can be used. - @param fieldName name of field to get attribute index of - @returns -1 if field does not exist or field map is not associated. - @see setFields + \param fieldName name of field to get attribute index of + \returns -1 if field does not exist or field map is not associated. + \see setFields %End operator QVariant() const; diff --git a/python/core/qgspropertytransformer.sip b/python/core/qgspropertytransformer.sip index f0ad7a870661..2b1606089ef6 100644 --- a/python/core/qgspropertytransformer.sip +++ b/python/core/qgspropertytransformer.sip @@ -26,7 +26,7 @@ class QgsCurveTransform QgsCurveTransform( const QList< QgsPoint > &controlPoints ); %Docstring - Constructs a QgsCurveTransform using a specified list of \a controlPoints. + Constructs a QgsCurveTransform using a specified list of controlPoints. Behavior is undefined if duplicate x values exist in the control points list. %End @@ -43,38 +43,38 @@ class QgsCurveTransform QList< QgsPoint > controlPoints() const; %Docstring Returns a list of the control points for the transform. - @see setControlPoints() + \see setControlPoints() %End void setControlPoints( const QList< QgsPoint > &points ); %Docstring Sets the list of control points for the transform. Any existing points are removed. - @see controlPoints() + \see controlPoints() %End void addControlPoint( double x, double y ); %Docstring Adds a control point to the transform. Behavior is undefined if duplicate x values exist in the control points list. - @see removeControlPoint() + \see removeControlPoint() %End void removeControlPoint( double x, double y ); %Docstring Removes a control point from the transform. This will have no effect if a matching control point does not exist. - @see addControlPoint() + \see addControlPoint() %End double y( double x ) const; %Docstring - Returns the mapped y value corresponding to the specified \a x value. + Returns the mapped y value corresponding to the specified x value. %End QVector< double > y( const QVector< double > &x ) const; %Docstring - Returns a list of y values corresponding to a list of \a x values. + Returns a list of y values corresponding to a list of x values. Calling this method is faster then calling the double variant multiple times. %End @@ -82,17 +82,17 @@ class QgsCurveTransform bool readXml( const QDomElement &elem, const QDomDocument &doc ); %Docstring Reads the curve's state from an XML element. - @param elem source DOM element for transform's state - @param doc DOM document - @see writeXml() + \param elem source DOM element for transform's state + \param doc DOM document + \see writeXml() %End bool writeXml( QDomElement &transformElem, QDomDocument &doc ) const; %Docstring Writes the current state of the transform into an XML element - @param transformElem destination element for the transform's state - @param doc DOM document - @see readXml() + \param transformElem destination element for the transform's state + \param doc DOM document + \see readXml() %End QVariant toVariant() const; @@ -100,7 +100,7 @@ class QgsCurveTransform Saves this curve transformer to a QVariantMap, wrapped in a QVariant. You can use QgsXmlUtils::writeVariant to save it to an XML document. - @see loadVariant() + \see loadVariant() %End bool loadVariant( const QVariant &transformer ); @@ -108,7 +108,7 @@ class QgsCurveTransform Load this curve transformer from a QVariantMap, wrapped in a QVariant. You can use QgsXmlUtils::writeVariant to load it from an XML document. - @see toVariant() + \see toVariant() %End }; @@ -148,14 +148,14 @@ class QgsPropertyTransformer static QgsPropertyTransformer *create( Type type ) /Factory/; %Docstring Factory method for creating a new property transformer of the specified type. - @param type transformer type to create + \param type transformer type to create %End QgsPropertyTransformer( double minValue = 0.0, double maxValue = 1.0 ); %Docstring Constructor for QgsPropertyTransformer - @param minValue minimum expected value from source property - @param maxValue maximum expected value from source property + \param minValue minimum expected value from source property + \param maxValue maximum expected value from source property %End QgsPropertyTransformer( const QgsPropertyTransformer &other ); @@ -181,7 +181,7 @@ class QgsPropertyTransformer Loads this transformer from a QVariantMap, wrapped in a QVariant. You can use QgsXmlUtils::writeVariant to save it to an XML document. - @see loadVariant() + \see loadVariant() %End virtual QVariant toVariant() const; @@ -189,79 +189,79 @@ class QgsPropertyTransformer Saves this transformer to a QVariantMap, wrapped in a QVariant. You can use QgsXmlUtils::writeVariant to save it to an XML document. - @see toVariant() + \see toVariant() %End double minValue() const; %Docstring Returns the minimum value expected by the transformer. - @see maxValue() - @see setMinValue() + \see maxValue() + \see setMinValue() %End void setMinValue( double min ); %Docstring Sets the minimum value expected by the transformer. - @param min minimum value - @see setMaxValue() - @see minValue() + \param min minimum value + \see setMaxValue() + \see minValue() %End double maxValue() const; %Docstring Returns the maximum value expected by the transformer. - @see minValue() - @see setMaxValue() + \see minValue() + \see setMaxValue() %End void setMaxValue( double max ); %Docstring Sets the maximum value expected by the transformer. - @param max maximum value - @see setMinValue() - @see maxValue() + \param max maximum value + \see setMinValue() + \see maxValue() %End QgsCurveTransform *curveTransform() const; %Docstring Returns the curve transform applied to input values before they are transformed by the individual transform subclasses. - @see setCurveTransform() + \see setCurveTransform() %End void setCurveTransform( QgsCurveTransform *transform /Transfer/ ); %Docstring Sets a curve transform to apply to input values before they are transformed - by the individual transform subclasses. Ownership of \a transform is transferred + by the individual transform subclasses. Ownership of transform is transferred to the property transformer. - @see curveTransform() + \see curveTransform() %End virtual QVariant transform( const QgsExpressionContext &context, const QVariant &value ) const = 0; %Docstring Calculates the transform of a value. Derived classes must implement this to perform their transformations on input values - @param context expression context - @param value input value to transform + \param context expression context + \param value input value to transform %End virtual QString toExpression( const QString &baseExpression ) const = 0; %Docstring - Converts the transformer to a QGIS expression string. The \a baseExpression string consists + Converts the transformer to a QGIS expression string. The baseExpression string consists of a sub-expression reflecting the parent property's state. %End static QgsPropertyTransformer *fromExpression( const QString &expression, QString &baseExpression /Out/, QString &fieldName /Out/ ) /Factory/; %Docstring Attempts to parse an expression into a corresponding property transformer. - @param expression expression to parse - @param baseExpression will be set to the component of the source expression which + \param expression expression to parse + \param baseExpression will be set to the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input. - @param fieldName will be set to a field name which is used to calculate the input + \param fieldName will be set to a field name which is used to calculate the input to the property transformer. This will be set to an empty string if an expression is the transformer input. - @returns corresponding property transformer, or nullptr if expression could not + \returns corresponding property transformer, or nullptr if expression could not be parsed to a transformer. %End @@ -270,7 +270,7 @@ class QgsPropertyTransformer double transformNumeric( double input ) const; %Docstring Applies base class numeric transformations. Derived classes should call this - to transform an \a input numeric value before they apply any transform to the result. + to transform an input numeric value before they apply any transform to the result. This applies any curve transforms which may exist on the transformer. %End }; @@ -292,12 +292,12 @@ class QgsGenericNumericTransformer : QgsPropertyTransformer double exponent = 1.0 ); %Docstring Constructor for QgsGenericNumericTransformer. - @param minValue minimum expected input value - @param maxValue maximum expected input value - @param minOutput minimum value to return - @param maxOutput maximum value to return - @param nullOutput value to return for null inputs - @param exponent optional exponential for non-linear scaling + \param minValue minimum expected input value + \param maxValue maximum expected input value + \param minOutput minimum value to return + \param maxOutput maximum value to return + \param nullOutput value to return for null inputs + \param exponent optional exponential for non-linear scaling %End QgsGenericNumericTransformer( const QgsGenericNumericTransformer &other ); @@ -316,77 +316,77 @@ class QgsGenericNumericTransformer : QgsPropertyTransformer static QgsGenericNumericTransformer *fromExpression( const QString &expression, QString &baseExpression /Out/, QString &fieldName /Out/ ) /Factory/; %Docstring Attempts to parse an expression into a corresponding QgsSizeScaleTransformer. - @param expression expression to parse - @param baseExpression will be set to the component of the source expression which + \param expression expression to parse + \param baseExpression will be set to the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input. - @param fieldName will be set to a field name which is used to calculate the input + \param fieldName will be set to a field name which is used to calculate the input to the property transformer. This will be set to an empty string if an expression is the transformer input. - @returns corresponding QgsSizeScaleTransformer, or nullptr if expression could not + \returns corresponding QgsSizeScaleTransformer, or nullptr if expression could not be parsed to a size scale transformer. %End double value( double input ) const; %Docstring - Calculates the size corresponding to a specific \a input value. - @returns calculated size using size scale transformer's parameters and type + Calculates the size corresponding to a specific input value. + \returns calculated size using size scale transformer's parameters and type %End double minOutputValue() const; %Docstring Returns the minimum calculated size. - @see setMinSize() - @see maxSize() + \see setMinSize() + \see maxSize() %End void setMinOutputValue( double size ); %Docstring Sets the minimum calculated size. - @param size minimum size - @see minSize() - @see setMaxSize() + \param size minimum size + \see minSize() + \see setMaxSize() %End double maxOutputValue() const; %Docstring Returns the maximum calculated size. - @see minSize() + \see minSize() %End void setMaxOutputValue( double size ); %Docstring Sets the maximum calculated size. - @param size maximum size - @see maxSize() - @see setMinSize() + \param size maximum size + \see maxSize() + \see setMinSize() %End double nullOutputValue() const; %Docstring Returns the size value when an expression evaluates to NULL. - @see setNullSize() + \see setNullSize() %End void setNullOutputValue( double size ); %Docstring Sets the size value for when an expression evaluates to NULL. - @param size null size - @see nullSize() + \param size null size + \see nullSize() %End double exponent() const; %Docstring Returns the exponent for an exponential expression. - @see setExponent() - @see type() + \see setExponent() + \see type() %End void setExponent( double exponent ); %Docstring Sets the exponent for an exponential expression. - @param exponent exponent - @see exponent() + \param exponent exponent + \see exponent() %End }; @@ -417,13 +417,13 @@ class QgsSizeScaleTransformer : QgsPropertyTransformer double exponent = 1.0 ); %Docstring Constructor for QgsSizeScaleTransformer. - @param type scaling type - @param minValue minimum expected value - @param maxValue maximum expected value - @param minSize minimum size to return - @param maxSize maximum size to return - @param nullSize size to return for null values - @param exponent exponent for Exponential scaling method + \param type scaling type + \param minValue minimum expected value + \param maxValue maximum expected value + \param minSize minimum size to return + \param maxSize maximum size to return + \param nullSize size to return for null values + \param exponent exponent for Exponential scaling method %End QgsSizeScaleTransformer( const QgsSizeScaleTransformer &other ); @@ -442,93 +442,93 @@ class QgsSizeScaleTransformer : QgsPropertyTransformer static QgsSizeScaleTransformer *fromExpression( const QString &expression, QString &baseExpression /Out/, QString &fieldName /Out/ ) /Factory/; %Docstring Attempts to parse an expression into a corresponding QgsSizeScaleTransformer. - @param expression expression to parse - @param baseExpression will be set to the component of the source expression which + \param expression expression to parse + \param baseExpression will be set to the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input. - @param fieldName will be set to a field name which is used to calculate the input + \param fieldName will be set to a field name which is used to calculate the input to the property transformer. This will be set to an empty string if an expression is the transformer input. - @returns corresponding QgsSizeScaleTransformer, or nullptr if expression could not + \returns corresponding QgsSizeScaleTransformer, or nullptr if expression could not be parsed to a size scale transformer. %End double size( double value ) const; %Docstring Calculates the size corresponding to a specific value. - @param value value to calculate size for - @returns calculated size using size scale transformer's parameters and type + \param value value to calculate size for + \returns calculated size using size scale transformer's parameters and type %End double minSize() const; %Docstring Returns the minimum calculated size. - @see setMinSize() - @see maxSize() + \see setMinSize() + \see maxSize() %End void setMinSize( double size ); %Docstring Sets the minimum calculated size. - @param size minimum size - @see minSize() - @see setMaxSize() + \param size minimum size + \see minSize() + \see setMaxSize() %End double maxSize() const; %Docstring Returns the maximum calculated size. - @see minSize() + \see minSize() %End void setMaxSize( double size ); %Docstring Sets the maximum calculated size. - @param size maximum size - @see maxSize() - @see setMinSize() + \param size maximum size + \see maxSize() + \see setMinSize() %End double nullSize() const; %Docstring Returns the size value when an expression evaluates to NULL. - @see setNullSize() + \see setNullSize() %End void setNullSize( double size ); %Docstring Sets the size value for when an expression evaluates to NULL. - @param size null size - @see nullSize() + \param size null size + \see nullSize() %End double exponent() const; %Docstring Returns the exponent for an exponential expression. - @see setExponent() - @see type() + \see setExponent() + \see type() %End void setExponent( double exponent ); %Docstring Sets the exponent for an exponential expression. - @param exponent exponent - @see exponent() + \param exponent exponent + \see exponent() %End ScaleType type() const; %Docstring Returns the size transformer's scaling type (the method used to calculate the size from a value). - @see setType() + \see setType() %End void setType( ScaleType type ); %Docstring Sets the size transformer's scaling type (the method used to calculate the size from a value). - @param type scale type - @see type() + \param type scale type + \see type() %End }; @@ -548,10 +548,10 @@ class QgsColorRampTransformer : QgsPropertyTransformer const QColor &nullColor = QColor( 0, 0, 0, 0 ) ); %Docstring Constructor for QgsColorRampTransformer. - @param minValue minimum expected value - @param maxValue maximum expected value - @param ramp source color ramp. Ownership is transferred to the transformer. - @param nullColor color to return for null values + \param minValue minimum expected value + \param maxValue maximum expected value + \param ramp source color ramp. Ownership is transferred to the transformer. + \param nullColor color to return for null values %End QgsColorRampTransformer( const QgsColorRampTransformer &other ); @@ -571,49 +571,49 @@ Copy constructor QColor color( double value ) const; %Docstring Calculates the color corresponding to a specific value. - @param value value to calculate color for - @returns calculated color using transformer's parameters and type + \param value value to calculate color for + \returns calculated color using transformer's parameters and type %End QgsColorRamp *colorRamp() const; %Docstring Returns the color ramp used for calculating property colors. - @returns color ramp - @see setColorRamp() + \returns color ramp + \see setColorRamp() %End void setColorRamp( QgsColorRamp *ramp /Transfer/ ); %Docstring Sets the color ramp to use for calculating property colors. - @param ramp color ramp, ownership of ramp is transferred to the transformer. - @see colorRamp() + \param ramp color ramp, ownership of ramp is transferred to the transformer. + \see colorRamp() %End QColor nullColor() const; %Docstring Returns the color corresponding to a null value. - @see setNullColor() + \see setNullColor() %End void setNullColor( const QColor &color ); %Docstring Sets the color corresponding to a null value. - @param color null color - @see nullSize() + \param color null color + \see nullSize() %End QString rampName() const; %Docstring Returns the color ramp's name. - @see setRampName() + \see setRampName() %End void setRampName( const QString &name ); %Docstring - Sets the color ramp's \a name. The ramp name must be set to match + Sets the color ramp's name. The ramp name must be set to match a color ramp available in the style database for conversion to expression to work correctly. - @see rampName() + \see rampName() %End }; diff --git a/python/core/qgsvectorlayer.sip b/python/core/qgsvectorlayer.sip index 733d84fea7a0..2d8027ea0f75 100644 --- a/python/core/qgsvectorlayer.sip +++ b/python/core/qgsvectorlayer.sip @@ -291,7 +291,7 @@ class QgsVectorLayer : QgsMapLayer, QgsExpressionContextGenerator Provider to display vector data in a GRASS GIS layer. TODO QGIS3: Remove virtual from non-inherited methods (like isModified) - @see QgsVectorLayerUtils() + \see QgsVectorLayerUtils() %End %TypeHeaderCode @@ -327,11 +327,11 @@ class QgsVectorLayer : QgsMapLayer, QgsExpressionContextGenerator interprets the supplied path (url) of the data source to connect to and access the data. - @param path The path or url of the parameter. Typically this encodes + \param path The path or url of the parameter. Typically this encodes parameters used by the data provider as url query items. - @param baseName The name used to represent the layer in the legend - @param providerLib The name of the data provider, e.g., "memory", "postgres" - @param loadDefaultStyleFlag whether to load the default style + \param baseName The name used to represent the layer in the legend + \param providerLib The name of the data provider, e.g., "memory", "postgres" + \param loadDefaultStyleFlag whether to load the default style %End @@ -360,24 +360,24 @@ Returns a comment for the data in the layer If the displayExpression is more complex than a simple field, a null string will be returned. - @see displayExpression + \see displayExpression %End void setDisplayExpression( const QString &displayExpression ); %Docstring Set the preview expression, used to create a human readable preview string. - Used e.g. in the attribute table feature list. Uses { @link QgsExpression }. + Used e.g. in the attribute table feature list. Uses QgsExpression. - @param displayExpression The expression which will be used to preview features + \param displayExpression The expression which will be used to preview features for this layer %End QString displayExpression() const; %Docstring Get the preview expression, used to create a human readable preview string. - Uses { @link QgsExpression } + Uses QgsExpression - @return The expression which will be used to preview features for this layer + \returns The expression which will be used to preview features for this layer %End QgsVectorDataProvider *dataProvider(); @@ -399,7 +399,7 @@ Setup the coordinate system transformation for the layer bool addJoin( const QgsVectorLayerJoinInfo &joinInfo ); %Docstring Joins another vector layer to this layer -@param joinInfo join object containing join layer id, target and source field +\param joinInfo join object containing join layer id, target and source field .. note:: since 2.6 returns bool indicating whether the join can be added * @@ -408,7 +408,7 @@ Setup the coordinate system transformation for the layer bool removeJoin( const QString &joinLayerId ); %Docstring Removes a vector layer join -@returns true if join was found and successfully removed * +\returns true if join was found and successfully removed * %End QgsVectorLayerJoinBuffer *joinBuffer(); @@ -421,19 +421,19 @@ Setup the coordinate system transformation for the layer virtual bool setDependencies( const QSet &layers ); %Docstring Sets the list of dependencies. - @see dependencies() + \see dependencies() - @param layers set of QgsMapLayerDependency. Only user-defined dependencies will be added - @returns false if a dependency cycle has been detected + \param layers set of QgsMapLayerDependency. Only user-defined dependencies will be added + \returns false if a dependency cycle has been detected .. versionadded:: 3.0 %End virtual QSet dependencies() const; %Docstring - Gets the list of dependencies. This includes data dependencies set by the user (@see setDataDependencies) + Gets the list of dependencies. This includes data dependencies set by the user (\see setDataDependencies) as well as dependencies given by the provider - @returns a set of QgsMapLayerDependency + \returns a set of QgsMapLayerDependency .. versionadded:: 3.0 %End @@ -441,10 +441,10 @@ Setup the coordinate system transformation for the layer %Docstring Add a new field which is calculated by the expression specified - @param exp The expression which calculates the field - @param fld The field to calculate + \param exp The expression which calculates the field + \param fld The field to calculate - @return The index of the new field + \returns The index of the new field .. versionadded:: 2.9 %End @@ -453,7 +453,7 @@ Setup the coordinate system transformation for the layer %Docstring Remove an expression field - @param index The index of the field + \param index The index of the field .. versionadded:: 2.6 %End @@ -462,9 +462,9 @@ Setup the coordinate system transformation for the layer %Docstring Returns the expression used for a given expression field - @param index An index of an epxression based (virtual) field + \param index An index of an epxression based (virtual) field - @return The expression for the field at index + \returns The expression for the field at index .. versionadded:: 2.9 %End @@ -473,9 +473,9 @@ Setup the coordinate system transformation for the layer %Docstring Changes the expression used to define an expression based (virtual) field - @param index The index of the expression to change + \param index The index of the expression to change - @param exp The new expression to set + \param exp The new expression to set .. versionadded:: 2.9 %End @@ -492,55 +492,55 @@ Setup the coordinate system transformation for the layer %Docstring The number of features that are selected in this layer - @return See description + \returns See description %End void selectByRect( QgsRectangle &rect, SelectBehavior behavior = SetSelection ); %Docstring Select features found within the search rectangle (in layer's coordinates) - @param rect search rectangle - @param behavior selection type, allows adding to current selection, removing + \param rect search rectangle + \param behavior selection type, allows adding to current selection, removing from selection, etc. - @see invertSelectionInRectangle(QgsRectangle & rect) - @see selectByExpression() - @see selectByIds() + \see invertSelectionInRectangle(QgsRectangle & rect) + \see selectByExpression() + \see selectByIds() %End void selectByExpression( const QString &expression, SelectBehavior behavior = SetSelection ); %Docstring Select matching features using an expression. - @param expression expression to evaluate to select features - @param behavior selection type, allows adding to current selection, removing + \param expression expression to evaluate to select features + \param behavior selection type, allows adding to current selection, removing from selection, etc. .. versionadded:: 2.16 - @see selectByRect() - @see selectByIds() + \see selectByRect() + \see selectByIds() %End void selectByIds( const QgsFeatureIds &ids, SelectBehavior behavior = SetSelection ); %Docstring Select matching features using a list of feature IDs. Will emit the selectionChanged() signal with the clearAndSelect flag set. - @param ids feature IDs to select - @param behavior selection type, allows adding to current selection, removing + \param ids feature IDs to select + \param behavior selection type, allows adding to current selection, removing from selection, etc. .. versionadded:: 2.16 - @see selectByRect() - @see selectByExpression() + \see selectByRect() + \see selectByExpression() %End void modifySelection( const QgsFeatureIds &selectIds, const QgsFeatureIds &deselectIds ); %Docstring Modifies the current selection on this layer - @param selectIds Select these ids - @param deselectIds Deselect these ids + \param selectIds Select these ids + \param deselectIds Deselect these ids - @see select(QgsFeatureIds) - @see select(QgsFeatureId) - @see deselect(QgsFeatureIds) - @see deselect(QgsFeatureId) - @see selectByExpression() + \see select(QgsFeatureIds) + \see select(QgsFeatureId) + \see deselect(QgsFeatureIds) + \see deselect(QgsFeatureId) + \see selectByExpression() %End void invertSelection(); @@ -562,40 +562,40 @@ Get all feature Ids %Docstring Invert selection of features found within the search rectangle (in layer's coordinates) - @param rect The rectangle in which the selection of features will be inverted + \param rect The rectangle in which the selection of features will be inverted - @see invertSelection() + \see invertSelection() %End QgsFeatureList selectedFeatures() const; %Docstring Get a copy of the user-selected features - @return A list of { @link QgsFeature } 's + \returns A list of QgsFeature - @see selectedFeatureIds() - @see selectedFeaturesIterator() which is more memory friendly when handling large selections + \see selectedFeatureIds() + \see selectedFeaturesIterator() which is more memory friendly when handling large selections %End QgsFeatureIterator selectedFeaturesIterator( QgsFeatureRequest request = QgsFeatureRequest() ) const; %Docstring Get an iterator of the selected features - @param request You may specify a request, e.g. to limit the set of requested attributes. + \param request You may specify a request, e.g. to limit the set of requested attributes. Any filter on the request will be discarded. - @return Iterator over the selected features + \returns Iterator over the selected features - @see selectedFeatureIds() - @see selectedFeatures() + \see selectedFeatureIds() + \see selectedFeatures() %End const QgsFeatureIds &selectedFeatureIds() const; %Docstring Return reference to identifiers of selected features - @return A list of { @link QgsFeatureId } 's - @see selectedFeatures() + \returns A list of QgsFeatureId + \see selectedFeatures() %End QgsRectangle boundingBoxOfSelected() const; @@ -606,14 +606,14 @@ Returns the bounding box of the selected features. If there is no selection, Qgs bool labelsEnabled() const; %Docstring Returns whether the layer contains labels which are enabled and should be drawn. - @return true if layer contains enabled labels + \returns true if layer contains enabled labels .. versionadded:: 2.9 %End bool diagramsEnabled() const; %Docstring Returns whether the layer contains diagrams which are enabled and should be drawn. - @return true if layer contains enabled diagrams + \returns true if layer contains enabled diagrams .. versionadded:: 2.9 %End @@ -685,22 +685,22 @@ Return the provider type for this layer QString &msgError /Out/ ); %Docstring Save named and sld style of the layer to the style table in the db. - @param name - @param description - @param useAsDefault - @param uiFileContent - @param msgError + \param name + \param description + \param useAsDefault + \param uiFileContent + \param msgError %End virtual int listStylesInDatabase( QStringList &ids /Out/, QStringList &names /Out/, QStringList &descriptions /Out/, QString &msgError /Out/ ); %Docstring Lists all the style in db split into related to the layer and not related to - @param ids the list in which will be stored the style db ids - @param names the list in which will be stored the style names - @param descriptions the list in which will be stored the style descriptions - @param msgError - @return the number of styles related to current layer + \param ids the list in which will be stored the style db ids + \param names the list in which will be stored the style names + \param descriptions the list in which will be stored the style descriptions + \param msgError + \returns the number of styles related to current layer %End virtual QString getStyleFromDatabase( const QString &styleId, QString &msgError /Out/ ); @@ -712,17 +712,17 @@ Return the provider type for this layer %Docstring Delete a style from the database .. versionadded:: 3.0 - @param styleId the provider's layer_styles table id of the style to delete - @param msgError reference to string that will be updated with any error messages - @return true in case of success + \param styleId the provider's layer_styles table id of the style to delete + \param msgError reference to string that will be updated with any error messages + \returns true in case of success %End virtual QString loadNamedStyle( const QString &theURI, bool &resultFlag /Out/, bool loadFromLocalDb ); %Docstring Load a named style from file/local db/datasource db - @param theURI the URI of the style or the URI of the layer - @param resultFlag will be set to true if a named style is correctly loaded - @param loadFromLocalDb if true forces to load from local db instead of datasource one + \param theURI the URI of the style or the URI of the layer + \param resultFlag will be set to true if a named style is correctly loaded + \param loadFromLocalDb if true forces to load from local db instead of datasource one %End virtual QString loadNamedStyle( const QString &theURI, bool &resultFlag /Out/ ); @@ -734,45 +734,45 @@ Return the provider type for this layer bool readSymbology( const QDomNode &layerNode, QString &errorMessage ); %Docstring Read the symbology for the current layer from the Dom node supplied. - @param layerNode node that will contain the symbology definition for this layer. - @param errorMessage reference to string that will be updated with any error messages - @return true in case of success. + \param layerNode node that will contain the symbology definition for this layer. + \param errorMessage reference to string that will be updated with any error messages + \returns true in case of success. %End bool readStyle( const QDomNode &node, QString &errorMessage ); %Docstring Read the style for the current layer from the Dom node supplied. - @param node node that will contain the style definition for this layer. - @param errorMessage reference to string that will be updated with any error messages - @return true in case of success. + \param node node that will contain the style definition for this layer. + \param errorMessage reference to string that will be updated with any error messages + \returns true in case of success. %End bool writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage ) const; %Docstring Write the symbology for the layer into the docment provided. - @param node the node that will have the style element added to it. - @param doc the document that will have the QDomNode added. - @param errorMessage reference to string that will be updated with any error messages - @return true in case of success. + \param node the node that will have the style element added to it. + \param doc the document that will have the QDomNode added. + \param errorMessage reference to string that will be updated with any error messages + \returns true in case of success. %End bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage ) const; %Docstring Write just the style information for the layer into the document - @param node the node that will have the style element added to it. - @param doc the document that will have the QDomNode added. - @param errorMessage reference to string that will be updated with any error messages - @return true in case of success. + \param node the node that will have the style element added to it. + \param doc the document that will have the QDomNode added. + \param errorMessage reference to string that will be updated with any error messages + \returns true in case of success. %End bool writeSld( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsStringMap &props = QgsStringMap() ) const; %Docstring Writes the symbology of the layer into the document provided in SLD 1.1 format - @param node the node that will have the style element added to it. - @param doc the document that will have the QDomNode added. - @param errorMessage reference to string that will be updated with any error messages - @param props a open ended set of properties that can drive/inform the SLD encoding - @return true in case of success + \param node the node that will have the style element added to it. + \param doc the document that will have the QDomNode added. + \param errorMessage reference to string that will be updated with any error messages + \param props a open ended set of properties that can drive/inform the SLD encoding + \returns true in case of success %End bool readSld( const QDomNode &node, QString &errorMessage ); @@ -781,17 +781,17 @@ Return the provider type for this layer %Docstring Number of features rendered with specified legend key. Features must be first calculated by countSymbolFeatures() - @return number of features rendered by symbol or -1 if failed or counts are not available + \returns number of features rendered by symbol or -1 if failed or counts are not available %End void setDataSource( const QString &dataSource, const QString &baseName, const QString &provider, bool loadDefaultStyleFlag = false ); %Docstring Update the data source of the layer. The layer's renderer and legend will be preserved only if the geometry type of the new data source matches the current geometry type of the layer. - @param dataSource new layer data source - @param baseName base name of the layer - @param provider provider string - @param loadDefaultStyleFlag set to true to reset the layer's style to the default for the + \param dataSource new layer data source + \param baseName base name of the layer + \param provider provider string + \param loadDefaultStyleFlag set to true to reset the layer's style to the default for the data source .. versionadded:: 2.10 %End @@ -799,30 +799,30 @@ Return the provider type for this layer bool countSymbolFeatures( bool showProgress = true ); %Docstring Count features for symbols. Feature counts may be get by featureCount(). - @param showProgress show progress dialog - @return true if calculated, false if failed or was canceled by user + \param showProgress show progress dialog + \returns true if calculated, false if failed or was canceled by user %End virtual bool setSubsetString( const QString &subset ); %Docstring Set the string (typically sql) used to define a subset of the layer - @param subset The subset string. This may be the where clause of a sql statement + \param subset The subset string. This may be the where clause of a sql statement or other definition string specific to the underlying dataprovider and data store. - @return true, when setting the subset string was successful, false otherwise + \returns true, when setting the subset string was successful, false otherwise %End virtual QString subsetString() const; %Docstring Get the string (typically sql) used to define a subset of the layer - @return The subset string or QString::null if not implemented by the provider + \returns The subset string or QString::null if not implemented by the provider %End QgsFeatureIterator getFeatures( const QgsFeatureRequest &request = QgsFeatureRequest() ) const; %Docstring Query the layer for features specified in request. - @param request feature request describing parameters of features to return - @returns iterator for matching features from provider + \param request feature request describing parameters of features to return + \returns iterator for matching features from provider %End QgsFeatureIterator getFeatures( const QString &expression ); @@ -849,18 +849,18 @@ Return the provider type for this layer bool addFeature( QgsFeature &feature, bool alsoUpdateExtent = true ); %Docstring Adds a feature -@param feature feature to add -@param alsoUpdateExtent If True, will also go to the effort of e.g. updating the extents. -@return True in case of success and False in case of error +\param feature feature to add +\param alsoUpdateExtent If True, will also go to the effort of e.g. updating the extents. +\returns True in case of success and False in case of error %End bool updateFeature( QgsFeature &f ); %Docstring Updates an existing feature. This method needs to query the datasource -on every call. Consider using {@link changeAttributeValue()} or -{@link changeGeometry()} instead. -@param f Feature to update -@return True in case of success and False in case of error +on every call. Consider using changeAttributeValue() or +changeGeometry() instead. +\param f Feature to update +\returns True in case of success and False in case of error %End bool insertVertex( double x, double y, QgsFeatureId atFeatureId, int beforeVertex ); @@ -897,15 +897,15 @@ on every call. Consider using {@link changeAttributeValue()} or EditResult deleteVertex( QgsFeatureId featureId, int vertex ); %Docstring Deletes a vertex from a feature. - @param featureId ID of feature to remove vertex from - @param vertex index of vertex to delete + \param featureId ID of feature to remove vertex from + \param vertex index of vertex to delete .. versionadded:: 2.14 %End bool deleteSelectedFeatures( int *deletedCount = 0 ); %Docstring Deletes the selected features - @return true in case of success and false otherwise + \returns true in case of success and false otherwise %End int addRing( const QList &ring, QgsFeatureId *featureId = 0 ); @@ -939,10 +939,10 @@ TODO QGIS 3.0 returns an enum instead of a magic constant int translateFeature( QgsFeatureId featureId, double dx, double dy ); %Docstring Translates feature by dx, dy - @param featureId id of the feature to translate - @param dx translation of x-coordinate - @param dy translation of y-coordinate - @return 0 in case of success + \param featureId id of the feature to translate + \param dx translation of x-coordinate + \param dy translation of y-coordinate + \returns 0 in case of success %End int splitParts( const QList &splitLine, bool topologicalEditing = false ); @@ -958,11 +958,11 @@ TODO QGIS 3.0 returns an enum instead of a magic constant int addTopologicalPoints( const QgsGeometry &geom ); %Docstring Adds topological points for every vertex of the geometry. - @param geom the geometry where each vertex is added to segments of other features + \param geom the geometry where each vertex is added to segments of other features .. note:: geom is not going to be modified by the function - @return 0 in case of success + \returns 0 in case of success %End int addTopologicalPoints( const QgsPoint &p ); @@ -971,16 +971,16 @@ TODO QGIS 3.0 returns an enum instead of a magic constant already have a vertex there. If a feature already has a vertex at position p, no additional vertex is inserted. This method is useful for topological editing. - @param p position of the vertex - @return 0 in case of success + \param p position of the vertex + \returns 0 in case of success %End int insertSegmentVerticesForSnap( const QList &snapResults ); %Docstring Inserts vertices to the snapped segments. This is useful for topological editing if snap to segment is enabled. - @param snapResults results collected from the snapping operation - @return 0 in case of success + \param snapResults results collected from the snapping operation + \returns 0 in case of success %End @@ -1000,10 +1000,10 @@ Returns true if the provider has been modified since the last commit bool snapPoint( QgsPoint &point, double tolerance ); %Docstring Snaps a point to the closest vertex if there is one within the snapping tolerance - @param point The point which is set to the position of a vertex if there is one within the snapping tolerance. + \param point The point which is set to the position of a vertex if there is one within the snapping tolerance. If there is no point within this tolerance, point is left unchanged. - @param tolerance The snapping tolerance - @return true if the point has been snapped, false if no vertex within search tolerance + \param tolerance The snapping tolerance + \returns true if the point has been snapped, false if no vertex within search tolerance %End int snapWithContext( const QgsPoint &startPoint, @@ -1012,11 +1012,11 @@ Returns true if the provider has been modified since the last commit QgsSnapper::SnappingType snap_to ); %Docstring Snaps to segment or vertex within given tolerance - @param startPoint point to snap (in layer coordinates) - @param snappingTolerance distance tolerance for snapping - @param snappingResults snapping results. Key is the distance between startPoint and snapping target - @param snap_to to segment / to vertex - @return 0 in case of success + \param startPoint point to snap (in layer coordinates) + \param snappingTolerance distance tolerance for snapping + \param snappingResults snapping results. Key is the distance between startPoint and snapping target + \param snap_to to segment / to vertex + \returns 0 in case of success %End virtual void reload(); @@ -1040,34 +1040,34 @@ Return the extent of the layer Returns the list of fields of this layer. This also includes fields which have not yet been saved to the provider. - @return A list of fields + \returns A list of fields %End QgsFields pendingFields() const; %Docstring Returns the list of fields of this layer. This also includes fields which have not yet been saved to the provider. - Alias for {@link fields()} + Alias for fields() - @return A list of fields + \returns A list of fields %End QgsAttributeList pendingAllAttributesList() const; %Docstring Returns list of attribute indexes. i.e. a list from 0 ... fieldCount() - Alias for {@link attributeList()} + Alias for attributeList() %End QgsAttributeList attributeList() const; %Docstring Returns list of attribute indexes. i.e. a list from 0 ... fieldCount() - Alias for {@link attributeList()} + Alias for attributeList() %End QgsAttributeList pendingPkAttributesList() const; %Docstring Returns list of attributes making up the primary key - Alias for {@link pkAttributeList()} + Alias for pkAttributeList() %End QgsAttributeList pkAttributeList() const; @@ -1078,7 +1078,7 @@ Returns list of attributes making up the primary key long pendingFeatureCount() const; %Docstring Returns feature count including changes which have not yet been committed - Alias for {@link featureCount()} + Alias for featureCount() %End long featureCount() const; @@ -1090,7 +1090,7 @@ Returns list of attributes making up the primary key bool setReadOnly( bool readonly = true ); %Docstring Make layer read-only (editing disabled) or not - @return false if the layer is in editing yet + \returns false if the layer is in editing yet %End bool changeGeometry( QgsFeatureId fid, const QgsGeometry &geom ); @@ -1102,12 +1102,12 @@ Change feature's geometry %Docstring Changes an attribute value (but does not commit it) - @param fid The feature id of the feature to be changed - @param field The index of the field to be updated - @param newValue The value which will be assigned to the field - @param oldValue The previous value to restore on undo (will otherwise be retrieved) + \param fid The feature id of the feature to be changed + \param field The index of the field to be updated + \param newValue The value which will be assigned to the field + \param oldValue The previous value to restore on undo (will otherwise be retrieved) - @return true in case of success + \returns true in case of success %End bool addAttribute( const QgsField &field ); @@ -1133,8 +1133,8 @@ Change feature's geometry bool renameAttribute( int index, const QString &newName ); %Docstring Renames an attribute field (but does not commit it). - @param index attribute index - @param newName new name of field + \param index attribute index + \param newName new name of field .. versionadded:: 2.16 %End @@ -1142,7 +1142,7 @@ Change feature's geometry %Docstring Returns the alias of an attribute name or a null string if there is no alias. - @see {attributeDisplayName( int attributeIndex )} which returns the field name + \see {attributeDisplayName( int attributeIndex )} which returns the field name if no alias is defined. %End @@ -1185,8 +1185,8 @@ Delete an attribute field (but does not commit it) %Docstring Deletes a list of attribute fields (but does not commit it) - @param attrs the indices of the attributes to delete - @return true if at least one attribute has been deleted + \param attrs the indices of the attributes to delete + \returns true if at least one attribute has been deleted %End bool addFeatures( QgsFeatureList features, bool makeSelected = true ); @@ -1202,9 +1202,9 @@ Delete a feature from the layer (but does not commit it) bool deleteFeatures( const QgsFeatureIds &fids ); %Docstring Deletes a set of features from the layer (but does not commit it) - @param fids The feature ids to delete + \param fids The feature ids to delete - @return false if the layer is not in edit mode or does not support deleting + \returns false if the layer is not in edit mode or does not support deleting in case of an active transaction depends on the provider implementation %End @@ -1223,20 +1223,20 @@ Delete a feature from the layer (but does not commit it) so if a stage fails, it's difficult to roll back cleanly. Therefore any error message also includes which stage failed so that the user has some chance of repairing the damage cleanly. - @see commitErrors() + \see commitErrors() %End QStringList commitErrors() const; %Docstring Returns a list containing any error messages generated when attempting to commit changes to the layer. - @see commitChanges() + \see commitChanges() %End bool rollBack( bool deleteBuffer = true ); %Docstring Stop editing and discard the edits - @param deleteBuffer whether to delete editing buffer + \param deleteBuffer whether to delete editing buffer %End QString annotationForm() const; @@ -1253,8 +1253,8 @@ Set annotation form for layer %Docstring Get relations, where the foreign key is on this layer - @param idx Only get relations, where idx forms part of the foreign key - @return A list of relations + \param idx Only get relations, where idx forms part of the foreign key + \returns A list of relations %End QgsVectorLayerEditBuffer *editBuffer(); @@ -1266,7 +1266,7 @@ Buffer with uncommitted editing operations. Only valid after editing has been tu void beginEditCommand( const QString &text ); %Docstring Create edit command for undo/redo operations - @param text text which is to be displayed in undo window + \param text text which is to be displayed in undo window %End void endEditCommand(); @@ -1302,37 +1302,37 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi Returns the calculated default value for the specified field index. The default value may be taken from a client side default value expression (see setDefaultValueExpression()) or taken from the underlying data provider. - @param index field index - @param feature optional feature to use for default value evaluation. If passed, + \param index field index + \param feature optional feature to use for default value evaluation. If passed, then properties from the feature (such as geometry) can be used when calculating the default value. - @param context optional expression context to evaluate expressions again. If not + \param context optional expression context to evaluate expressions again. If not specified, a default context will be created - @return calculated default value + \returns calculated default value .. versionadded:: 3.0 - @see setDefaultValueExpression() + \see setDefaultValueExpression() %End void setDefaultValueExpression( int index, const QString &expression ); %Docstring Sets an expression to use when calculating the default value for a field. - @param index field index - @param expression expression to evaluate when calculating default values for field. Pass + \param index field index + \param expression expression to evaluate when calculating default values for field. Pass an empty expression to clear the default. .. versionadded:: 3.0 - @see defaultValue() - @see defaultValueExpression() + \see defaultValue() + \see defaultValueExpression() %End QString defaultValueExpression( int index ) const; %Docstring Returns the expression used when calculating the default value for a field. - @param index field index - @returns expression evaluated when calculating default values for field, or an + \param index field index + \returns expression evaluated when calculating default values for field, or an empty string if no default is set .. versionadded:: 3.0 - @see defaultValue() - @see setDefaultValueExpression() + \see defaultValue() + \see setDefaultValueExpression() %End QgsFieldConstraints::Constraints fieldConstraints( int fieldIndex ) const; @@ -1341,7 +1341,7 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi field index. These constraints may be inherited from the layer's data provider or may be set manually on the vector layer from within QGIS. .. versionadded:: 3.0 - @see setFieldConstraint() + \see setFieldConstraint() %End void setFieldConstraint( int index, QgsFieldConstraints::Constraint constraint, QgsFieldConstraints::ConstraintStrength strength = QgsFieldConstraints::ConstraintStrengthHard ); @@ -1350,8 +1350,8 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi data provider will be kept intact and cannot be modified. Ie, calling this method only allows for new constraints to be added on top of the existing provider constraints. .. versionadded:: 3.0 - @see fieldConstraints() - @see removeFieldConstraint() + \see fieldConstraints() + \see removeFieldConstraint() %End void removeFieldConstraint( int index, QgsFieldConstraints::Constraint constraint ); @@ -1359,26 +1359,26 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi Removes a constraint for a specified field index. Any constraints inherited from the layer's data provider will be kept intact and cannot be removed. .. versionadded:: 3.0 - @see fieldConstraints() - @see setFieldConstraint() + \see fieldConstraints() + \see setFieldConstraint() %End QString constraintExpression( int index ) const; %Docstring Returns the constraint expression for for a specified field index, if set. .. versionadded:: 3.0 - @see fieldConstraints() - @see constraintDescription() - @see setConstraintExpression() + \see fieldConstraints() + \see constraintDescription() + \see setConstraintExpression() %End QString constraintDescription( int index ) const; %Docstring Returns the descriptive name for the constraint expression for a specified field index. .. versionadded:: 3.0 - @see constraints() - @see constraintExpression() - @see setConstraintExpression() + \see constraints() + \see constraintExpression() + \see setConstraintExpression() %End void setConstraintExpression( int index, const QString &expression, const QString &description = QString() ); @@ -1386,9 +1386,9 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi Set the constraint expression for the specified field index. An optional descriptive name for the constraint can also be set. Setting an empty expression will clear any existing expression constraint. .. versionadded:: 3.0 - @see constraintExpression() - @see constraintDescription() - @see constraints() + \see constraintExpression() + \see constraintDescription() + \see constraints() %End void setEditorWidgetSetup( int index, const QgsEditorWidgetSetup &setup ); @@ -1411,11 +1411,11 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi may contain outdated values (for instance when the attribute value in a saved feature has been changed inside the edit buffer then the previous saved value will be included in the returned list). - @param index column index for attribute - @param uniqueValues out: result list - @param limit maximum number of values to return (or -1 if unlimited) - @see minimumValue() - @see maximumValue() + \param index column index for attribute + \param uniqueValues out: result list + \param limit maximum number of values to return (or -1 if unlimited) + \see minimumValue() + \see maximumValue() %End QStringList uniqueStringsMatching( int index, const QString &substring, int limit = -1, @@ -1427,11 +1427,11 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi may contain outdated values (for instance when the attribute value in a saved feature has been changed inside the edit buffer then the previous saved value will be included in the returned list). - @param index column index for attribute - @param substring substring to match (case insensitive) - @param limit maxmum number of the values to return, or -1 to return all unique values - @param feedback optional feedback object for canceling request - @returns list of unique strings containing substring + \param index column index for attribute + \param substring substring to match (case insensitive) + \param limit maxmum number of the values to return, or -1 to return all unique values + \param feedback optional feedback object for canceling request + \returns list of unique strings containing substring %End QVariant minimumValue( int index ) const; @@ -1440,8 +1440,8 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi Note that in some circumstances when unsaved changes are present for the layer then the returned value may be outdated (for instance when the attribute value in a saved feature has been changed inside the edit buffer then the previous saved value may be returned as the minimum). - @see maximumValue() - @see uniqueValues() + \see maximumValue() + \see uniqueValues() %End QVariant maximumValue( int index ) const; @@ -1450,8 +1450,8 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi Note that in some circumstances when unsaved changes are present for the layer then the returned value may be outdated (for instance when the attribute value in a saved feature has been changed inside the edit buffer then the previous saved value may be returned as the maximum). - @see minimumValue() - @see uniqueValues() + \see minimumValue() + \see uniqueValues() %End QVariant aggregate( QgsAggregateCalculator::Aggregate aggregate, @@ -1461,39 +1461,39 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi bool *ok = 0 ) const; %Docstring Calculates an aggregated value from the layer's features. - @param aggregate aggregate to calculate - @param fieldOrExpression source field or expression to use as basis for aggregated values. - @param parameters parameters controlling aggregate calculation - @param context expression context for expressions and filters - @param ok if specified, will be set to true if aggregate calculation was successful - @return calculated aggregate value + \param aggregate aggregate to calculate + \param fieldOrExpression source field or expression to use as basis for aggregated values. + \param parameters parameters controlling aggregate calculation + \param context expression context for expressions and filters + \param ok if specified, will be set to true if aggregate calculation was successful + \returns calculated aggregate value .. versionadded:: 2.16 %End QList< QVariant > getValues( const QString &fieldOrExpression, bool &ok, bool selectedOnly = false, QgsFeedback *feedback = 0 ) const; %Docstring Fetches all values from a specified field name or expression. - @param fieldOrExpression field name or an expression string - @param ok will be set to false if field or expression is invalid, otherwise true - @param selectedOnly set to true to get values from selected features only - @param feedback optional feedback object to allow cancelation - @returns list of fetched values + \param fieldOrExpression field name or an expression string + \param ok will be set to false if field or expression is invalid, otherwise true + \param selectedOnly set to true to get values from selected features only + \param feedback optional feedback object to allow cancelation + \returns list of fetched values .. versionadded:: 2.9 - @see getDoubleValues + \see getDoubleValues %End QList< double > getDoubleValues( const QString &fieldOrExpression, bool &ok, bool selectedOnly = false, int *nullCount = 0, QgsFeedback *feedback = 0 ) const; %Docstring Fetches all double values from a specified field name or expression. Null values or invalid expression results are skipped. - @param fieldOrExpression field name or an expression string evaluating to a double value - @param ok will be set to false if field or expression is invalid, otherwise true - @param selectedOnly set to true to get values from selected features only - @param nullCount optional pointer to integer to store number of null values encountered in - @param feedback optional feedback object to allow cancelation - @returns list of fetched values + \param fieldOrExpression field name or an expression string evaluating to a double value + \param ok will be set to false if field or expression is invalid, otherwise true + \param selectedOnly set to true to get values from selected features only + \param nullCount optional pointer to integer to store number of null values encountered in + \param feedback optional feedback object to allow cancelation + \returns list of fetched values .. versionadded:: 2.9 - @see getValues + \see getValues %End void setFeatureBlendMode( QPainter::CompositionMode blendMode ); @@ -1542,7 +1542,7 @@ Returns the current transparency for the vector layer %Docstring Return the conditional styles that are set for this layer. Style information is used to render conditional formatting in the attribute table. - @return Return a QgsConditionalLayerStyles object holding the conditional attribute + \returns Return a QgsConditionalLayerStyles object holding the conditional attribute style information. Style information is generic and can be used for anything. .. versionadded:: 2.12 %End @@ -1584,7 +1584,7 @@ Returns the current transparency for the vector layer Get the configuration of the form used to represent this vector layer. This is a writable configuration that can directly be changed in place. - @return The configuration of this layers' form + \returns The configuration of this layers' form .. versionadded:: 2.14 %End @@ -1594,7 +1594,7 @@ Returns the current transparency for the vector layer Get the configuration of the form used to represent this vector layer. This is a writable configuration that can directly be changed in place. - @return The configuration of this layers' form + \returns The configuration of this layers' form .. versionadded:: 3.0 %End @@ -1605,43 +1605,43 @@ Returns the current transparency for the vector layer %Docstring Select feature by its ID - @param featureId The id of the feature to select + \param featureId The id of the feature to select - @see select(QgsFeatureIds) + \see select(QgsFeatureIds) %End void select( const QgsFeatureIds &featureIds ); %Docstring Select features by their ID - @param featureIds The ids of the features to select + \param featureIds The ids of the features to select - @see select(QgsFeatureId) + \see select(QgsFeatureId) %End void deselect( const QgsFeatureId featureId ); %Docstring Deselect feature by its ID - @param featureId The id of the feature to deselect + \param featureId The id of the feature to deselect - @see deselect(QgsFeatureIds) + \see deselect(QgsFeatureIds) %End void deselect( const QgsFeatureIds &featureIds ); %Docstring Deselect features by their ID - @param featureIds The ids of the features to deselect + \param featureIds The ids of the features to deselect - @see deselect(QgsFeatureId) + \see deselect(QgsFeatureId) %End void removeSelection(); %Docstring Clear selection - @see selectByIds() + \see selectByIds() %End virtual void updateExtents(); @@ -1654,8 +1654,8 @@ Returns the current transparency for the vector layer %Docstring Make layer editable. This starts an edit session on this layer. Changes made in this edit session will not - be made persistent until {@link commitChanges()} is called and can be reverted by calling - {@link rollBack()}. + be made persistent until commitChanges() is called and can be reverted by calling + rollBack(). %End @@ -1668,9 +1668,9 @@ Returns the current transparency for the vector layer %Docstring This signal is emitted when selection was changed - @param selected Newly selected feature ids - @param deselected Ids of all features which have previously been selected but are not any more - @param clearAndSelect In case this is set to true, the old selection was dismissed and the new selection corresponds to selected + \param selected Newly selected feature ids + \param deselected Ids of all features which have previously been selected but are not any more + \param clearAndSelect In case this is set to true, the old selection was dismissed and the new selection corresponds to selected %End void layerModified(); @@ -1711,44 +1711,44 @@ Is emitted, before changes are rolled back void attributeAdded( int idx ); %Docstring Will be emitted, when a new attribute has been added to this vector layer. - Applies only to types {@link QgsFields::OriginEdit}, {@link QgsFields::OriginProvider} and {@link QgsFields::OriginExpression } + Applies only to types QgsFields::OriginEdit, QgsFields::OriginProvider and QgsFields::OriginExpression - @param idx The index of the new attribute + \param idx The index of the new attribute - @see updatedFields() + \see updatedFields() %End void beforeAddingExpressionField( const QString &fieldName ); %Docstring Will be emitted, when an expression field is going to be added to this vector layer. - Applies only to types {@link QgsFields::OriginExpression } + Applies only to types QgsFields::OriginExpression - @param fieldName The name of the attribute to be added + \param fieldName The name of the attribute to be added %End void attributeDeleted( int idx ); %Docstring Will be emitted, when an attribute has been deleted from this vector layer. - Applies only to types {@link QgsFields::OriginEdit}, {@link QgsFields::OriginProvider} and {@link QgsFields::OriginExpression } + Applies only to types QgsFields::OriginEdit, QgsFields::OriginProvider and QgsFields::OriginExpression - @param idx The index of the deleted attribute + \param idx The index of the deleted attribute - @see updatedFields() + \see updatedFields() %End void beforeRemovingExpressionField( int idx ); %Docstring Will be emitted, when an expression field is going to be deleted from this vector layer. - Applies only to types {@link QgsFields::OriginExpression } + Applies only to types QgsFields::OriginExpression - @param idx The index of the attribute to be deleted + \param idx The index of the attribute to be deleted %End void featureAdded( QgsFeatureId fid ); %Docstring Emitted when a new feature has been added to the layer - @param fid The id of the new feature + \param fid The id of the new feature %End void featureDeleted( QgsFeatureId fid ); @@ -1756,9 +1756,9 @@ Is emitted, before changes are rolled back Emitted when a feature has been deleted. If you do expensive operations in a slot connected to this, you should prever to use - {@link featuresDeleted( const QgsFeatureIds& )}. + featuresDeleted( const QgsFeatureIds& ). - @param fid The id of the feature which has been deleted + \param fid The id of the feature which has been deleted %End void featuresDeleted( const QgsFeatureIds &fids ); @@ -1769,7 +1769,7 @@ Is emitted, before changes are rolled back to allow connected slots to minimize the overhead. If features are deleted outside of an edit command, this signal will be emitted once per feature. - @param fids The feature ids that have been deleted. + \param fids The feature ids that have been deleted. %End void updatedFields(); @@ -1784,9 +1784,9 @@ Is emitted, before changes are rolled back Is emitted whenever an attribute value change is done in the edit buffer. Note that at this point the attribute change is not yet saved to the provider. - @param fid The id of the changed feature - @param idx The attribute index of the changed attribute - @param value The new value of the attribute + \param fid The id of the changed feature + \param idx The attribute index of the changed attribute + \param value The new value of the attribute %End void geometryChanged( QgsFeatureId fid, const QgsGeometry &geometry ); @@ -1794,8 +1794,8 @@ Is emitted, before changes are rolled back Is emitted whenever a geometry change is done in the edit buffer. Note that at this point the geometry change is not yet saved to the provider. - @param fid The id of the changed feature - @param geometry The new geometry + \param fid The id of the changed feature + \param geometry The new geometry %End void committedAttributesDeleted( const QString &layerId, const QgsAttributeList &deletedAttributes ); @@ -1842,7 +1842,7 @@ Signal emitted when setLayerTransparency() is called %Docstring Signal emitted when a new edit command has been started - @param text Description for this edit command + \param text Description for this edit command %End void editCommandEnded(); @@ -1851,7 +1851,7 @@ Signal emitted when setLayerTransparency() is called .. note:: This does not mean it is also committed, only that it is written - to the edit buffer. See {@link beforeCommitChanges()} + to the edit buffer. See beforeCommitChanges() %End void editCommandDestroyed(); @@ -1860,7 +1860,7 @@ Signal emitted when setLayerTransparency() is called .. note:: This is not a rollback, it is only related to the current edit command. - See {@link beforeRollBack()} + See beforeRollBack() %End void readCustomSymbology( const QDomElement &element, QString &errorMessage ); @@ -1869,9 +1869,9 @@ Signal emitted when setLayerTransparency() is called If there is custom style information saved in the file, you can connect to this signal and update the layer style accordingly. - @param element The XML layer style element. + \param element The XML layer style element. - @param errorMessage Write error messages into this string. + \param errorMessage Write error messages into this string. %End void writeCustomSymbology( QDomElement &element, QDomDocument &doc, QString &errorMessage ) const; @@ -1880,9 +1880,9 @@ Signal emitted when setLayerTransparency() is called If there is custom style information you want to save to the file, you can connect to this signal and update the element accordingly. - @param element The XML element where you can add additional style information to. - @param doc The XML document that you can use to create new XML nodes. - @param errorMessage Write error messages into this string. + \param element The XML element where you can add additional style information to. + \param doc The XML document that you can use to create new XML nodes. + \param errorMessage Write error messages into this string. %End void mapTipTemplateChanged(); diff --git a/python/gui/symbology-ng/characterwidget.sip b/python/gui/symbology-ng/characterwidget.sip index 9c3ebf599464..af5a8e3eb4c5 100644 --- a/python/gui/symbology-ng/characterwidget.sip +++ b/python/gui/symbology-ng/characterwidget.sip @@ -1,29 +1,113 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/characterwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + + class CharacterWidget : QWidget { +%Docstring + + A widget for displaying characters available in a preset font, and allowing + users to select an individual character. +%End + %TypeHeaderCode -#include +#include "characterwidget.h" %End + public: + CharacterWidget( QWidget *parent /TransferThis/ = 0 ); +%Docstring + Constructor for CharacterWidget. +%End + QSize sizeHint() const; - int getColumns() const; - int getSquareSize() const; + int columns() const; +%Docstring + Returns the number of columns of characters shown in the widget. +%End + + int squareSize() const; +%Docstring + Returns the size (in pixels) of the square used to render each character preview. +%End + + QChar character() const; +%Docstring + Returns the currently selected character in the widget. + \see setCharacter() +.. versionadded:: 3.0 +%End + + QFont font() const; +%Docstring + Returns the font shown in the widget + \see setFont() +.. versionadded:: 3.0 +%End public slots: - void updateFont( const QFont &font ); - void updateSize( double fontSize ); - void updateStyle( const QString &fontStyle ); + + void setFont( const QFont &font ); +%Docstring + Sets the font to show in the widget. + \see font() +.. versionadded:: 3.0 +%End + + void setFontSize( double fontSize ); +%Docstring + Sets the font size (in points) to render in the widget. +.. versionadded:: 3.0 +%End + + void setFontStyle( const QString &fontStyle ); +%Docstring + Sets the font style to show in the widget. +.. versionadded:: 3.0 +%End + void updateFontMerging( bool enable ); - void updateColumns( int cols ); + + void setColumns( int columns ); +%Docstring + Sets the number of columns of characters to show in the widget. +.. versionadded:: 3.0 +%End + void setCharacter( QChar character ); +%Docstring + Sets the currently selected character in the widget. + \see character() + \see characterSelected() +%End signals: + void characterSelected( QChar character ); +%Docstring + Emitted when a character is selected in the widget. +%End protected: void mouseMoveEvent( QMouseEvent *event ); void mousePressEvent( QMouseEvent *event ); void paintEvent( QPaintEvent *event ); + }; +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/characterwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/scripts/sipify.pl b/scripts/sipify.pl index 0147c446472f..ff3e1f0f17da 100755 --- a/scripts/sipify.pl +++ b/scripts/sipify.pl @@ -9,19 +9,22 @@ sub processDoxygenLine { - if ( $_[0] =~ m/[\\@](ingroup|class)/ ) { + my $line = $_[0]; + # remove \a formatting + $line =~ s/\\a //g; + if ( $line =~ m/[\\@](ingroup|class)/ ) { return "" } - if ( $_[0] =~ m/\\since .*?([\d\.]+)/i ) { + if ( $line =~ m/\\since .*?([\d\.]+)/i ) { return ".. versionadded:: $1\n"; } - if ( $_[0] =~ m/[\\@]note (.*)/ ) { + if ( $line =~ m/[\\@]note (.*)/ ) { return ".. note::\n\n $1\n"; } - if ( $_[0] =~ m/[\\@]brief (.*)/ ) { + if ( $line =~ m/[\\@]brief (.*)/ ) { return " $1\n"; } - return $_[0]; + return $line; } diff --git a/scripts/spell_check/spelling.dat b/scripts/spell_check/spelling.dat index dc1f5da0dd2b..7f92ce417a57 100644 --- a/scripts/spell_check/spelling.dat +++ b/scripts/spell_check/spelling.dat @@ -7334,6 +7334,7 @@ vauled:valued vaules:values vauling:valuing vebrose:verbose +vecotr:vector vegatarian:vegetarian vegitable:vegetable vegitables:vegetables diff --git a/src/analysis/interpolation/DualEdgeTriangulation.h b/src/analysis/interpolation/DualEdgeTriangulation.h index d6f35d6a6e65..a8f7fab55f8d 100644 --- a/src/analysis/interpolation/DualEdgeTriangulation.h +++ b/src/analysis/interpolation/DualEdgeTriangulation.h @@ -59,7 +59,7 @@ class ANALYSIS_EXPORT DualEdgeTriangulation: public Triangulation //! Returns the number of the point opposite to the triangle points p1, p2 (which have to be on a halfedge) 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 + //! \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; //! 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; @@ -101,7 +101,7 @@ class ANALYSIS_EXPORT DualEdgeTriangulation: public Triangulation virtual QList *getPointsAroundEdge( double x, double y ) override; /** Saves the triangulation as a (line) shapefile - @return true in case of success*/ + \returns true in case of success*/ virtual bool saveAsShapefile( const QString &fileName ) const override; protected: diff --git a/src/analysis/interpolation/NormVecDecorator.h b/src/analysis/interpolation/NormVecDecorator.h index 309b4613d64a..72386d613b3e 100644 --- a/src/analysis/interpolation/NormVecDecorator.h +++ b/src/analysis/interpolation/NormVecDecorator.h @@ -55,7 +55,7 @@ class ANALYSIS_EXPORT NormVecDecorator: public TriDecorator bool getTriangle( double x, double y, Point3D *p1, Vector3D *v1, Point3D *p2, Vector3D *v2, Point3D *p3, Vector3D *v3 ); /** 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 + * \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 ); //! Returns the state of the point with the number 'pointno' @@ -66,7 +66,7 @@ class ANALYSIS_EXPORT NormVecDecorator: public TriDecorator virtual bool swapEdge( double x, double y ) override; /** Saves the triangulation as a (line) shapefile - @return true in case of success*/ + \returns true in case of success*/ virtual bool saveAsShapefile( const QString &fileName ) const override; protected: diff --git a/src/analysis/interpolation/Triangulation.h b/src/analysis/interpolation/Triangulation.h index a9b404542595..dc048839b3ce 100644 --- a/src/analysis/interpolation/Triangulation.h +++ b/src/analysis/interpolation/Triangulation.h @@ -52,7 +52,7 @@ class ANALYSIS_EXPORT Triangulation /** * Calculates the normal at a point on the surface and assigns it to 'result'. - * @return true in case of success and false in case of failure + * \returns true in case of success and false in case of failure */ virtual bool calcNormal( double x, double y, Vector3D *result ) = 0; @@ -148,7 +148,7 @@ class ANALYSIS_EXPORT Triangulation /** * Saves the triangulation as a (line) shapefile - * @return true in case of success + * \returns true in case of success */ virtual bool saveAsShapefile( const QString &fileName ) const = 0; }; diff --git a/src/analysis/interpolation/qgsgridfilewriter.h b/src/analysis/interpolation/qgsgridfilewriter.h index ba09d4028316..d2da79019260 100644 --- a/src/analysis/interpolation/qgsgridfilewriter.h +++ b/src/analysis/interpolation/qgsgridfilewriter.h @@ -34,8 +34,8 @@ class ANALYSIS_EXPORT QgsGridFileWriter QgsGridFileWriter( QgsInterpolator *i, const QString &outputPath, const QgsRectangle &extent, int nCols, int nRows, double cellSizeX, double cellSizeY ); /** Writes the grid file. - @param showProgressDialog shows a dialog with the possibility to cancel - @return 0 in case of success*/ + \param showProgressDialog shows a dialog with the possibility to cancel + \returns 0 in case of success*/ int writeFile( bool showProgressDialog = false ); diff --git a/src/analysis/interpolation/qgsidwinterpolator.h b/src/analysis/interpolation/qgsidwinterpolator.h index 3ac9f48c1ef3..032522fb9468 100644 --- a/src/analysis/interpolation/qgsidwinterpolator.h +++ b/src/analysis/interpolation/qgsidwinterpolator.h @@ -30,10 +30,10 @@ class ANALYSIS_EXPORT QgsIDWInterpolator: public QgsInterpolator QgsIDWInterpolator( const QList &layerData ); /** Calculates interpolation value for map coordinates x, y - @param x x-coordinate (in map units) - @param y y-coordinate (in map units) - @param result out: interpolation result - @return 0 in case of success*/ + \param x x-coordinate (in map units) + \param y y-coordinate (in map units) + \param result out: interpolation result + \returns 0 in case of success*/ int interpolatePoint( double x, double y, double &result ) override; void setDistanceCoefficient( double p ) {mDistanceCoefficient = p;} diff --git a/src/analysis/interpolation/qgsinterpolator.h b/src/analysis/interpolation/qgsinterpolator.h index a77751cbd601..b2f59aeaf83a 100644 --- a/src/analysis/interpolation/qgsinterpolator.h +++ b/src/analysis/interpolation/qgsinterpolator.h @@ -60,20 +60,20 @@ class ANALYSIS_EXPORT QgsInterpolator virtual ~QgsInterpolator() = default; /** Calculates interpolation value for map coordinates x, y - @param x x-coordinate (in map units) - @param y y-coordinate (in map units) - @param result out: interpolation result - @return 0 in case of success*/ + \param x x-coordinate (in map units) + \param y y-coordinate (in map units) + \param result out: interpolation result + \returns 0 in case of success*/ virtual int interpolatePoint( double x, double y, double &result ) = 0; - //! @note not available in Python bindings + //! \note not available in Python bindings QList layerData() const { return mLayerData; } protected: /** Caches the vertex and value data from the provider. All the vertex data will be held in virtual memory - @return 0 in case of success*/ + \returns 0 in case of success*/ int cacheBaseData(); QVector mCachedBaseData; @@ -88,10 +88,10 @@ class ANALYSIS_EXPORT QgsInterpolator QgsInterpolator(); //forbidden /** Helper method that adds the vertices of a geometry to the mCachedBaseData - @param geom the geometry - @param zCoord true if the z-coordinate of the geometry is to be interpolated - @param attributeValue the attribute value for interpolation (if not interpolated from z-coordinate) - @return 0 in case of success*/ + \param geom the geometry + \param zCoord true if the z-coordinate of the geometry is to be interpolated + \param attributeValue the attribute value for interpolation (if not interpolated from z-coordinate) + \returns 0 in case of success*/ int addVerticesToCache( const QgsGeometry &geom, bool zCoord, double attributeValue ); }; diff --git a/src/analysis/interpolation/qgstininterpolator.h b/src/analysis/interpolation/qgstininterpolator.h index d4368cbabd0b..ce5f13c63b1e 100644 --- a/src/analysis/interpolation/qgstininterpolator.h +++ b/src/analysis/interpolation/qgstininterpolator.h @@ -41,10 +41,10 @@ class ANALYSIS_EXPORT QgsTINInterpolator: public QgsInterpolator ~QgsTINInterpolator(); /** Calculates interpolation value for map coordinates x, y - @param x x-coordinate (in map units) - @param y y-coordinate (in map units) - @param result out: interpolation result - @return 0 in case of success*/ + \param x x-coordinate (in map units) + \param y y-coordinate (in map units) + \param result out: interpolation result + \returns 0 in case of success*/ int interpolatePoint( double x, double y, double &result ) override; void setExportTriangulationToFile( bool e ) {mExportTriangulationToFile = e;} @@ -66,11 +66,11 @@ class ANALYSIS_EXPORT QgsTINInterpolator: public QgsInterpolator void initialize(); /** Inserts the vertices of a feature into the triangulation - @param f the feature - @param zCoord true if the z coordinate is the interpolation attribute - @param attr interpolation attribute index (if zCoord is false) - @param type point/structure line, break line - @return 0 in case of success, -1 if the feature could not be inserted because of numerical problems*/ + \param f the feature + \param zCoord true if the z coordinate is the interpolation attribute + \param attr interpolation attribute index (if zCoord is false) + \param type point/structure line, break line + \returns 0 in case of success, -1 if the feature could not be inserted because of numerical problems*/ int insertData( QgsFeature *f, bool zCoord, int attr, InputType type ); }; diff --git a/src/analysis/network/qgsgraph.h b/src/analysis/network/qgsgraph.h index aa6c12cfe139..9b30312471fd 100644 --- a/src/analysis/network/qgsgraph.h +++ b/src/analysis/network/qgsgraph.h @@ -47,7 +47,7 @@ class ANALYSIS_EXPORT QgsGraphEdge /** * Returns edge cost calculated using specified strategy - * @param strategyIndex strategy index + * \param strategyIndex strategy index */ QVariant cost( int strategyIndex ) const; @@ -167,7 +167,7 @@ class ANALYSIS_EXPORT QgsGraph /** * Find vertex by associated point - * \return vertex index + * \returns vertex index */ int findVertex( const QgsPoint &pt ) const; diff --git a/src/analysis/network/qgsgraphanalyzer.h b/src/analysis/network/qgsgraphanalyzer.h index 55cc0f4bac77..2969ee6fa6b7 100644 --- a/src/analysis/network/qgsgraphanalyzer.h +++ b/src/analysis/network/qgsgraphanalyzer.h @@ -32,19 +32,19 @@ class ANALYSIS_EXPORT QgsGraphAnalyzer /** * Solve shortest path problem using Dijkstra algorithm - * @param source source graph - * @param startVertexIdx index of the start vertex - * @param criterionNum index of the optimization strategy - * @param resultTree array that represents shortest path tree. resultTree[ vertexIndex ] == inboundingArcIndex if vertex reachable, otherwise resultTree[ vertexIndex ] == -1 - * @param resultCost array of the paths costs + * \param source source graph + * \param startVertexIdx index of the start vertex + * \param criterionNum index of the optimization strategy + * \param resultTree array that represents shortest path tree. resultTree[ vertexIndex ] == inboundingArcIndex if vertex reachable, otherwise resultTree[ vertexIndex ] == -1 + * \param resultCost array of the paths costs */ static void dijkstra( const QgsGraph *source, int startVertexIdx, int criterionNum, QVector *resultTree = nullptr, QVector *resultCost = nullptr ); /** * Returns shortest path tree with root-node in startVertexIdx - * @param source source graph - * @param startVertexIdx index of the start vertex - * @param criterionNum index of the optimization strategy + * \param source source graph + * \param startVertexIdx index of the start vertex + * \param criterionNum index of the optimization strategy */ static QgsGraph *shortestTree( const QgsGraph *source, int startVertexIdx, int criterionNum ); }; diff --git a/src/analysis/network/qgsgraphbuilderinterface.h b/src/analysis/network/qgsgraphbuilderinterface.h index 41abf1576e6b..284d1941c5d2 100644 --- a/src/analysis/network/qgsgraphbuilderinterface.h +++ b/src/analysis/network/qgsgraphbuilderinterface.h @@ -36,10 +36,10 @@ class ANALYSIS_EXPORT QgsGraphBuilderInterface /** * Default constructor - * @param crs Coordinate reference system for new graph vertex - * @param ctfEnabled enable coordinate transform from source graph CRS to CRS graph - * @param topologyTolerance sqrt distance between source point as one graph vertex - * @param ellipsoidID ellipsoid for edge measurement + * \param crs Coordinate reference system for new graph vertex + * \param ctfEnabled enable coordinate transform from source graph CRS to CRS graph + * \param topologyTolerance sqrt distance between source point as one graph vertex + * \param ellipsoidID ellipsoid for edge measurement */ QgsGraphBuilderInterface( const QgsCoordinateReferenceSystem &crs, bool ctfEnabled = true, double topologyTolerance = 0.0, const QString &ellipsoidID = "WGS84" ) : mCrs( crs ) @@ -80,9 +80,9 @@ class ANALYSIS_EXPORT QgsGraphBuilderInterface /** * Add vertex to the graph - * @param id vertex identifier - * @param pt vertex coordinates - * @note id and pt are redundant. You can use pt or id to identify the vertex + * \param id vertex identifier + * \param pt vertex coordinates + * \note id and pt are redundant. You can use pt or id to identify the vertex */ virtual void addVertex( int id, const QgsPoint &pt ) { @@ -92,12 +92,12 @@ class ANALYSIS_EXPORT QgsGraphBuilderInterface /** * Add edge to the graph - * @param pt1id first vertex identificator - * @param pt1 first vertex coordinates - * @param pt2id second vertex identificator - * @param pt2 second vertex coordinates - * @param strategies optimization strategies - * @note pt1id, pt1 and pt2id, pt2 is a redundant interface. You can use vertex coordinates or their identificators. + * \param pt1id first vertex identificator + * \param pt1 first vertex coordinates + * \param pt2id second vertex identificator + * \param pt2 second vertex coordinates + * \param strategies optimization strategies + * \note pt1id, pt1 and pt2id, pt2 is a redundant interface. You can use vertex coordinates or their identificators. */ virtual void addEdge( int pt1id, const QgsPoint &pt1, int pt2id, const QgsPoint &pt2, const QVector< QVariant > &strategies ) { diff --git a/src/analysis/network/qgsgraphdirector.h b/src/analysis/network/qgsgraphdirector.h index 96fa8996bb13..193667e41e2a 100644 --- a/src/analysis/network/qgsgraphdirector.h +++ b/src/analysis/network/qgsgraphdirector.h @@ -47,10 +47,10 @@ class ANALYSIS_EXPORT QgsGraphDirector : public QObject /** * Make a graph using QgsGraphBuilder * - * @param builder the graph builder - * @param additionalPoints list of points that should be snapped to the graph - * @param snappedPoints list of snapped points - * @note if snappedPoints[i] == QgsPoint(0.0,0.0) then snapping failed. + * \param builder the graph builder + * \param additionalPoints list of points that should be snapped to the graph + * \param snappedPoints list of snapped points + * \note if snappedPoints[i] == QgsPoint(0.0,0.0) then snapping failed. */ virtual void makeGraph( QgsGraphBuilderInterface *builder, const QVector< QgsPoint > &additionalPoints, diff --git a/src/analysis/network/qgsnetworkstrategy.h b/src/analysis/network/qgsnetworkstrategy.h index ba3e0612ea57..0541c311fc86 100644 --- a/src/analysis/network/qgsnetworkstrategy.h +++ b/src/analysis/network/qgsnetworkstrategy.h @@ -45,7 +45,7 @@ class ANALYSIS_EXPORT QgsNetworkStrategy /** * Returns list of the source layer attributes needed for cost calculation. * This method called by QgsGraphDirector. - * \return list of required attributes + * \returns list of required attributes */ virtual QgsAttributeList requiredAttributes() const { return QgsAttributeList(); } diff --git a/src/analysis/network/qgsvectorlayerdirector.h b/src/analysis/network/qgsvectorlayerdirector.h index e3a1951927e2..9cacb7645664 100644 --- a/src/analysis/network/qgsvectorlayerdirector.h +++ b/src/analysis/network/qgsvectorlayerdirector.h @@ -49,12 +49,12 @@ class ANALYSIS_EXPORT QgsVectorLayerDirector : public QgsGraphDirector /** * Default constructor - * @param myLayer source vector layer - * @param directionFieldId field containing direction value - * @param directDirectionValue value for direct one-way road - * @param reverseDirectionValue value for reversed one-way road - * @param bothDirectionValue value for two-way (bidirectional) road - * @param defaultDirection default direction. Will be used if corresponding + * \param myLayer source vector layer + * \param directionFieldId field containing direction value + * \param directDirectionValue value for direct one-way road + * \param reverseDirectionValue value for reversed one-way road + * \param bothDirectionValue value for two-way (bidirectional) road + * \param defaultDirection default direction. Will be used if corresponding * attribute value is not set or does not equal to the given values */ QgsVectorLayerDirector( QgsVectorLayer *myLayer, diff --git a/src/analysis/openstreetmap/qgsosmdatabase.h b/src/analysis/openstreetmap/qgsosmdatabase.h index 8ea915af5ed6..84f187c720a2 100644 --- a/src/analysis/openstreetmap/qgsosmdatabase.h +++ b/src/analysis/openstreetmap/qgsosmdatabase.h @@ -69,10 +69,10 @@ class ANALYSIS_EXPORT QgsOSMDatabase int countNodes() const; int countWays() const; - //! @note not available in Python bindings + //! \note not available in Python bindings QgsOSMNodeIterator listNodes() const; - //! @note not available in Python bindings + //! \note not available in Python bindings QgsOSMWayIterator listWays() const; QgsOSMNode node( QgsOSMId id ) const; @@ -81,7 +81,7 @@ class ANALYSIS_EXPORT QgsOSMDatabase QgsOSMTags tags( bool way, QgsOSMId id ) const; - //! @note available in Python bindings + //! \note available in Python bindings QList usedTags( bool ways ) const; QgsPolyline wayPoints( QgsOSMId id ) const; @@ -98,7 +98,7 @@ class ANALYSIS_EXPORT QgsOSMDatabase int runCountStatement( const char *sql ) const; /** - * @note not available in Python bindings + * \note not available in Python bindings */ void deleteStatement( sqlite3_stmt *&stmt ); @@ -131,7 +131,7 @@ class ANALYSIS_EXPORT QgsOSMDatabase /** \ingroup analysis * Encapsulate iteration over table of nodes/ - * @note not available in Python bindings + * \note not available in Python bindings */ class ANALYSIS_EXPORT QgsOSMNodeIterator // clazy:exclude=rule-of-three { @@ -143,7 +143,7 @@ class ANALYSIS_EXPORT QgsOSMNodeIterator // clazy:exclude=rule-of-three protected: - /** @note not available in Python bindings + /** \note not available in Python bindings */ QgsOSMNodeIterator( sqlite3 *handle ); @@ -157,7 +157,7 @@ class ANALYSIS_EXPORT QgsOSMNodeIterator // clazy:exclude=rule-of-three /** \ingroup analysis * Encapsulate iteration over table of ways - * @note not available in Python bindings + * \note not available in Python bindings */ class ANALYSIS_EXPORT QgsOSMWayIterator // clazy:exclude=rule-of-three { @@ -169,7 +169,7 @@ class ANALYSIS_EXPORT QgsOSMWayIterator // clazy:exclude=rule-of-three protected: - /** @note not available in Python bindings + /** \note not available in Python bindings */ QgsOSMWayIterator( sqlite3 *handle ); diff --git a/src/analysis/openstreetmap/qgsosmdownload.h b/src/analysis/openstreetmap/qgsosmdownload.h index 041dcdb6c658..1a641f1b5fbb 100644 --- a/src/analysis/openstreetmap/qgsosmdownload.h +++ b/src/analysis/openstreetmap/qgsosmdownload.h @@ -25,7 +25,7 @@ class QgsRectangle; /** \ingroup analysis - * @brief OSMDownload is a utility class for downloading OpenStreetMap via Overpass API. + * \brief OSMDownload is a utility class for downloading OpenStreetMap via Overpass API. * * To use this class, it is necessary to set query, output file name and start the request. * The interface is asynchronous, the caller has to wait for finished() signal that is @@ -64,18 +64,18 @@ class ANALYSIS_EXPORT QgsOSMDownload : public QObject QString errorString() const { return mError; } /** - * @brief Starts network request for data. The prerequisite is that the query string and output + * \brief Starts network request for data. The prerequisite is that the query string and output * file name have been set. * * Only one request may be pending at one point - if you need more requests at once, use several instances. * - * @return true if the network request has been issued, false otherwise (and sets error string) + * \returns true if the network request has been issued, false otherwise (and sets error string) */ bool start(); /** - * @brief Aborts current pending request - * @return true if there is a pending request and has been aborted, false otherwise + * \brief Aborts current pending request + * \returns true if there is a pending request and has been aborted, false otherwise */ bool abort(); diff --git a/src/analysis/openstreetmap/qgsosmimport.h b/src/analysis/openstreetmap/qgsosmimport.h index 5ade43b40fb6..06346007667b 100644 --- a/src/analysis/openstreetmap/qgsosmimport.h +++ b/src/analysis/openstreetmap/qgsosmimport.h @@ -25,7 +25,7 @@ class QXmlStreamReader; /** \ingroup analysis - * @brief The QgsOSMXmlImport class imports OpenStreetMap XML format to our topological representation + * \brief The QgsOSMXmlImport class imports OpenStreetMap XML format to our topological representation * in a SQLite database (see QgsOSMDatabase for details). * * How to use the class: @@ -44,19 +44,19 @@ class ANALYSIS_EXPORT QgsOSMXmlImport : public QObject /** * Sets the filename for the output database. - * @see outputDatabaseFileName() + * \see outputDatabaseFileName() */ void setOutputDatabaseFileName( const QString &fileName ) { mDbFileName = fileName; } /** * Returns the filename for the output database. - * @see setOutputDatabaseFileName() + * \see setOutputDatabaseFileName() */ QString outputDatabaseFileName() const { return mDbFileName; } /** * Run import. This will parse the XML file and store the data in a SQLite database. - * @return true on success, false when import failed (see errorString() for the error) + * \returns true on success, false when import failed (see errorString() for the error) */ bool import(); @@ -71,7 +71,7 @@ class ANALYSIS_EXPORT QgsOSMXmlImport : public QObject bool createDatabase(); bool closeDatabase(); - //! @note not available in Python bindings + //! \note not available in Python bindings void deleteStatement( sqlite3_stmt *&stmt ); bool createIndexes(); diff --git a/src/analysis/raster/qgsalignraster.h b/src/analysis/raster/qgsalignraster.h index 658d00e336e2..c049f52fcba7 100644 --- a/src/analysis/raster/qgsalignraster.h +++ b/src/analysis/raster/qgsalignraster.h @@ -29,7 +29,7 @@ typedef void *GDALDatasetH; /** \ingroup analysis - * @brief QgsAlignRaster takes one or more raster layers and warps (resamples) them + * \brief QgsAlignRaster takes one or more raster layers and warps (resamples) them * so they have the same: * - coordinate reference system * - cell size and raster size @@ -96,7 +96,7 @@ class ANALYSIS_EXPORT QgsAlignRaster //! Resampling algorithm to be used (equivalent to GDAL's enum GDALResampleAlg) - //! @note RA_Max, RA_Min, RA_Median, RA_Q1 and RA_Q3 are available on GDAL >= 2.0 builds only + //! \note RA_Max, RA_Min, RA_Median, RA_Q1 and RA_Q3 are available on GDAL >= 2.0 builds only enum ResampleAlg { RA_NearestNeighbour = 0, //!< Nearest neighbour (select on one input pixel) @@ -144,8 +144,8 @@ class ANALYSIS_EXPORT QgsAlignRaster struct ProgressHandler { //! Method to be overridden for progress reporting. - //! @param complete Overall progress of the alignment operation - //! @return false if the execution should be canceled, true otherwise + //! \param complete Overall progress of the alignment operation + //! \returns false if the execution should be canceled, true otherwise virtual bool progress( double complete ) = 0; virtual ~ProgressHandler() = default; @@ -194,25 +194,25 @@ class ANALYSIS_EXPORT QgsAlignRaster //! If a custom CRS is provided, suggested reprojection is calculated first (using GDAL) in order //! to determine suitable defaults for cell size and grid offset. //! - //! @return true on success (may fail if it is not possible to reproject raster to given CRS) + //! \returns true on success (may fail if it is not possible to reproject raster to given CRS) bool setParametersFromRaster( const RasterInfo &rasterInfo, const QString &customCRSWkt = QString(), QSizeF customCellSize = QSizeF(), QPointF customGridOffset = QPointF( -1, -1 ) ); //! Overridden variant for convenience, taking filename instead RasterInfo object. //! See the other variant for details. bool setParametersFromRaster( const QString &filename, const QString &customCRSWkt = QString(), QSizeF customCellSize = QSizeF(), QPointF customGridOffset = QPointF( -1, -1 ) ); //! Determine destination extent from the input rasters and calculate derived values - //! @return true on success, sets error on error (see errorMessage()) + //! \returns true on success, sets error on error (see errorMessage()) bool checkInputParameters(); //! Return expected size of the resulting aligned raster - //! @note first need to run checkInputParameters() which returns with success + //! \note first need to run checkInputParameters() which returns with success QSize alignedRasterSize() const; //! Return expected extent of the resulting aligned raster - //! @note first need to run checkInputParameters() which returns with success + //! \note first need to run checkInputParameters() which returns with success QgsRectangle alignedRasterExtent() const; //! Run the alignment process - //! @return true on success, sets error on error (see errorMessage()) + //! \returns true on success, sets error on error (see errorMessage()) bool run(); //! Return error from a previous run() call. diff --git a/src/analysis/raster/qgskde.h b/src/analysis/raster/qgskde.h index bacc7e960bf8..91019fffbbee 100644 --- a/src/analysis/raster/qgskde.h +++ b/src/analysis/raster/qgskde.h @@ -110,22 +110,22 @@ class ANALYSIS_EXPORT QgsKernelDensityEstimation /** * Prepares the output file for writing and setups up the surface calculation. This must be called * before adding features via addFeature(). - * @see addFeature() - * @see finalise() + * \see addFeature() + * \see finalise() */ Result prepare(); /** * Adds a single feature to the KDE surface. prepare() must be called before adding features. - * @see prepare() - * @see finalise() + * \see prepare() + * \see finalise() */ Result addFeature( const QgsFeature &feature ); /** * Finalises the output file. Must be called after adding all features via addFeature(). - * @see prepare() - * @see addFeature() + * \see prepare() + * \see addFeature() */ Result finalise(); diff --git a/src/analysis/raster/qgsninecellfilter.h b/src/analysis/raster/qgsninecellfilter.h index 810703c0936b..e3297af157fa 100644 --- a/src/analysis/raster/qgsninecellfilter.h +++ b/src/analysis/raster/qgsninecellfilter.h @@ -37,8 +37,8 @@ class ANALYSIS_EXPORT QgsNineCellFilter virtual ~QgsNineCellFilter() = default; /** Starts the calculation, reads from mInputFile and stores the result in mOutputFile - @param p progress dialog that receives update and that is checked for abort. 0 if no progress bar is needed. - @return 0 in case of success*/ + \param p progress dialog that receives update and that is checked for abort. 0 if no progress bar is needed. + \returns 0 in case of success*/ int processRaster( QProgressDialog *p ); double cellSizeX() const { return mCellSizeX; } @@ -68,11 +68,11 @@ class ANALYSIS_EXPORT QgsNineCellFilter GDALDatasetH openInputFile( int &nCellsX, int &nCellsY ); /** Opens the output driver and tests if it supports the creation of a new dataset - @return nullptr on error and the driver handle on success*/ + \returns nullptr on error and the driver handle on success*/ GDALDriverH openOutputDriver(); /** Opens the output file and sets the same geotransform and CRS as the input data - @return the output dataset or nullptr in case of error*/ + \returns the output dataset or nullptr in case of error*/ GDALDatasetH openOutputFile( GDALDatasetH inputDataset, GDALDriverH outputDriver ); protected: diff --git a/src/analysis/raster/qgsrastercalcnode.h b/src/analysis/raster/qgsrastercalcnode.h index c36881b58b50..62179d8ca5a9 100644 --- a/src/analysis/raster/qgsrastercalcnode.h +++ b/src/analysis/raster/qgsrastercalcnode.h @@ -89,12 +89,12 @@ class ANALYSIS_EXPORT QgsRasterCalcNode void setRight( QgsRasterCalcNode *right ) { delete mRight; mRight = right; } /** Calculates result of raster calculation (might be real matrix or single number). - * @param rasterData input raster data references, map of raster name to raster data block - * @param result destination raster matrix for calculation results - * @param row optional row number to calculate for calculating result by rows, or -1 to + * \param rasterData input raster data references, map of raster name to raster data block + * \param result destination raster matrix for calculation results + * \param row optional row number to calculate for calculating result by rows, or -1 to * calculate entire result * \since QGIS 2.10 - * @note not available in Python bindings + * \note not available in Python bindings */ bool calculate( QMap &rasterData, QgsRasterMatrix &result, int row = -1 ) const; diff --git a/src/analysis/raster/qgsrastercalculator.h b/src/analysis/raster/qgsrastercalculator.h index 769cb00679b1..a0a849791f30 100644 --- a/src/analysis/raster/qgsrastercalculator.h +++ b/src/analysis/raster/qgsrastercalculator.h @@ -54,34 +54,34 @@ class ANALYSIS_EXPORT QgsRasterCalculator }; /** QgsRasterCalculator constructor. - * @param formulaString formula for raster calculation - * @param outputFile output file path - * @param outputFormat output file format - * @param outputExtent output extent. CRS for output is taken from first entry in rasterEntries. - * @param nOutputColumns number of columns in output raster - * @param nOutputRows number of rows in output raster - * @param rasterEntries list of referenced raster layers + * \param formulaString formula for raster calculation + * \param outputFile output file path + * \param outputFormat output file format + * \param outputExtent output extent. CRS for output is taken from first entry in rasterEntries. + * \param nOutputColumns number of columns in output raster + * \param nOutputRows number of rows in output raster + * \param rasterEntries list of referenced raster layers */ QgsRasterCalculator( const QString &formulaString, const QString &outputFile, const QString &outputFormat, const QgsRectangle &outputExtent, int nOutputColumns, int nOutputRows, const QVector &rasterEntries ); /** QgsRasterCalculator constructor. - * @param formulaString formula for raster calculation - * @param outputFile output file path - * @param outputFormat output file format - * @param outputExtent output extent, CRS is specified by outputCrs parameter - * @param outputCrs destination CRS for output raster - * @param nOutputColumns number of columns in output raster - * @param nOutputRows number of rows in output raster - * @param rasterEntries list of referenced raster layers + * \param formulaString formula for raster calculation + * \param outputFile output file path + * \param outputFormat output file format + * \param outputExtent output extent, CRS is specified by outputCrs parameter + * \param outputCrs destination CRS for output raster + * \param nOutputColumns number of columns in output raster + * \param nOutputRows number of rows in output raster + * \param rasterEntries list of referenced raster layers * \since QGIS 2.10 */ QgsRasterCalculator( const QString &formulaString, const QString &outputFile, const QString &outputFormat, const QgsRectangle &outputExtent, const QgsCoordinateReferenceSystem &outputCrs, int nOutputColumns, int nOutputRows, const QVector &rasterEntries ); /** Starts the calculation and writes new raster - @param p progress bar (or 0 if called from non-gui code) - @return 0 in case of success*/ + \param p progress bar (or 0 if called from non-gui code) + \returns 0 in case of success*/ //TODO QGIS 3.0 - return QgsRasterCalculator::Result int processCalculation( QProgressDialog *p = nullptr ); @@ -90,15 +90,15 @@ class ANALYSIS_EXPORT QgsRasterCalculator QgsRasterCalculator(); /** Opens the output driver and tests if it supports the creation of a new dataset - @return nullptr on error and the driver handle on success*/ + \returns nullptr on error and the driver handle on success*/ GDALDriverH openOutputDriver(); /** Opens the output file and sets the same geotransform and CRS as the input data - @return the output dataset or nullptr in case of error*/ + \returns the output dataset or nullptr in case of error*/ GDALDatasetH openOutputFile( GDALDriverH outputDriver ); /** Sets gdal 6 parameters array from mOutputRectangle, mNumOutputColumns, mNumOutputRows - @param transform double[6] array that receives the GDAL parameters*/ + \param transform double[6] array that receives the GDAL parameters*/ void outputGeoTransform( double *transform ) const; QString mFormulaString; diff --git a/src/analysis/raster/qgsrastermatrix.h b/src/analysis/raster/qgsrastermatrix.h index 40a7056afe90..c507e228d617 100644 --- a/src/analysis/raster/qgsrastermatrix.h +++ b/src/analysis/raster/qgsrastermatrix.h @@ -60,7 +60,7 @@ class ANALYSIS_EXPORT QgsRasterMatrix //! Takes ownership of data array QgsRasterMatrix(); - //! @note note available in Python bindings + //! \note note available in Python bindings QgsRasterMatrix( int nCols, int nRows, double *data, double nodataValue ); QgsRasterMatrix( const QgsRasterMatrix &m ); ~QgsRasterMatrix(); @@ -70,10 +70,10 @@ class ANALYSIS_EXPORT QgsRasterMatrix double number() const { return mData[0]; } //! Returns data array (but not ownership) - //! @note not available in Python bindings + //! \note not available in Python bindings double *data() { return mData; } //! Returns data and ownership. Sets data and nrows, ncols of this matrix to 0 - //! @note not available in Python bindings + //! \note not available in Python bindings double *takeData(); void setData( int cols, int rows, double *data, double nodataValue ); diff --git a/src/analysis/raster/qgsrelief.h b/src/analysis/raster/qgsrelief.h index 2a38ec5bfea2..92c5eaf9da80 100644 --- a/src/analysis/raster/qgsrelief.h +++ b/src/analysis/raster/qgsrelief.h @@ -52,8 +52,8 @@ class ANALYSIS_EXPORT QgsRelief QgsRelief &operator=( const QgsRelief &rh ) = delete; /** Starts the calculation, reads from mInputFile and stores the result in mOutputFile - @param p progress dialog that receives update and that is checked for abort. 0 if no progress bar is needed. - @return 0 in case of success*/ + \param p progress dialog that receives update and that is checked for abort. 0 if no progress bar is needed. + \returns 0 in case of success*/ int processRaster( QProgressDialog *p ); double zFactor() const { return mZFactor; } @@ -65,7 +65,7 @@ class ANALYSIS_EXPORT QgsRelief void setReliefColors( const QList< ReliefColor > &c ) { mReliefColors = c; } /** Calculates class breaks according with the method of Buenzli (2011) using an iterative algorithm for segmented regression - @return true in case of success*/ + \returns true in case of success*/ QList< ReliefColor > calculateOptimizedReliefClasses(); //! Write frequency of elevation values to file for manual inspection @@ -102,11 +102,11 @@ class ANALYSIS_EXPORT QgsRelief GDALDatasetH openInputFile( int &nCellsX, int &nCellsY ); /** Opens the output driver and tests if it supports the creation of a new dataset - @return nullptr on error and the driver handle on success*/ + \returns nullptr on error and the driver handle on success*/ GDALDriverH openOutputDriver(); /** Opens the output file and sets the same geotransform and CRS as the input data - @return the output dataset or nullptr in case of error*/ + \returns the output dataset or nullptr in case of error*/ GDALDatasetH openOutputFile( GDALDatasetH inputDataset, GDALDriverH outputDriver ); //! Set elevation color @@ -116,15 +116,15 @@ class ANALYSIS_EXPORT QgsRelief void setDefaultReliefColors(); /** Returns class (0-255) for an elevation value - @return elevation class or -1 in case of error*/ + \returns elevation class or -1 in case of error*/ int frequencyClassForElevation( double elevation, double minElevation, double elevationClassRange ); //! Do one iteration of class break optimisation (algorithm from Garcia and Rodriguez) void optimiseClassBreaks( QList &breaks, double *frequencies ); /** Calculates coefficients a and b - @param input data points ( elevation class / frequency ) - @param a slope - @param b y value for x=0 + \param input data points ( elevation class / frequency ) + \param a slope + \param b y value for x=0 */ bool calculateRegression( const QList< QPair < int, double > > &input, double &a, double &b ); diff --git a/src/analysis/vector/qgsgeometryanalyzer.h b/src/analysis/vector/qgsgeometryanalyzer.h index 582ddc58ab1f..cf5098552d01 100644 --- a/src/analysis/vector/qgsgeometryanalyzer.h +++ b/src/analysis/vector/qgsgeometryanalyzer.h @@ -37,83 +37,83 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer /** Simplify vector layer using (a modified) Douglas-Peucker algorithm * and write it to a new shape file - * @param layer input vector layer - * @param shapefileName path to the output shp - * @param tolerance (level of simplification) - * @param onlySelectedFeatures if true, only selected features are considered, else all the features - * @param p progress dialog (or 0 if no progress dialog is to be shown) + * \param layer input vector layer + * \param shapefileName path to the output shp + * \param tolerance (level of simplification) + * \param onlySelectedFeatures if true, only selected features are considered, else all the features + * \param p progress dialog (or 0 if no progress dialog is to be shown) */ bool simplify( QgsVectorLayer *layer, const QString &shapefileName, double tolerance, bool onlySelectedFeatures = false, QProgressDialog *p = nullptr ); /** Calculate the true centroids, or 'center of mass' for a vector layer and * write it to a new shape file - * @param layer input vector layer - * @param shapefileName path to the output shp - * @param onlySelectedFeatures if true, only selected features are considered, else all the features - * @param p progress dialog (or 0 if no progress dialog is to be shown) + * \param layer input vector layer + * \param shapefileName path to the output shp + * \param onlySelectedFeatures if true, only selected features are considered, else all the features + * \param p progress dialog (or 0 if no progress dialog is to be shown) */ bool centroids( QgsVectorLayer *layer, const QString &shapefileName, bool onlySelectedFeatures = false, QProgressDialog *p = nullptr ); /** Create a polygon based on the extent of all (selected) features and write it to a new shape file - * @param layer input vector layer - * @param shapefileName path to the output shp - * @param onlySelectedFeatures if true, only selected features are considered, else all the features - * @param p progress dialog (or 0 if no progress dialog is to be shown) + * \param layer input vector layer + * \param shapefileName path to the output shp + * \param onlySelectedFeatures if true, only selected features are considered, else all the features + * \param p progress dialog (or 0 if no progress dialog is to be shown) */ bool extent( QgsVectorLayer *layer, const QString &shapefileName, bool onlySelectedFeatures = false, QProgressDialog *p = 0 ); /** Create buffers for a vector layer and write it to a new shape file - * @param layer input vector layer - * @param shapefileName path to the output shp - * @param bufferDistance distance for buffering (if no buffer field is specified) - * @param onlySelectedFeatures if true, only selected features are considered, else all the features - * @param dissolve if true, merge all the buffers to a big multipolygon - * @param bufferDistanceField index of the attribute field that contains the buffer distance (or -1 if all features have the same buffer distance) - * @param p progress dialog (or 0 if no progress dialog is to be shown) + * \param layer input vector layer + * \param shapefileName path to the output shp + * \param bufferDistance distance for buffering (if no buffer field is specified) + * \param onlySelectedFeatures if true, only selected features are considered, else all the features + * \param dissolve if true, merge all the buffers to a big multipolygon + * \param bufferDistanceField index of the attribute field that contains the buffer distance (or -1 if all features have the same buffer distance) + * \param p progress dialog (or 0 if no progress dialog is to be shown) */ bool buffer( QgsVectorLayer *layer, const QString &shapefileName, double bufferDistance, bool onlySelectedFeatures = false, bool dissolve = false, int bufferDistanceField = -1, QProgressDialog *p = nullptr ); /** Create convex hull(s) of a vector layer and write it to a new shape file - * @param layer input vector layer - * @param shapefileName path to the output shp - * @param onlySelectedFeatures if true, only selected features are considered, else all the features - * @param uniqueIdField index of the attribute field that contains the unique convex hull id (or -1 if + * \param layer input vector layer + * \param shapefileName path to the output shp + * \param onlySelectedFeatures if true, only selected features are considered, else all the features + * \param uniqueIdField index of the attribute field that contains the unique convex hull id (or -1 if * all features have the same buffer distance) - * @param p progress dialog (or 0 if no progress dialog is to be shown) + * \param p progress dialog (or 0 if no progress dialog is to be shown) */ bool convexHull( QgsVectorLayer *layer, const QString &shapefileName, bool onlySelectedFeatures = false, int uniqueIdField = -1, QProgressDialog *p = nullptr ); /** Dissolve a vector layer and write it to a new shape file - * @param layer input vector layer - * @param shapefileName path to the output shp - * @param onlySelectedFeatures if true, only selected features are considered, else all the features - * @param uniqueIdField index of the attribute field that contains the unique id to dissolve on (or -1 if + * \param layer input vector layer + * \param shapefileName path to the output shp + * \param onlySelectedFeatures if true, only selected features are considered, else all the features + * \param uniqueIdField index of the attribute field that contains the unique id to dissolve on (or -1 if * all features should be dissolved together) - * @param p progress dialog (or 0 if no progress dialog is to be shown) + * \param p progress dialog (or 0 if no progress dialog is to be shown) */ bool dissolve( QgsVectorLayer *layer, const QString &shapefileName, bool onlySelectedFeatures = false, int uniqueIdField = -1, QProgressDialog *p = nullptr ); /** Creates an event layer (multipoint or multiline) by locating features from a (non-spatial) event table along the features of a line layer. * Note that currently (until QgsGeometry supports m-values) the z-coordinate of the line layer is used for linear referencing - * @param lineLayer layer with the line geometry - * @param eventLayer layer with features and location field - * @param lineField join index in line layer - * @param eventField join index in event layer - * @param outputLayer name of output file (can be empty if a memory layer is used) - * @param outputFormat name of output format (can be empty if a memory provider is used to store the results) - * @param unlocatedFeatureIds out: ids of event features where linear referencing was not successful - * @param locationField1 attribute index of location field in event layer - * @param locationField2 attribute index of location end field (or -1 for point layer) - * @param offsetField attribute index for offset field. Negative offset value = offset to left side, positive value = offset to right side - * @param offsetScale factor to scale offset - * @param forceSingleGeometry force layer to single point/line type. Feature attributes are copied in case of multiple matches - * @param memoryProvider memory provider to write output to (can be 0 if output is written to a file) - * @param p progress dialog or 0 if no progress dialog should be shown + * \param lineLayer layer with the line geometry + * \param eventLayer layer with features and location field + * \param lineField join index in line layer + * \param eventField join index in event layer + * \param outputLayer name of output file (can be empty if a memory layer is used) + * \param outputFormat name of output format (can be empty if a memory provider is used to store the results) + * \param unlocatedFeatureIds out: ids of event features where linear referencing was not successful + * \param locationField1 attribute index of location field in event layer + * \param locationField2 attribute index of location end field (or -1 for point layer) + * \param offsetField attribute index for offset field. Negative offset value = offset to left side, positive value = offset to right side + * \param offsetScale factor to scale offset + * \param forceSingleGeometry force layer to single point/line type. Feature attributes are copied in case of multiple matches + * \param memoryProvider memory provider to write output to (can be 0 if output is written to a file) + * \param p progress dialog or 0 if no progress dialog should be shown */ bool eventLayer( QgsVectorLayer *lineLayer, QgsVectorLayer *eventLayer, int lineField, int eventField, QgsFeatureIds &unlocatedFeatureIds, const QString &outputLayer, const QString &outputFormat, int locationField1, int locationField2 = -1, int offsetField = -1, double offsetScale = 1.0, @@ -148,9 +148,9 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer bool forceSingleType = false ); /** Create geometry offset relative to line geometry. - @param geom the geometry to modify - @param lineGeom the line geometry to which the feature is referenced - @param offset the offset value in layer unit. Negative values mean offset towards left, positive values offset to the right side*/ + \param geom the geometry to modify + \param lineGeom the line geometry to which the feature is referenced + \param offset the offset value in layer unit. Negative values mean offset towards left, positive values offset to the right side*/ QgsGeometry createOffsetGeometry( const QgsGeometry &geom, const QgsGeometry &lineGeom, double offset ); QgsPoint createPointOffset( double x, double y, double dist, const QgsGeometry &lineGeom ) const; QgsConstWkbPtr locateBetweenWkbString( QgsConstWkbPtr ptr, QgsMultiPolyline &result, double fromMeasure, double toMeasure ); diff --git a/src/analysis/vector/qgsoverlayanalyzer.h b/src/analysis/vector/qgsoverlayanalyzer.h index a9e05e7df7fa..0fd9ada8a495 100644 --- a/src/analysis/vector/qgsoverlayanalyzer.h +++ b/src/analysis/vector/qgsoverlayanalyzer.h @@ -34,11 +34,11 @@ class ANALYSIS_EXPORT QgsOverlayAnalyzer public: /** Perform an intersection on two input vector layers and write output to a new shape file - @param layerA input vector layer - @param layerB input vector layer - @param shapefileName path to the output shp - @param onlySelectedFeatures if true, only selected features are considered, else all the features - @param p progress dialog (or 0 if no progress dialog is to be shown) + \param layerA input vector layer + \param layerB input vector layer + \param shapefileName path to the output shp + \param onlySelectedFeatures if true, only selected features are considered, else all the features + \param p progress dialog (or 0 if no progress dialog is to be shown) */ bool intersection( QgsVectorLayer *layerA, QgsVectorLayer *layerB, const QString &shapefileName, bool onlySelectedFeatures = false, diff --git a/src/analysis/vector/qgspointsample.h b/src/analysis/vector/qgspointsample.h index 965981057708..209022b87016 100644 --- a/src/analysis/vector/qgspointsample.h +++ b/src/analysis/vector/qgspointsample.h @@ -34,7 +34,7 @@ class ANALYSIS_EXPORT QgsPointSample QgsPointSample( QgsVectorLayer *inputLayer, const QString &outputLayer, const QString &nPointsAttribute, const QString &minDistAttribute = QString() ); /** Starts calculation of random points - @return 0 in case of success*/ + \returns 0 in case of success*/ int createRandomPoints( QProgressDialog *pd ); private: diff --git a/src/analysis/vector/qgstransectsample.h b/src/analysis/vector/qgstransectsample.h index 8fd8680cca1a..3ab663383ff9 100644 --- a/src/analysis/vector/qgstransectsample.h +++ b/src/analysis/vector/qgstransectsample.h @@ -77,21 +77,21 @@ class ANALYSIS_EXPORT QgsTransectSample double mBaselineSimplificationTolerance; /** Finds the closest points between two line segments - @param g1 first input geometry. Must be a linestring with two vertices - @param g2 second input geometry. Must be a linestring with two vertices - @param dist out: distance between the segments - @param pt1 out: closest point on first geometry - @param pt2 out: closest point on secont geometry - @return true in case of success*/ + \param g1 first input geometry. Must be a linestring with two vertices + \param g2 second input geometry. Must be a linestring with two vertices + \param dist out: distance between the segments + \param pt1 out: closest point on first geometry + \param pt2 out: closest point on secont geometry + \returns true in case of success*/ static bool closestSegmentPoints( const QgsGeometry &g1, const QgsGeometry &g2, double &dist, QgsPoint &pt1, QgsPoint &pt2 ); //! Returns a copy of the multiline element closest to a point (caller takes ownership) static QgsGeometry closestMultilineElement( const QgsPoint &pt, const QgsGeometry &multiLine ); /** Returns clipped buffer line. Iteratively applies reduced tolerances if the result is not a single line - @param stratumGeom stratum polygon - @param clippedBaseline base line geometry clipped to the stratum - @param tolerance buffer distance (in layer units) - @return clipped buffer line or 0 in case of error*/ + \param stratumGeom stratum polygon + \param clippedBaseline base line geometry clipped to the stratum + \param tolerance buffer distance (in layer units) + \returns clipped buffer line or 0 in case of error*/ QgsGeometry *clipBufferLine( const QgsGeometry &stratumGeom, QgsGeometry *clippedBaseline, double tolerance ); //! Returns distance to buffer the baseline (takes care of units and buffer settings diff --git a/src/analysis/vector/qgszonalstatistics.h b/src/analysis/vector/qgszonalstatistics.h index 5030dcf25e41..8bbff7d60569 100644 --- a/src/analysis/vector/qgszonalstatistics.h +++ b/src/analysis/vector/qgszonalstatistics.h @@ -63,7 +63,7 @@ class ANALYSIS_EXPORT QgsZonalStatistics Statistics stats = Statistics( Count | Sum | Mean ) ); /** Starts the calculation - @return 0 in case of success*/ + \returns 0 in case of success*/ int calculateStatistics( QProgressDialog *p ); private: @@ -111,7 +111,7 @@ class ANALYSIS_EXPORT QgsZonalStatistics }; /** Analysis what cells need to be considered to cover the bounding box of a feature - @return 0 in case of success*/ + \returns 0 in case of success*/ int cellInfoForBBox( const QgsRectangle &rasterBBox, const QgsRectangle &featureBBox, double cellSizeX, double cellSizeY, int &offsetX, int &offsetY, int &nCellsX, int &nCellsY ) const; diff --git a/src/app/composer/qgscomposer.h b/src/app/composer/qgscomposer.h index 6ee37b544a1d..2c8f78d8d12b 100644 --- a/src/app/composer/qgscomposer.h +++ b/src/app/composer/qgscomposer.h @@ -123,9 +123,9 @@ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase void restoreWindowState(); /** Loads the contents of a template document into the composer's composition. - * @param templateDoc template document to load - * @param clearExisting set to true to remove all existing composition settings and items before loading template - * @returns true if template load was successful + * \param templateDoc template document to load + * \param clearExisting set to true to remove all existing composition settings and items before loading template + * \returns true if template load was successful */ bool loadFromTemplate( const QDomDocument &templateDoc, bool clearExisting ); diff --git a/src/app/composer/qgscomposerimageexportoptionsdialog.h b/src/app/composer/qgscomposerimageexportoptionsdialog.h index 9af7ca4d5904..e78de22b9453 100644 --- a/src/app/composer/qgscomposerimageexportoptionsdialog.h +++ b/src/app/composer/qgscomposerimageexportoptionsdialog.h @@ -32,65 +32,65 @@ class QgsComposerImageExportOptionsDialog: public QDialog, private Ui::QgsCompos public: /** Constructor for QgsComposerImageExportOptionsDialog - * @param parent parent widget - * @param flags window flags + * \param parent parent widget + * \param flags window flags */ QgsComposerImageExportOptionsDialog( QWidget *parent = nullptr, Qt::WindowFlags flags = 0 ); ~QgsComposerImageExportOptionsDialog(); /** Sets the initial resolution displayed in the dialog. - * @param resolution default resolution in DPI - * @see resolution() + * \param resolution default resolution in DPI + * \see resolution() */ void setResolution( int resolution ); /** Returns the selected resolution from the dialog. - * @returns image resolution in DPI - * @see setResolution() + * \returns image resolution in DPI + * \see setResolution() */ int resolution() const; /** Sets the target image size. This is used to calculate the default size in pixels * and also for determining the image's width to height ratio. - * @param size image size + * \param size image size */ void setImageSize( QSizeF size ); /** Returns the user-set image width in pixels. - * @see imageHeight + * \see imageHeight */ int imageWidth() const; /** Returns the user-set image height in pixels. - * @see imageWidth + * \see imageWidth */ int imageHeight() const; /** Sets whether the crop to contents option should be checked in the dialog - * @param crop set to true to check crop to contents - * @see cropToContents() + * \param crop set to true to check crop to contents + * \see cropToContents() */ void setCropToContents( bool crop ); /** Returns whether the crop to contents option is checked in the dialog. - * @see setCropToContents() + * \see setCropToContents() */ bool cropToContents() const; /** Fetches the current crop to contents margin values, in pixels. - * @param topMargin destination for top margin - * @param rightMargin destination for right margin - * @param bottomMargin destination for bottom margin - * @param leftMargin destination for left margin + * \param topMargin destination for top margin + * \param rightMargin destination for right margin + * \param bottomMargin destination for bottom margin + * \param leftMargin destination for left margin */ void getCropMargins( int &topMargin, int &rightMargin, int &bottomMargin, int &leftMargin ) const; /** Sets the current crop to contents margin values, in pixels. - * @param topMargin top margin - * @param rightMargin right margin - * @param bottomMargin bottom margin - * @param leftMargin left margin + * \param topMargin top margin + * \param rightMargin right margin + * \param bottomMargin bottom margin + * \param leftMargin left margin */ void setCropMargins( int topMargin, int rightMargin, int bottomMargin, int leftMargin ); diff --git a/src/app/composer/qgscomposeritemwidget.h b/src/app/composer/qgscomposeritemwidget.h index e8139182149e..71cc3abf4368 100644 --- a/src/app/composer/qgscomposeritemwidget.h +++ b/src/app/composer/qgscomposeritemwidget.h @@ -56,8 +56,8 @@ class QgsComposerConfigObject: public QObject ~QgsComposerConfigObject(); /** Registers a data defined button, setting up its initial value, connections and description. - * @param button button to register - * @param key corresponding data defined property key + * \param button button to register + * \param key corresponding data defined property key */ void initializeDataDefinedButton( QgsPropertyOverrideButton *button, QgsComposerObject::DataDefinedProperty key ); @@ -98,8 +98,8 @@ class QgsComposerItemBaseWidget: public QgsPanelWidget protected: /** Registers a data defined button, setting up its initial value, connections and description. - * @param button button to register - * @param property corresponding data defined property key + * \param button button to register + * \param property corresponding data defined property key */ void registerDataDefinedButton( QgsPropertyOverrideButton *button, QgsComposerObject::DataDefinedProperty property ); diff --git a/src/app/composer/qgscomposermanager.h b/src/app/composer/qgscomposermanager.h index 068e1e1d7bf7..46bb38c923f2 100644 --- a/src/app/composer/qgscomposermanager.h +++ b/src/app/composer/qgscomposermanager.h @@ -73,7 +73,7 @@ class QgsComposerManager: public QDialog, private Ui::QgsComposerManagerBase private: /** Returns the default templates (key: template name, value: absolute path to template file) - * @param fromUser whether to return user templates from ~/.qgis/composer_templates + * \param fromUser whether to return user templates from ~/.qgis/composer_templates */ QMap defaultTemplates( bool fromUser = false ) const; QMap otherTemplates() const; diff --git a/src/app/composer/qgscomposerpicturewidget.h b/src/app/composer/qgscomposerpicturewidget.h index 5c57edd3e485..d4fba1a19e8c 100644 --- a/src/app/composer/qgscomposerpicturewidget.h +++ b/src/app/composer/qgscomposerpicturewidget.h @@ -64,7 +64,7 @@ class QgsComposerPictureWidget: public QgsComposerItemBaseWidget, private Ui::Qg void setPicRotationSpinValue( double r ); /** Load SVG and pixel-based image previews - * @param collapsed Whether the parent group box is collapsed */ + * \param collapsed Whether the parent group box is collapsed */ void loadPicturePreviews( bool collapsed ); void on_mFillColorButton_colorChanged( const QColor &color ); diff --git a/src/app/composer/qgscomposertablebackgroundcolorsdialog.h b/src/app/composer/qgscomposertablebackgroundcolorsdialog.h index 1116572fcc69..2280499c3867 100644 --- a/src/app/composer/qgscomposertablebackgroundcolorsdialog.h +++ b/src/app/composer/qgscomposertablebackgroundcolorsdialog.h @@ -34,9 +34,9 @@ class QgsComposerTableBackgroundColorsDialog: public QDialog, private Ui::QgsCom public: /** Constructor for QgsComposerTableBackgroundColorsDialog - * @param table associated composer table - * @param parent parent widget - * @param flags window flags + * \param table associated composer table + * \param parent parent widget + * \param flags window flags */ QgsComposerTableBackgroundColorsDialog( QgsComposerTableV2 *table, QWidget *parent = nullptr, Qt::WindowFlags flags = 0 ); diff --git a/src/app/dwg/libdxfrw/drw_interface.h b/src/app/dwg/libdxfrw/drw_interface.h index 556a08fe007f..7af45d7c7f0c 100644 --- a/src/app/dwg/libdxfrw/drw_interface.h +++ b/src/app/dwg/libdxfrw/drw_interface.h @@ -56,7 +56,7 @@ class DRW_Interface * Called for every block. Note: all entities added after this * command go into this block until endBlock() is called. * - * @see endBlock() + * \see endBlock() */ virtual void addBlock( const DRW_Block &data ) = 0; diff --git a/src/app/dwg/libdxfrw/libdxfrw.h b/src/app/dwg/libdxfrw/libdxfrw.h index 8223ec4f2632..6f01f017bec9 100644 --- a/src/app/dwg/libdxfrw/libdxfrw.h +++ b/src/app/dwg/libdxfrw/libdxfrw.h @@ -33,9 +33,9 @@ class dxfRW /*! * An interface must be provided. It is used by the class to signal various * components being added. - * @param interface_ the interface to use - * @param ext should the extrusion be applied to convert in 2D? - * @return true for success + * \param interface_ the interface to use + * \param ext should the extrusion be applied to convert in 2D? + * \returns true for success */ bool read( DRW_Interface *interface_, bool ext ); void setBinary( bool b ) {binFile = b;} diff --git a/src/app/gps/qwtpolar-0.1/qwt_polar_curve.h b/src/app/gps/qwtpolar-0.1/qwt_polar_curve.h index 170010356974..577f1d363018 100644 --- a/src/app/gps/qwtpolar-0.1/qwt_polar_curve.h +++ b/src/app/gps/qwtpolar-0.1/qwt_polar_curve.h @@ -117,13 +117,13 @@ class QWT_POLAR_EXPORT QwtPolarCurve: public QwtPolarItem PrivateData *d_data; }; -//! \return the curve data +//! \returns the curve data inline QwtData &QwtPolarCurve::data() { return *d_points; } -//! \return the curve data +//! \returns the curve data inline const QwtData &QwtPolarCurve::data() const { return *d_points; @@ -131,7 +131,7 @@ inline const QwtData &QwtPolarCurve::data() const /*! \param i index - \return azimuth at position i + \returns azimuth at position i */ inline double QwtPolarCurve::azimuth( int i ) const { @@ -140,7 +140,7 @@ inline double QwtPolarCurve::azimuth( int i ) const /*! \param i index - \return radius at position i + \returns radius at position i */ inline double QwtPolarCurve::radius( int i ) const { @@ -149,7 +149,7 @@ inline double QwtPolarCurve::radius( int i ) const /*! \param i index - \return point at position i + \returns point at position i */ inline QwtPolarPoint QwtPolarCurve::sample( int i ) const { diff --git a/src/app/gps/qwtpolar-1.0/qwt_polar_curve.h b/src/app/gps/qwtpolar-1.0/qwt_polar_curve.h index 81437957a1bb..793602f44dcf 100644 --- a/src/app/gps/qwtpolar-1.0/qwt_polar_curve.h +++ b/src/app/gps/qwtpolar-1.0/qwt_polar_curve.h @@ -143,7 +143,7 @@ class QWT_POLAR_EXPORT QwtPolarCurve: public QwtPolarItem PrivateData *d_data; }; -//! \return the curve data +//! \returns the curve data inline const QwtSeriesData *QwtPolarCurve::data() const { return d_series; @@ -151,7 +151,7 @@ inline const QwtSeriesData *QwtPolarCurve::data() const /*! \param i index - \return point at position i + \returns point at position i */ inline QwtPointPolar QwtPolarCurve::sample( int i ) const { diff --git a/src/app/gps/qwtpolar-1.1.1/qwt_polar_curve.h b/src/app/gps/qwtpolar-1.1.1/qwt_polar_curve.h index a4745222cecb..0ea3489a9b20 100644 --- a/src/app/gps/qwtpolar-1.1.1/qwt_polar_curve.h +++ b/src/app/gps/qwtpolar-1.1.1/qwt_polar_curve.h @@ -141,7 +141,7 @@ class QWT_POLAR_EXPORT QwtPolarCurve: public QwtPolarItem PrivateData *d_data; }; -//! \return the the curve data +//! \returns the the curve data inline const QwtSeriesData *QwtPolarCurve::data() const { return d_series; @@ -149,7 +149,7 @@ inline const QwtSeriesData *QwtPolarCurve::data() const /*! \param i index - \return point at position i + \returns point at position i */ inline QwtPointPolar QwtPolarCurve::sample( int i ) const { diff --git a/src/app/nodetool/qgsmaptoolnodetool.h b/src/app/nodetool/qgsmaptoolnodetool.h index f32717bdb2bd..06da7638b807 100644 --- a/src/app/nodetool/qgsmaptoolnodetool.h +++ b/src/app/nodetool/qgsmaptoolnodetool.h @@ -100,8 +100,8 @@ class QgsMapToolNodeTool: public QgsMapToolEdit /** * Function to check if selected feature exists and is same with original one * stored in internal structures - * @param vlayer vector layer for checking - * @return if feature is same as one in internal structures + * \param vlayer vector layer for checking + * \returns if feature is same as one in internal structures */ bool checkCorrectnessOfFeature( QgsVectorLayer *vlayer ); @@ -123,16 +123,16 @@ class QgsMapToolNodeTool: public QgsMapToolEdit /** Extracts a single snapping point from a set of snapping results. This is useful for snapping operations that just require a position to snap to and not all the snapping results. If the list is empty, the screen coordinates are transformed into map coordinates and returned - @param snapResults results collected from the snapping operation. - @return the snapped point in map coordinates*/ + \param snapResults results collected from the snapping operation. + \returns the snapped point in map coordinates*/ QgsPoint snapPointFromResults( const QList &snapResults, QPoint screenCoords ); /** Inserts vertices to the snapped segments of the editing layer. This is useful for topological editing if snap to segment is enabled. - @param snapResults results collected from the snapping operation - @param editedLayer pointer to the editing layer - @param skipFids set of feature IDs to avoid inserting vertices in - @return 0 in case of success*/ + \param snapResults results collected from the snapping operation + \param editedLayer pointer to the editing layer + \param skipFids set of feature IDs to avoid inserting vertices in + \returns 0 in case of success*/ int insertSegmentVerticesForSnap( const QList &snapResults, QgsVectorLayer *editedLayer, const QgsFeatureIds &skipFids ); /** Snapper object that reads the settings from project and option diff --git a/src/app/nodetool/qgsselectedfeature.h b/src/app/nodetool/qgsselectedfeature.h index d439469c2743..578e2a1919ce 100644 --- a/src/app/nodetool/qgsselectedfeature.h +++ b/src/app/nodetool/qgsselectedfeature.h @@ -48,21 +48,21 @@ class QgsSelectedFeature: public QObject /** * Setting selected feature - * @param featureId id of feature which was selected - * @param vlayer vector layer in which feature is selected - * @param canvas mapCanvas on which we are working + * \param featureId id of feature which was selected + * \param vlayer vector layer in which feature is selected + * \param canvas mapCanvas on which we are working */ void setSelectedFeature( QgsFeatureId featureId, QgsVectorLayer *vlayer, QgsMapCanvas *canvas ); /** * Function to select vertex with number - * @param vertexNr number of vertex which is to be selected + * \param vertexNr number of vertex which is to be selected */ void selectVertex( int vertexNr ); /** * Function to deselect vertex with number - * @param vertexNr number of vertex which is to be deselected + * \param vertexNr number of vertex which is to be deselected */ void deselectVertex( int vertexNr ); @@ -78,38 +78,38 @@ class QgsSelectedFeature: public QObject /** * Moves selected vertex - * @param v translation vector + * \param v translation vector */ void moveSelectedVertexes( QgsVector v ); /** * Inverts selection of vertex with number - * @param vertexNr number of vertex which is to be inverted + * \param vertexNr number of vertex which is to be inverted */ void invertVertexSelection( int vertexNr ); /** * Inverts selection of a set of vertices at once. - * @param vertexIndices list of vertex indices to invert whether or not they are selected + * \param vertexIndices list of vertex indices to invert whether or not they are selected */ void invertVertexSelection( const QVector &vertexIndices ); /** * Tells if vertex is selected - * @param vertexNr number of vertex for which we are getting info - * @return true if vertex is selected, false otherwise + * \param vertexNr number of vertex for which we are getting info + * \returns true if vertex is selected, false otherwise */ bool isSelected( int vertexNr ); /** * Getting feature Id of feature selected - * @return feature id of selected feature + * \returns feature id of selected feature */ QgsFeatureId featureId(); /** * Getting vertex map of vertexes - * @return currently used vertex map + * \returns currently used vertex map */ QList &vertexMap(); @@ -120,7 +120,7 @@ class QgsSelectedFeature: public QObject /** * Get the layer of the selected feature - * @return used vector layer + * \returns used vector layer */ QgsVectorLayer *vlayer(); diff --git a/src/app/ogr/qgsvectorlayersaveasdialog.h b/src/app/ogr/qgsvectorlayersaveasdialog.h index 2022bc6e86c0..a028762d0a55 100644 --- a/src/app/ogr/qgsvectorlayersaveasdialog.h +++ b/src/app/ogr/qgsvectorlayersaveasdialog.h @@ -74,19 +74,19 @@ class APP_EXPORT QgsVectorLayerSaveAsDialog : public QDialog, private Ui::QgsVec bool onlySelected() const; /** Returns the selected flat geometry type for the export. - * @see automaticGeometryType() - * @see forceMulti() - * @see includeZ() + * \see automaticGeometryType() + * \see forceMulti() + * \see includeZ() */ QgsWkbTypes::Type geometryType() const; /** Returns true if geometry type is set to automatic. - * @see geometryType() + * \see geometryType() */ bool automaticGeometryType() const; /** Returns true if force multi geometry type is checked. - * @see includeZ() + * \see includeZ() */ bool forceMulti() const; @@ -95,7 +95,7 @@ class APP_EXPORT QgsVectorLayerSaveAsDialog : public QDialog, private Ui::QgsVec void setForceMulti( bool checked ); /** Returns true if include z dimension is checked. - * @see forceMulti() + * \see forceMulti() */ bool includeZ() const; diff --git a/src/app/pluginmanager/qgsapppluginmanagerinterface.cpp b/src/app/pluginmanager/qgsapppluginmanagerinterface.cpp index e196d58e21b1..f801a60533a0 100644 --- a/src/app/pluginmanager/qgsapppluginmanagerinterface.cpp +++ b/src/app/pluginmanager/qgsapppluginmanagerinterface.cpp @@ -29,8 +29,6 @@ QgsAppPluginManagerInterface::~QgsAppPluginManagerInterface() { } - -//! show the Plugin Manager window and optionally open tab tabIndex void QgsAppPluginManagerInterface::showPluginManager( int tabIndex ) { mPluginManager->getCppPluginsMetadata(); @@ -45,15 +43,11 @@ void QgsAppPluginManagerInterface::showPluginManager( int tabIndex ) mPluginManager->exec(); } - -//! remove python plugins from the metadata registry (c++ plugins stay) void QgsAppPluginManagerInterface::clearPythonPluginMetadata() { mPluginManager->clearPythonPluginMetadata(); } - -//! add a single plugin to the metadata registry void QgsAppPluginManagerInterface::addPluginMetadata( const QMap &metadata ) { if ( metadata.isEmpty() || !metadata.contains( QStringLiteral( "id" ) ) ) @@ -64,36 +58,26 @@ void QgsAppPluginManagerInterface::addPluginMetadata( const QMapaddPluginMetadata( metadata.value( QStringLiteral( "id" ) ), metadata ); } - -//! refresh plugin list model (and metadata browser content if necessary) void QgsAppPluginManagerInterface::reloadModel() { mPluginManager->reloadModelData(); } - -//! return given plugin metadata const QMap *QgsAppPluginManagerInterface::pluginMetadata( const QString &key ) const { return mPluginManager->pluginMetadata( key ); } - -//! clear the repository listWidget void QgsAppPluginManagerInterface::clearRepositoryList() { mPluginManager->clearRepositoryList(); } - -//! add repository to the repository listWidget void QgsAppPluginManagerInterface::addToRepositoryList( const QMap &repository ) { mPluginManager->addToRepositoryList( repository ); } - -//! show the given message in the Plugin Manager internal message bar void QgsAppPluginManagerInterface::pushMessage( const QString &text, QgsMessageBar::MessageLevel level, int duration ) { mPluginManager->pushMessage( text, level, duration ); diff --git a/src/app/pluginmanager/qgspluginmanager.cpp b/src/app/pluginmanager/qgspluginmanager.cpp index 70111d13da57..13879f6532b4 100644 --- a/src/app/pluginmanager/qgspluginmanager.cpp +++ b/src/app/pluginmanager/qgspluginmanager.cpp @@ -984,9 +984,6 @@ const QMap *QgsPluginManager::pluginMetadata( const QString &k return nullptr; } - - -//! Clear the repository listWidget void QgsPluginManager::clearRepositoryList() { treeRepositories->clear(); @@ -999,9 +996,6 @@ void QgsPluginManager::clearRepositoryList() } } - - -//! Add repository to the repository listWidget void QgsPluginManager::addToRepositoryList( const QMap &repository ) { // If it's the second item on the tree, change the button text to plural form and add the filter context menu diff --git a/src/app/pluginmanager/qgspluginmanager.h b/src/app/pluginmanager/qgspluginmanager.h index 9bb577421db6..8b9e092d69bc 100644 --- a/src/app/pluginmanager/qgspluginmanager.h +++ b/src/app/pluginmanager/qgspluginmanager.h @@ -39,9 +39,8 @@ const int PLUGMAN_TAB_UPGRADEABLE = 3; const int PLUGMAN_TAB_NEW = 4; const int PLUGMAN_TAB_INVALID = 5; -/*! +/** * \brief Plugin manager for browsing, (un)installing and (un)loading plugins -@author Gary Sherman */ class QgsPluginManager : public QgsOptionsDialogBase, private Ui::QgsPluginManagerBase { diff --git a/src/app/pluginmanager/qgspluginsortfilterproxymodel.h b/src/app/pluginmanager/qgspluginsortfilterproxymodel.h index ef9bbf56c3fe..40c14900e023 100644 --- a/src/app/pluginmanager/qgspluginsortfilterproxymodel.h +++ b/src/app/pluginmanager/qgspluginsortfilterproxymodel.h @@ -35,7 +35,7 @@ const int SPACER_ROLE = Qt::UserRole + 20; // for sorting -/*! +/** * \brief Proxy model for filtering and sorting items in Plugin Manager */ class QgsPluginSortFilterProxyModel : public QSortFilterProxyModel diff --git a/src/app/qgisapp.cpp b/src/app/qgisapp.cpp index 921018d7f61c..8c894596b1f4 100644 --- a/src/app/qgisapp.cpp +++ b/src/app/qgisapp.cpp @@ -4805,7 +4805,7 @@ void QgisApp::fileNew( bool promptToSaveFlag, bool forceBlank ) prj->setCrs( srs ); prj->setDirty( false ); - /** New Empty Project Created + /* New Empty Project Created (before attempting to load custom project templates/filepaths) */ // load default template @@ -4915,10 +4915,10 @@ void QgisApp::fileOpenAfterLaunch() // notify user if last attempt at auto-opening a project failed - /** NOTE: Notification will not show if last auto-opened project failed but + /* NOTE: Notification will not show if last auto-opened project failed but next project opened is from command line (minor issue) */ - /** TODO: Keep projOpenedOKAtLaunch from being reset to true after + /* TODO: Keep projOpenedOKAtLaunch from being reset to true after reading command line project (which happens before initialization signal) */ if ( !projOpenedOK ) { @@ -6588,7 +6588,7 @@ void QgisApp::saveAsLayerDefinition() ///@cond PRIVATE -/** Field value converter for export as vecotr layer +/** Field value converter for export as vector layer * \note Not available in Python bindings */ class QgisAppFieldValueConverter : public QgsVectorFileWriter::FieldValueConverter @@ -9604,13 +9604,11 @@ void QgisApp::unregisterOptionsWidgetFactory( QgsOptionsWidgetFactory *factory ) mOptionsWidgetFactories.removeAll( factory ); } -//! Get a pointer to the currently selected map layer QgsMapLayer *QgisApp::activeLayer() { return mLayerTreeView ? mLayerTreeView->currentLayer() : nullptr; } -//! Set the current layer bool QgisApp::setActiveLayer( QgsMapLayer *layer ) { if ( !layer ) @@ -9623,13 +9621,7 @@ bool QgisApp::setActiveLayer( QgsMapLayer *layer ) return true; } -/** Add a vector layer directly without prompting user for location - The caller must provide information compatible with the provider plugin - using the vectorLayerPath and baseName. The provider can use these - parameters in any way necessary to initialize the layer. The baseName - parameter is used in the Map Legend so it should be formed in a meaningful - way. - */ + QgsVectorLayer *QgisApp::addVectorLayer( const QString &vectorLayerPath, const QString &baseName, const QString &providerKey ) { bool wasfrozen = mMapCanvas->isFrozen(); @@ -11493,15 +11485,6 @@ QgsRasterLayer *QgisApp::addRasterLayer( } -/** Add a raster layer directly without prompting user for location - The caller must provide information compatible with the provider plugin - using the uri and baseName. The provider can use these - parameters in any way necessary to initialize the layer. The baseName - parameter is used in the Map Legend so it should be formed in a meaningful - way. - - \note Copied from the equivalent addVectorLayer function in this file - */ QgsRasterLayer *QgisApp::addRasterLayer( QString const &uri, QString const &baseName, QString const &providerKey ) { diff --git a/src/app/qgisapp.h b/src/app/qgisapp.h index 96d500131d89..ad2a1f67553f 100644 --- a/src/app/qgisapp.h +++ b/src/app/qgisapp.h @@ -164,29 +164,33 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow QgisApp( QgisApp const & ) = delete; QgisApp &operator=( QgisApp const & ) = delete; - /** - * Add a vector layer to the canvas, returns pointer to it - */ + /** Add a vector layer directly without prompting user for location + The caller must provide information compatible with the provider plugin + using the vectorLayerPath and baseName. The provider can use these + parameters in any way necessary to initialize the layer. The baseName + parameter is used in the Map Legend so it should be formed in a meaningful + way. + */ QgsVectorLayer *addVectorLayer( const QString &vectorLayerPath, const QString &baseName, const QString &providerKey ); /** \brief overloaded version of the private addLayer method that takes a list of * file names instead of prompting user with a dialog. - @param enc encoding type for the layer - @param dataSourceType type of ogr datasource - @returns true if successfully added layer + \param enc encoding type for the layer + \param dataSourceType type of ogr datasource + \returns true if successfully added layer */ bool addVectorLayers( const QStringList &layerQStringList, const QString &enc, const QString &dataSourceType ); /** Overloaded vesion of the private addRasterLayer() Method that takes a list of file names instead of prompting user with a dialog. - @returns true if successfully added layer(s) + \returns true if successfully added layer(s) */ bool addRasterLayers( const QStringList &layerQStringList, bool guiWarning = true ); /** Open a raster layer for the given file - @returns false if unable to open a raster layer for rasterFile - @note + \returns false if unable to open a raster layer for rasterFile + \note This is essentially a simplified version of the above */ QgsRasterLayer *addRasterLayer( const QString &rasterFile, const QString &baseName, bool guiWarning = true ); @@ -208,7 +212,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow Used to process a commandline argument, FileOpen or Drop event. Set interactive to true if it is ok to ask the user for information (mostly for when a vector layer has sublayers and we want to ask which sublayers to use). - @returns true if the file is successfully opened + \returns true if the file is successfully opened */ bool openLayer( const QString &fileName, bool allowInteractive = false ); @@ -223,7 +227,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow void openTemplate( const QString &fileName ); /** Opens a qgis project file - @returns false if unable to open the project + \returns false if unable to open the project */ bool addProject( const QString &projectFile ); @@ -340,9 +344,9 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow QSet printComposers() const {return mPrintComposers;} /** Get a unique title from user for new and duplicate composers - * @param acceptEmpty whether to accept empty titles (one will be generated) - * @param currentTitle base name for initial title choice - * @return QString::null if user cancels input dialog + * \param acceptEmpty whether to accept empty titles (one will be generated) + * \param currentTitle base name for initial title choice + * \returns QString::null if user cancels input dialog */ bool uniqueComposerTitle( QWidget *parent, QString &composerTitle, bool acceptEmpty, const QString ¤tTitle = QString() ); //! Creates a new composer and returns a pointer to it @@ -364,20 +368,20 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow QMenu *createPopupMenu() override; /** - * Access the vector layer tools. This will be an instance of {@see QgsGuiVectorLayerTools} + * Access the vector layer tools. This will be an instance of {\see QgsGuiVectorLayerTools} * by default. - * @return The vector layer tools + * \returns The vector layer tools */ QgsVectorLayerTools *vectorLayerTools() { return mVectorLayerTools; } /** Notify the user by using the system tray notifications * - * @note usage of the system tray notifications should be limited + * \note usage of the system tray notifications should be limited * to long running tasks and to when the user needs to be notified * about interaction with OS services, like the password manager. * - * @param title - * @param message + * \param title + * \param message */ void showSystemNotification( const QString title, const QString message ); @@ -570,8 +574,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow QgsPluginManager *pluginManager(); /** Return vector layers in edit mode - * @param modified whether to return only layers that have been modified - * @returns list of layers in legend order, or empty list */ + * \param modified whether to return only layers that have been modified + * \returns list of layers in legend order, or empty list */ QList editableLayers( bool modified = false ) const; //! Get timeout for timed messages: default of 5 seconds @@ -661,14 +665,14 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow void saveActiveLayerEdits(); /** Save edits of a layer - * @param leaveEditable leave the layer in editing mode when done - * @param triggerRepaint send layer signal to repaint canvas when done + * \param leaveEditable leave the layer in editing mode when done + * \param triggerRepaint send layer signal to repaint canvas when done */ void saveEdits( QgsMapLayer *layer, bool leaveEditable = true, bool triggerRepaint = true ); /** Cancel edits for a layer - * @param leaveEditable leave the layer in editing mode when done - * @param triggerRepaint send layer signal to repaint canvas when done + * \param leaveEditable leave the layer in editing mode when done + * \param triggerRepaint send layer signal to repaint canvas when done */ void cancelEdits( QgsMapLayer *layer, bool leaveEditable = true, bool triggerRepaint = true ); @@ -771,7 +775,13 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! Watch for QFileOpenEvent. virtual bool event( QEvent *event ) override; - //! Open a raster layer using the Raster Data Provider. + /** Add a raster layer directly without prompting user for location + The caller must provide information compatible with the provider plugin + using the uri and baseName. The provider can use these + parameters in any way necessary to initialize the layer. The baseName + parameter is used in the Map Legend so it should be formed in a meaningful + way. + */ QgsRasterLayer *addRasterLayer( QString const &uri, QString const &baseName, QString const &providerKey ); //! Open a plugin layer using its provider @@ -987,11 +997,11 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow /** * Add a widget to the plugins toolbar. - * To remove this widget again, call {@link removeToolBarIcon} + * To remove this widget again, call removeToolBarIcon() * with the returned QAction. * - * @param widget widget to add. The toolbar will take ownership of this widget - * @return the QAction you can use to remove this widget from the toolbar + * \param widget widget to add. The toolbar will take ownership of this widget + * \returns the QAction you can use to remove this widget from the toolbar */ QAction *addPluginToolBarWidget( QWidget *widget ); //! Remove an icon from the plugin toolbar @@ -1001,11 +1011,11 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow /** * Add a widget to the raster toolbar. - * To remove this widget again, call {@link removeRasterToolBarIcon} + * To remove this widget again, call removeRasterToolBarIcon() * with the returned QAction. * - * @param widget widget to add. The toolbar will take ownership of this widget - * @return the QAction you can use to remove this widget from the toolbar + * \param widget widget to add. The toolbar will take ownership of this widget + * \returns the QAction you can use to remove this widget from the toolbar */ QAction *addRasterToolBarWidget( QWidget *widget ); //! Remove an icon from the Raster toolbar @@ -1015,11 +1025,11 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow /** * Add a widget to the vector toolbar. - * To remove this widget again, call {@link removeVectorToolBarIcon} + * To remove this widget again, call removeVectorToolBarIcon() * with the returned QAction. * - * @param widget widget to add. The toolbar will take ownership of this widget - * @return the QAction you can use to remove this widget from the toolbar + * \param widget widget to add. The toolbar will take ownership of this widget + * \returns the QAction you can use to remove this widget from the toolbar */ QAction *addVectorToolBarWidget( QWidget *widget ); //! Remove an icon from the Vector toolbar @@ -1029,11 +1039,11 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow /** * Add a widget to the database toolbar. - * To remove this widget again, call {@link removeDatabaseToolBarIcon} + * To remove this widget again, call removeDatabaseToolBarIcon() * with the returned QAction. * - * @param widget widget to add. The toolbar will take ownership of this widget - * @return the QAction you can use to remove this widget from the toolbar + * \param widget widget to add. The toolbar will take ownership of this widget + * \returns the QAction you can use to remove this widget from the toolbar */ QAction *addDatabaseToolBarWidget( QWidget *widget ); //! Remove an icon from the Database toolbar @@ -1043,11 +1053,11 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow /** * Add a widget to the web toolbar. - * To remove this widget again, call {@link removeWebToolBarIcon} + * To remove this widget again, call removeWebToolBarIcon() * with the returned QAction. * - * @param widget widget to add. The toolbar will take ownership of this widget - * @return the QAction you can use to remove this widget from the toolbar + * \param widget widget to add. The toolbar will take ownership of this widget + * \returns the QAction you can use to remove this widget from the toolbar */ QAction *addWebToolBarWidget( QWidget *widget ); //! Remove an icon from the Web toolbar @@ -1069,7 +1079,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow void openProject( QAction *action ); /** Attempts to run a Python script - * @param filePath full path to Python script + * \param filePath full path to Python script * \since QGIS 2.7 */ void runScript( const QString &filePath ); @@ -1475,7 +1485,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow void keyPressed( QKeyEvent *e ); /** Emitted when a project file is successfully read - @note + \note This is useful for plug-ins that store properties with project files. A plug-in can connect to this signal. When it is emitted, the plug-in knows to then check the project properties for any relevant state. @@ -1483,7 +1493,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow void projectRead(); /** Emitted when starting an entirely new project - @note + \note This is similar to projectRead(); plug-ins might want to be notified that they're in a new project. Yes, projectRead() could have been overloaded to be used in the case of new projects instead. However, @@ -1528,7 +1538,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow void functionProfile( void ( QgisApp::*fnc )(), QgisApp *instance, QString name ); /** This method will open a dialog so the user can select GDAL sublayers to load - * @returns true if any items were loaded + * \returns true if any items were loaded */ bool askUserForZipItemLayers( const QString &path ); @@ -1558,7 +1568,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow * pass settings by reference since creating more than one * instance simultaneously results in data loss. * - * @param savePreviewImage Set to false when the preview image should not be saved. E.g. project load. + * \param savePreviewImage Set to false when the preview image should not be saved. E.g. project load. */ void saveRecentProjectPath( const QString &projectPath, bool savePreviewImage = true ); //! Update project menu with the current list of recently accessed projects @@ -1573,7 +1583,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow bool checkTasksDependOnProject(); /** Helper function to union several geometries together (used in function mergeSelectedFeatures) - @return empty geometry in case of error or if canceled */ + \returns empty geometry in case of error or if canceled */ QgsGeometry unionGeometries( const QgsVectorLayer *vl, QgsFeatureList &featureList, bool &canceled ); //! Deletes all the composer objects and clears mPrintComposers @@ -1589,7 +1599,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow /** Paste features from clipboard into a new memory layer. * If no features are in clipboard an empty layer is returned. - * @return pointer to a new layer or 0 if failed + * \returns pointer to a new layer or 0 if failed */ QgsVectorLayer *pasteToNewMemoryVector(); diff --git a/src/app/qgisappinterface.cpp b/src/app/qgisappinterface.cpp index 66023c3f222c..e69bb7a8ff5e 100644 --- a/src/app/qgisappinterface.cpp +++ b/src/app/qgisappinterface.cpp @@ -529,7 +529,6 @@ void QgisAppInterface::unregisterCustomDropHandler( QgsCustomDropHandler *handle qgis->unregisterCustomDropHandler( handler ); } -//! Menus QMenu *QgisAppInterface::projectMenu() { return qgis->projectMenu(); } QMenu *QgisAppInterface::editMenu() { return qgis->editMenu(); } QMenu *QgisAppInterface::viewMenu() { return qgis->viewMenu(); } @@ -546,7 +545,6 @@ QMenu *QgisAppInterface::firstRightStandardMenu() { return qgis->firstRightStand QMenu *QgisAppInterface::windowMenu() { return qgis->windowMenu(); } QMenu *QgisAppInterface::helpMenu() { return qgis->helpMenu(); } -//! ToolBars QToolBar *QgisAppInterface::fileToolBar() { return qgis->fileToolBar(); } QToolBar *QgisAppInterface::layerToolBar() { return qgis->layerToolBar(); } QToolBar *QgisAppInterface::mapNavToolToolBar() { return qgis->mapNavToolToolBar(); } @@ -560,7 +558,6 @@ QToolBar *QgisAppInterface::vectorToolBar() { return qgis->vectorToolBar(); } QToolBar *QgisAppInterface::databaseToolBar() { return qgis->databaseToolBar(); } QToolBar *QgisAppInterface::webToolBar() { return qgis->webToolBar(); } -//! Project menu actions QAction *QgisAppInterface::actionNewProject() { return qgis->actionNewProject(); } QAction *QgisAppInterface::actionOpenProject() { return qgis->actionOpenProject(); } QAction *QgisAppInterface::actionSaveProject() { return qgis->actionSaveProject(); } @@ -571,7 +568,6 @@ QAction *QgisAppInterface::actionPrintComposer() { return qgis->actionNewPrintCo QAction *QgisAppInterface::actionShowComposerManager() { return qgis->actionShowComposerManager(); } QAction *QgisAppInterface::actionExit() { return qgis->actionExit(); } -//! Edit menu actions QAction *QgisAppInterface::actionCutFeatures() { return qgis->actionCutFeatures(); } QAction *QgisAppInterface::actionCopyFeatures() { return qgis->actionCopyFeatures(); } QAction *QgisAppInterface::actionPasteFeatures() { return qgis->actionPasteFeatures(); } @@ -587,7 +583,6 @@ QAction *QgisAppInterface::actionDeleteRing() { return qgis->actionDeleteRing(); QAction *QgisAppInterface::actionDeletePart() { return qgis->actionDeletePart(); } QAction *QgisAppInterface::actionNodeTool() { return qgis->actionNodeTool(); } -//! View menu actions QAction *QgisAppInterface::actionPan() { return qgis->actionPan(); } QAction *QgisAppInterface::actionPanToSelected() { return qgis->actionPanToSelected(); } QAction *QgisAppInterface::actionZoomIn() { return qgis->actionZoomIn(); } @@ -612,7 +607,6 @@ QAction *QgisAppInterface::actionNewBookmark() { return qgis->actionNewBookmark( QAction *QgisAppInterface::actionShowBookmarks() { return qgis->actionShowBookmarks(); } QAction *QgisAppInterface::actionDraw() { return qgis->actionDraw(); } -//! Layer menu actions QAction *QgisAppInterface::actionNewVectorLayer() { return qgis->actionNewVectorLayer(); } QAction *QgisAppInterface::actionAddOgrLayer() { return qgis->actionAddOgrLayer(); } QAction *QgisAppInterface::actionAddRasterLayer() { return qgis->actionAddRasterLayer(); } @@ -645,17 +639,14 @@ QAction *QgisAppInterface::actionHideSelectedLayers() { return qgis->actionHideS QAction *QgisAppInterface::actionHideDeselectedLayers() { return qgis->actionHideDeselectedLayers(); } QAction *QgisAppInterface::actionShowSelectedLayers() { return qgis->actionShowSelectedLayers(); } -//! Plugin menu actions QAction *QgisAppInterface::actionManagePlugins() { return qgis->actionManagePlugins(); } QAction *QgisAppInterface::actionPluginListSeparator() { return qgis->actionPluginListSeparator(); } QAction *QgisAppInterface::actionShowPythonDialog() { return qgis->actionShowPythonDialog(); } -//! Settings menu actions QAction *QgisAppInterface::actionToggleFullScreen() { return qgis->actionToggleFullScreen(); } QAction *QgisAppInterface::actionOptions() { return qgis->actionOptions(); } QAction *QgisAppInterface::actionCustomProjection() { return qgis->actionCustomProjection(); } -//! Help menu actions QAction *QgisAppInterface::actionHelpContents() { return qgis->actionHelpContents(); } QAction *QgisAppInterface::actionQgisHomePage() { return qgis->actionQgisHomePage(); } QAction *QgisAppInterface::actionCheckQgisVersion() { return qgis->actionCheckQgisVersion(); } diff --git a/src/app/qgisappinterface.h b/src/app/qgisappinterface.h index 7af4b36f5908..47f2340f899d 100644 --- a/src/app/qgisappinterface.h +++ b/src/app/qgisappinterface.h @@ -41,7 +41,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface /** * Constructor. - * @param qgis Pointer to the QgisApp object + * \param qgis Pointer to the QgisApp object */ QgisAppInterface( QgisApp *qgisapp ); @@ -91,11 +91,11 @@ class APP_EXPORT QgisAppInterface : public QgisInterface /** * Add a widget to the plugins toolbar. - * To remove this widget again, call {@link removeToolBarIcon} + * To remove this widget again, call removeToolBarIcon() * with the returned QAction. * - * @param widget widget to add. The toolbar will take ownership of this widget - * @return the QAction you can use to remove this widget from the toolbar + * \param widget widget to add. The toolbar will take ownership of this widget + * \returns the QAction you can use to remove this widget from the toolbar */ QAction *addToolBarWidget( QWidget *widget ) override; //! Remove an icon (action) from the plugin toolbar @@ -105,11 +105,11 @@ class APP_EXPORT QgisAppInterface : public QgisInterface /** * Add a widget to the raster toolbar. - * To remove this widget again, call {@link removeRasterToolBarIcon} + * To remove this widget again, call removeRasterToolBarIcon() * with the returned QAction. * - * @param widget widget to add. The toolbar will take ownership of this widget - * @return the QAction you can use to remove this widget from the toolbar + * \param widget widget to add. The toolbar will take ownership of this widget + * \returns the QAction you can use to remove this widget from the toolbar */ QAction *addRasterToolBarWidget( QWidget *widget ) override; //! Remove an icon (action) from the Raster toolbar @@ -119,11 +119,11 @@ class APP_EXPORT QgisAppInterface : public QgisInterface /** * Add a widget to the vector toolbar. - * To remove this widget again, call {@link removeVectorToolBarIcon} + * To remove this widget again, call removeVectorToolBarIcon() * with the returned QAction. * - * @param widget widget to add. The toolbar will take ownership of this widget - * @return the QAction you can use to remove this widget from the toolbar + * \param widget widget to add. The toolbar will take ownership of this widget + * \returns the QAction you can use to remove this widget from the toolbar */ QAction *addVectorToolBarWidget( QWidget *widget ) override; //! Remove an icon (action) from the Vector toolbar @@ -133,11 +133,11 @@ class APP_EXPORT QgisAppInterface : public QgisInterface /** * Add a widget to the database toolbar. - * To remove this widget again, call {@link removeDatabaseToolBarIcon} + * To remove this widget again, call removeDatabaseToolBarIcon() * with the returned QAction. * - * @param widget widget to add. The toolbar will take ownership of this widget - * @return the QAction you can use to remove this widget from the toolbar + * \param widget widget to add. The toolbar will take ownership of this widget + * \returns the QAction you can use to remove this widget from the toolbar */ QAction *addDatabaseToolBarWidget( QWidget *widget ) override; //! Remove an icon (action) from the Database toolbar @@ -147,11 +147,11 @@ class APP_EXPORT QgisAppInterface : public QgisInterface /** * Add a widget to the web toolbar. - * To remove this widget again, call {@link removeWebToolBarIcon} + * To remove this widget again, call removeWebToolBarIcon() * with the returned QAction. * - * @param widget widget to add. The toolbar will take ownership of this widget - * @return the QAction you can use to remove this widget from the toolbar + * \param widget widget to add. The toolbar will take ownership of this widget + * \returns the QAction you can use to remove this widget from the toolbar */ QAction *addWebToolBarWidget( QWidget *widget ) override; //! Remove an icon (action) from the Web toolbar @@ -167,8 +167,8 @@ class APP_EXPORT QgisAppInterface : public QgisInterface /** Open a url in the users browser. By default the QGIS doc directory is used * as the base for the URL. To open a URL that is not relative to the installed * QGIS documentation, set useQgisDocDirectory to false. - * @param url URL to open - * @param useQgisDocDirectory If true, the URL will be formed by concatenating + * \param url URL to open + * \param useQgisDocDirectory If true, the URL will be formed by concatenating * url to the QGIS documentation directory path (/share/doc) */ #ifndef Q_MOC_RUN @@ -214,7 +214,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface QMap defaultStyleSheetOptions() override; /** Generate stylesheet - * @param opts generated default option values, or a changed copy of them */ + * \param opts generated default option values, or a changed copy of them */ void buildStyleSheet( const QMap &opts ) override; //! Save changed default option keys/values to user settings @@ -263,12 +263,12 @@ class APP_EXPORT QgisAppInterface : public QgisInterface QgsAdvancedDigitizingDockWidget *cadDockWidget() override; /** Show layer properties dialog for layer - * @param l layer to show properties table for + * \param l layer to show properties table for */ virtual void showLayerProperties( QgsMapLayer *l ) override; /** Show layer attribute dialog for layer - * @param l layer to show attribute table for + * \param l layer to show attribute table for */ virtual QDialog *showAttributeTable( QgsVectorLayer *l, const QString &filterExpression = QString() ) override; @@ -294,14 +294,14 @@ class APP_EXPORT QgisAppInterface : public QgisInterface /** Register a new custom drop handler. * \since QGIS 3.0 - * @note Ownership of the factory is not transferred, and the factory must + * \note Ownership of the factory is not transferred, and the factory must * be unregistered when plugin is unloaded. - * @see unregisterCustomDropHandler() */ + * \see unregisterCustomDropHandler() */ virtual void registerCustomDropHandler( QgsCustomDropHandler *handler ) override; /** Unregister a previously registered custom drop handler. * \since QGIS 3.0 - * @see registerCustomDropHandler() */ + * \see registerCustomDropHandler() */ virtual void unregisterCustomDropHandler( QgsCustomDropHandler *handler ) override; /** Accessors for inserting items into menus and toolbars. @@ -446,20 +446,20 @@ class APP_EXPORT QgisAppInterface : public QgisInterface /** * Open feature form * returns true when dialog was accepted (if shown modal, true otherwise) - * @param l vector layer - * @param f feature to show/modify - * @param updateFeatureOnly only update the feature update (don't change any attributes of the layer) [UNUSED] - * @param showModal if true, will wait for the dialog to be executed (only shown otherwise) + * \param l vector layer + * \param f feature to show/modify + * \param updateFeatureOnly only update the feature update (don't change any attributes of the layer) [UNUSED] + * \param showModal if true, will wait for the dialog to be executed (only shown otherwise) */ virtual bool openFeatureForm( QgsVectorLayer *l, QgsFeature &f, bool updateFeatureOnly = false, bool showModal = true ) override; /** * Returns a feature form for a given feature * - * @param layer The layer for which the dialog will be created - * @param feature The feature for which the dialog will be created + * \param layer The layer for which the dialog will be created + * \param feature The feature for which the dialog will be created * - * @return A feature form + * \returns A feature form */ virtual QgsAttributeDialog *getFeatureForm( QgsVectorLayer *layer, QgsFeature &feature ) override; @@ -468,7 +468,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface * With the help of this you can access methods like addFeature, startEditing * or stopEditing while giving the user the appropriate dialogs. * - * @return An instance of the vector layer tools + * \returns An instance of the vector layer tools */ virtual QgsVectorLayerTools *vectorLayerTools() override; @@ -486,8 +486,8 @@ class APP_EXPORT QgisAppInterface : public QgisInterface virtual void preloadForm( const QString &uifile ) override; /** Return vector layers in edit mode - * @param modified whether to return only layers that have been modified - * @returns list of layers in legend order, or empty list + * \param modified whether to return only layers that have been modified + * \returns list of layers in legend order, or empty list */ virtual QList editableLayers( bool modified = false ) const override; diff --git a/src/app/qgisappstylesheet.cpp b/src/app/qgisappstylesheet.cpp index 3cbaa62aebfd..5a8fd2afd8a5 100644 --- a/src/app/qgisappstylesheet.cpp +++ b/src/app/qgisappstylesheet.cpp @@ -25,10 +25,6 @@ #include #include -/** @class QgisAppStyleSheet - * @brief Adjustable stylesheet for the Qgis application - */ - QgisAppStyleSheet::QgisAppStyleSheet( QObject *parent ) : QObject( parent ) { diff --git a/src/app/qgisappstylesheet.h b/src/app/qgisappstylesheet.h index f30ffe4fe88c..cb1dc23450a9 100644 --- a/src/app/qgisappstylesheet.h +++ b/src/app/qgisappstylesheet.h @@ -23,8 +23,8 @@ #include #include "qgis_app.h" -/** @class QgisAppStyleSheet - * @brief Adjustable stylesheet for the Qgis application +/** \class QgisAppStyleSheet + * \brief Adjustable stylesheet for the Qgis application */ class APP_EXPORT QgisAppStyleSheet: public QObject { @@ -38,8 +38,8 @@ class APP_EXPORT QgisAppStyleSheet: public QObject QMap defaultOptions(); /** Generate stylesheet - * @param opts generated default option values, or a changed copy of them - * @note on success emits appStyleSheetChanged + * \param opts generated default option values, or a changed copy of them + * \note on success emits appStyleSheetChanged */ void buildStyleSheet( const QMap &opts ); @@ -52,7 +52,7 @@ class APP_EXPORT QgisAppStyleSheet: public QObject signals: /** Signal the successful stylesheet build results - * @note connect to (app|widget)->setStyleSheet or similar custom slot + * \note connect to (app|widget)->setStyleSheet or similar custom slot */ void appStyleSheetChanged( const QString &appStyleSheet ); diff --git a/src/app/qgsattributetabledialog.h b/src/app/qgsattributetabledialog.h index b2255b3516a3..d4150c258bb0 100644 --- a/src/app/qgsattributetabledialog.h +++ b/src/app/qgsattributetabledialog.h @@ -46,9 +46,9 @@ class APP_EXPORT QgsAttributeTableDialog : public QDialog, private Ui::QgsAttrib /** * Constructor - * @param layer layer pointer - * @param parent parent object - * @param flags window flags + * \param layer layer pointer + * \param parent parent object + * \param flags window flags */ QgsAttributeTableDialog( QgsVectorLayer *layer, QWidget *parent = nullptr, Qt::WindowFlags flags = Qt::Window ); ~QgsAttributeTableDialog(); @@ -64,7 +64,7 @@ class APP_EXPORT QgsAttributeTableDialog : public QDialog, private Ui::QgsAttrib /** * Sets the filter expression to filter visible features - * @param filterString filter query string. QgsExpression compatible. + * \param filterString filter query string. QgsExpression compatible. */ void setFilterExpression( const QString &filterString, QgsAttributeForm::FilterType type = QgsAttributeForm::ReplaceFilter, @@ -187,7 +187,7 @@ class APP_EXPORT QgsAttributeTableDialog : public QDialog, private Ui::QgsAttrib /** * Informs that edits should be saved - * @param layer layer whose edits are to be saved + * \param layer layer whose edits are to be saved */ void saveEdits( QgsMapLayer *layer ); @@ -195,13 +195,13 @@ class APP_EXPORT QgsAttributeTableDialog : public QDialog, private Ui::QgsAttrib /** * Handle closing of the window - * @param event unused + * \param event unused */ void closeEvent( QCloseEvent *event ) override; /* * Handle KeyPress event of the window - * @param event + * \param event */ void keyPressEvent( QKeyEvent *event ) override; diff --git a/src/app/qgsattributetypedialog.h b/src/app/qgsattributetypedialog.h index a93465fe89fc..0efe859ca8fe 100644 --- a/src/app/qgsattributetypedialog.h +++ b/src/app/qgsattributetypedialog.h @@ -36,7 +36,7 @@ class APP_EXPORT QgsAttributeTypeDialog: public QDialog, private Ui::QgsAttribut /** * Setting page which is to be selected - * @param index index of page which was selected + * \param index index of page which was selected */ void setPage( int index ); @@ -52,7 +52,7 @@ class APP_EXPORT QgsAttributeTypeDialog: public QDialog, private Ui::QgsAttribut /** * Setter for checkbox to label on top - * @param bool onTop + * \param bool onTop */ void setLabelOnTop( bool onTop ); @@ -118,14 +118,14 @@ class APP_EXPORT QgsAttributeTypeDialog: public QDialog, private Ui::QgsAttribut /** * Setter for constraint expression description - * @param desc the expression description + * \param desc the expression description * \since QGIS 2.16 **/ void setConstraintExpressionDescription( const QString &desc ); /** * Getter for constraint expression description - * @return the expression description + * \returns the expression description * \since QGIS 2.16 **/ QString constraintExpressionDescription(); @@ -167,7 +167,7 @@ class APP_EXPORT QgsAttributeTypeDialog: public QDialog, private Ui::QgsAttribut /** * Slot to handle change of index in combobox to select correct page - * @param index index of value in combobox + * \param index index of value in combobox */ void on_selectionListWidget_currentRowChanged( int index ); diff --git a/src/app/qgsbrowserdockwidget.h b/src/app/qgsbrowserdockwidget.h index f1f5e69d9558..9e5e611aadeb 100644 --- a/src/app/qgsbrowserdockwidget.h +++ b/src/app/qgsbrowserdockwidget.h @@ -56,7 +56,7 @@ class QgsBrowserPropertiesWidget : public QWidget /** Sets whether the properties widget should display in condensed mode, ie, for display in a dock * widget rather than it's own separate dialog. - * @param condensedMode set to true to enable condensed mode + * \param condensedMode set to true to enable condensed mode * \since QGIS 2.10 */ virtual void setCondensedMode( bool condensedMode ) { Q_UNUSED( condensedMode ); } diff --git a/src/app/qgsclipboard.h b/src/app/qgsclipboard.h index f298ba32fd5a..2539a1268098 100644 --- a/src/app/qgsclipboard.h +++ b/src/app/qgsclipboard.h @@ -156,20 +156,20 @@ class APP_EXPORT QgsClipboard : public QObject void setSystemClipboard(); /** Creates a text representation of the clipboard features. - * @returns clipboard text, respecting user export format + * \returns clipboard text, respecting user export format */ QString generateClipboardText() const; /** Attempts to convert a string to a list of features, by parsing the string as WKT and GeoJSON - * @param string string to convert - * @param fields fields for resultant features - * @returns list of features if conversion was successful + * \param string string to convert + * \param fields fields for resultant features + * \returns list of features if conversion was successful */ QgsFeatureList stringToFeatureList( const QString &string, const QgsFields &fields ) const; /** Attempts to parse the clipboard contents and return a QgsFields object representing the fields * present in the clipboard. - * @note Only valid for text based clipboard contents + * \note Only valid for text based clipboard contents */ QgsFields retrieveFields() const; diff --git a/src/app/qgscustomprojectiondialog.h b/src/app/qgscustomprojectiondialog.h index 3c848e96ccaf..e7f8a8ed75db 100644 --- a/src/app/qgscustomprojectiondialog.h +++ b/src/app/qgscustomprojectiondialog.h @@ -27,8 +27,6 @@ class QDir; /** The custom projection widget is used to define the projection family, ellipsoid and paremters needed by proj4 to assemble a customised projection definition. The resulting projection will be store in an sqlite backend. - -@author Tim Sutton */ class APP_EXPORT QgsCustomProjectionDialog : public QDialog, private Ui::QgsCustomProjectionDialogBase { diff --git a/src/app/qgsdecorationgrid.h b/src/app/qgsdecorationgrid.h index 28039114d8f9..3cce5bf30d4e 100644 --- a/src/app/qgsdecorationgrid.h +++ b/src/app/qgsdecorationgrid.h @@ -197,25 +197,25 @@ class APP_EXPORT QgsDecorationGrid: public QgsDecorationItem QgsUnitTypes::DistanceUnit mMapUnits; /** Draw coordinates for mGridAnnotationType Coordinate - @param p drawing painter - @param hLines horizontal coordinate lines in item coordinates - @param vLines vertical coordinate lines in item coordinates*/ + \param p drawing painter + \param hLines horizontal coordinate lines in item coordinates + \param vLines vertical coordinate lines in item coordinates*/ void drawCoordinateAnnotations( QPainter *p, const QList< QPair< qreal, QLineF > > &hLines, const QList< QPair< qreal, QLineF > > &vLines ); void drawCoordinateAnnotation( QPainter *p, QPointF pos, const QString &annotationString ); /** Draws a single annotation - @param p drawing painter - @param pos item coordinates where to draw - @param rotation text rotation - @param annotationText the text to draw*/ + \param p drawing painter + \param pos item coordinates where to draw + \param rotation text rotation + \param annotationText the text to draw*/ void drawAnnotation( QPainter *p, QPointF pos, int rotation, const QString &annotationText ); /** Returns the grid lines with associated coordinate value - @return 0 in case of success*/ + \returns 0 in case of success*/ int xGridLines( QList< QPair< qreal, QLineF > > &lines ) const; /** Returns the grid lines for the y-coordinates. Not vertical in case of rotation - @return 0 in case of success*/ + \returns 0 in case of success*/ int yGridLines( QList< QPair< qreal, QLineF > > &lines ) const; //! Returns the item border of a point (in item coordinates) Border borderForLineCoord( QPointF point, QPainter *p ) const; diff --git a/src/app/qgsdecorationgriddialog.h b/src/app/qgsdecorationgriddialog.h index 25fade5f1370..08aae9927fe4 100644 --- a/src/app/qgsdecorationgriddialog.h +++ b/src/app/qgsdecorationgriddialog.h @@ -26,9 +26,6 @@ class QgsDecorationGrid; class QgsLineSymbol; class QgsMarkerSymbol; -/** -@author Etienne Tourigny -*/ class APP_EXPORT QgsDecorationGridDialog : public QDialog, private Ui::QgsDecorationGridDialog { Q_OBJECT diff --git a/src/app/qgsdecorationitem.h b/src/app/qgsdecorationitem.h index d938b3b9dbba..f162201c3d1b 100644 --- a/src/app/qgsdecorationitem.h +++ b/src/app/qgsdecorationitem.h @@ -49,12 +49,12 @@ class APP_EXPORT QgsDecorationItem: public QObject bool enabled() const { return mEnabled; } /** Returns the current placement for the item. - * @see setPlacement() + * \see setPlacement() */ Placement placement() const { return mPlacement; } /** Sets the placement of the item. - * @see placement() + * \see placement() */ void setPlacement( Placement placement ) { mPlacement = placement; } diff --git a/src/app/qgsdecorationscalebardialog.h b/src/app/qgsdecorationscalebardialog.h index f6819cde83bf..68fa20f2fdc4 100644 --- a/src/app/qgsdecorationscalebardialog.h +++ b/src/app/qgsdecorationscalebardialog.h @@ -18,9 +18,6 @@ class QgsDecorationScaleBar; -/** -@author Peter Brewer -*/ class APP_EXPORT QgsDecorationScaleBarDialog : public QDialog, private Ui::QgsDecorationScaleBarDialog { Q_OBJECT diff --git a/src/app/qgsfeatureaction.h b/src/app/qgsfeatureaction.h index a6d66eb75362..90adfb6a0149 100644 --- a/src/app/qgsfeatureaction.h +++ b/src/app/qgsfeatureaction.h @@ -47,9 +47,9 @@ class APP_EXPORT QgsFeatureAction : public QAction * Will set the default values to recently used or provider defaults based on settings * and override with values in defaultAttributes if provided. * - * @param defaultAttributes Provide some default attributes here if desired. + * \param defaultAttributes Provide some default attributes here if desired. * - * @return true if feature was added if showModal is true. If showModal is false, returns true in every case + * \returns true if feature was added if showModal is true. If showModal is false, returns true in every case */ bool addFeature( const QgsAttributeMap &defaultAttributes = QgsAttributeMap(), bool showModal = true ); diff --git a/src/app/qgsfieldsproperties.h b/src/app/qgsfieldsproperties.h index 698a76e325ca..b970b9e108cd 100644 --- a/src/app/qgsfieldsproperties.h +++ b/src/app/qgsfieldsproperties.h @@ -138,12 +138,12 @@ class APP_EXPORT QgsFieldsProperties : public QWidget, private Ui_QgsFieldsPrope ~QgsFieldsProperties(); /** Adds an attribute to the table (but does not commit it yet) - @param field the field to add - @return false in case of a name conflict, true in case of success */ + \param field the field to add + \returns false in case of a name conflict, true in case of success */ bool addAttribute( const QgsField &field ); /** Creates the a proper item to save from the tree - * @return A widget definition. Containing another container or the final field + * \returns A widget definition. Containing another container or the final field */ QgsAttributeEditorElement *createAttributeEditorWidget( QTreeWidgetItem *item, QgsAttributeEditorElement *parent, bool forceGroup = true ); @@ -159,12 +159,12 @@ class APP_EXPORT QgsFieldsProperties : public QWidget, private Ui_QgsFieldsPrope QTreeWidgetItem *loadAttributeEditorTreeItem( QgsAttributeEditorElement *const widgetDef, QTreeWidgetItem *parent ); /** - * @brief setEditFormInit set the private ui fields - * @param editForm - * @param initFunction - * @param initCode - * @param initFilePath - * @param codeSource + * \brief setEditFormInit set the private ui fields + * \param editForm + * \param initFunction + * \param initCode + * \param initFilePath + * \param codeSource */ void setEditFormInit( const QString &editForm, const QString &initFunction, diff --git a/src/app/qgsguivectorlayertools.h b/src/app/qgsguivectorlayertools.h index aeb2fa0185f8..689eb2551296 100644 --- a/src/app/qgsguivectorlayertools.h +++ b/src/app/qgsguivectorlayertools.h @@ -33,11 +33,11 @@ class QgsGuiVectorLayerTools : public QgsVectorLayerTools /** * This method should be called, whenever a new feature is added to a layer * - * @param layer The layer to which the feature should be added - * @param defaultValues Default values for the feature to add - * @param defaultGeometry A default geometry to add to the feature + * \param layer The layer to which the feature should be added + * \param defaultValues Default values for the feature to add + * \param defaultGeometry A default geometry to add to the feature * - * @return True in case of success, False if the operation failed/was aborted + * \returns True in case of success, False if the operation failed/was aborted */ bool addFeature( QgsVectorLayer *layer, const QgsAttributeMap &defaultValues, const QgsGeometry &defaultGeometry, QgsFeature *feat = nullptr ) const override; @@ -45,9 +45,9 @@ class QgsGuiVectorLayerTools : public QgsVectorLayerTools * This should be called, whenever a vector layer should be switched to edit mode. If successful * the layer is switched to editable and an edit sessions started. * - * @param layer The layer on which to start an edit session + * \param layer The layer on which to start an edit session * - * @return True, if the editing session was started + * \returns True, if the editing session was started */ bool startEditing( QgsVectorLayer *layer ) const override; @@ -56,18 +56,18 @@ class QgsGuiVectorLayerTools : public QgsVectorLayerTools * An appropriate dialog asking the user if he wants to save the edits will be shown if * allowCancel is set to true. * - * @param layer The layer to commit - * @param allowCancel True if a cancel button should be offered + * \param layer The layer to commit + * \param allowCancel True if a cancel button should be offered * - * @return True if successful + * \returns True if successful */ bool stopEditing( QgsVectorLayer *layer, bool allowCancel = true ) const override; /** * Should be called, when the features should be committed but the editing session is not ended. * - * @param layer The layer to commit - * @return True if successful + * \param layer The layer to commit + * \returns True if successful */ bool saveEdits( QgsVectorLayer *layer ) const override; diff --git a/src/app/qgsidentifyresultsdialog.h b/src/app/qgsidentifyresultsdialog.h index 2814070900bd..ef4d792cdd6d 100644 --- a/src/app/qgsidentifyresultsdialog.h +++ b/src/app/qgsidentifyresultsdialog.h @@ -49,10 +49,6 @@ class QgsEditorWidgetSetup; class QwtPlotCurve; -/** - *@author Gary E.Sherman - */ - class APP_EXPORT QgsIdentifyResultsWebView : public QgsWebView { Q_OBJECT diff --git a/src/app/qgslayerstylingwidget.h b/src/app/qgslayerstylingwidget.h index 76cac761fa6c..977a93785028 100644 --- a/src/app/qgslayerstylingwidget.h +++ b/src/app/qgslayerstylingwidget.h @@ -95,7 +95,7 @@ class APP_EXPORT QgsLayerStylingWidget : public QWidget, private Ui::QgsLayerSty /** Sets whether updates of the styling widget are blocked. This can be called to prevent * the widget being refreshed multiple times when a batch of layer style changes are * about to be applied - * @param blocked set to true to block updates, or false to re-allow updates + * \param blocked set to true to block updates, or false to re-allow updates */ void blockUpdates( bool blocked ); @@ -111,7 +111,7 @@ class APP_EXPORT QgsLayerStylingWidget : public QWidget, private Ui::QgsLayerSty void updateCurrentWidgetLayer(); /** Sets the current visible page in the widget. - * @param page standard page to display + * \param page standard page to display */ void setCurrentPage( Page page ); diff --git a/src/app/qgsmapcanvasdockwidget.h b/src/app/qgsmapcanvasdockwidget.h index 626b0e238366..239f76845693 100644 --- a/src/app/qgsmapcanvasdockwidget.h +++ b/src/app/qgsmapcanvasdockwidget.h @@ -56,77 +56,77 @@ class APP_EXPORT QgsMapCanvasDockWidget : public QgsDockWidget, private Ui::QgsM /** * Sets whether the view center should be synchronized with the main canvas center. - * @see isViewCenterSynchronized() + * \see isViewCenterSynchronized() */ void setViewCenterSynchronized( bool enabled ); /** * Returns true if the view extent is synchronized with the main canvas extent. - * @see setViewCenterSynchronized() + * \see setViewCenterSynchronized() */ bool isViewCenterSynchronized() const; /** * Sets whether the cursor position marker is visible. - * @see isCursorMarkerVisible() + * \see isCursorMarkerVisible() */ void setCursorMarkerVisible( bool visible ); /** * Returns true if the cursor position marker is visible. - * @see setCursorMarkerVisible() + * \see setCursorMarkerVisible() */ bool isCursorMarkerVisible() const; /** * Sets whether the main canvas extent is visible. - * @see isMainCanvasExtentVisible() + * \see isMainCanvasExtentVisible() */ void setMainCanvasExtentVisible( bool visible ); /** * Returns true if the main canvas extent is visible. - * @see setMainCanvasExtentVisible() + * \see setMainCanvasExtentVisible() */ bool isMainCanvasExtentVisible() const; /** * Returns the scaling factor for main canvas scale to view scale. - * @see setScaleFactor() - * @see isViewScaleSynchronized() + * \see setScaleFactor() + * \see isViewScaleSynchronized() */ double scaleFactor() const; /** * Sets the scaling \a factor for main canvas scale to view scale. - * @see scaleFactor() - * @see setViewScaleSynchronized() + * \see scaleFactor() + * \see setViewScaleSynchronized() */ void setScaleFactor( double factor ); /** * Sets whether the view scale should be synchronized with the main canvas center. - * @see isViewScaleSynchronized() - * @see setScaleFactor() + * \see isViewScaleSynchronized() + * \see setScaleFactor() */ void setViewScaleSynchronized( bool enabled ); /** * Returns true if the view scale is synchronized with the main canvas extent. - * @see setViewScaleSynchronized() - * @see scaleFactor() + * \see setViewScaleSynchronized() + * \see scaleFactor() */ bool isViewScaleSynchronized() const; /** * Sets whether labels should be rendered in the view. - * @see labelsVisible() + * \see labelsVisible() */ void setLabelsVisible( bool enabled ); /** * Returns whether labels are rendered in the view. - * @see setLabelsVisible() + * \see setLabelsVisible() */ bool labelsVisible() const; diff --git a/src/app/qgsmaptoolchangelabelproperties.h b/src/app/qgsmaptoolchangelabelproperties.h index 999fa988335b..38b271c4651d 100644 --- a/src/app/qgsmaptoolchangelabelproperties.h +++ b/src/app/qgsmaptoolchangelabelproperties.h @@ -35,7 +35,7 @@ class APP_EXPORT QgsMapToolChangeLabelProperties: public QgsMapToolLabel protected: /** Applies the label property changes - * @param changes attribute map of changes + * \param changes attribute map of changes * \since QGIS 2.9 */ void applyChanges( const QgsAttributeMap &changes ); diff --git a/src/app/qgsmaptoollabel.h b/src/app/qgsmaptoollabel.h index b82eaaa5deff..82733eaec53f 100644 --- a/src/app/qgsmaptoollabel.h +++ b/src/app/qgsmaptoollabel.h @@ -34,35 +34,35 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool ~QgsMapToolLabel(); /** Returns true if label move can be applied to a layer - @param xCol out: index of the attribute for data defined x coordinate - @param yCol out: index of the attribute for data defined y coordinate - @return true if labels of layer can be moved*/ + \param xCol out: index of the attribute for data defined x coordinate + \param yCol out: index of the attribute for data defined y coordinate + \returns true if labels of layer can be moved*/ bool labelMoveable( QgsVectorLayer *vlayer, int &xCol, int &yCol ) const; bool labelMoveable( QgsVectorLayer *vlayer, const QgsPalLayerSettings &settings, int &xCol, int &yCol ) const; /** Returns true if diagram move can be applied to a layer - @param xCol out: index of the attribute for data defined x coordinate - @param yCol out: index of the attribute for data defined y coordinate - @return true if labels of layer can be moved*/ + \param xCol out: index of the attribute for data defined x coordinate + \param yCol out: index of the attribute for data defined y coordinate + \returns true if labels of layer can be moved*/ bool diagramMoveable( QgsVectorLayer *vlayer, int &xCol, int &yCol ) const; /** Returns true if layer has attribute fields set up - @param xCol out: index of the attribute for data defined x coordinate - @param yCol out: index of the attribute for data defined y coordinate - @return true if layer fields set up and exist*/ + \param xCol out: index of the attribute for data defined x coordinate + \param yCol out: index of the attribute for data defined y coordinate + \returns true if layer fields set up and exist*/ bool layerCanPin( QgsVectorLayer *vlayer, int &xCol, int &yCol ) const; /** Returns true if layer has attribute field set up for diagrams - @param showCol out: attribute column for data defined diagram showing + \param showCol out: attribute column for data defined diagram showing \since QGIS 2.16 */ bool diagramCanShowHide( QgsVectorLayer *vlayer, int &showCol ) const; /** Returns true if layer has attribute field set up - @param showCol out: attribute column for data defined label showing*/ + \param showCol out: attribute column for data defined label showing*/ bool labelCanShowHide( QgsVectorLayer *vlayer, int &showCol ) const; /** Checks if labels in a layer can be rotated - @param rotationCol out: attribute column for data defined label rotation*/ + \param rotationCol out: attribute column for data defined label rotation*/ bool layerIsRotatable( QgsVectorLayer *layer, int &rotationCol ) const; bool labelIsRotatable( QgsVectorLayer *layer, const QgsPalLayerSettings &settings, int &rotationCol ) const; @@ -87,14 +87,14 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool /** Returns label position for mouse click location - @param e mouse event - @param p out: label position - @return true in case of success, false if no label at this location*/ + \param e mouse event + \param p out: label position + \returns true in case of success, false if no label at this location*/ bool labelAtPosition( QMouseEvent *e, QgsLabelPosition &p ); /** Finds out rotation point of current label position - @param ignoreUpsideDown treat label as right-side-up - @return true in case of success*/ + \param ignoreUpsideDown treat label as right-side-up + \returns true in case of success*/ bool currentLabelRotationPoint( QgsPoint &pos, bool ignoreUpsideDown = false, bool rotatingUnpinned = false ); //! Creates label / feature / fixpoint rubber bands for the current label position @@ -104,13 +104,13 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool void deleteRubberBands(); /** Returns current label's text - @param trunc number of chars to truncate to, with ... added */ + \param trunc number of chars to truncate to, with ... added */ QString currentLabelText( int trunc = 0 ); void currentAlignment( QString &hali, QString &vali ); /** Gets vector feature for current label pos - @return true in case of success*/ + \returns true in case of success*/ bool currentFeature( QgsFeature &f, bool fetchGeom = false ); //! Returns the font for the current feature (considering default font and data defined properties) @@ -120,43 +120,43 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool QString dataDefinedColumnName( QgsPalLayerSettings::Property p, const QgsPalLayerSettings &labelSettings ) const; /** Returns a data defined attribute column index - @return -1 if column does not exist or an expression is used instead */ + \returns -1 if column does not exist or an expression is used instead */ int dataDefinedColumnIndex( QgsPalLayerSettings::Property p, const QgsPalLayerSettings &labelSettings, const QgsVectorLayer *vlayer ) const; //! Returns whether to preserve predefined rotation data during label pin/unpin operations bool currentLabelPreserveRotation(); /** Get data defined position of current label - @param x out: data defined x-coordinate - @param xSuccess out: false if attribute value is NULL - @param y out: data defined y-coordinate - @param ySuccess out: false if attribute value is NULL - @param xCol out: index of the x position column - @param yCol out: index of the y position column - @return false if layer does not have data defined label position enabled*/ + \param x out: data defined x-coordinate + \param xSuccess out: false if attribute value is NULL + \param y out: data defined y-coordinate + \param ySuccess out: false if attribute value is NULL + \param xCol out: index of the x position column + \param yCol out: index of the y position column + \returns false if layer does not have data defined label position enabled*/ bool currentLabelDataDefinedPosition( double &x, bool &xSuccess, double &y, bool &ySuccess, int &xCol, int &yCol ) const; /** Returns data defined rotation of current label - @param rotation out: rotation value - @param rotationSuccess out: false if rotation value is NULL - @param rCol out: index of the rotation column - @param ignoreXY ignore that x and y are required to be data-defined - @return true if data defined rotation is enabled on the layer + \param rotation out: rotation value + \param rotationSuccess out: false if rotation value is NULL + \param rCol out: index of the rotation column + \param ignoreXY ignore that x and y are required to be data-defined + \returns true if data defined rotation is enabled on the layer */ bool currentLabelDataDefinedRotation( double &rotation, bool &rotationSuccess, int &rCol, bool ignoreXY = false ) const; /** Returns data defined show/hide of a feature. - @param vlayer vector layer - @param featureId feature identification integer - @param show out: show/hide value - @param showSuccess out: false if show/hide value is NULL - @param showCol out: index of the show label column - @return true if data defined show/hide is enabled on the layer + \param vlayer vector layer + \param featureId feature identification integer + \param show out: show/hide value + \param showSuccess out: false if show/hide value is NULL + \param showCol out: index of the show label column + \returns true if data defined show/hide is enabled on the layer */ bool dataDefinedShowHide( QgsVectorLayer *vlayer, QgsFeatureId featureId, int &show, bool &showSuccess, int &showCol ) const; /** Returns the pin status for the current label/diagram - @return true if the label/diagram is pinned, false otherwise + \returns true if the label/diagram is pinned, false otherwise \since QGIS 2.16 */ bool isPinned(); diff --git a/src/app/qgsmaptoolmovefeature.cpp b/src/app/qgsmaptoolmovefeature.cpp index 8832b739db90..0511a34e2155 100644 --- a/src/app/qgsmaptoolmovefeature.cpp +++ b/src/app/qgsmaptoolmovefeature.cpp @@ -198,7 +198,6 @@ void QgsMapToolMoveFeature::cadCanvasReleaseEvent( QgsMapMouseEvent *e ) } } -//! called when map tool is being deactivated void QgsMapToolMoveFeature::deactivate() { //delete rubber band diff --git a/src/app/qgsmaptoolmovefeature.h b/src/app/qgsmaptoolmovefeature.h index e56c63f2990a..388fba123ac6 100644 --- a/src/app/qgsmaptoolmovefeature.h +++ b/src/app/qgsmaptoolmovefeature.h @@ -38,7 +38,6 @@ class APP_EXPORT QgsMapToolMoveFeature: public QgsMapToolAdvancedDigitizing virtual void cadCanvasReleaseEvent( QgsMapMouseEvent *e ) override; - //! called when map tool is being deactivated void deactivate() override; private: diff --git a/src/app/qgsmaptooloffsetpointsymbol.h b/src/app/qgsmaptooloffsetpointsymbol.h index 232bbf82191b..c5478a560e51 100644 --- a/src/app/qgsmaptooloffsetpointsymbol.h +++ b/src/app/qgsmaptooloffsetpointsymbol.h @@ -75,16 +75,16 @@ class APP_EXPORT QgsMapToolOffsetPointSymbol: public QgsMapToolPointSymbol void createPreviewItem( QgsMarkerSymbol *markerSymbol ); //! Calculates the new values for offset attributes, respecting the symbol's offset units - //! @note start and end point are in map units + //! \note start and end point are in map units QMap< int, QVariant > calculateNewOffsetAttributes( const QgsPoint &startPoint, const QgsPoint &endPoint ) const; /** Updates the preview item to reflect a new offset. - * @note start and end points are in map units + * \note start and end points are in map units */ void updateOffsetPreviewItem( const QgsPoint &startPoint, const QgsPoint &endPoint ); //! Calculates the required offset from the start to end points, in the specified unit - //! @note start and end points are in map units + //! \note start and end points are in map units QPointF calculateOffset( const QgsPoint &startPoint, const QgsPoint &endPoint, QgsUnitTypes::RenderUnit unit ) const; //! Adjusts the calculated offset to account for the symbol's rotation diff --git a/src/app/qgsmaptoolselectutils.h b/src/app/qgsmaptoolselectutils.h index 8dd6ab263c75..4b1f9803c8a0 100644 --- a/src/app/qgsmaptoolselectutils.h +++ b/src/app/qgsmaptoolselectutils.h @@ -34,28 +34,28 @@ namespace QgsMapToolSelectUtils { /** Calculates a list of features matching a selection geometry and flags. - * @param canvas the map canvas used to get the current selected vector layer and + * \param canvas the map canvas used to get the current selected vector layer and for any required geometry transformations - * @param selectGeometry the geometry to select the layers features. This geometry + * \param selectGeometry the geometry to select the layers features. This geometry must be in terms of the canvas coordinate system. - * @param doContains features will only be selected if fully contained within + * \param doContains features will only be selected if fully contained within the selection rubber band (otherwise intersection is enough). - * @param singleSelect only selects the closest feature to the selectGeometry. - * @returns list of features which match search geometry and parameters + * \param singleSelect only selects the closest feature to the selectGeometry. + * \returns list of features which match search geometry and parameters * \since QGIS 2.16 */ QgsFeatureIds getMatchingFeatures( QgsMapCanvas *canvas, const QgsGeometry &selectGeometry, bool doContains, bool singleSelect ); /** Selects the features within currently selected layer. - @param canvas the map canvas used to get the current selected vector layer and + \param canvas the map canvas used to get the current selected vector layer and for any required geometry transformations - @param selectGeometry the geometry to select the layers features. This geometry + \param selectGeometry the geometry to select the layers features. This geometry must be in terms of the canvas coordinate system. - @param selectBehavior behavior of select (ie replace selection, add to selection) - @param doContains features will only be selected if fully contained within + \param selectBehavior behavior of select (ie replace selection, add to selection) + \param doContains features will only be selected if fully contained within the selection rubber band (otherwise intersection is enough). - @param singleSelect only selects the closest feature to the selectGeometry. + \param singleSelect only selects the closest feature to the selectGeometry. \since QGIS 2.16 */ void setSelectedFeatures( QgsMapCanvas *canvas, @@ -66,49 +66,49 @@ namespace QgsMapToolSelectUtils /** Selects multiple matching features from within currently selected layer. - @param canvas the map canvas used to get the current selected vector layer and + \param canvas the map canvas used to get the current selected vector layer and for any required geometry transformations - @param selectGeometry the geometry to select the layers features. This geometry + \param selectGeometry the geometry to select the layers features. This geometry must be in terms of the canvas coordinate system. - @param e MouseEvents are used to determine the current selection + \param e MouseEvents are used to determine the current selection operations (add, subtract, contains) \since QGIS 2.16 - @see selectSingleFeature() + \see selectSingleFeature() */ void selectMultipleFeatures( QgsMapCanvas *canvas, const QgsGeometry &selectGeometry, QMouseEvent *e ); /** Selects a single feature from within currently selected layer. - @param canvas the map canvas used to get the current selected vector layer and + \param canvas the map canvas used to get the current selected vector layer and for any required geometry transformations - @param selectGeometry the geometry to select the layers features. This geometry + \param selectGeometry the geometry to select the layers features. This geometry must be in terms of the canvas coordinate system. - @param e MouseEvents are used to determine the current selection + \param e MouseEvents are used to determine the current selection operations (add, subtract, contains) - @see selectMultipleFeatures() + \see selectMultipleFeatures() */ void selectSingleFeature( QgsMapCanvas *canvas, const QgsGeometry &selectGeometry, QMouseEvent *e ); /** Get the current selected canvas map layer. Returns nullptr if it is not a vector layer - @param canvas The map canvas used for getting the current layer - @return QgsVectorLayer The layer + \param canvas The map canvas used for getting the current layer + \returns QgsVectorLayer The layer */ QgsVectorLayer *getCurrentVectorLayer( QgsMapCanvas *canvas ); /** Expands a rectangle to a minimum size for selection based on the vector layer type - @param selectRect The QRect to expand - @param vlayer The vector layer layer - @param vlayer The point to expand the rectangle around + \param selectRect The QRect to expand + \param vlayer The vector layer layer + \param vlayer The point to expand the rectangle around */ void expandSelectRectangle( QRect &selectRect, QgsVectorLayer *vlayer, QPoint point ); /** Sets a QgsRubberband to rectangle in map units using a rectangle defined in device coords - @param canvas The map canvas used to transform the rectangle into map units - @param selectRect The input rectangle in device coords - @param rubberBand The rubberband that will be set in map units using the input rectangle + \param canvas The map canvas used to transform the rectangle into map units + \param selectRect The input rectangle in device coords + \param rubberBand The rubberband that will be set in map units using the input rectangle */ void setRubberBand( QgsMapCanvas *canvas, QRect &selectRect, QgsRubberBand *rubberBand ); } diff --git a/src/app/qgsmeasuredialog.h b/src/app/qgsmeasuredialog.h index e7b76c14bbae..2cfc01b90a56 100644 --- a/src/app/qgsmeasuredialog.h +++ b/src/app/qgsmeasuredialog.h @@ -86,7 +86,7 @@ class APP_EXPORT QgsMeasureDialog : public QDialog, private Ui::QgsMeasureBase void updateUi(); /** Resets the units combo box to display either distance or area units - * @param isArea set to true to populate with areal units, or false to show distance units + * \param isArea set to true to populate with areal units, or false to show distance units */ void repopulateComboBoxUnits( bool isArea ); diff --git a/src/app/qgsmeasuretool.h b/src/app/qgsmeasuretool.h index 33a1723e1fae..7aba8beb6d26 100644 --- a/src/app/qgsmeasuretool.h +++ b/src/app/qgsmeasuretool.h @@ -103,7 +103,7 @@ class APP_EXPORT QgsMeasureTool : public QgsMapTool QgsCoordinateReferenceSystem mDestinationCrs; //! Returns the snapped (map) coordinate - //@param p (pixel) coordinate + //\param p (pixel) coordinate QgsPoint snapPoint( QPoint p ); //! Removes the last vertex from mRubberBand diff --git a/src/app/qgsmergeattributesdialog.h b/src/app/qgsmergeattributesdialog.h index 2f9cfcaf4b0d..3380fd08cb20 100644 --- a/src/app/qgsmergeattributesdialog.h +++ b/src/app/qgsmergeattributesdialog.h @@ -73,7 +73,7 @@ class APP_EXPORT QgsMergeAttributesDialog: public QDialog, private Ui::QgsMergeA QComboBox *createMergeComboBox( QVariant::Type columnType ) const; /** Returns the table widget column index of a combo box - @return the column index or -1 in case of error*/ + \returns the column index or -1 in case of error*/ int findComboColumn( QComboBox *c ) const; //! Calculates the merged value of a column (depending on the selected merge behavior) and inserts the value in the corresponding cell void refreshMergedValue( int col ); diff --git a/src/app/qgsoptions.h b/src/app/qgsoptions.h index e17ec0f6637a..d01c3f658d89 100644 --- a/src/app/qgsoptions.h +++ b/src/app/qgsoptions.h @@ -43,10 +43,10 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption /** * Constructor - * @param parent Parent widget (usually a QgisApp) - * @param name name for the widget - * @param modal true for modal dialog - * @param optionsFactories factories for additional option pages + * \param parent Parent widget (usually a QgisApp) + * \param name name for the widget + * \param modal true for modal dialog + * \param optionsFactories factories for additional option pages */ QgsOptions( QWidget *parent = nullptr, Qt::WindowFlags fl = QgisGui::ModalDialogFlags, const QList &optionsFactories = QList() ); @@ -73,7 +73,8 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption void on_pbnEditPyramidsOptions_pressed(); void editGdalDriver( const QString &driverName ); void saveOptions(); - /*! + + /** * Slot to reset any temporarily applied options on dialog close/cancel */ void rejectOptions(); //! Slot to change the theme this is handled when the user diff --git a/src/app/qgspointmarkeritem.h b/src/app/qgspointmarkeritem.h index 5b40e8ad623f..b9c8edec5443 100644 --- a/src/app/qgspointmarkeritem.h +++ b/src/app/qgspointmarkeritem.h @@ -40,33 +40,33 @@ class APP_EXPORT QgsPointMarkerItem: public QgsMapCanvasItem void paint( QPainter *painter ) override; /** Sets the center point of the marker symbol (in map coordinates) - * @param p center point + * \param p center point */ void setPointLocation( const QgsPoint &p ); /** Sets the marker symbol to use for rendering the point. Note - you may need to call * updateSize() after setting the symbol. - * @param symbol marker symbol. Ownership is transferred to item. - * @see symbol() - * @see updateSize() + * \param symbol marker symbol. Ownership is transferred to item. + * \see symbol() + * \see updateSize() */ void setSymbol( QgsMarkerSymbol *symbol ); /** Returns the marker symbol used for rendering the point. - * @see setSymbol() + * \see setSymbol() */ QgsMarkerSymbol *symbol(); /** Sets the feature used for rendering the marker symbol. The feature's attributes * may affect the rendered symbol if data defined overrides are in place. - * @param feature feature for symbol - * @see feature() - * @see updateSize() + * \param feature feature for symbol + * \see feature() + * \see updateSize() */ void setFeature( const QgsFeature &feature ); /** Returns the feature used for rendering the marker symbol. - * @see setFeature() + * \see setFeature() */ QgsFeature feature() const { return mFeature; } @@ -76,16 +76,16 @@ class APP_EXPORT QgsPointMarkerItem: public QgsMapCanvasItem void updateSize(); /** Sets the transparency for the marker. - * @param transparency double between 0 and 1 inclusive, where 0 is fully opaque + * \param transparency double between 0 and 1 inclusive, where 0 is fully opaque * and 1 is fully transparent - * @see transparency() + * \see transparency() */ void setTransparency( double transparency ); /** Returns the transparency for the marker. - * @returns transparency value between 0 and 1 inclusive, where 0 is fully opaque + * \returns transparency value between 0 and 1 inclusive, where 0 is fully opaque * and 1 is fully transparent - * @see setTransparency() + * \see setTransparency() */ double transparency() const; diff --git a/src/app/qgsprojectproperties.cpp b/src/app/qgsprojectproperties.cpp index 113850008f6e..146a57baf38b 100644 --- a/src/app/qgsprojectproperties.cpp +++ b/src/app/qgsprojectproperties.cpp @@ -1281,23 +1281,14 @@ void QgsProjectProperties::srIdUpdated() } } -/*! - * Function to save non-base dialog states - */ void QgsProjectProperties::saveState() { } -/*! - * Function to restore non-base dialog states - */ void QgsProjectProperties::restoreState() { } -/*! - * Set WMS default extent to current canvas extent - */ void QgsProjectProperties::on_pbnWMSExtCanvas_clicked() { QgsRectangle ext = mMapCanvas->extent(); diff --git a/src/app/qgsprojectproperties.h b/src/app/qgsprojectproperties.h index 54ef0fd3935e..ad42eb033032 100644 --- a/src/app/qgsprojectproperties.h +++ b/src/app/qgsprojectproperties.h @@ -33,7 +33,7 @@ class QgsLayerTreeGroup; /** Dialog to set project level properties - @note actual state is stored in QgsProject singleton instance + \note actual state is stored in QgsProject singleton instance */ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui::QgsProjectPropertiesBase @@ -47,7 +47,7 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui: ~QgsProjectProperties(); - /*! + /** Every project has a title */ QString title() const; @@ -57,12 +57,13 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui: QString projectionWkt(); public slots: - /*! + + /** * Slot called when apply button is pressed or dialog is accepted */ void apply(); - /*! + /** * Slot to show the projections tab when the dialog is opened */ void showProjectionsTab(); @@ -84,8 +85,8 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui: //! A scale in the list of project scales changed void scaleItemChanged( QListWidgetItem *changedScaleItem ); - /*! - * Slots for WMS project settings + /** + * Set WMS default extent to current canvas extent */ void on_pbnWMSExtCanvas_clicked(); void on_pbnWMSAddSRS_clicked(); @@ -98,24 +99,24 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui: void on_mWMSInspireScenario1_toggled( bool on ); void on_mWMSInspireScenario2_toggled( bool on ); - /*! + /** * Slots to select/deselect all the WFS layers */ void on_pbnWFSLayersSelectAll_clicked(); void on_pbnWFSLayersDeselectAll_clicked(); - /*! + /** * Slots to select/deselect all the WCS layers */ void on_pbnWCSLayersSelectAll_clicked(); void on_pbnWCSLayersDeselectAll_clicked(); - /*! + /** * Slots to launch OWS test */ void on_pbnLaunchOWSChecker_clicked(); - /*! + /** * Slots for Styles */ void on_pbtnStyleManager_clicked(); @@ -126,22 +127,22 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui: void on_mTransparencySlider_valueChanged( int value ); void on_mTransparencySpinBox_valueChanged( int value ); - /*! + /** * Slot to show the context help for this dialog */ void on_buttonBox_helpRequested() { QgsHelp::openHelp( QStringLiteral( "introduction/qgis_configuration.html#project-properties" ) ); } - /*! + /** * Slot to link WFS checkboxes */ void cbxWFSPubliedStateChanged( int aIdx ); - /*! + /** * Slot to link WCS checkboxes */ void cbxWCSPubliedStateChanged( int aIdx ); - /*! + /** * If user changes the CRS, set the corresponding map units */ void srIdUpdated(); @@ -180,17 +181,17 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui: void populateStyles(); void editSymbol( QComboBox *cbo ); - /*! + /** * Function to save non-base dialog states */ void saveState(); - /*! + /** * Function to restore non-base dialog states */ void restoreState(); - /*! + /** * Reset the Python macros */ void resetPythonMacros(); diff --git a/src/app/qgsrasterlayerproperties.h b/src/app/qgsrasterlayerproperties.h index 588a47ec4032..d1a2e3892f9e 100644 --- a/src/app/qgsrasterlayerproperties.h +++ b/src/app/qgsrasterlayerproperties.h @@ -36,9 +36,7 @@ class QgsRasterRendererWidget; class QgsRasterHistogramWidget; /** Property sheet for a raster map layer - *@author Tim Sutton */ - class APP_EXPORT QgsRasterLayerProperties : public QgsOptionsDialogBase, private Ui::QgsRasterLayerPropertiesBase { Q_OBJECT @@ -46,7 +44,7 @@ class APP_EXPORT QgsRasterLayerProperties : public QgsOptionsDialogBase, private public: /** \brief Constructor - * @param ml Map layer for which properties will be displayed + * \param ml Map layer for which properties will be displayed */ QgsRasterLayerProperties( QgsMapLayer *lyr, QgsMapCanvas *canvas, QWidget *parent = nullptr, Qt::WindowFlags = QgisGui::ModalDialogFlags ); diff --git a/src/app/qgsselectbyformdialog.h b/src/app/qgsselectbyformdialog.h index 8b81f5edf76a..2a9d827023b7 100644 --- a/src/app/qgsselectbyformdialog.h +++ b/src/app/qgsselectbyformdialog.h @@ -28,7 +28,7 @@ class QgsMapCanvas; /** \ingroup app * \class QgsSelectByFormDialog * A dialog for selecting features from a layer, using a form based off the layer's editor widgets. - * @note introduced in QGIS 2.16 + * \since QGIS 2.16 */ class APP_EXPORT QgsSelectByFormDialog : public QDialog @@ -38,10 +38,10 @@ class APP_EXPORT QgsSelectByFormDialog : public QDialog public: /** Constructor for QgsSelectByFormDialog - * @param layer vector layer to select from - * @param context editor context - * @param parent parent widget - * @param fl window flags + * \param layer vector layer to select from + * \param context editor context + * \param parent parent widget + * \param fl window flags */ QgsSelectByFormDialog( QgsVectorLayer *layer, const QgsAttributeEditorContext &context = QgsAttributeEditorContext(), @@ -51,7 +51,7 @@ class APP_EXPORT QgsSelectByFormDialog : public QDialog /** Sets the message bar to display feedback from the form in. This is used in the search/filter * mode to display the count of selected features. - * @param messageBar target message bar + * \param messageBar target message bar * \since QGIS 2.16 */ void setMessageBar( QgsMessageBar *messageBar ); diff --git a/src/app/qgssnappingwidget.h b/src/app/qgssnappingwidget.h index c5930a705c7a..f156e6a36878 100644 --- a/src/app/qgssnappingwidget.h +++ b/src/app/qgssnappingwidget.h @@ -49,9 +49,9 @@ class APP_EXPORT QgsSnappingWidget : public QWidget /** * Constructor - * @param project The project with which this widget configuration will be synchronized - * @param canvas the map canvas (used for map units) - * @param parent is the parent widget. Based on the type of parent, it will + * \param project The project with which this widget configuration will be synchronized + * \param canvas the map canvas (used for map units) + * \param parent is the parent widget. Based on the type of parent, it will * be displayed a tool bar, in the status bar or as a widget/dialog. */ QgsSnappingWidget( QgsProject *project, QgsMapCanvas *canvas, QWidget *parent = nullptr ); diff --git a/src/app/qgsstatusbarmagnifierwidget.h b/src/app/qgsstatusbarmagnifierwidget.h index a01ce16ec1dd..f291191ccc0e 100644 --- a/src/app/qgsstatusbarmagnifierwidget.h +++ b/src/app/qgsstatusbarmagnifierwidget.h @@ -37,7 +37,7 @@ class APP_EXPORT QgsStatusBarMagnifierWidget : public QWidget public: /** Constructor - * @param parent is the parent widget + * \param parent is the parent widget */ QgsStatusBarMagnifierWidget( QWidget *parent = nullptr ); @@ -47,7 +47,7 @@ class APP_EXPORT QgsStatusBarMagnifierWidget : public QWidget void setDefaultFactor( double factor ); /** Set the font of the text - * @param font the font to use + * \param font the font to use */ void setFont( const QFont &font ); diff --git a/src/app/qgsstatusbarscalewidget.h b/src/app/qgsstatusbarscalewidget.h index e3ade8e9f5b3..0146cafee408 100644 --- a/src/app/qgsstatusbarscalewidget.h +++ b/src/app/qgsstatusbarscalewidget.h @@ -44,19 +44,19 @@ class APP_EXPORT QgsStatusBarScaleWidget : public QWidget virtual ~QgsStatusBarScaleWidget(); /** - * @brief setScale set the selected scale from double - * @param scale + * \brief setScale set the selected scale from double + * \param scale */ void setScale( double scale ); /** - * @brief isLocked check if the scale should be locked to use magnifier instead of scale to zoom in/out - * @return True if the scale shall be locked + * \brief isLocked check if the scale should be locked to use magnifier instead of scale to zoom in/out + * \returns True if the scale shall be locked */ bool isLocked() const; /** Set the font of the text - * @param font the font to use + * \param font the font to use */ void setFont( const QFont &font ); diff --git a/src/app/qgstip.h b/src/app/qgstip.h index fedf4f905043..7fcd57ce1b35 100644 --- a/src/app/qgstip.h +++ b/src/app/qgstip.h @@ -25,7 +25,7 @@ * Tips can be generic, in which case they make no mention of * gui dialogs etc, or gui-specific in which case they may allude * to features of the graphical user interface. -* @see also QgsTipOfTheDay, QgsTipFactory +* \see also QgsTipOfTheDay, QgsTipFactory */ class APP_EXPORT QgsTip diff --git a/src/app/qgstipfactory.h b/src/app/qgstipfactory.h index f715cdf73224..9c66aa800906 100644 --- a/src/app/qgstipfactory.h +++ b/src/app/qgstipfactory.h @@ -25,7 +25,7 @@ * Tips can be generic, in which case they make no mention of * gui dialogs etc, or gui-specific in which case they may allude * to features of the graphical user interface. -* @see also QgsTipOfTheDay, QgsTip +* \see also QgsTipOfTheDay, QgsTip */ class APP_EXPORT QgsTipFactory : public QObject @@ -38,26 +38,26 @@ class APP_EXPORT QgsTipFactory : public QObject ~QgsTipFactory(); /** Get a random tip (generic or gui-centric) - * @return An QgsTip containing the tip + * \returns An QgsTip containing the tip */ QgsTip getTip(); /** Get a specific tip (generic or gui-centric). - * @param position The tip returned will be based on the + * \param position The tip returned will be based on the * number passed in as position. If the * position is invalid, an empty string will be * returned. - * @return An QgsTip containing the tip + * \returns An QgsTip containing the tip */ QgsTip getTip( int position ); /** Get a random generic tip - * @return An QgsTip containing the tip + * \returns An QgsTip containing the tip */ QgsTip getGenericTip(); /** Get a random gui-centric tip - * @return An QgsTip containing the tip + * \returns An QgsTip containing the tip */ QgsTip getGuiTip(); diff --git a/src/app/qgsvectorlayerproperties.cpp b/src/app/qgsvectorlayerproperties.cpp index 058f24a9472f..7eb405009d43 100644 --- a/src/app/qgsvectorlayerproperties.cpp +++ b/src/app/qgsvectorlayerproperties.cpp @@ -377,7 +377,7 @@ void QgsVectorLayerProperties::insertFieldOrExpression() mMapTipWidget->insertText( expression ); } -//! @note in raster props, this method is called sync() +// in raster props, this method is called sync() void QgsVectorLayerProperties::syncToLayer() { // populate the general information diff --git a/src/app/qgsvectorlayerproperties.h b/src/app/qgsvectorlayerproperties.h index 5b396f27863d..b1afa3507a7b 100644 --- a/src/app/qgsvectorlayerproperties.h +++ b/src/app/qgsvectorlayerproperties.h @@ -61,13 +61,13 @@ class APP_EXPORT QgsVectorLayerProperties : public QgsOptionsDialogBase, private void setRendererDirty( bool ) {} /** Adds an attribute to the table (but does not commit it yet) - @param field the field to add - @return false in case of a name conflict, true in case of success */ + \param field the field to add + \returns false in case of a name conflict, true in case of success */ bool addAttribute( const QgsField &field ); /** Deletes an attribute (but does not commit it) - @param name attribute name - @return false in case of a non-existing attribute.*/ + \param name attribute name + \returns false in case of a non-existing attribute.*/ bool deleteAttribute( int attr ); //! Adds a properties page factory to the vector layer properties dialog. @@ -139,7 +139,7 @@ class APP_EXPORT QgsVectorLayerProperties : public QgsOptionsDialogBase, private void updateVariableEditor(); /** - * @brief updates the FieldsPropertiesDialog when syncing the layer properties + * \brief updates the FieldsPropertiesDialog when syncing the layer properties */ void updateFieldsPropertiesDialog(); diff --git a/src/core/annotations/qgsannotation.h b/src/core/annotations/qgsannotation.h index d748cdbdef87..5fe50f079710 100644 --- a/src/core/annotations/qgsannotation.h +++ b/src/core/annotations/qgsannotation.h @@ -59,13 +59,13 @@ class CORE_EXPORT QgsAnnotation : public QObject /** * Returns true if the annotation is visible and should be rendered. - * @see setVisible() + * \see setVisible() */ bool isVisible() const { return mVisible; } /** * Sets whether the annotation is visible and should be rendered. - * @see isVisible() + * \see isVisible() */ void setVisible( bool visible ); @@ -73,45 +73,45 @@ class CORE_EXPORT QgsAnnotation : public QObject * Returns true if the annotation is attached to a fixed map position, or * false if the annotation uses a position relative to the current map * extent. - * @see setHasFixedMapPosition() - * @see mapPosition() - * @see relativePosition() + * \see setHasFixedMapPosition() + * \see mapPosition() + * \see relativePosition() */ bool hasFixedMapPosition() const { return mHasFixedMapPosition; } /** * Sets whether the annotation is attached to a fixed map position, or * uses a position relative to the current map extent. - * @see hasFixedMapPosition() + * \see hasFixedMapPosition() */ void setHasFixedMapPosition( bool fixed ); /** * Returns the map position of the annotation, if it is attached to a fixed map * position. - * @see setMapPosition() - * @see hasFixedMapPosition() - * @see mapPositionCrs() + * \see setMapPosition() + * \see hasFixedMapPosition() + * \see mapPositionCrs() */ QgsPoint mapPosition() const { return mMapPosition; } /** * Sets the map position of the annotation, if it is attached to a fixed map * position. - * @see mapPosition() + * \see mapPosition() */ void setMapPosition( const QgsPoint &position ); /** * Returns the CRS of the map position, or an invalid CRS if the annotation does * not have a fixed map position. - * @see setMapPositionCrs() + * \see setMapPositionCrs() */ QgsCoordinateReferenceSystem mapPositionCrs() const { return mMapPositionCrs; } /** * Sets the CRS of the map position. - * @see mapPositionCrs() + * \see mapPositionCrs() */ void setMapPositionCrs( const QgsCoordinateReferenceSystem &crs ); @@ -119,7 +119,7 @@ class CORE_EXPORT QgsAnnotation : public QObject * Returns the relative position of the annotation, if it is not attached to a fixed map * position. The coordinates in the return point should be between 0 and 1, and represent * the relative percentage for the position compared to the map width and height. - * @see setRelativePosition() + * \see setRelativePosition() */ QPointF relativePosition() const { return mRelativePosition; } @@ -127,60 +127,60 @@ class CORE_EXPORT QgsAnnotation : public QObject * Sets the relative position of the annotation, if it is not attached to a fixed map * position. The coordinates in the return point should be between 0 and 1, and represent * the relative percentage for the position compared to the map width and height. - * @see relativePosition() + * \see relativePosition() */ void setRelativePosition( QPointF position ); /** * Sets the annotation's frame's offset from the mapPosition() reference point. - * @see frameOffsetFromReferencePoint() + * \see frameOffsetFromReferencePoint() */ void setFrameOffsetFromReferencePoint( QPointF offset ); /** * Returns the annotation's frame's offset from the mapPosition() reference point. - * @see setFrameOffsetFromReferencePoint() + * \see setFrameOffsetFromReferencePoint() */ QPointF frameOffsetFromReferencePoint() const { return mOffsetFromReferencePoint; } /** * Sets the size of the annotation's frame (the main area in which * the annotation's content is drawn). - * @see frameSize() + * \see frameSize() */ void setFrameSize( QSizeF size ); /** * Returns the size of the annotation's frame (the main area in which * the annotation's content is drawn). - * @see setFrameSize() + * \see setFrameSize() */ QSizeF frameSize() const { return mFrameSize; } /** * Sets the margins (in millimeters) between the outside of the frame and the annotation * content. - * @see contentsMargin() + * \see contentsMargin() */ void setContentsMargin( const QgsMargins &margins ); /** * Returns the margins (in millimeters) between the outside of the frame and the annotation * content. - * @see setContentsMargin() + * \see setContentsMargin() */ QgsMargins contentsMargin() const { return mContentsMargins; } /** * Sets the fill symbol used for rendering the annotation frame. Ownership * of the symbol is transferred to the annotation. - * @see fillSymbol() + * \see fillSymbol() */ void setFillSymbol( QgsFillSymbol *symbol ); /** * Returns the symbol that is used for rendering the annotation frame. - * @see setFillSymbol() + * \see setFillSymbol() */ QgsFillSymbol *fillSymbol() const { return mFillSymbol.get(); } @@ -192,29 +192,29 @@ class CORE_EXPORT QgsAnnotation : public QObject /** * Writes the annotation state to a DOM element. Derived classes should * call _writeXml() within their implementation of this method. - * @see readXml() - * @see _writeXml() + * \see readXml() + * \see _writeXml() */ virtual void writeXml( QDomElement &elem, QDomDocument &doc ) const = 0; /** * Restores the annotation's state from a DOM element. Derived classes should * call _readXml() within their implementation of this method. - * @see writeXml() - * @see _readXml() + * \see writeXml() + * \see _readXml() */ virtual void readXml( const QDomElement &itemElem, const QDomDocument &doc ) = 0; /** * Sets the symbol that is drawn at the annotation's map position. Ownership * of the symbol is transferred to the annotation. - * @see markerSymbol() + * \see markerSymbol() */ void setMarkerSymbol( QgsMarkerSymbol *symbol ); /** * Returns the symbol that is drawn at the annotation's map position. - * @see setMarkerSymbol() + * \see setMarkerSymbol() */ QgsMarkerSymbol *markerSymbol() const { return mMarkerSymbol.get(); } @@ -222,7 +222,7 @@ class CORE_EXPORT QgsAnnotation : public QObject * Returns the map layer associated with the annotation. Annotations can be * associated with a map layer if their visibility should be synchronized * with the layer's visibility. - * @see setMapLayer() + * \see setMapLayer() */ QgsMapLayer *mapLayer() const { return mMapLayer.data(); } @@ -230,20 +230,20 @@ class CORE_EXPORT QgsAnnotation : public QObject * Sets the map layer associated with the annotation. Annotations can be * associated with a map layer if their visibility should be synchronized * with the layer's visibility. - * @see mapLayer() + * \see mapLayer() */ void setMapLayer( QgsMapLayer *layer ); /** * Returns the feature associated with the annotation, or an invalid * feature if none has been set. - * @see setAssociatedFeature() + * \see setAssociatedFeature() */ QgsFeature associatedFeature() const { return mFeature; } /** * Sets the feature associated with the annotation. - * @see associatedFeature() + * \see associatedFeature() */ virtual void setAssociatedFeature( const QgsFeature &feature ) { mFeature = feature; } @@ -280,16 +280,16 @@ class CORE_EXPORT QgsAnnotation : public QObject /** * Writes common annotation properties to a DOM element. * This method should be called from subclasses in their writeXml method. - * @see writeXml() - * @see _readXml() + * \see writeXml() + * \see _readXml() */ void _writeXml( QDomElement &itemElem, QDomDocument &doc ) const; /** * Reads common annotation properties from a DOM element. * This method should be called from subclasses in their readXml method. - * @see readXml() - * @see _writeXml() + * \see readXml() + * \see _writeXml() */ void _readXml( const QDomElement &annotationElem, const QDomDocument &doc ); diff --git a/src/core/annotations/qgsannotationmanager.h b/src/core/annotations/qgsannotationmanager.h index 31515fb008f8..998bebe5387c 100644 --- a/src/core/annotations/qgsannotationmanager.h +++ b/src/core/annotations/qgsannotationmanager.h @@ -55,8 +55,8 @@ class CORE_EXPORT QgsAnnotationManager : public QObject /** * Adds an annotation to the manager. Ownership of the annotation is transferred to the manager. * Returns true if the addition was successful, or false if the annotation could not be added. - * @see removeAnnotation() - * @see annotationAdded() + * \see removeAnnotation() + * \see annotationAdded() */ bool addAnnotation( QgsAnnotation *annotation SIP_TRANSFER ); @@ -64,16 +64,16 @@ class CORE_EXPORT QgsAnnotationManager : public QObject * Removes an annotation from the manager. The annotation is deleted. * Returns true if the removal was successful, or false if the removal failed (eg as a result * of removing an annotation which is not contained in the manager). - * @see addAnnotation() - * @see compositionRemoved() - * @see compositionAboutToBeRemoved() - * @see clear() + * \see addAnnotation() + * \see compositionRemoved() + * \see compositionAboutToBeRemoved() + * \see clear() */ bool removeAnnotation( QgsAnnotation *annotation ); /** * Removes and deletes all annotations from the manager. - * @see removeAnnotation() + * \see removeAnnotation() */ void clear(); @@ -85,13 +85,13 @@ class CORE_EXPORT QgsAnnotationManager : public QObject /** * Reads the manager's state from a DOM element, restoring all annotations * present in the XML document. - * @see writeXml() + * \see writeXml() */ bool readXml( const QDomElement &element, const QDomDocument &doc ); /** * Returns a DOM element representing the state of the manager. - * @see readXml() + * \see readXml() */ QDomElement writeXml( QDomDocument &doc ) const; diff --git a/src/core/annotations/qgshtmlannotation.h b/src/core/annotations/qgshtmlannotation.h index 0675304ac59c..6b8c153df528 100644 --- a/src/core/annotations/qgshtmlannotation.h +++ b/src/core/annotations/qgshtmlannotation.h @@ -48,13 +48,13 @@ class CORE_EXPORT QgsHtmlAnnotation: public QgsAnnotation /** * Sets the file path for the source HTML file. - * @see sourceFile() + * \see sourceFile() */ void setSourceFile( const QString &htmlFile ); /** * Returns the file path for the source HTML file. - * @see setSourceFile() + * \see setSourceFile() */ QString sourceFile() const { return mHtmlFile; } diff --git a/src/core/annotations/qgssvgannotation.h b/src/core/annotations/qgssvgannotation.h index 47ba69566606..6e0a10dd05cc 100644 --- a/src/core/annotations/qgssvgannotation.h +++ b/src/core/annotations/qgssvgannotation.h @@ -44,13 +44,13 @@ class CORE_EXPORT QgsSvgAnnotation: public QgsAnnotation /** * Sets the file path for the source SVG file. - * @see filePath() + * \see filePath() */ void setFilePath( const QString &file ); /** * Returns the file path for the source SVG file. - * @see setFilePath() + * \see setFilePath() */ QString filePath() const { return mFilePath; } diff --git a/src/core/annotations/qgstextannotation.h b/src/core/annotations/qgstextannotation.h index bb04da6aa64f..825d44aec903 100644 --- a/src/core/annotations/qgstextannotation.h +++ b/src/core/annotations/qgstextannotation.h @@ -42,14 +42,14 @@ class CORE_EXPORT QgsTextAnnotation: public QgsAnnotation /** * Returns the text document which will be rendered * within the annotation. - * @see setDocument() + * \see setDocument() */ const QTextDocument *document() const; /** * Sets the text document which will be rendered * within the annotation. Ownership is not transferred. - * @see document() + * \see document() */ void setDocument( const QTextDocument *doc ); diff --git a/src/core/auth/qgsauthcertutils.h b/src/core/auth/qgsauthcertutils.h index ccc42ab489f5..52ca1497a02d 100644 --- a/src/core/auth/qgsauthcertutils.h +++ b/src/core/auth/qgsauthcertutils.h @@ -86,7 +86,7 @@ class CORE_EXPORT QgsAuthCertUtils static QMap mapDigestToCerts( const QList &certs ); /** Map certificates to their oraganization. - * @note not available in Python bindings + * \note not available in Python bindings */ static QMap< QString, QList > certsGroupedByOrg( const QList &certs ); @@ -95,7 +95,7 @@ class CORE_EXPORT QgsAuthCertUtils static QMap mapDigestToSslConfigs( const QList &configs ); /** Map SSL custom configs' certificates to their oraganization. - * @note not available in Python bindings + * \note not available in Python bindings */ static QMap< QString, QList > sslConfigsGroupedByOrg( const QList &configs ); @@ -106,9 +106,9 @@ class CORE_EXPORT QgsAuthCertUtils static QSslCertificate certFromFile( const QString &certpath ); /** Return non-encrypted key from a PEM or DER formatted file - * @param keypath File path to private key - * @param keypass Passphrase for private key - * @param algtype QString to set with resolved algorithm type + * \param keypath File path to private key + * \param keypass Passphrase for private key + * \param algtype QString to set with resolved algorithm type */ static QSslKey keyFromFile( const QString &keypath, const QString &keypass = QString(), @@ -118,11 +118,11 @@ class CORE_EXPORT QgsAuthCertUtils static QList certsFromString( const QString &pemtext ); /** Return 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 - * @param keypass Passphrase for private key - * @param reencrypt Whether to re-encrypt the private key with the passphrase - * @return certificate, private key, key's algorithm type + * \param certpath File path to certificate + * \param keypath File path to private key + * \param keypass Passphrase for private key + * \param reencrypt Whether to re-encrypt the private key with the passphrase + * \returns certificate, private key, key's algorithm type */ static QStringList certKeyBundleToPem( const QString &certpath, const QString &keypath, @@ -130,25 +130,25 @@ class CORE_EXPORT QgsAuthCertUtils bool reencrypt = true ); /** Return 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 - * @param reencrypt Whether to re-encrypt the private key with the passphrase - * @return certificate, private key, key's algorithm type + * \param bundlepath File path to the PKCS bundle + * \param bundlepass Passphrase for bundle + * \param reencrypt Whether to re-encrypt the private key with the passphrase + * \returns certificate, private key, key's algorithm type */ static QStringList pkcs12BundleToPem( const QString &bundlepath, const QString &bundlepass = QString(), bool reencrypt = true ); /** Write a temporary file for a PEM text of cert/key/CAs bundle component - * @param pemtext Component content as PEM text - * @param name Name of file - * @return File path to temporary file + * \param pemtext Component content as PEM text + * \param name Name of file + * \returns File path to temporary file */ static QString pemTextToTempFile( const QString &name, const QByteArray &pemtext ); /** Get 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 + * \param source The enum source type for the CA + * \param single Whether to return singular or plural description */ static QString getCaSourceName( QgsAuthCertUtils::CaCertSource source, bool single = false ); @@ -156,10 +156,10 @@ class CORE_EXPORT QgsAuthCertUtils static QString resolvedCertName( const QSslCertificate &cert, bool issuer = false ); /** Get combined distinguished name for certificate - * @param qcert Qt SSL cert object - * @param acert QCA SSL cert object to add more info to the output - * @param issuer Whether to return cert's subject or issuer combined name - * @note not available in Python bindings + * \param qcert Qt SSL cert object + * \param acert QCA SSL cert object to add more info to the output + * \param issuer Whether to return cert's subject or issuer combined name + * \note not available in Python bindings */ static QString getCertDistinguishedName( const QSslCertificate &qcert, const QCA::Certificate &acert = QCA::Certificate(), @@ -172,43 +172,43 @@ class CORE_EXPORT QgsAuthCertUtils static QString getColonDelimited( const QString &txt ); /** Get the sha1 hash for certificate - * @param cert Qt SSL certificate to generate hash from - * @param formatted Whether to colon-delimit the hash + * \param cert Qt SSL certificate to generate hash from + * \param formatted Whether to colon-delimit the hash */ static QString shaHexForCert( const QSslCertificate &cert, bool formatted = false ); /** Convert a QSslCertificate to a QCA::Certificate. - * @note not available in Python bindings + * \note not available in Python bindings */ static QCA::Certificate qtCertToQcaCert( const QSslCertificate &cert ); /** Convert a QList of QSslCertificate to a QCA::CertificateCollection. - * @note not available in Python bindings + * \note not available in Python bindings */ static QCA::CertificateCollection qtCertsToQcaCollection( const QList &certs ); /** PKI key/cert bundle from file path, e.g. from .p12 or pfx files. - * @note not available in Python bindings + * \note not available in Python bindings */ static QCA::KeyBundle qcaKeyBundle( const QString &path, const QString &pass ); /** Certificate validity check messages per enum. - * @note not available in Python bindings + * \note not available in Python bindings */ static QString qcaValidityMessage( QCA::Validity validity ); /** Certificate signature algorithm strings per enum. - * @note not available in Python bindings + * \note not available in Python bindings */ static QString qcaSignatureAlgorithm( QCA::SignatureAlgorithm algorithm ); /** Certificate well-known constraint strings per enum. - * @note not available in Python bindings + * \note not available in Python bindings */ static QString qcaKnownConstraint( QCA::ConstraintTypeKnown constraint ); /** Certificate usage type strings per enum - * @note not available in Python bindings + * \note not available in Python bindings */ static QString certificateUsageTypeString( QgsAuthCertUtils::CertUsageType usagetype ); @@ -234,7 +234,7 @@ class CORE_EXPORT QgsAuthCertUtils static QString sslErrorEnumString( QSslError::SslError errenum ); /** Get short strings describing SSL errors. - * @note not available in Python bindings + * \note not available in Python bindings */ static QList > sslErrorEnumStrings(); diff --git a/src/core/auth/qgsauthconfig.h b/src/core/auth/qgsauthconfig.h index e5da4e9876e5..52848c3fc39a 100644 --- a/src/core/auth/qgsauthconfig.h +++ b/src/core/auth/qgsauthconfig.h @@ -40,8 +40,8 @@ class CORE_EXPORT QgsAuthMethodConfig /** * Construct a configuration for an authentication method - * @param method Textual key of the authentication method - * @param version Version of the configuration (for updating previously saved configs later on) + * \param method Textual key of the authentication method + * \param version Version of the configuration (for updating previously saved configs later on) */ QgsAuthMethodConfig( const QString &method = QString(), int version = 0 ); @@ -53,7 +53,7 @@ class CORE_EXPORT QgsAuthMethodConfig /** * Get 'authcfg' 7-character alphanumeric ID of the config - * @note This is set by QgsAuthManager when the config is initially stored + * \note This is set by QgsAuthManager when the config is initially stored */ const QString id() const { return mId; } //! Set auth config ID @@ -79,19 +79,19 @@ class CORE_EXPORT QgsAuthMethodConfig /** * Whether the configuration is valid - * @param validateid Additionally verify the auth config ID is not empty + * \param validateid Additionally verify the auth config ID is not empty */ bool isValid( bool validateid = false ) const; /** * The extended configuration, as stored and retrieved from the authentication database - * @note This is an internal construct used by QgsAuthManager that should generally not be set by client code + * \note This is an internal construct used by QgsAuthManager that should generally not be set by client code */ const QString configString() const; /** * Load existing extended configuration - * @param configstr Configuration string to load + * \param configstr Configuration string to load */ void loadConfigString( const QString &configstr ); @@ -100,49 +100,49 @@ class CORE_EXPORT QgsAuthMethodConfig /** * Set extended configuration map - * @param map Map to set + * \param map Map to set */ void setConfigMap( const QgsStringMap &map ) { mConfigMap = map; } /** * Set a single config value per key in the map - * @note if key exists, it is replaced - * @param key Config key - * @param value Config value + * \note if key exists, it is replaced + * \param key Config key + * \param value Config value */ void setConfig( const QString &key, const QString &value ); /** * Set a multiple config values per key in the map - * @note if key exists, it is replaced - * @param key Config key - * @param value Config value + * \note if key exists, it is replaced + * \param key Config key + * \param value Config value */ void setConfigList( const QString &key, const QStringList &value ); /** * Remove a config from map - * @param key Config to remove - * @return Number of keys removed (should always be 1 or 0) + * \param key Config to remove + * \returns Number of keys removed (should always be 1 or 0) */ int removeConfig( const QString &key ); /** * Return a config's value - * @param key Config key - * @param defaultvalue Default value, if key not found + * \param key Config key + * \param defaultvalue Default value, if key not found */ QString config( const QString &key, const QString &defaultvalue = QString() ) const; /** * Return a config's list of values - * @param key + * \param key */ QStringList configList( const QString &key ) const; /** * Whether a config key exists in config map - * @param key + * \param key */ bool hasConfig( const QString &key ) const; @@ -152,10 +152,10 @@ class CORE_EXPORT QgsAuthMethodConfig /** * A utility function for generating a resource from a URL to be compared * against the config's uri() for auto-selecting authentication configs to use - * @note Essentially strips the URL query variables, and by default, strips the path as well - * @param accessurl A URL to process - * @param resource Output variable for result - * @param withpath Whether to include the URI's path in output + * \note Essentially strips the URL query variables, and by default, strips the path as well + * \param accessurl A URL to process + * \param resource Output variable for result + * \param withpath Whether to include the URI's path in output */ static bool uriToResource( const QString &accessurl, QString *resource, bool withpath = false ); @@ -190,9 +190,9 @@ class CORE_EXPORT QgsPkiBundle /** * Construct a bundle from existing PKI components - * @param clientCert Certificate to store in bundle - * @param clientKey Private key to store in bundle - * @param caChain Chain of Certificate Authorities for client certificate + * \param clientCert Certificate to store in bundle + * \param clientKey Private key to store in bundle + * \param caChain Chain of Certificate Authorities for client certificate */ QgsPkiBundle( const QSslCertificate &clientCert = QSslCertificate(), const QSslKey &clientKey = QSslKey(), @@ -200,10 +200,10 @@ class CORE_EXPORT QgsPkiBundle /** * Construct a bundle of PKI components from PEM-formatted file paths - * @param certPath Certificate file path - * @param keyPath Private key path - * @param keyPass Private key passphrase - * @param caChain Chain of Certificate Authorities for client certificate + * \param certPath Certificate file path + * \param keyPath Private key path + * \param keyPass Private key passphrase + * \param caChain Chain of Certificate Authorities for client certificate */ static const QgsPkiBundle fromPemPaths( const QString &certPath, const QString &keyPath, @@ -212,8 +212,8 @@ class CORE_EXPORT QgsPkiBundle /** * Construct a bundle of PKI components from a PKCS#12 file path - * @param bundlepath Bundle file path - * @param bundlepass Optional bundle passphrase + * \param bundlepath Bundle file path + * \param bundlepass Optional bundle passphrase */ static const QgsPkiBundle fromPkcs12Paths( const QString &bundlepath, const QString &bundlepass = QString::null ); @@ -258,9 +258,9 @@ class CORE_EXPORT QgsPkiConfigBundle /** * Construct a bundle from existing PKI components and authentication method configuration - * @param config Authentication method configuration - * @param cert Certificate to store in bundle - * @param certkey Private key to store in bundle + * \param config Authentication method configuration + * \param cert Certificate to store in bundle + * \param certkey Private key to store in bundle */ QgsPkiConfigBundle( const QgsAuthMethodConfig &config, const QSslCertificate &cert, @@ -328,12 +328,12 @@ class CORE_EXPORT QgsAuthConfigSslServer void setSslPeerVerifyMode( QSslSocket::PeerVerifyMode mode ) { mSslPeerVerifyMode = mode; } /** Number or SSL client's peer to verify in connections - * @note When set to 0 = unlimited depth + * \note When set to 0 = unlimited depth */ int sslPeerVerifyDepth() const { return mSslPeerVerifyDepth; } /** Set number or SSL client's peer to verify in connections - * @note When set to 0 = unlimited depth + * \note When set to 0 = unlimited depth */ void setSslPeerVerifyDepth( int depth ) { mSslPeerVerifyDepth = depth; } diff --git a/src/core/auth/qgsauthmanager.h b/src/core/auth/qgsauthmanager.h index b21668bab5c7..6f54e5a26750 100644 --- a/src/core/auth/qgsauthmanager.h +++ b/src/core/auth/qgsauthmanager.h @@ -67,7 +67,7 @@ class CORE_EXPORT QgsAuthManager : public QObject }; /** Enforce singleton pattern - * @note To set up the manager instance and initialize everything use QgsAuthManager::instance()->init() + * \note To set up the manager instance and initialize everything use QgsAuthManager::instance()->init() */ static QgsAuthManager *instance(); @@ -92,26 +92,26 @@ class CORE_EXPORT QgsAuthManager : public QObject const QString disabledMessage() const; /** The standard authentication database file in ~/.qgis3/ or defined location - * @see QgsApplication::qgisAuthDatabaseFilePath + * \see QgsApplication::qgisAuthDatabaseFilePath */ const QString authenticationDatabasePath() const { return mAuthDbPath; } /** Main call to initially set or continually check master password is set - * @note If it is not set, the user is asked for its input - * @param verify Whether password's hash was saved in authentication database + * \note If it is not set, the user is asked for its input + * \param verify Whether password's hash was saved in authentication database */ bool setMasterPassword( bool verify = false ); /** Overloaded call to reset master password or set it initially without user interaction - * @note Only use this in trusted reset functions, unit tests or user/app setup scripts! - * @param pass Password to use - * @param verify Whether password's hash was saved in authentication database + * \note Only use this in trusted reset functions, unit tests or user/app setup scripts! + * \param pass Password to use + * \param verify Whether password's hash was saved in authentication database */ bool setMasterPassword( const QString &pass, bool verify = false ); /** Verify the supplied master password against any existing hash in authentication database - * @note Do not emit verification signals when only comparing - * @param compare Password to compare against + * \note Do not emit verification signals when only comparing + * \param compare Password to compare against */ bool verifyMasterPassword( const QString &compare = QString::null ); @@ -122,31 +122,31 @@ class CORE_EXPORT QgsAuthManager : public QObject bool masterPasswordHashInDatabase() const; /** Clear supplied master password - * @note This will not necessarily clear authenticated connections cached in network connection managers + * \note This will not necessarily clear authenticated connections cached in network connection managers */ void clearMasterPassword() { mMasterPass = QString(); } /** Check whether supplied password is the same as the one already set - * @param pass Password to verify + * \param pass Password to verify */ bool masterPasswordSame( const QString &pass ) const; /** Reset the master password to a new one, then re-encrypt all previous * configs in a new database file, optionally backup curren database - * @param newpass New master password to replace existing - * @param oldpass Current master password to replace existing - * @param keepbackup Whether to keep the generated backup of current database - * @param backuppath Where the backup is located, if kept + * \param newpass New master password to replace existing + * \param oldpass Current master password to replace existing + * \param keepbackup Whether to keep the generated backup of current database + * \param backuppath Where the backup is located, if kept */ bool resetMasterPassword( const QString &newpass, const QString &oldpass, bool keepbackup, QString *backuppath = nullptr ); /** Whether there is a scheduled opitonal erase of authentication database. - * @note not available in Python bindings + * \note not available in Python bindings */ bool scheduledAuthDatabaseErase() { return mScheduledDbErase; } /** 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, + * \note When an erase is scheduled, any attempt to set the master password, * e.g. password input dialog, is effectively canceled. * For example: In a GUI app, this keeps excess password input dialogs from popping * up when a user has initiated an erase, from a password input dialog, because @@ -154,15 +154,15 @@ class CORE_EXPORT QgsAuthManager : public QObject * The created schedule timer will emit a request to gain access to the user, * through the given application, to prompt the erase operation (e.g. via a dialog); * if no access to user interaction occurs wihtin 90 seconds, it cancels the schedule. - * @note not available in Python bindings + * \note not available in Python bindings */ void setScheduledAuthDatabaseErase( bool scheduleErase ); /** 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, + * \note This can be called from the slot connected to a previously emitted scheduling signal, * so that the slot can ask for another emit later, if the slot noticies the current GUI * processing state is not ready for interacting with the user, e.g. project is still loading - * @param emitted Setting to false will cause signal to be emitted by the schedule timer. + * \param emitted Setting to false will cause signal to be emitted by the schedule timer. * Setting to true will stop any emitting, but will not stop the schedule timer. */ void setScheduledAuthDatabaseEraseRequestEmitted( bool emitted ) { mScheduledDbEraseRequestEmitted = emitted; } @@ -181,13 +181,13 @@ class CORE_EXPORT QgsAuthManager : public QObject /** * Get authentication method from the config/provider cache - * @param authcfg Authentication config id + * \param authcfg Authentication config id */ QgsAuthMethod *configAuthMethod( const QString &authcfg ); /** * Get key of authentication method associated with config ID - * @param authcfg + * \param authcfg */ QString configAuthMethodKey( const QString &authcfg ) const; @@ -198,27 +198,27 @@ class CORE_EXPORT QgsAuthManager : public QObject /** * Get authentication method from the config/provider cache via its key - * @param authMethodKey Authentication method key + * \param authMethodKey Authentication method key */ QgsAuthMethod *authMethod( const QString &authMethodKey ); /** * Get available authentication methods mapped to their key - * @param dataprovider Provider key filter, returning only methods that support a particular provider - * @note not available in Python bindings + * \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() ); /** * Get authentication method edit widget via its key - * @param authMethodKey Authentication method key - * @param parent Parent widget + * \param authMethodKey Authentication method key + * \param parent Parent widget */ QWidget *authMethodEditWidget( const QString &authMethodKey, QWidget *parent ); /** * Get supported authentication method expansion(s), e.g. NetworkRequest | DataSourceURI, as flags - * @param authcfg + * \param authcfg */ QgsAuthMethod::Expansions supportedAuthMethodExpansions( const QString &authcfg ); @@ -227,13 +227,13 @@ class CORE_EXPORT QgsAuthManager : public QObject /** * Verify if provided authentication id is unique - * @param id Id to check + * \param id Id to check */ bool configIdUnique( const QString &id ) const; /** * Return whether a string includes an authcfg ID token - * @param txt String to check + * \param txt String to check */ bool hasConfigId( const QString &txt ) const; @@ -245,51 +245,51 @@ class CORE_EXPORT QgsAuthManager : public QObject /** * Store an authentication config in the database - * @param mconfig Associated authentication config id - * @return Whether operation succeeded + * \param mconfig Associated authentication config id + * \returns Whether operation succeeded */ bool storeAuthenticationConfig( QgsAuthMethodConfig &mconfig ); /** * Update an authentication config in the database - * @param config Associated authentication config id - * @return Whether operation succeeded + * \param config Associated authentication config id + * \returns Whether operation succeeded */ bool updateAuthenticationConfig( const QgsAuthMethodConfig &config ); /** * Load an authentication config from the database into subclass - * @param authcfg Associated authentication config id - * @param mconfig Subclassed config to load into - * @param full Whether to decrypt and populate all sensitive data in subclass - * @return Whether operation succeeded + * \param authcfg Associated authentication config id + * \param mconfig Subclassed config to load into + * \param full Whether to decrypt and populate all sensitive data in subclass + * \returns Whether operation succeeded */ bool loadAuthenticationConfig( const QString &authcfg, QgsAuthMethodConfig &mconfig, bool full = false ); /** * Remove an authentication config in the database - * @param authcfg Associated authentication config id - * @return Whether operation succeeded + * \param authcfg Associated authentication config id + * \returns Whether operation succeeded */ bool removeAuthenticationConfig( const QString &authcfg ); /** * Clear all authentication configs from table in database and from provider caches - * @return Whether operation succeeded + * \returns Whether operation succeeded */ bool removeAllAuthenticationConfigs(); /** * Close connection to current authentication database and back it up - * @return Path to backup + * \returns Path to backup */ bool backupAuthenticationDatabase( QString *backuppath = nullptr ); /** * Erase all rows from all tables in authentication database - * @param backup Whether to backup of current database - * @param backuppath Where the backup is locate - * @return Whether operation succeeded + * \param backup Whether to backup of current database + * \param backuppath Where the backup is locate + * \returns Whether operation succeeded */ bool eraseAuthenticationDatabase( bool backup, QString *backuppath = nullptr ); @@ -298,30 +298,30 @@ class CORE_EXPORT QgsAuthManager : public QObject /** * Provider call to update a QNetworkRequest with an authentication config - * @param request The QNetworkRequest - * @param authcfg Associated authentication config id - * @param dataprovider Provider key filter, offering logic branching in authentication method - * @return Whether operation succeeded + * \param request The QNetworkRequest + * \param authcfg Associated authentication config id + * \param dataprovider Provider key filter, offering logic branching in authentication method + * \returns Whether operation succeeded */ bool updateNetworkRequest( QNetworkRequest &request, const QString &authcfg, const QString &dataprovider = QString() ); /** * Provider call to update a QNetworkReply with an authentication config (used to skip known SSL errors, etc.) - * @param reply The QNetworkReply - * @param authcfg Associated authentication config id - * @param dataprovider Provider key filter, offering logic branching in authentication method - * @return Whether operation succeeded + * \param reply The QNetworkReply + * \param authcfg Associated authentication config id + * \param dataprovider Provider key filter, offering logic branching in authentication method + * \returns Whether operation succeeded */ bool updateNetworkReply( QNetworkReply *reply, const QString &authcfg, const QString &dataprovider = QString() ); /** * Provider call to update a QgsDataSourceUri with an authentication config - * @param connectionItems The connection items, e.g. username=myname, of QgsDataSourceUri - * @param authcfg Associated authentication config id - * @param dataprovider Provider key filter, offering logic branching in authentication method - * @return Whether operation succeeded + * \param connectionItems The connection items, e.g. username=myname, of QgsDataSourceUri + * \param authcfg Associated authentication config id + * \param dataprovider Provider key filter, offering logic branching in authentication method + * \returns Whether operation succeeded */ bool updateDataSourceUriItems( QStringList &connectionItems, const QString &authcfg, const QString &dataprovider = QString() ); @@ -353,7 +353,7 @@ class CORE_EXPORT QgsAuthManager : public QObject const QSslCertificate getCertIdentity( const QString &id ); /** Get a certificate identity bundle by id (sha hash). - * @note not available in Python bindings + * \note not available in Python bindings */ const QPair getCertIdentityBundle( const QString &id ); @@ -392,7 +392,7 @@ class CORE_EXPORT QgsAuthManager : public QObject bool removeSslCertCustomConfig( const QString &id, const QString &hostport ); /** Get ignored SSL error cache, keyed with cert/connection's sha:host:port. - * @note not available in Python bindings + * \note not available in Python bindings */ QHash > getIgnoredSslErrorCache() { return mIgnoredSslErrorsCache; } @@ -437,7 +437,7 @@ class CORE_EXPORT QgsAuthManager : public QObject const QMap getMappedDatabaseCAs(); /** Get all CA certs mapped to their sha1 from cache. - * @note not available in Python bindings + * \note not available in Python bindings */ const QMap > getCaCertsCache() { @@ -451,7 +451,7 @@ class CORE_EXPORT QgsAuthManager : public QObject bool storeCertTrustPolicy( const QSslCertificate &cert, QgsAuthCertUtils::CertTrustPolicy policy ); /** Get a whether certificate is trusted by user - @return DefaultTrust if certificate sha not in trust table, i.e. follows default trust policy + \returns DefaultTrust if certificate sha not in trust table, i.e. follows default trust policy */ QgsAuthCertUtils::CertTrustPolicy getCertTrustPolicy( const QSslCertificate &cert ); @@ -500,16 +500,16 @@ class CORE_EXPORT QgsAuthManager : public QObject /** * Custom logging signal to relay to console output and QgsMessageLog - * @see QgsMessageLog - * @param message Message to send - * @param tag Associated tag (title) - * @param level Message log level + * \see QgsMessageLog + * \param message Message to send + * \param tag Associated tag (title) + * \param level Message log level */ void messageOut( const QString &message, const QString &tag = AUTH_MAN_TAG, QgsAuthManager::MessageLevel level = INFO ) const; /** * Emitted when a password has been verify (or not) - * @param verified The state of password's verification + * \param verified The state of password's verification */ void masterPasswordVerified( bool verified ) const; diff --git a/src/core/auth/qgsauthmethod.h b/src/core/auth/qgsauthmethod.h index f1b9f49abee1..7b2356d43665 100644 --- a/src/core/auth/qgsauthmethod.h +++ b/src/core/auth/qgsauthmethod.h @@ -41,8 +41,8 @@ class CORE_EXPORT QgsAuthMethod : public QObject * supported by an authentication method. These equate to the 'update*()' virtual functions * below, and allow for update point code to skip calling an unused update by a method, because * the base virtual function will always return true, giving a false impression an update occurred. - * @note When adding an 'update' member function, also add the corresponding Expansion flag. - * @note These flags will be added to as new update points are added + * \note When adding an 'update' member function, also add the corresponding Expansion flag. + * \note These flags will be added to as new update points are added */ enum Expansion { @@ -69,7 +69,7 @@ class CORE_EXPORT QgsAuthMethod : public QObject /** Flags that represent the update points (where authentication configurations are expanded) * supported by an authentication method. - * @note These should directly correlate to existing 'update*()' member functions + * \note These should directly correlate to existing 'update*()' member functions */ QgsAuthMethod::Expansions supportedExpansions() const { return mExpansions; } @@ -79,11 +79,11 @@ class CORE_EXPORT QgsAuthMethod : public QObject QStringList supportedDataProviders() const { return mDataProviders; } /** Update a network request with authentication components - * @param request The network request to update - * @param authcfg Authentication configuration ID - * @param dataprovider Textual key for a data provider, e.g. 'postgres', that allows + * \param request The network request to update + * \param authcfg Authentication configuration ID + * \param dataprovider Textual key for a data provider, e.g. 'postgres', that allows * for custom updater code specific to the provider - * @return Whether the update succeeded + * \returns Whether the update succeeded */ virtual bool updateNetworkRequest( QNetworkRequest &request, const QString &authcfg, const QString &dataprovider = QString() ) @@ -95,11 +95,11 @@ class CORE_EXPORT QgsAuthMethod : public QObject } /** Update a network reply with authentication components - * @param reply The network reply object to update - * @param authcfg Authentication configuration ID - * @param dataprovider Textual key for a data provider, e.g. 'postgres', that allows + * \param reply The network reply object to update + * \param authcfg Authentication configuration ID + * \param dataprovider Textual key for a data provider, e.g. 'postgres', that allows * for custom updater code specific to the provider - * @return Whether the update succeeded + * \returns Whether the update succeeded */ virtual bool updateNetworkReply( QNetworkReply *reply, const QString &authcfg, const QString &dataprovider = QString() ) @@ -111,11 +111,11 @@ class CORE_EXPORT QgsAuthMethod : public QObject } /** Update data source connection items with authentication components - * @param connectionItems QStringlist of 'key=value' pairs, as utilized in QgsDataSourceUri::connectionInfo() - * @param authcfg Authentication configuration ID - * @param dataprovider Textual key for a data provider, e.g. 'postgres', that allows + * \param connectionItems QStringlist of 'key=value' pairs, as utilized in QgsDataSourceUri::connectionInfo() + * \param authcfg Authentication configuration ID + * \param dataprovider Textual key for a data provider, e.g. 'postgres', that allows * for custom updater code specific to the provider - * @return Whether the update succeeded + * \returns Whether the update succeeded */ virtual bool updateDataSourceUriItems( QStringList &connectionItems, const QString &authcfg, const QString &dataprovider = QString() ) @@ -127,14 +127,14 @@ class CORE_EXPORT QgsAuthMethod : public QObject } /** Clear any cached configuration. Called when the QgsAuthManager deletes an authentication configuration (authcfg). - * @note It is highly recommended that a cache of authentication components (per requested authcfg) + * \note It is highly recommended that a cache of authentication components (per requested authcfg) * be implemented, to avoid excessive queries on the auth database. Such a cache could be as * simple as a QHash or QMap of authcfg -> QgsAuthMethodConfig. See 'Basic' auth method plugin for example. */ virtual void clearCachedConfig( const QString &authcfg ) = 0; /** Update an authentication configuration in place - * @note Useful for updating previously stored authcfgs, when an authentication method has been significantly updated + * \note Useful for updating previously stored authcfgs, when an authentication method has been significantly updated */ virtual void updateMethodConfig( QgsAuthMethodConfig &mconfig ) = 0; @@ -142,7 +142,7 @@ class CORE_EXPORT QgsAuthMethod : public QObject /** * Construct a default authentication method - * @note Non-public since this is an abstract base class + * \note Non-public since this is an abstract base class */ explicit QgsAuthMethod() : mExpansions( QgsAuthMethod::Expansions( nullptr ) ) diff --git a/src/core/auth/qgsauthmethodmetadata.h b/src/core/auth/qgsauthmethodmetadata.h index 087de74fdb27..8de33d640c38 100644 --- a/src/core/auth/qgsauthmethodmetadata.h +++ b/src/core/auth/qgsauthmethodmetadata.h @@ -40,9 +40,9 @@ class CORE_EXPORT QgsAuthMethodMetadata /** * Construct an authentication method metadata container - * @param _key Textual key of the library plugin - * @param _description Description of the library plugin - * @param _library File name of library plugin + * \param _key Textual key of the library plugin + * \param _description Description of the library plugin + * \param _library File name of library plugin */ QgsAuthMethodMetadata( const QString &_key, const QString &_description, const QString &_library ); diff --git a/src/core/auth/qgsauthmethodregistry.h b/src/core/auth/qgsauthmethodregistry.h index 6d0a61f50a45..d42a1d5a63d2 100644 --- a/src/core/auth/qgsauthmethodregistry.h +++ b/src/core/auth/qgsauthmethodregistry.h @@ -62,26 +62,26 @@ class CORE_EXPORT QgsAuthMethodRegistry void setLibraryDirectory( const QDir &path ); /** Create an instance of the auth method - @param authMethodKey identificator of the auth method - @return instance of auth method or nullptr on error + \param authMethodKey identificator of the auth method + \returns instance of auth method or nullptr on error */ QgsAuthMethod *authMethod( const QString &authMethodKey ); /** Return the auth method capabilities - @param authMethodKey identificator of the auth method + \param authMethodKey identificator of the auth method */ // int authMethodCapabilities( const QString& authMethodKey ) const; /** Return the GUI edit widget associated with the auth method - * @param parent Parent widget - * @param authMethodKey identificator of the auth method + * \param parent Parent widget + * \param authMethodKey identificator of the auth method */ QWidget *editWidget( const QString &authMethodKey, QWidget *parent = nullptr ); /** Get pointer to auth method function - @param authMethodKey identificator of the auth method - @param functionName name of function - @return pointer to function or nullptr on error + \param authMethodKey identificator of the auth method + \param functionName name of function + \returns pointer to function or nullptr on error */ QFunctionPointer function( const QString &authMethodKey, const QString &functionName ); diff --git a/src/core/composer/qgsatlascomposition.h b/src/core/composer/qgsatlascomposition.h index 64616479e628..f6a730330038 100644 --- a/src/core/composer/qgsatlascomposition.h +++ b/src/core/composer/qgsatlascomposition.h @@ -37,7 +37,7 @@ class QgsExpressionContext; * Class used to render an Atlas, iterating over geometry features. * prepareForFeature() modifies the atlas map's extent to zoom on the given feature. * This class is used for printing, exporting to PDF and images. - * @note This class should not be created directly. For the atlas to function correctly + * \note This class should not be created directly. For the atlas to function correctly * the atlasComposition() property for QgsComposition should be used to retrieve a * QgsAtlasComposition which is automatically created and attached to the composition. */ @@ -48,103 +48,103 @@ class CORE_EXPORT QgsAtlasComposition : public QObject QgsAtlasComposition( QgsComposition *composition ); /** Returns whether the atlas generation is enabled - * @returns true if atlas is enabled - * @see setEnabled + * \returns true if atlas is enabled + * \see setEnabled */ bool enabled() const { return mEnabled; } /** Sets whether the atlas is enabled - * @param enabled set to true to enable to atlas - * @see enabled + * \param enabled set to true to enable to atlas + * \see enabled */ void setEnabled( bool enabled ); /** Returns true if the atlas is set to hide the coverage layer - * @returns true if coverage layer is hidden - * @see setHideCoverage + * \returns true if coverage layer is hidden + * \see setHideCoverage */ bool hideCoverage() const { return mHideCoverage; } /** Sets whether the coverage layer should be hidden in map items in the composition - * @param hide set to true to hide the coverage layer - * @see hideCoverage + * \param hide set to true to hide the coverage layer + * \see hideCoverage */ void setHideCoverage( bool hide ); /** Returns the filename expression used for generating output filenames for each * atlas page. - * @returns filename pattern - * @see setFilenamePattern - * @see filenamePatternErrorString - * @note This property has no effect when exporting to PDF if singleFile() is true + * \returns filename pattern + * \see setFilenamePattern + * \see filenamePatternErrorString + * \note This property has no effect when exporting to PDF if singleFile() is true */ QString filenamePattern() const { return mFilenamePattern; } /** Sets the filename expression used for generating output filenames for each * atlas page. - * @returns true if filename expression could be successful set, false if expression is invalid - * @param pattern expression to use for output filenames - * @see filenamePattern - * @see filenamePatternErrorString - * @note This method has no effect when exporting to PDF if singleFile() is true + * \returns true if filename expression could be successful set, false if expression is invalid + * \param pattern expression to use for output filenames + * \see filenamePattern + * \see filenamePatternErrorString + * \note This method has no effect when exporting to PDF if singleFile() is true */ bool setFilenamePattern( const QString &pattern ); /** Returns an error string from parsing the filename expression. - * @returns filename pattern parser error - * @see setFilenamePattern - * @see filenamePattern + * \returns filename pattern parser error + * \see setFilenamePattern + * \see filenamePattern */ QString filenamePatternErrorString() const { return mFilenameParserError; } /** Returns the coverage layer used for the atlas features - * @returns atlas coverage layer - * @see setCoverageLayer + * \returns atlas coverage layer + * \see setCoverageLayer */ QgsVectorLayer *coverageLayer() const { return mCoverageLayer; } /** Sets the coverage layer to use for the atlas features - * @param layer vector coverage layer - * @see coverageLayer + * \param layer vector coverage layer + * \see coverageLayer */ void setCoverageLayer( QgsVectorLayer *layer ); /** Returns the expression used for calculating the page name. - * @returns expression string, or field name from coverage layer - * @see setPageNameExpression - * @see nameForPage + * \returns expression string, or field name from coverage layer + * \see setPageNameExpression + * \see nameForPage * \since QGIS 2.12 */ QString pageNameExpression() const { return mPageNameExpression; } /** Sets the expression used for calculating the page name. - * @param pageNameExpression expression string, or field name from coverage layer - * @see pageNameExpression + * \param pageNameExpression expression string, or field name from coverage layer + * \see pageNameExpression * \since QGIS 2.12 */ void setPageNameExpression( const QString &pageNameExpression ) { mPageNameExpression = pageNameExpression; } /** Returns the calculated name for a specified atlas page number. - * @param pageNumber number of page, where 0 = first page - * @returns page name - * @see pageNameExpression + * \param pageNumber number of page, where 0 = first page + * \returns page name + * \see pageNameExpression * \since QGIS 2.12 */ QString nameForPage( int pageNumber ) const; /** Returns whether the atlas will be exported to a single file. This is only * applicable for PDF exports. - * @returns true if atlas will be exported to a single file - * @see setSingleFile - * @note This property is only used for PDF exports. + * \returns true if atlas will be exported to a single file + * \see setSingleFile + * \note This property is only used for PDF exports. */ bool singleFile() const { return mSingleFile; } /** Sets whether the atlas should be exported to a single file. This is only * applicable for PDF exports. - * @param single set to true to export atlas to a single file. - * @see singleFile - * @note This method is only used for PDF exports. + * \param single set to true to export atlas to a single file. + * \see singleFile + * \note This method is only used for PDF exports. */ void setSingleFile( bool single ) { mSingleFile = single; } @@ -161,9 +161,9 @@ class CORE_EXPORT QgsAtlasComposition : public QObject void setFeatureFilter( const QString &expression ) { mFeatureFilter = expression; } /** Returns an error string from parsing the feature filter expression. - * @returns filename pattern parser error - * @see setFilenamePattern - * @see filenamePattern + * \returns filename pattern parser error + * \see setFilenamePattern + * \see filenamePattern */ QString featureFilterErrorString() const { return mFilterParserError; } @@ -172,17 +172,17 @@ class CORE_EXPORT QgsAtlasComposition : public QObject /** Returns the current list of predefined scales for the atlas. This is used * for maps which are set to the predefined atlas scaling mode. - * @returns a vector of doubles representing predefined scales - * @see setPredefinedScales - * @see QgsComposerMap::atlasScalingMode + * \returns a vector of doubles representing predefined scales + * \see setPredefinedScales + * \see QgsComposerMap::atlasScalingMode */ QVector predefinedScales() const { return mPredefinedScales; } /** Sets the list of predefined scales for the atlas. This is used * for maps which are set to the predefined atlas scaling mode. - * @param scales a vector of doubles representing predefined scales - * @see predefinedScales - * @see QgsComposerMap::atlasScalingMode + * \param scales a vector of doubles representing predefined scales + * \see predefinedScales + * \see QgsComposerMap::atlasScalingMode */ void setPredefinedScales( const QVector &scales ); @@ -196,14 +196,14 @@ class CORE_EXPORT QgsAtlasComposition : public QObject int numFeatures() const; /** Prepare the atlas map for the given feature. Sets the extent and context variables - * @param i feature number - * @param updateMaps set to true to redraw maps and recalculate their extent - * @returns true if feature was successfully prepared + * \param i feature number + * \param updateMaps set to true to redraw maps and recalculate their extent + * \returns true if feature was successfully prepared */ bool prepareForFeature( const int i, const bool updateMaps = true ); /** Prepare the atlas map for the given feature. Sets the extent and context variables - * @returns true if feature was successfully prepared + * \returns true if feature was successfully prepared */ bool prepareForFeature( const QgsFeature *feat ); @@ -213,10 +213,10 @@ class CORE_EXPORT QgsAtlasComposition : public QObject void writeXml( QDomElement &elem, QDomDocument &doc ) const; /** Reads general atlas settings from xml - * @param elem a QDomElement holding the atlas properties. - * @param doc QDomDocument for the source xml. - * @see readXMLMapSettings - * @note This method should be called before restoring composer item properties + * \param elem a QDomElement holding the atlas properties. + * \param doc QDomDocument for the source xml. + * \see readXMLMapSettings + * \note This method should be called before restoring composer item properties */ void readXml( const QDomElement &elem, const QDomDocument &doc ); @@ -290,12 +290,12 @@ class CORE_EXPORT QgsAtlasComposition : public QObject private: /** Updates the filename expression. - * @returns true if expression was successfully parsed, false if expression is invalid + * \returns true if expression was successfully parsed, false if expression is invalid */ bool updateFilenameExpression(); /** Evaluates filename for current feature - * @returns true if feature filename was successfully evaluated + * \returns true if feature filename was successfully evaluated */ bool evalFeatureFilename( const QgsExpressionContext &context ); diff --git a/src/core/composer/qgscomposerarrow.h b/src/core/composer/qgscomposerarrow.h index 34000efb6e02..8bff70af36b6 100644 --- a/src/core/composer/qgscomposerarrow.h +++ b/src/core/composer/qgscomposerarrow.h @@ -42,14 +42,14 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem }; /** Constructor - * @param c parent composition + * \param c parent composition */ QgsComposerArrow( QgsComposition *c ); /** Constructor - * @param startPoint start point for line - * @param stopPoint end point for line - * @param c parent composition + * \param startPoint start point for line + * \param stopPoint end point for line + * \param c parent composition */ QgsComposerArrow( QPointF startPoint, QPointF stopPoint, QgsComposition *c ); @@ -66,128 +66,128 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem void setSceneRect( const QRectF &rectangle ) override; /** Sets the width of the arrow head in mm - * @param width width of arrow head - * @see arrowHeadWidth + * \param width width of arrow head + * \see arrowHeadWidth */ void setArrowHeadWidth( double width ); /** Returns the width of the arrow head in mm - * @returns width of arrow head - * @see setArrowHeadWidth + * \returns width of arrow head + * \see setArrowHeadWidth */ double arrowHeadWidth() const { return mArrowHeadWidth; } /** Sets the marker to draw at the start of the line - * @param svgPath file path for svg marker graphic to draw - * @see startMarker - * @see setEndMarker + * \param svgPath file path for svg marker graphic to draw + * \see startMarker + * \see setEndMarker */ void setStartMarker( const QString &svgPath ); /** Returns the marker drawn at the start of the line - * @returns file path for svg marker graphic - * @see setStartMarker - * @see endMarker + * \returns file path for svg marker graphic + * \see setStartMarker + * \see endMarker */ QString startMarker() const { return mStartMarkerFile; } /** Sets the marker to draw at the end of the line - * @param svgPath file path for svg marker graphic to draw - * @see endMarker - * @see setStartMarker + * \param svgPath file path for svg marker graphic to draw + * \see endMarker + * \see setStartMarker */ void setEndMarker( const QString &svgPath ); /** Returns the marker drawn at the end of the line - * @returns file path for svg marker graphic - * @see setEndMarker - * @see startMarker + * \returns file path for svg marker graphic + * \see setEndMarker + * \see startMarker */ QString endMarker() const { return mEndMarkerFile; } /** Returns the color used to draw stroke around the the arrow head. - * @returns arrow head stroke color - * @see arrowHeadFillColor - * @see setArrowHeadStrokeColor + * \returns arrow head stroke color + * \see arrowHeadFillColor + * \see setArrowHeadStrokeColor * \since QGIS 2.5 */ QColor arrowHeadStrokeColor() const { return mArrowHeadStrokeColor; } /** Sets the color used to draw the stroke around the arrow head. - * @param color arrow head stroke color - * @see setArrowHeadFillColor - * @see arrowHeadStrokeColor + * \param color arrow head stroke color + * \see setArrowHeadFillColor + * \see arrowHeadStrokeColor * \since QGIS 2.5 */ void setArrowHeadStrokeColor( const QColor &color ); /** Returns the color used to fill the arrow head. - * @returns arrow head fill color - * @see arrowHeadStrokeColor - * @see setArrowHeadFillColor + * \returns arrow head fill color + * \see arrowHeadStrokeColor + * \see setArrowHeadFillColor * \since QGIS 2.5 */ QColor arrowHeadFillColor() const { return mArrowHeadFillColor; } /** Sets the color used to fill the arrow head. - * @param color arrow head fill color - * @see arrowHeadFillColor - * @see setArrowHeadStrokeColor + * \param color arrow head fill color + * \see arrowHeadFillColor + * \see setArrowHeadStrokeColor * \since QGIS 2.5 */ void setArrowHeadFillColor( const QColor &color ); /** Sets the pen width for the stroke of the arrow head - * @param width pen width for arrow head stroke - * @see arrowHeadStrokeWidth - * @see setArrowHeadStrokeColor + * \param width pen width for arrow head stroke + * \see arrowHeadStrokeWidth + * \see setArrowHeadStrokeColor * \since QGIS 2.5 */ void setArrowHeadStrokeWidth( const double width ); /** Returns the pen width for the stroke of the arrow head - * @returns pen width for arrow head stroke - * @see setArrowHeadStrokeWidth - * @see arrowHeadStrokeColor + * \returns pen width for arrow head stroke + * \see setArrowHeadStrokeWidth + * \see arrowHeadStrokeColor * \since QGIS 2.5 */ double arrowHeadStrokeWidth() const { return mArrowHeadStrokeWidth; } /** Sets the line symbol used for drawing the line portion of the arrow - * @param symbol line symbol - * @see lineSymbol + * \param symbol line symbol + * \see lineSymbol * \since QGIS 2.5 */ void setLineSymbol( QgsLineSymbol *symbol ); /** Returns the line symbol used for drawing the line portion of the arrow - * @returns line symbol - * @see setLineSymbol + * \returns line symbol + * \see setLineSymbol * \since QGIS 2.5 */ QgsLineSymbol *lineSymbol() { return mLineSymbol; } /** Returns marker mode, which controls how the arrow endpoints are drawn - * @returns marker mode - * @see setMarkerMode + * \returns marker mode + * \see setMarkerMode */ MarkerMode markerMode() const { return mMarkerMode; } /** Sets the marker mode, which controls how the arrow endpoints are drawn - * @param mode marker mode - * @see setMarkerMode + * \param mode marker mode + * \see setMarkerMode */ void setMarkerMode( MarkerMode mode ); /** Stores state in DOM element - * @param elem is DOM element corresponding to 'Composer' tag - * @param doc document + * \param elem is DOM element corresponding to 'Composer' tag + * \param doc document */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; /** Sets state from DOM document - * @param itemElem is DOM node corresponding to item tag - * @param doc is the document to read + * \param itemElem is DOM node corresponding to item tag + * \param doc is the document to read */ bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override; diff --git a/src/core/composer/qgscomposerattributetablemodelv2.h b/src/core/composer/qgscomposerattributetablemodelv2.h index 66dc634381b2..f57522862ee2 100644 --- a/src/core/composer/qgscomposerattributetablemodelv2.h +++ b/src/core/composer/qgscomposerattributetablemodelv2.h @@ -46,8 +46,8 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM }; /** Constructor for QgsComposerAttributeTableColumnModel. - * @param composerTable QgsComposerAttributeTable the model is attached to - * @param parent optional parent + * \param composerTable QgsComposerAttributeTable the model is attached to + * \param parent optional parent */ QgsComposerAttributeTableColumnModelV2( QgsComposerAttributeTableV2 *composerTable, QObject *parent = nullptr ); @@ -64,9 +64,9 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM /** Moves the specified row up or down in the model. Used for rearranging the attribute tables * columns. - * @returns true if the move is allowed - * @param row row in model representing attribute table column to move - * @param direction direction to move the attribute table column + * \returns true if the move is allowed + * \param row row in model representing attribute table column to move + * \param direction direction to move the attribute table column * \since QGIS 2.3 */ bool moveRow( int row, ShiftDirection direction ); @@ -78,44 +78,44 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM void resetToLayer(); /** Returns the QgsComposerTableColumn corresponding to an index in the model. - * @returns QgsComposerTableColumn for specified index - * @param index a QModelIndex + * \returns QgsComposerTableColumn for specified index + * \param index a QModelIndex * \since QGIS 2.3 - * @see indexFromColumn + * \see indexFromColumn */ QgsComposerTableColumn *columnFromIndex( const QModelIndex &index ) const; /** Returns a QModelIndex corresponding to a QgsComposerTableColumn in the model. - * @returns QModelIndex for specified QgsComposerTableColumn - * @param column a QgsComposerTableColumn + * \returns QModelIndex for specified QgsComposerTableColumn + * \param column a QgsComposerTableColumn * \since QGIS 2.3 - * @see columnFromIndex + * \see columnFromIndex */ QModelIndex indexFromColumn( QgsComposerTableColumn *column ); /** Sets a specified column as a sorted column in the QgsComposerAttributeTable. The column will be * added to the end of the sort rank list, ie it will take the next largest available sort rank. - * @param column a QgsComposerTableColumn - * @param order sort order for column + * \param column a QgsComposerTableColumn + * \param order sort order for column * \since QGIS 2.3 - * @see removeColumnFromSort - * @see moveColumnInSortRank + * \see removeColumnFromSort + * \see moveColumnInSortRank */ void setColumnAsSorted( QgsComposerTableColumn *column, Qt::SortOrder order ); /** Sets a specified column as an unsorted column in the QgsComposerAttributeTable. The column will be * removed from the sort rank list. - * @param column a QgsComposerTableColumn + * \param column a QgsComposerTableColumn * \since QGIS 2.3 - * @see setColumnAsSorted + * \see setColumnAsSorted */ void setColumnAsUnsorted( QgsComposerTableColumn *column ); /** Moves a column up or down in the sort rank for the QgsComposerAttributeTable. - * @param column a QgsComposerTableColumn - * @param direction direction to move the column in the sort rank list + * \param column a QgsComposerTableColumn + * \param direction direction to move the column in the sort rank list * \since QGIS 2.3 - * @see setColumnAsSorted + * \see setColumnAsSorted */ bool moveColumnInSortRank( QgsComposerTableColumn *column, ShiftDirection direction ); @@ -145,9 +145,9 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro }; /** Constructor for QgsComposerTableSortColumnsProxyModel. - * @param composerTable QgsComposerAttributeTable the model is attached to - * @param filterType filter for columns, controls whether sorted or unsorted columns are shown - * @param parent optional parent + * \param composerTable QgsComposerAttributeTable the model is attached to + * \param filterType filter for columns, controls whether sorted or unsorted columns are shown + * \param parent optional parent */ QgsComposerTableSortColumnsProxyModelV2( QgsComposerAttributeTableV2 *composerTable, ColumnFilterType filterType, QObject *parent = nullptr ); @@ -159,29 +159,29 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro virtual bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ) override; /** Returns the QgsComposerTableColumn corresponding to a row in the proxy model. - * @returns QgsComposerTableColumn for specified row - * @param row a row number + * \returns QgsComposerTableColumn for specified row + * \param row a row number * \since QGIS 2.3 - * @see columnFromIndex + * \see columnFromIndex */ QgsComposerTableColumn *columnFromRow( int row ); /** Returns the QgsComposerTableColumn corresponding to an index in the proxy model. - * @returns QgsComposerTableColumn for specified index - * @param index a QModelIndex + * \returns QgsComposerTableColumn for specified index + * \param index a QModelIndex * \since QGIS 2.3 - * @see columnFromRow - * @see columnFromSourceIndex + * \see columnFromRow + * \see columnFromSourceIndex */ QgsComposerTableColumn *columnFromIndex( const QModelIndex &index ) const; /** Returns the QgsComposerTableColumn corresponding to an index from the source * QgsComposerAttributeTableColumnModel model. - * @returns QgsComposerTableColumn for specified index from QgsComposerAttributeTableColumnModel - * @param sourceIndex a QModelIndex + * \returns QgsComposerTableColumn for specified index from QgsComposerAttributeTableColumnModel + * \param sourceIndex a QModelIndex * \since QGIS 2.3 - * @see columnFromRow - * @see columnFromIndex + * \see columnFromRow + * \see columnFromIndex */ QgsComposerTableColumn *columnFromSourceIndex( const QModelIndex &sourceIndex ) const; @@ -198,7 +198,7 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro ColumnFilterType mFilterType; /** Returns a list of QgsComposerTableColumns without a set sort rank - * @returns QgsComposerTableColumns in attribute table without a sort rank + * \returns QgsComposerTableColumns in attribute table without a sort rank * \since QGIS 2.3 */ QList columnsWithoutSortRank() const; diff --git a/src/core/composer/qgscomposerattributetablev2.h b/src/core/composer/qgscomposerattributetablev2.h index 7704ec2a6cc2..0e0ac2cfb864 100644 --- a/src/core/composer/qgscomposerattributetablev2.h +++ b/src/core/composer/qgscomposerattributetablev2.h @@ -34,12 +34,12 @@ class CORE_EXPORT QgsComposerAttributeTableCompareV2 bool operator()( const QgsComposerTableRow &m1, const QgsComposerTableRow &m2 ); /** Sets column number to sort by - * @param col column number for sorting + * \param col column number for sorting */ void setSortColumn( int col ) { mCurrentSortColumn = col; } /** Sets sort order for column sorting - * @param asc set to true to sort in ascending order, false to sort in descending order + * \param asc set to true to sort in ascending order, false to sort in descending order */ void setAscending( bool asc ) { mAscending = asc; } @@ -72,32 +72,32 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 virtual QString displayName() const override; /** Writes properties specific to attribute tables - * @param elem an existing QDomElement in which to store the attribute table's properties. - * @param doc QDomDocument for the destination xml. - * @param ignoreFrames ignore frames - * @see readXml + * \param elem an existing QDomElement in which to store the attribute table's properties. + * \param doc QDomDocument for the destination xml. + * \param ignoreFrames ignore frames + * \see readXml */ virtual bool writeXml( QDomElement &elem, QDomDocument &doc, bool ignoreFrames = false ) const override; /** Reads the properties specific to an attribute table from xml. - * @param itemElem a QDomElement holding the attribute table's desired properties. - * @param doc QDomDocument for the source xml. - * @param ignoreFrames ignore frames - * @see writeXml + * \param itemElem a QDomElement holding the attribute table's desired properties. + * \param doc QDomDocument for the source xml. + * \param ignoreFrames ignore frames + * \see writeXml */ virtual bool readXml( const QDomElement &itemElem, const QDomDocument &doc, bool ignoreFrames = false ) override; virtual void addFrame( QgsComposerFrame *frame, bool recalcFrameSizes = true ) override; /** Sets the source for attributes to show in table body. - * @param source content source - * @see source + * \param source content source + * \see source */ void setSource( const ContentSource source ); /** Returns the source for attributes shown in the table body. - * @returns content source - * @see setSource + * \returns content source + * \see setSource */ ContentSource source() const { return mSource; } @@ -105,40 +105,40 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 * if the table is set to atlas feature mode, then the source layer will be the * atlas coverage layer. If the table is set to layer attributes mode, then * the source layer will be the user specified vector layer. - * @returns actual source layer + * \returns actual source layer */ QgsVectorLayer *sourceLayer(); /** Sets the vector layer from which to display feature attributes - * @param layer Vector layer for attribute table - * @see vectorLayer + * \param layer Vector layer for attribute table + * \see vectorLayer */ void setVectorLayer( QgsVectorLayer *layer ); /** Returns the vector layer the attribute table is currently using - * @returns attribute table's current vector layer - * @see setVectorLayer + * \returns attribute table's current vector layer + * \see setVectorLayer */ QgsVectorLayer *vectorLayer() const { return mVectorLayer; } /** Sets the relation id from which to display child features - * @param relationId id for relation to display child features from - * @see relationId - * @see setSource - * @note only used if table source is set to RelationChildren + * \param relationId id for relation to display child features from + * \see relationId + * \see setSource + * \note only used if table source is set to RelationChildren */ void setRelationId( const QString &relationId ); /** Returns the relation id which the table displays child features from - * @returns relation id - * @see setRelationId - * @see source - * @note only used if table source is set to RelationChildren + * \returns relation id + * \see setRelationId + * \see source + * \note only used if table source is set to RelationChildren */ QString relationId() const { return mRelationId; } /** Resets the attribute table's columns to match the vector layer's fields - * @see setVectorLayer + * \see setVectorLayer */ void resetColumns(); @@ -147,101 +147,101 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 * set to true. Changing the composer map forces the table to refetch features from its * vector layer, and may result in the table changing size to accommodate the new displayed * feature attributes. - * @param map QgsComposerMap which drives the extents of the table's features - * @see composerMap - * @see setDisplayOnlyVisibleFeatures + * \param map QgsComposerMap which drives the extents of the table's features + * \see composerMap + * \see setDisplayOnlyVisibleFeatures */ void setComposerMap( const QgsComposerMap *map ); /** Returns the composer map whose extents are controlling the features shown in the * table. The extents of the map are only used if displayOnlyVisibleFeatures() is true. - * @returns composer map controlling the attribute table - * @see setComposerMap - * @see displayOnlyVisibleFeatures + * \returns composer map controlling the attribute table + * \see setComposerMap + * \see displayOnlyVisibleFeatures */ const QgsComposerMap *composerMap() const { return mComposerMap; } /** Sets the maximum number of features shown by the table. Changing this setting may result * in the attribute table changing its size to accommodate the new number of rows, and requires * the table to refetch features from its vector layer. - * @param features maximum number of features to show in the table - * @see maximumNumberOfFeatures + * \param features maximum number of features to show in the table + * \see maximumNumberOfFeatures */ void setMaximumNumberOfFeatures( const int features ); /** Returns the maximum number of features to be shown by the table. - * @returns maximum number of features - * @see setMaximumNumberOfFeatures + * \returns maximum number of features + * \see setMaximumNumberOfFeatures */ int maximumNumberOfFeatures() const { return mMaximumNumberOfFeatures; } /** Sets attribute table to only show unique rows. - * @param uniqueOnly set to true to show only unique rows. Duplicate rows + * \param uniqueOnly set to true to show only unique rows. Duplicate rows * will be stripped from the table. - * @see uniqueRowsOnly + * \see uniqueRowsOnly */ void setUniqueRowsOnly( const bool uniqueOnly ); /** Returns true if the table is set to show only unique rows. - * @returns true if table only shows unique rows and is stripping out + * \returns true if table only shows unique rows and is stripping out * duplicate rows. - * @see setUniqueRowsOnly + * \see setUniqueRowsOnly */ bool uniqueRowsOnly() const { return mShowUniqueRowsOnly; } /** Sets attribute table to only show features which are visible in a composer map item. Changing * this setting forces the table to refetch features from its vector layer, and may result in * the table changing size to accommodate the new displayed feature attributes. - * @param visibleOnly set to true to show only visible features - * @see displayOnlyVisibleFeatures - * @see setComposerMap + * \param visibleOnly set to true to show only visible features + * \see displayOnlyVisibleFeatures + * \see setComposerMap */ void setDisplayOnlyVisibleFeatures( const bool visibleOnly ); /** Returns true if the table is set to show only features visible on a corresponding * composer map item. - * @returns true if table only shows visible features - * @see composerMap - * @see setDisplayOnlyVisibleFeatures + * \returns true if table only shows visible features + * \see composerMap + * \see setDisplayOnlyVisibleFeatures */ bool displayOnlyVisibleFeatures() const { return mShowOnlyVisibleFeatures; } /** Sets attribute table to only show features which intersect the current atlas * feature. - * @param filterToAtlas set to true to show only features which intersect + * \param filterToAtlas set to true to show only features which intersect * the atlas feature - * @see filterToAtlasFeature + * \see filterToAtlasFeature */ void setFilterToAtlasFeature( const bool filterToAtlas ); /** Returns true if the table is set to only show features which intersect the current atlas * feature. - * @returns true if table only shows features which intersect the atlas feature - * @see setFilterToAtlasFeature + * \returns true if table only shows features which intersect the atlas feature + * \see setFilterToAtlasFeature */ bool filterToAtlasFeature() const { return mFilterToAtlasIntersection; } /** Returns true if a feature filter is active on the attribute table - * @returns bool state of the feature filter - * @see setFilterFeatures - * @see featureFilter + * \returns bool state of the feature filter + * \see setFilterFeatures + * \see featureFilter */ bool filterFeatures() const { return mFilterFeatures; } /** Sets whether the feature filter is active for the attribute table. Changing * this setting forces the table to refetch features from its vector layer, and may result in * the table changing size to accommodate the new displayed feature attributes. - * @param filter Set to true to enable the feature filter - * @see filterFeatures - * @see setFeatureFilter + * \param filter Set to true to enable the feature filter + * \see filterFeatures + * \see setFeatureFilter */ void setFilterFeatures( const bool filter ); /** Returns the current expression used to filter features for the table. The filter is only * active if filterFeatures() is true. - * @returns feature filter expression - * @see setFeatureFilter - * @see filterFeatures + * \returns feature filter expression + * \see setFeatureFilter + * \see filterFeatures */ QString featureFilter() const { return mFeatureFilter; } @@ -249,16 +249,16 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 * active if filterFeatures() is set to true. Changing this setting forces the table * to refetch features from its vector layer, and may result in * the table changing size to accommodate the new displayed feature attributes. - * @param expression filter to use for selecting which features to display in the table - * @see featureFilter - * @see setFilterFeatures + * \param expression filter to use for selecting which features to display in the table + * \see featureFilter + * \see setFilterFeatures */ void setFeatureFilter( const QString &expression ); /** Sets the attributes to display in the table. - * @param fields list of fields names from the vector layer to show. + * \param fields list of fields names from the vector layer to show. * Set to an empty list to show all feature attributes. - * @param refresh set to true to force the table to refetch features from its vector layer + * \param refresh set to true to force the table to refetch features from its vector layer * and immediately update the display of the table. This may result in the table changing size * to accommodate the new displayed feature attributes. * \since QGIS 2.16 @@ -266,33 +266,33 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 void setDisplayedFields( const QStringList &fields, bool refresh = true ); /** Returns the attributes used to sort the table's features. - * @returns a QList of integer/bool pairs, where the integer refers to the attribute index and + * \returns a QList of integer/bool pairs, where the integer refers to the attribute index and * the bool to the sort order for the attribute. If true the attribute is sorted ascending, * if false, the attribute is sorted in descending order. - * @note not available in Python bindings + * \note not available in Python bindings */ QList > sortAttributes() const; /** Sets a string to wrap the contents of the table cells by. Occurrences of this string will * be replaced by a line break. - * @param wrapString string to replace with line break + * \param wrapString string to replace with line break * \since QGIS 2.12 - * @see wrapString + * \see wrapString */ void setWrapString( const QString &wrapString ); /** Returns the string used to wrap the contents of the table cells by. Occurrences of this string will * be replaced by a line break. - * @returns string which will be replaced with line break + * \returns string which will be replaced with line break * \since QGIS 2.12 - * @see setWrapString + * \see setWrapString */ QString wrapString() const { return mWrapString; } /** Queries the attribute table's vector layer for attributes to show in the table. - * @param contents table content - * @returns true if attributes were successfully fetched - * @note not available in Python bindings + * \param contents table content + * \returns true if attributes were successfully fetched + * \note not available in Python bindings */ bool getTableContents( QgsComposerTableContents &contents ) override; @@ -332,18 +332,18 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 QString mWrapString; /** Returns a list of attribute indices corresponding to displayed fields in the table. - * @note kept for compatibility with 2.0 api only + * \note kept for compatibility with 2.0 api only */ QList fieldsToDisplay() const; /** Restores a field alias map from a pre 2.4 format project file format - * @param map QMap of integers to strings, where the string is the alias to use for the + * \param map QMap of integers to strings, where the string is the alias to use for the * corresponding field, and the integer is the field index from the vector layer */ void restoreFieldAliasMap( const QMap &map ); /** Replaces occurrences of the wrap character with line breaks. - * @param variant input cell contents + * \param variant input cell contents */ QVariant replaceWrapChar( const QVariant &variant ) const; diff --git a/src/core/composer/qgscomposerframe.h b/src/core/composer/qgscomposerframe.h index ae989c4e7736..e3b285c793b6 100644 --- a/src/core/composer/qgscomposerframe.h +++ b/src/core/composer/qgscomposerframe.h @@ -34,13 +34,13 @@ class CORE_EXPORT QgsComposerFrame: public QgsComposerItem /** Sets the visible part of the multiframe's content which is visible within * this frame (relative to the total multiframe extent in mm). - * @param section visible portion of content - * @see extent + * \param section visible portion of content + * \see extent */ void setContentSection( const QRectF §ion ) { mSection = section; } /** Returns the parent multiframe for the frame. - * @returns parent multiframe + * \returns parent multiframe */ QgsComposerMultiFrame *multiFrame() const { return mMultiFrame; } @@ -59,44 +59,44 @@ class CORE_EXPORT QgsComposerFrame: public QgsComposerItem /** Returns the visible portion of the multi frame's content which * is shown in this frame. - * @returns extent of visible portion + * \returns extent of visible portion * \since QGIS 2.5 - * @see setContentSection + * \see setContentSection */ QRectF extent() const { return mSection; } /** Returns whether the page should be hidden (ie, not included in composer exports) if this frame is empty - * @returns true if page should be hidden if frame is empty + * \returns true if page should be hidden if frame is empty * \since QGIS 2.5 - * @see setHidePageIfEmpty + * \see setHidePageIfEmpty */ bool hidePageIfEmpty() const { return mHidePageIfEmpty; } /** Sets whether the page should be hidden (ie, not included in composer exports) if this frame is empty - * @param hidePageIfEmpty set to true if page should be hidden if frame is empty + * \param hidePageIfEmpty set to true if page should be hidden if frame is empty * \since QGIS 2.5 - * @see hidePageIfEmpty + * \see hidePageIfEmpty */ void setHidePageIfEmpty( const bool hidePageIfEmpty ); /** Returns whether the background and frame stroke should be hidden if this frame is empty - * @returns true if background and stroke should be hidden if frame is empty + * \returns true if background and stroke should be hidden if frame is empty * \since QGIS 2.5 - * @see setHideBackgroundIfEmpty + * \see setHideBackgroundIfEmpty */ bool hideBackgroundIfEmpty() const { return mHideBackgroundIfEmpty; } /** Sets whether the background and frame stroke should be hidden if this frame is empty - * @param hideBackgroundIfEmpty set to true if background and stroke should be hidden if frame is empty + * \param hideBackgroundIfEmpty set to true if background and stroke should be hidden if frame is empty * \since QGIS 2.5 - * @see hideBackgroundIfEmpty + * \see hideBackgroundIfEmpty */ void setHideBackgroundIfEmpty( const bool hideBackgroundIfEmpty ); /** Returns whether the frame is empty - * @returns true if frame is empty + * \returns true if frame is empty * \since QGIS 2.5 - * @see hidePageIfEmpty + * \see hidePageIfEmpty */ bool isEmpty() const; diff --git a/src/core/composer/qgscomposerhtml.h b/src/core/composer/qgscomposerhtml.h index 9d548aa788bc..06ea185344bc 100644 --- a/src/core/composer/qgscomposerhtml.h +++ b/src/core/composer/qgscomposerhtml.h @@ -48,19 +48,19 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame ~QgsComposerHtml(); /** Sets the source mode for item's HTML content. - * @param mode ContentMode for the item's source - * @see contentMode - * @see setUrl - * @see setHtml + * \param mode ContentMode for the item's source + * \see contentMode + * \see setUrl + * \see setHtml * \since QGIS 2.5 */ void setContentMode( ContentMode mode ) { mContentMode = mode; } /** Returns the source mode for item's HTML content. - * @returns ContentMode for the item's source - * @see setContentMode - * @see url - * @see html + * \returns ContentMode for the item's source + * \see setContentMode + * \see url + * \see html * \since QGIS 2.5 */ ContentMode contentMode() const { return mContentMode; } @@ -68,17 +68,17 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame /** Sets the URL for content to display in the item when the item is using * the QgsComposerHtml::Url mode. Content is automatically fetched and the * HTML item refreshed after calling this function. - * @param url URL of content to display in the item - * @see url - * @see contentMode + * \param url URL of content to display in the item + * \see url + * \see contentMode */ void setUrl( const QUrl &url ); /** Returns the URL of the content displayed in the item if the item is using * the QgsComposerHtml::Url mode. - * @returns url for content displayed in item - * @see setUrl - * @see contentMode + * \returns url for content displayed in item + * \see setUrl + * \see contentMode */ QUrl url() const { return mUrl; } @@ -86,19 +86,19 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame * the QgsComposerHtml::ManualHtml mode. Setting the HTML using this function * does not automatically refresh the item's contents. Call loadHtml to trigger * a refresh of the item after setting the HTML content. - * @param html HTML to display in item - * @see html - * @see contentMode - * @see loadHtml + * \param html HTML to display in item + * \see html + * \see contentMode + * \see loadHtml * \since QGIS 2.5 */ void setHtml( const QString &html ); /** Returns the HTML source displayed in the item if the item is using * the QgsComposerHtml::ManualHtml mode. - * @returns HTML displayed in item - * @see setHtml - * @see contentMode + * \returns HTML displayed in item + * \see setHtml + * \see contentMode * \since QGIS 2.5 */ QString html() const { return mHtml; } @@ -107,8 +107,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame * the HTML content. If set, any content inside [% %] tags will be * treated as a QGIS expression and evaluated against the current atlas * feature. - * @returns true if html item will evaluate expressions in the content - * @see setEvaluateExpressions + * \returns true if html item will evaluate expressions in the content + * \see setEvaluateExpressions * \since QGIS 2.5 */ bool evaluateExpressions() const { return mEvaluateExpressions; } @@ -117,24 +117,24 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame * the HTML content. If set, any content inside [% %] tags will be * treated as a QGIS expression and evaluated against the current atlas * feature. - * @param evaluateExpressions set to true to evaluate expressions in the HTML content - * @see evaluateExpressions + * \param evaluateExpressions set to true to evaluate expressions in the HTML content + * \see evaluateExpressions * \since QGIS 2.5 */ void setEvaluateExpressions( bool evaluateExpressions ); /** Returns whether html item is using smart breaks. Smart breaks prevent * the html frame contents from breaking mid-way though a line of text. - * @returns true if html item is using smart breaks - * @see setUseSmartBreaks + * \returns true if html item is using smart breaks + * \see setUseSmartBreaks */ bool useSmartBreaks() const { return mUseSmartBreaks; } /** Sets whether the html item should use smart breaks. Smart breaks prevent * the html frame contents from breaking mid-way though a line of text. - * @param useSmartBreaks set to true to prevent content from breaking + * \param useSmartBreaks set to true to prevent content from breaking * mid-way through a line of text - * @see useSmartBreaks + * \see useSmartBreaks */ void setUseSmartBreaks( bool useSmartBreaks ); @@ -144,11 +144,11 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame * a larger value will result in better choice of page break location, but more * wasted space at the bottom of frames. This setting is only effective if * useSmartBreaks is true. - * @param maxBreakDistance maximum amount of empty space to leave when calculating + * \param maxBreakDistance maximum amount of empty space to leave when calculating * page break locations * \since QGIS 2.3 - * @see maxBreakDistance - * @see setUseSmartBreaks + * \see maxBreakDistance + * \see setUseSmartBreaks */ void setMaxBreakDistance( double maxBreakDistance ); @@ -156,10 +156,10 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame * in the html. This distance is the maximum amount of empty space allowed * at the bottom of a frame after calculating the optimum break location. This setting * is only effective if useSmartBreaks is true. - * @returns maximum amount of empty space to leave when calculating page break locations + * \returns maximum amount of empty space to leave when calculating page break locations * \since QGIS 2.3 - * @see setMaxBreakDistance - * @see useSmartBreaks + * \see setMaxBreakDistance + * \see useSmartBreaks */ double maxBreakDistance() const { return mMaxBreakDistance; } @@ -167,35 +167,35 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame * allow for overriding the styles specified within the HTML source. Setting the stylesheet * using this function does not automatically refresh the item's contents. Call loadHtml * to trigger a refresh of the item after setting the stylesheet rules. - * @param stylesheet CSS rules for user stylesheet - * @see userStylesheet - * @see setUserStylesheetEnabled - * @see loadHtml + * \param stylesheet CSS rules for user stylesheet + * \see userStylesheet + * \see setUserStylesheetEnabled + * \see loadHtml * \since QGIS 2.5 */ void setUserStylesheet( const QString &stylesheet ); /** Returns the user stylesheet CSS rules used while rendering the HTML content. These * overriding the styles specified within the HTML source. - * @returns CSS rules for user stylesheet - * @see setUserStylesheet - * @see userStylesheetEnabled + * \returns CSS rules for user stylesheet + * \see setUserStylesheet + * \see userStylesheetEnabled * \since QGIS 2.5 */ QString userStylesheet() const { return mUserStylesheet; } /** Sets whether user stylesheets are enabled for the HTML content. - * @param stylesheetEnabled set to true to enable user stylesheets - * @see userStylesheetEnabled - * @see setUserStylesheet + * \param stylesheetEnabled set to true to enable user stylesheets + * \see userStylesheetEnabled + * \see setUserStylesheet * \since QGIS 2.5 */ void setUserStylesheetEnabled( const bool stylesheetEnabled ); /** Returns whether user stylesheets are enabled for the HTML content. - * @returns true if user stylesheets are enabled - * @see setUserStylesheetEnabled - * @see userStylesheet + * \returns true if user stylesheets are enabled + * \see setUserStylesheetEnabled + * \see userStylesheet * \since QGIS 2.5 */ bool userStylesheetEnabled() const { return mEnableUserStylesheet; } @@ -212,11 +212,11 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame public slots: /** Reloads the html source from the url and redraws the item. - * @param useCache set to true to use a cached copy of remote html + * \param useCache set to true to use a cached copy of remote html * content - * @param context expression context for evaluating data defined urls and expressions in html - * @see setUrl - * @see url + * \param context expression context for evaluating data defined urls and expressions in html + * \see setUrl + * \see url */ void loadHtml( const bool useCache = false, const QgsExpressionContext *context = nullptr ); diff --git a/src/core/composer/qgscomposeritem.h b/src/core/composer/qgscomposeritem.h index 977524b98c77..8172ec37b43c 100644 --- a/src/core/composer/qgscomposeritem.h +++ b/src/core/composer/qgscomposeritem.h @@ -106,17 +106,17 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec }; /** Constructor - @param composition parent composition - @param manageZValue true if the z-Value of this object should be managed by mComposition*/ + \param composition parent composition + \param manageZValue true if the z-Value of this object should be managed by mComposition*/ QgsComposerItem( QgsComposition *composition, bool manageZValue = true ); /** Constructor with box position and composer object - @param x x coordinate of item - @param y y coordinate of item - @param width width of item - @param height height of item - @param composition parent composition - @param manageZValue true if the z-Value of this object should be managed by mComposition*/ + \param x x coordinate of item + \param y y coordinate of item + \param width width of item + \param height height of item + \param composition parent composition + \param manageZValue true if the z-Value of this object should be managed by mComposition*/ QgsComposerItem( qreal x, qreal y, qreal width, qreal height, QgsComposition *composition, bool manageZValue = true ); virtual ~QgsComposerItem(); @@ -126,18 +126,18 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec /** Returns whether this item has been removed from the composition. Items removed * from the composition are not deleted so that they can be restored via an undo * command. - * @returns true if the item has been removed from the composition + * \returns true if the item has been removed from the composition * \since QGIS 2.5 - * @see setIsRemoved + * \see setIsRemoved */ virtual bool isRemoved() const { return mRemovedFromComposition; } /** Sets whether this item has been removed from the composition. Items removed * from the composition are not deleted so that they can be restored via an undo * command. - * @param removed set to true if the item has been removed from the composition + * \param removed set to true if the item has been removed from the composition * \since QGIS 2.5 - * @see isRemoved + * \see isRemoved */ void setIsRemoved( const bool removed ) { mRemovedFromComposition = removed; } @@ -151,67 +151,67 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec void move( double dx, double dy ); /** Move Content of item. Does nothing per default (but implemented in composer map) - @param dx move in x-direction (canvas coordinates) - @param dy move in y-direction(canvas coordinates)*/ + \param dx move in x-direction (canvas coordinates) + \param dy move in y-direction(canvas coordinates)*/ virtual void moveContent( double dx, double dy ) { Q_UNUSED( dx ); Q_UNUSED( dy ); } /** Zoom content of item. Does nothing per default (but implemented in composer map) - * @param factor zoom factor, where > 1 results in a zoom in and < 1 results in a zoom out - * @param point item point for zoom center - * @param mode zoom mode + * \param factor zoom factor, where > 1 results in a zoom in and < 1 results in a zoom out + * \param point item point for zoom center + * \param mode zoom mode * \since QGIS 2.5 */ virtual void zoomContent( const double factor, const QPointF point, const ZoomMode mode = QgsComposerItem::Zoom ) { Q_UNUSED( factor ); Q_UNUSED( point ); Q_UNUSED( mode ); } /** Gets the page the item is currently on. - * @returns page number for item, beginning on page 1 - * @see pagePos - * @see updatePagePos + * \returns page number for item, beginning on page 1 + * \see pagePos + * \see updatePagePos * \since QGIS 2.4 */ int page() const; /** Returns the item's position relative to its current page. - * @returns position relative to the page's top left corner. - * @see page - * @see updatePagePos + * \returns position relative to the page's top left corner. + * \see page + * \see updatePagePos * \since QGIS 2.4 */ QPointF pagePos() const; /** Moves the item so that it retains its relative position on the page * when the paper size changes. - * @param newPageWidth new width of the page in mm - * @param newPageHeight new height of the page in mm - * @see page - * @see pagePos + * \param newPageWidth new width of the page in mm + * \param newPageHeight new height of the page in mm + * \see page + * \see pagePos * \since QGIS 2.4 */ void updatePagePos( double newPageWidth, double newPageHeight ); /** Moves the item to a new position (in canvas coordinates) - @param x item position x (mm) - @param y item position y (mm) - @param itemPoint reference point which coincides with specified position - @param page if page > 0, y is interpreted as relative to the origin of the specified page, if page <= 0, y is in absolute canvas coordinates. + \param x item position x (mm) + \param y item position y (mm) + \param itemPoint reference point which coincides with specified position + \param page if page > 0, y is interpreted as relative to the origin of the specified page, if page <= 0, y is in absolute canvas coordinates. a page number of 1 corresponds to the first page. */ void setItemPosition( double x, double y, ItemPositionMode itemPoint = UpperLeft, int page = -1 ); /** Sets item position and width / height in one go - @param x item position x (mm) - @param y item position y (mm) - @param width item width (mm) - @param height item height (mm) - @param itemPoint reference point which coincides with specified position - @param posIncludesFrame set to true if the position and size arguments include the item's frame stroke - @param page if page > 0, y is interpreted as relative to the origin of the specified page, if page <= 0, y is in absolute canvas coordinates. + \param x item position x (mm) + \param y item position y (mm) + \param width item width (mm) + \param height item height (mm) + \param itemPoint reference point which coincides with specified position + \param posIncludesFrame set to true if the position and size arguments include the item's frame stroke + \param page if page > 0, y is interpreted as relative to the origin of the specified page, if page <= 0, y is in absolute canvas coordinates. a page number of 1 corresponds to the first page. */ void setItemPosition( double x, double y, double width, double height, ItemPositionMode itemPoint = UpperLeft, bool posIncludesFrame = false, int page = -1 ); /** Returns item's last used position mode. - @note: This property has no effect on actual's item position, which is always the top-left corner. */ + \note: This property has no effect on actual's item position, which is always the top-left corner. */ ItemPositionMode lastUsedPositionMode() { return mLastUsedPositionMode; } /** Sets this items bound in scene coordinates such that 1 item size units @@ -225,80 +225,80 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec bool _readXml( const QDomElement &itemElem, const QDomDocument &doc ); /** Whether this item has a frame or not. - * @returns true if there is a frame around this item, otherwise false. - * @see setFrameEnabled - * @see frameStrokeWidth - * @see frameJoinStyle - * @see frameStrokeColor + * \returns true if there is a frame around this item, otherwise false. + * \see setFrameEnabled + * \see frameStrokeWidth + * \see frameJoinStyle + * \see frameStrokeColor */ bool hasFrame() const {return mFrame;} /** Set whether this item has a frame drawn around it or not. - * @param drawFrame draw frame - * @see hasFrame - * @see setFrameStrokeWidth - * @see setFrameJoinStyle - * @see setFrameStrokeColor + * \param drawFrame draw frame + * \see hasFrame + * \see setFrameStrokeWidth + * \see setFrameJoinStyle + * \see setFrameStrokeColor */ virtual void setFrameEnabled( const bool drawFrame ); /** Sets frame stroke color - * @param color new color for stroke frame - * @note introduced in 2.6 - * @see frameStrokeColor - * @see setFrameEnabled - * @see setFrameJoinStyle - * @see setFrameStrokeWidth + * \param color new color for stroke frame + * \since QGIS 2.6 + * \see frameStrokeColor + * \see setFrameEnabled + * \see setFrameJoinStyle + * \see setFrameStrokeWidth */ virtual void setFrameStrokeColor( const QColor &color ); /** Returns the frame's stroke color. Only used if hasFrame is true. - * @returns frame stroke color - * @note introduced in 2.6 - * @see hasFrame - * @see setFrameStrokeColor - * @see frameJoinStyle - * @see setFrameStrokeColor + * \returns frame stroke color + * \since QGIS 2.6 + * \see hasFrame + * \see setFrameStrokeColor + * \see frameJoinStyle + * \see setFrameStrokeColor */ QColor frameStrokeColor() const { return mFrameColor; } /** Sets frame stroke width - * @param strokeWidth new width for stroke frame - * @note introduced in 2.2 - * @see frameStrokeWidth - * @see setFrameEnabled - * @see setFrameJoinStyle - * @see setFrameStrokeColor + * \param strokeWidth new width for stroke frame + * \since QGIS 2.2 + * \see frameStrokeWidth + * \see setFrameEnabled + * \see setFrameJoinStyle + * \see setFrameStrokeColor */ virtual void setFrameStrokeWidth( const double strokeWidth ); /** Returns the frame's stroke width. Only used if hasFrame is true. - * @returns Frame stroke width - * @note introduced in 2.3 - * @see hasFrame - * @see setFrameStrokeWidth - * @see frameJoinStyle - * @see frameStrokeColor + * \returns Frame stroke width + * \since QGIS 2.3 + * \see hasFrame + * \see setFrameStrokeWidth + * \see frameJoinStyle + * \see frameStrokeColor */ double frameStrokeWidth() const { return mFrameWidth; } /** Returns the join style used for drawing the item's frame - * @returns Join style for stroke frame - * @note introduced in 2.3 - * @see hasFrame - * @see setFrameJoinStyle - * @see frameStrokeWidth - * @see frameStrokeColor + * \returns Join style for stroke frame + * \since QGIS 2.3 + * \see hasFrame + * \see setFrameJoinStyle + * \see frameStrokeWidth + * \see frameStrokeColor */ Qt::PenJoinStyle frameJoinStyle() const { return mFrameJoinStyle; } /** Sets join style used when drawing the item's frame - * @param style Join style for stroke frame - * @note introduced in 2.3 - * @see setFrameEnabled - * @see frameJoinStyle - * @see setFrameStrokeWidth - * @see setFrameStrokeColor + * \param style Join style for stroke frame + * \since QGIS 2.3 + * \see setFrameEnabled + * \see frameJoinStyle + * \see setFrameStrokeWidth + * \see setFrameStrokeColor */ void setFrameJoinStyle( const Qt::PenJoinStyle style ); @@ -306,8 +306,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec * actual rectangle. For instance, if the item has a 2mm frame stroke, then * 1mm of this frame is drawn outside the item's rect. In this case the * return value will be 1.0 - * @note introduced in 2.2 - * @see rectWithFrame + * \since QGIS 2.2 + * \see rectWithFrame */ virtual double estimatedFrameBleed() const; @@ -316,78 +316,78 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec * more details about QGraphicsItem coordinate systems). The results differ from Qt's rect() * function, as rect() makes no allowances for the portion of outlines which are drawn * outside of the item. - * @note introduced in 2.2 - * @see estimatedFrameBleed + * \since QGIS 2.2 + * \see estimatedFrameBleed */ virtual QRectF rectWithFrame() const; /** Whether this item has a Background or not. - * @returns true if there is a Background around this item, otherwise false. - * @see setBackgroundEnabled - * @see backgroundColor + * \returns true if there is a Background around this item, otherwise false. + * \see setBackgroundEnabled + * \see backgroundColor */ bool hasBackground() const {return mBackground;} /** Set whether this item has a Background drawn around it or not. - * @param drawBackground draw Background - * @returns nothing - * @see hasBackground - * @see setBackgroundColor + * \param drawBackground draw Background + * \returns nothing + * \see hasBackground + * \see setBackgroundColor */ void setBackgroundEnabled( const bool drawBackground ) { mBackground = drawBackground; } /** Gets the background color for this item - * @returns background color - * @see setBackgroundColor - * @see hasBackground + * \returns background color + * \see setBackgroundColor + * \see hasBackground */ QColor backgroundColor() const { return mBackgroundColor; } /** Sets the background color for this item - * @param backgroundColor new background color - * @returns nothing - * @see backgroundColor - * @see setBackgroundEnabled + * \param backgroundColor new background color + * \returns nothing + * \see backgroundColor + * \see setBackgroundEnabled */ void setBackgroundColor( const QColor &backgroundColor ); /** Returns the item's composition blending mode. - * @returns item blending mode - * @see setBlendMode + * \returns item blending mode + * \see setBlendMode */ QPainter::CompositionMode blendMode() const { return mBlendMode; } /** Sets the item's composition blending mode - * @param blendMode blending mode for item - * @see blendMode + * \param blendMode blending mode for item + * \see blendMode */ void setBlendMode( const QPainter::CompositionMode blendMode ); /** Returns the item's transparency - * @returns transparency as integer between 0 (transparent) and 255 (opaque) - * @see setTransparency + * \returns transparency as integer between 0 (transparent) and 255 (opaque) + * \see setTransparency */ int transparency() const { return mTransparency; } /** Sets the item's transparency - * @param transparency integer between 0 (transparent) and 255 (opaque) - * @see transparency + * \param transparency integer between 0 (transparent) and 255 (opaque) + * \see transparency */ void setTransparency( const int transparency ); /** Returns whether effects (e.g., blend modes) are enabled for the item - * @returns true if effects are enabled - * @see setEffectsEnabled - * @see transparency - * @see blendMode + * \returns true if effects are enabled + * \see setEffectsEnabled + * \see transparency + * \see blendMode */ bool effectsEnabled() const { return mEffectsEnabled; } /** Sets whether effects (e.g., blend modes) are enabled for the item - * @param effectsEnabled set to true to enable effects - * @see effectsEnabled - * @see setTransparency - * @see setBlendMode + * \param effectsEnabled set to true to enable effects + * \see effectsEnabled + * \see setTransparency + * \see setBlendMode */ void setEffectsEnabled( const bool effectsEnabled ); @@ -398,8 +398,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec virtual void beginItemCommand( const QString &text ) { beginCommand( text ); } /** Starts new composer undo command - @param commandText command title - @param c context for mergeable commands (unknown for non-mergeable commands*/ + \param commandText command title + \param c context for mergeable commands (unknown for non-mergeable commands*/ void beginCommand( const QString &commandText, QgsComposerMergeCommand::Context c = QgsComposerMergeCommand::Unknown ); virtual void endItemCommand() { endCommand(); } @@ -411,24 +411,24 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec //painter down by the same factor for drawing /** Locks / unlocks the item position for mouse drags - * @param lock set to true to prevent item movement and resizing via the mouse - * @see positionLock + * \param lock set to true to prevent item movement and resizing via the mouse + * \see positionLock */ void setPositionLock( const bool lock ); /** Returns whether position lock for mouse drags is enabled * returns true if item is locked for mouse movement and resizing - * @see setPositionLock + * \see setPositionLock */ bool positionLock() const { return mItemPositionLocked; } /** Returns the current rotation for the composer item. - * @returns rotation for composer item - * @param valueType controls whether the returned value is the user specified rotation, + * \returns rotation for composer item + * \param valueType controls whether the returned value is the user specified rotation, * or the current evaluated rotation (which may be affected by data driven rotation * settings). * \since QGIS 2.1 - * @see setItemRotation + * \see setItemRotation */ double itemRotation( const QgsComposerObject::PropertyValueType valueType = QgsComposerObject::EvaluatedValue ) const; @@ -440,37 +440,37 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec virtual void updateItem(); /** Get item's id (which is not necessarly unique) - * @returns item id - * @see setId + * \returns item id + * \see setId */ QString id() const { return mId; } /** Set item's id (which is not necessarly unique) - * @param id new id for item - * @see id + * \param id new id for item + * \see id */ virtual void setId( const QString &id ); /** Get item identification name - * @returns unique item identification string - * @note there is not setter since one can't manually set the id - * @see id - * @see setId + * \returns unique item identification string + * \note there is not setter since one can't manually set the id + * \see id + * \see setId */ QString uuid() const { return mUuid; } /** Get item display name. This is the item's id if set, and if * not, a user-friendly string identifying item type. - * @returns display name for item - * @see id - * @see setId + * \returns display name for item + * \see id + * \see setId * \since QGIS 2.5 */ virtual QString displayName() const; /** Sets visibility for item. - * @param visible set to true to show item, false to hide item - * @note QGraphicsItem::setVisible should not be called directly + * \param visible set to true to show item, false to hide item + * \note QGraphicsItem::setVisible should not be called directly * on a QgsComposerItem, as some item types (e.g., groups) need to override * the visibility toggle. * \since QGIS 2.5 @@ -478,47 +478,47 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec virtual void setVisibility( const bool visible ); /** Returns whether the item should be excluded from composer exports and prints - * @param valueType controls whether the returned value is the user specified value, + * \param valueType controls whether the returned value is the user specified value, * or the current evaluated value (which may be affected by data driven settings). - * @returns true if item should be excluded + * \returns true if item should be excluded * \since QGIS 2.5 - * @see setExcludeFromExports + * \see setExcludeFromExports */ bool excludeFromExports( const QgsComposerObject::PropertyValueType valueType = QgsComposerObject::EvaluatedValue ); /** Sets whether the item should be excluded from composer exports and prints - * @param exclude set to true to exclude the item from exports + * \param exclude set to true to exclude the item from exports * \since QGIS 2.5 - * @see excludeFromExports + * \see excludeFromExports */ virtual void setExcludeFromExports( const bool exclude ); /** Returns whether this item is part of a group - * @returns true if item is in a group + * \returns true if item is in a group * \since QGIS 2.5 - * @see setIsGroupMember + * \see setIsGroupMember */ bool isGroupMember() const { return mIsGroupMember; } /** Sets whether this item is part of a group - * @param isGroupMember set to true if item is in a group + * \param isGroupMember set to true if item is in a group * \since QGIS 2.5 - * @see isGroupMember + * \see isGroupMember */ void setIsGroupMember( const bool isGroupMember ); /** Get the number of layers that this item requires for exporting as layers - * @returns 0 if this item is to be placed on the same layer as the previous item, + * \returns 0 if this item is to be placed on the same layer as the previous item, * 1 if it should be placed on its own layer, and >1 if it requires multiple export layers * \since QGIS 2.4 - * @see setCurrentExportLayer + * \see setCurrentExportLayer */ virtual int numberExportLayers() const { return 0; } /** Sets the current layer to draw for exporting - * @param layerIdx can be set to -1 to draw all item layers, and must be less than numberExportLayers() + * \param layerIdx can be set to -1 to draw all item layers, and must be less than numberExportLayers() * \since QGIS 2.4 - * @see numberExportLayers + * \see numberExportLayers */ virtual void setCurrentExportLayer( const int layerIdx = -1 ) { mCurrentExportLayer = layerIdx; } @@ -534,7 +534,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec * multiple item updates when many settings for an item are * changed sequentially. * \since QGIS 3.0 - * @see updatesEnabled() + * \see updatesEnabled() */ void setUpdatesEnabled( bool enabled ) { mUpdatesEnabled = enabled; } @@ -544,18 +544,18 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec * multiple item updates when many settings for an item are * changed sequentially. * \since QGIS 3.0 - * @see setUpdatesEnabled() + * \see setUpdatesEnabled() */ bool updatesEnabled() const { return mUpdatesEnabled; } public slots: /** Sets the item rotation - * @param r item rotation in degrees - * @param adjustPosition set to true if item should be shifted so that rotation occurs + * \param r item rotation in degrees + * \param adjustPosition set to true if item should be shifted so that rotation occurs * around item center. If false, rotation occurs around item origin * \since QGIS 2.1 - * @see itemRotation + * \see itemRotation */ virtual void setItemRotation( const double r, const bool adjustPosition = false ); @@ -563,10 +563,10 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec /** Refreshes a data defined property for the item by reevaluating the property's value * and redrawing the item with this new value. - * @param property data defined property to refresh. If property is set to + * \param property data defined property to refresh. If property is set to * QgsComposerItem::AllProperties then all data defined properties for the item will be * refreshed. - * @param context expression context for evaluating data defined expressions + * \param context expression context for evaluating data defined expressions * \since QGIS 2.5 */ virtual void refreshDataDefinedProperty( const QgsComposerObject::DataDefinedProperty property = QgsComposerObject::AllProperties, const QgsExpressionContext *context = nullptr ) override; @@ -638,7 +638,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec bool mIsGroupMember; /** The layer that needs to be exported - * @note: if -1, all layers are to be exported + * \note: if -1, all layers are to be exported * \since QGIS 2.4 */ int mCurrentExportLayer; @@ -659,7 +659,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec double rectHandlerBorderTolerance() const; /** Returns the zoom factor of the graphics view. - * @return the factor or -1 in case of error (e.g. graphic view does not exist) + * \returns the factor or -1 in case of error (e.g. graphic view does not exist) */ double horizontalViewScaleFactor() const; @@ -675,19 +675,19 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec /** Evaluates an item's bounding rect to consider data defined position and size of item * and reference point - * @param newRect target bounding rect for item - * @param resizeOnly set to true if the item is only being resized. If true then + * \param newRect target bounding rect for item + * \param resizeOnly set to true if the item is only being resized. If true then * the position of the returned rect will be adjusted to account for the item's * position mode - * @param context expression context for evaluating data defined expressions - * @returns bounding box rectangle for item after data defined size and position have been + * \param context expression context for evaluating data defined expressions + * \returns bounding box rectangle for item after data defined size and position have been * set and position mode has been accounted for * \since QGIS 2.5 */ QRectF evalItemRect( const QRectF &newRect, const bool resizeOnly = false, const QgsExpressionContext *context = nullptr ); /** Returns whether the item should be drawn in the current context - * @returns true if item should be drawn + * \returns true if item should be drawn * \since QGIS 2.5 */ bool shouldDrawItem() const; @@ -699,12 +699,12 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec void sizeChanged(); /** Emitted if the item's frame style changes - * @note: this function was introduced in version 2.2 + * \since QGIS 2.2 */ void frameChanged(); /** Emitted if the item's lock status changes - * @note: this function was introduced in version 2.5 + * \since QGIS 2.5 */ void lockChanged(); @@ -725,33 +725,33 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec bool mUpdatesEnabled = true; /** Refresh item's rotation, considering data defined rotation setting - *@param updateItem set to false to prevent the item being automatically updated - *@param rotateAroundCenter set to true to rotate the item around its center rather + *\param updateItem set to false to prevent the item being automatically updated + *\param rotateAroundCenter set to true to rotate the item around its center rather * than its origin - * @param context expression context for evaulating data defined rotation + * \param context expression context for evaulating data defined rotation * \since QGIS 2.5 */ void refreshRotation( const bool updateItem = true, const bool rotateAroundCenter = false, const QgsExpressionContext &context = QgsExpressionContext() ); /** Refresh item's transparency, considering data defined transparency - * @param updateItem set to false to prevent the item being automatically updated + * \param updateItem set to false to prevent the item being automatically updated * after the transparency is set - * @param context expression context for evaulating data defined transparency + * \param context expression context for evaulating data defined transparency * \since QGIS 2.5 */ void refreshTransparency( const bool updateItem = true, const QgsExpressionContext &context = QgsExpressionContext() ); /** Refresh item's frame color, considering data defined transparency - * @param updateItem set to false to prevent the item being automatically updated + * \param updateItem set to false to prevent the item being automatically updated * after the frame color is set - * @param context expression context for evaulating data defined transparency + * \param context expression context for evaulating data defined transparency */ void refreshFrameColor( const bool updateItem = true, const QgsExpressionContext &context = QgsExpressionContext() ); /** Refresh item's transparency, considering data defined transparency - * @param updateItem set to false to prevent the item being automatically updated + * \param updateItem set to false to prevent the item being automatically updated * after the background color is set - * @param context expression context for evaulating data defined transparency + * \param context expression context for evaulating data defined transparency */ void refreshBackgroundColor( const bool updateItem = true, const QgsExpressionContext &context = QgsExpressionContext() ); diff --git a/src/core/composer/qgscomposeritemcommand.h b/src/core/composer/qgscomposeritemcommand.h index 18f0bab24081..1193e1eb96b9 100644 --- a/src/core/composer/qgscomposeritemcommand.h +++ b/src/core/composer/qgscomposeritemcommand.h @@ -51,7 +51,7 @@ class CORE_EXPORT QgsComposerItemCommand: public QUndoCommand bool containsChange() const; /** Returns the target item the command applies to. - * @returns target composer item + * \returns target composer item */ QgsComposerItem *item() const; diff --git a/src/core/composer/qgscomposeritemgroup.h b/src/core/composer/qgscomposeritemgroup.h index 7ab41e93ca2c..148959058173 100644 --- a/src/core/composer/qgscomposeritemgroup.h +++ b/src/core/composer/qgscomposeritemgroup.h @@ -50,14 +50,14 @@ class CORE_EXPORT QgsComposerItemGroup: public QgsComposerItem virtual void setVisibility( const bool visible ) override; /** Stores state in Dom node - * @param elem is Dom element corresponding to 'Composer' tag - * @param doc is the Dom document + * \param elem is Dom element corresponding to 'Composer' tag + * \param doc is the Dom document */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; /** Sets state from Dom document - * @param itemElem is Dom node corresponding to item tag - * @param doc is the Dom document + * \param itemElem is Dom node corresponding to item tag + * \param doc is the Dom document */ bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override; diff --git a/src/core/composer/qgscomposerlabel.h b/src/core/composer/qgscomposerlabel.h index 9b7c8841c74b..99dbd14aadc5 100644 --- a/src/core/composer/qgscomposerlabel.h +++ b/src/core/composer/qgscomposerlabel.h @@ -58,37 +58,37 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem void setFont( const QFont &f ); /** Accessor for the vertical alignment of the label - * @returns Qt::AlignmentFlag + * \returns Qt::AlignmentFlag */ Qt::AlignmentFlag vAlign() const { return mVAlignment; } /** Accessor for the horizontal alignment of the label - * @returns Qt::AlignmentFlag + * \returns Qt::AlignmentFlag */ Qt::AlignmentFlag hAlign() const { return mHAlignment; } /** Mutator for the horizontal alignment of the label - * @param a alignment - * @returns void + * \param a alignment + * \returns void */ void setHAlign( Qt::AlignmentFlag a ) {mHAlignment = a;} /** Mutator for the vertical alignment of the label - * @param a alignment - * @returns void + * \param a alignment + * \returns void */ void setVAlign( Qt::AlignmentFlag a ) { mVAlignment = a; } /** Returns the horizontal margin between the edge of the frame and the label * contents. - * @returns horizontal margin in mm + * \returns horizontal margin in mm * \since QGIS 2.7 */ double marginX() const { return mMarginX; } /** Returns the vertical margin between the edge of the frame and the label * contents. - * @returns vertical margin in mm + * \returns vertical margin in mm * \since QGIS 2.7 */ double marginY() const { return mMarginY; } @@ -97,26 +97,26 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem * This method sets both the horizontal and vertical margins to the same * value. The margins can be individually controlled using the setMarginX * and setMarginY methods. - * @param m margin in mm - * @see setMarginX - * @see setMarginY + * \param m margin in mm + * \see setMarginX + * \see setMarginY */ void setMargin( const double m ); /** Sets the horizontal margin between the edge of the frame and the label * contents. - * @param margin horizontal margin in mm - * @see setMargin - * @see setMarginY + * \param margin horizontal margin in mm + * \see setMargin + * \see setMarginY * \since QGIS 2.7 */ void setMarginX( const double margin ); /** Sets the vertical margin between the edge of the frame and the label * contents. - * @param margin vertical margin in mm - * @see setMargin - * @see setMarginX + * \param margin vertical margin in mm + * \see setMargin + * \see setMarginX * \since QGIS 2.7 */ void setMarginY( const double margin ); @@ -127,14 +127,14 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem QColor fontColor() const { return mFontColor; } /** Stores state in Dom element - * @param elem is Dom element corresponding to 'Composer' tag - * @param doc document + * \param elem is Dom element corresponding to 'Composer' tag + * \param doc document */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; /** Sets state from Dom document - * @param itemElem is Dom element corresponding to 'ComposerLabel' tag - * @param doc document + * \param itemElem is Dom element corresponding to 'ComposerLabel' tag + * \param doc document */ bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override; diff --git a/src/core/composer/qgscomposerlegend.h b/src/core/composer/qgscomposerlegend.h index 185c4abee405..56dfe39894a0 100644 --- a/src/core/composer/qgscomposerlegend.h +++ b/src/core/composer/qgscomposerlegend.h @@ -73,15 +73,15 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem void adjustBoxSize(); /** Sets whether the legend should automatically resize to fit its contents. - * @param enabled set to false to disable automatic resizing. The legend frame will not + * \param enabled set to false to disable automatic resizing. The legend frame will not * be expanded to fit legend items, and items may be cropped from display. - * @see resizeToContents() + * \see resizeToContents() * \since QGIS 3.0 */ void setResizeToContents( bool enabled ); /** Returns whether the legend should automatically resize to fit its contents. - * @see setResizeToContents() + * \see setResizeToContents() * \since QGIS 3.0 */ bool resizeToContents() const; @@ -114,7 +114,7 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem void setLegendFilterOutAtlas( bool doFilter ); //! Whether to filter out legend elements outside of the current atlas feature - //! @see setLegendFilterOutAtlas() + //! \see setLegendFilterOutAtlas() //! \since QGIS 2.14 bool legendFilterOutAtlas() const; @@ -123,16 +123,16 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem QString title() const; /** Returns the alignment of the legend title - * @returns Qt::AlignmentFlag for the legend title + * \returns Qt::AlignmentFlag for the legend title * \since QGIS 2.3 - * @see setTitleAlignment + * \see setTitleAlignment */ Qt::AlignmentFlag titleAlignment() const; /** Sets the alignment of the legend title - * @param alignment Text alignment for drawing the legend title + * \param alignment Text alignment for drawing the legend title * \since QGIS 2.3 - * @see titleAlignment + * \see titleAlignment */ void setTitleAlignment( Qt::AlignmentFlag alignment ); @@ -152,14 +152,14 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem /** Returns the spacing in-between lines in mm * \since QGIS 3.0 - * @see setLineSpacing + * \see setLineSpacing */ double lineSpacing() const; /** Sets the spacing in-between multiple lines - * @param spacing Double value to use as spacing in between multiple lines + * \param spacing Double value to use as spacing in between multiple lines * \since QGIS 3.0 - * @see lineSpacing + * \see lineSpacing */ void setLineSpacing( double spacing ); @@ -197,56 +197,56 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem void setEqualColumnWidth( bool s ); /** Returns whether a stroke will be drawn around raster symbol items. - * @see setDrawRasterStroke() - * @see rasterStrokeColor() - * @see rasterStrokeWidth() + * \see setDrawRasterStroke() + * \see rasterStrokeColor() + * \see rasterStrokeWidth() * \since QGIS 2.12 */ bool drawRasterStroke() const; /** Sets whether a stroke will be drawn around raster symbol items. - * @param enabled set to true to draw borders - * @see drawRasterStroke() - * @see setRasterStrokeColor() - * @see setRasterStrokeWidth() + * \param enabled set to true to draw borders + * \see drawRasterStroke() + * \see setRasterStrokeColor() + * \see setRasterStrokeWidth() * \since QGIS 2.12 */ void setDrawRasterStroke( bool enabled ); /** Returns the stroke color for the stroke drawn around raster symbol items. The stroke is * only drawn if drawRasterStroke() is true. - * @see setRasterStrokeColor() - * @see drawRasterStroke() - * @see rasterStrokeWidth() + * \see setRasterStrokeColor() + * \see drawRasterStroke() + * \see rasterStrokeWidth() * \since QGIS 2.12 */ QColor rasterStrokeColor() const; /** Sets the stroke color for the stroke drawn around raster symbol items. The stroke is * only drawn if drawRasterStroke() is true. - * @param color stroke color - * @see rasterStrokeColor() - * @see setDrawRasterStroke() - * @see setRasterStrokeWidth() + * \param color stroke color + * \see rasterStrokeColor() + * \see setDrawRasterStroke() + * \see setRasterStrokeWidth() * \since QGIS 2.12 */ void setRasterStrokeColor( const QColor &color ); /** Returns the stroke width (in millimeters) for the stroke drawn around raster symbol items. The stroke is * only drawn if drawRasterStroke() is true. - * @see setRasterStrokeWidth() - * @see drawRasterStroke() - * @see rasterStrokeColor() + * \see setRasterStrokeWidth() + * \see drawRasterStroke() + * \see rasterStrokeColor() * \since QGIS 2.12 */ double rasterStrokeWidth() const; /** Sets the stroke width for the stroke drawn around raster symbol items. The stroke is * only drawn if drawRasterStroke() is true. - * @param width stroke width in millimeters - * @see rasterStrokeWidth() - * @see setDrawRasterStroke() - * @see setRasterStrokeColor() + * \param width stroke width in millimeters + * \see rasterStrokeWidth() + * \see setDrawRasterStroke() + * \see setRasterStrokeColor() * \since QGIS 2.12 */ void setRasterStrokeWidth( double width ); @@ -258,14 +258,14 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem void updateLegend(); /** Stores state in Dom node - * @param elem is Dom element corresponding to 'Composer' tag - * @param doc Dom document + * \param elem is Dom element corresponding to 'Composer' tag + * \param doc Dom document */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; /** Sets state from Dom document - * @param itemElem is Dom node corresponding to item tag - * @param doc is Dom document + * \param itemElem is Dom node corresponding to item tag + * \param doc is Dom document */ bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override; diff --git a/src/core/composer/qgscomposermap.h b/src/core/composer/qgscomposermap.h index 40204ff6ec46..c2a8276b1f9c 100644 --- a/src/core/composer/qgscomposermap.h +++ b/src/core/composer/qgscomposermap.h @@ -75,20 +75,20 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem Fixed, //!< The current scale of the map is used for each feature of the atlas Predefined, /*!< A scale is chosen from the predefined scales. The smallest scale from the list of scales where the atlas feature is fully visible is chosen. - @see QgsAtlasComposition::setPredefinedScales. - @note This mode is only valid for polygon or line atlas coverage layers + \see QgsAtlasComposition::setPredefinedScales. + \note This mode is only valid for polygon or line atlas coverage layers */ Auto /*!< The extent is adjusted so that each feature is fully visible. - A margin is applied around the center @see setAtlasMargin - @note This mode is only valid for polygon or line atlas coverage layers*/ + A margin is applied around the center \see setAtlasMargin + \note This mode is only valid for polygon or line atlas coverage layers*/ }; /** \brief Draw to paint device - * @param painter painter - * @param extent map extent - * @param size size in scene coordinates - * @param dpi scene dpi - * @param forceWidthScale force wysiwyg line widths / marker sizes + * \param painter painter + * \param extent map extent + * \param size size in scene coordinates + * \param dpi scene dpi + * \param forceWidthScale force wysiwyg line widths / marker sizes */ void draw( QPainter *painter, const QgsRectangle &extent, QSizeF size, double dpi, double *forceWidthScale = nullptr ); @@ -112,15 +112,15 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem void resize( double dx, double dy ); /** Move content of map - * @param dx move in x-direction (item and canvas coordinates) - * @param dy move in y-direction (item and canvas coordinates) + * \param dx move in x-direction (item and canvas coordinates) + * \param dy move in y-direction (item and canvas coordinates) */ void moveContent( double dx, double dy ) override; /** Zoom content of item. Does nothing per default (but implemented in composer map) - * @param factor zoom factor, where > 1 results in a zoom in and < 1 results in a zoom out - * @param point item point for zoom center - * @param mode zoom mode + * \param factor zoom factor, where > 1 results in a zoom in and < 1 results in a zoom out + * \param point item point for zoom center + * \param mode zoom mode * \since QGIS 2.5 */ virtual void zoomContent( const double factor, const QPointF point, const ZoomMode mode = QgsComposerItem::Zoom ) override; @@ -137,8 +137,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem /** Sets new extent for the map. This method may change the width or height of the map * item to ensure that the extent exactly matches the specified extent, with no * overlap or margin. This method implicitly alters the map scale. - * @param extent new extent for the map - * @see zoomToExtent + * \param extent new extent for the map + * \see zoomToExtent */ void setNewExtent( const QgsRectangle &extent ); @@ -146,8 +146,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem * This method will not change the width or height of the map, and may result in * an overlap or margin from the specified extent. This method implicitly alters the * map scale. - * @param extent new extent for the map - * @see setNewExtent + * \param extent new extent for the map + * \see setNewExtent * \since QGIS 2.5 */ void zoomToExtent( const QgsRectangle &extent ); @@ -160,12 +160,12 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem /** Returns a pointer to the current map extent, which is either the original user specified * extent or the temporary atlas-driven feature extent depending on the current atlas state * of the composition. Both a const and non-const version are included. - * @returns pointer to current map extent - * @see visibleExtentPolygon + * \returns pointer to current map extent + * \see visibleExtentPolygon */ const QgsRectangle *currentMapExtent() const; - //! @note not available in Python bindings + //! \note not available in Python bindings QgsRectangle *currentMapExtent(); /** @@ -174,8 +174,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem * CRS is not set then the map's CRS will follow the composition's * project's CRS. * \since QGIS 3.0 - * @see presetCrs() - * @see setCrs() + * \see presetCrs() + * \see setCrs() */ QgsCoordinateReferenceSystem crs() const; @@ -185,8 +185,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem * setting. If the returned CRS is not valid then the project CRS * will be used to render the map. * \since QGIS 3.0 - * @see crs() - * @see setCrs() + * \see crs() + * \see setCrs() */ QgsCoordinateReferenceSystem presetCrs() const { return mCrs; } @@ -194,8 +194,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem * Sets the map's preset coordinate reference system. If a valid CRS is * set, this CRS will be used to render the map regardless of any project CRS * setting. If the CRS is not valid then the project CRS will be used to render the map. - * @see crs() - * @see presetCrs() + * \see crs() + * \see presetCrs() * \since QGIS 3.0 */ void setCrs( const QgsCoordinateReferenceSystem &crs ); @@ -208,8 +208,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem * or the current layer set of the QGIS map canvas. This is just a GUI flag, * and itself does not change which layers are rendered in the map. * Instead, use setLayers() to control which layers are rendered. - * @see setKeepLayerSet() - * @see layers() + * \see setKeepLayerSet() + * \see layers() */ bool keepLayerSet() const {return mKeepLayerSet;} @@ -218,24 +218,24 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem * or the current layer set of the QGIS map canvas. This is just a GUI flag, * and itself does not change which layers are rendered in the map. * Instead, use setLayers() to control which layers are rendered. - * @see keepLayerSet() - * @see layers() + * \see keepLayerSet() + * \see layers() */ void setKeepLayerSet( bool enabled ) {mKeepLayerSet = enabled;} /** * Getter for stored layer set. If empty, the current canvas layers will * be used instead. - * @see setLayers() - * @see keepLayerSet() + * \see setLayers() + * \see keepLayerSet() */ QList layers() const; /** * Setter for stored layer set. If empty, the current canvas layers will * be used instead. - * @see layers() - * @see keepLayerSet() + * \see layers() + * \see keepLayerSet() */ void setLayers( const QList &layers ); @@ -290,44 +290,44 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem bool containsAdvancedEffects() const; /** Stores state in Dom node - * @param elem is Dom element corresponding to 'Composer' tag - * @param doc Dom document + * \param elem is Dom element corresponding to 'Composer' tag + * \param doc Dom document */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; /** Sets state from Dom document - * @param itemElem is Dom node corresponding to 'ComposerMap' tag - * @param doc is Dom document + * \param itemElem is Dom node corresponding to 'ComposerMap' tag + * \param doc is Dom document */ bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override; /** Returns the map item's grid stack, which is used to control how grids * are drawn over the map's contents. - * @returns pointer to grid stack - * @see grid() - * @note introduced in QGIS 2.5 + * \returns pointer to grid stack + * \see grid() + * \since QGIS 2.5 */ QgsComposerMapGridStack *grids() { return mGridStack; } /** Returns the map item's first grid. This is a convenience function. - * @returns pointer to first grid for map item - * @see grids() - * @note introduced in QGIS 2.5 + * \returns pointer to first grid for map item + * \see grids() + * \since QGIS 2.5 */ QgsComposerMapGrid *grid(); /** Returns the map item's overview stack, which is used to control how overviews * are drawn over the map's contents. - * @returns pointer to overview stack - * @see overview() - * @note introduced in QGIS 2.5 + * \returns pointer to overview stack + * \see overview() + * \since QGIS 2.5 */ QgsComposerMapOverviewStack *overviews() { return mOverviewStack; } /** Returns the map item's first overview. This is a convenience function. - * @returns pointer to first overview for map item - * @see overviews() - * @note introduced in QGIS 2.5 + * \returns pointer to first overview for map item + * \see overviews() + * \since QGIS 2.5 */ QgsComposerMapOverview *overview(); @@ -344,8 +344,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem void setMapRotation( double r ); /** Returns the rotation used for drawing the map within the composer item - * @returns rotation for map - * @param valueType controls whether the returned value is the user specified rotation, + * \returns rotation for map + * \param valueType controls whether the returned value is the user specified rotation, * or the current evaluated rotation (which may be affected by data driven rotation * settings). */ @@ -355,13 +355,13 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem /** * Sets whether annotations are drawn within the composer map. - * @see drawAnnotations() + * \see drawAnnotations() */ void setDrawAnnotations( bool draw ) { mDrawAnnotations = draw; } /** * Returns whether annotations are drawn within the composer map. - * @see setDrawAnnotations() + * \see setDrawAnnotations() */ bool drawAnnotations() const { return mDrawAnnotations; } @@ -373,60 +373,60 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem void assignFreeId(); /** Returns whether the map extent is set to follow the current atlas feature. - * @returns true if map will follow the current atlas feature. - * @see setAtlasDriven - * @see atlasScalingMode + * \returns true if map will follow the current atlas feature. + * \see setAtlasDriven + * \see atlasScalingMode */ bool atlasDriven() const { return mAtlasDriven; } /** Sets whether the map extent will follow the current atlas feature. - * @param enabled set to true if the map extents should be set by the current atlas feature. - * @see atlasDriven - * @see setAtlasScalingMode + * \param enabled set to true if the map extents should be set by the current atlas feature. + * \see atlasDriven + * \see setAtlasScalingMode */ void setAtlasDriven( bool enabled ); /** Returns the current atlas scaling mode. This controls how the map's extents * are calculated for the current atlas feature when an atlas composition * is enabled. - * @returns the current scaling mode - * @note this parameter is only used if atlasDriven() is true - * @see setAtlasScalingMode - * @see atlasDriven + * \returns the current scaling mode + * \note this parameter is only used if atlasDriven() is true + * \see setAtlasScalingMode + * \see atlasDriven */ AtlasScalingMode atlasScalingMode() const { return mAtlasScalingMode; } /** Sets the current atlas scaling mode. This controls how the map's extents * are calculated for the current atlas feature when an atlas composition * is enabled. - * @param mode atlas scaling mode to set - * @note this parameter is only used if atlasDriven() is true - * @see atlasScalingMode - * @see atlasDriven + * \param mode atlas scaling mode to set + * \note this parameter is only used if atlasDriven() is true + * \see atlasScalingMode + * \see atlasDriven */ void setAtlasScalingMode( AtlasScalingMode mode ) { mAtlasScalingMode = mode; } /** Returns the margin size (percentage) used when the map is in atlas mode. - * @param valueType controls whether the returned value is the user specified atlas margin, + * \param valueType controls whether the returned value is the user specified atlas margin, * or the current evaluated atlas margin (which may be affected by data driven atlas margin * settings). - * @returns margin size in percentage to leave around the atlas feature's extent - * @note this is only used if atlasScalingMode() is Auto. - * @see atlasScalingMode - * @see setAtlasMargin + * \returns margin size in percentage to leave around the atlas feature's extent + * \note this is only used if atlasScalingMode() is Auto. + * \see atlasScalingMode + * \see setAtlasMargin */ double atlasMargin( const QgsComposerObject::PropertyValueType valueType = QgsComposerObject::EvaluatedValue ); /** Sets the margin size (percentage) used when the map is in atlas mode. - * @param margin size in percentage to leave around the atlas feature's extent - * @note this is only used if atlasScalingMode() is Auto. - * @see atlasScalingMode - * @see atlasMargin + * \param margin size in percentage to leave around the atlas feature's extent + * \note this is only used if atlasScalingMode() is Auto. + * \see atlasScalingMode + * \see atlasMargin */ void setAtlasMargin( double margin ) { mAtlasMargin = margin; } /** Get the number of layers that this item requires for exporting as layers - * @returns 0 if this item is to be placed on the same layer as the previous item, + * \returns 0 if this item is to be placed on the same layer as the previous item, * 1 if it should be placed on its own layer, and >1 if it requires multiple export layers * \since QGIS 2.4 */ @@ -434,9 +434,9 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem /** Returns a polygon representing the current visible map extent, considering map extents and rotation. * If the map rotation is 0, the result is the same as currentMapExtent - * @returns polygon with the four corner points representing the visible map extent. The points are + * \returns polygon with the four corner points representing the visible map extent. The points are * clockwise, starting at the top-left point - * @see currentMapExtent + * \see currentMapExtent */ QPolygonF visibleExtentPolygon() const; @@ -476,7 +476,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem void updateCachedImage(); /** Updates the cached map image if the map is set to Render mode - * @see updateCachedImage + * \see updateCachedImage */ void renderModeUpdateCachedImage(); @@ -602,8 +602,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem void mapPolygon( const QgsRectangle &extent, QPolygonF &poly ) const; /** Scales a composer map shift (in MM) and rotates it by mRotation - @param xShift in: shift in x direction (in item units), out: xShift in map units - @param yShift in: shift in y direction (in item units), out: yShift in map units*/ + \param xShift in: shift in x direction (in item units), out: xShift in map units + \param yShift in: shift in y direction (in item units), out: yShift in map units*/ void transformShift( double &xShift, double &yShift ) const; void drawAnnotations( QPainter *painter ); @@ -624,7 +624,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem bool shouldDrawPart( PartType part ) const; /** Refresh the map's extents, considering data defined extent, scale and rotation - * @param context expression context for evaluating data defined map parameters + * \param context expression context for evaluating data defined map parameters * \since QGIS 2.5 */ void refreshMapExtents( const QgsExpressionContext *context = nullptr ); diff --git a/src/core/composer/qgscomposermapgrid.h b/src/core/composer/qgscomposermapgrid.h index 500581870156..1a3701856b1d 100644 --- a/src/core/composer/qgscomposermapgrid.h +++ b/src/core/composer/qgscomposermapgrid.h @@ -48,102 +48,102 @@ class CORE_EXPORT QgsComposerMapGridStack : public QgsComposerMapItemStack public: /** Constructor for QgsComposerMapGridStack. - * @param map QgsComposerMap the grid stack is attached to + * \param map QgsComposerMap the grid stack is attached to */ QgsComposerMapGridStack( QgsComposerMap *map ); /** Adds a new map grid to the stack and takes ownership of the grid. * The grid will be added to the end of the stack, and rendered * above any existing map grids already present in the stack. - * @param grid QgsComposerMapGrid to add to the stack - * @note after adding a grid to the stack, updateBoundingRect() and update() + * \param grid QgsComposerMapGrid to add to the stack + * \note after adding a grid to the stack, updateBoundingRect() and update() * should be called for the QgsComposerMap to prevent rendering artifacts - * @see removeGrid + * \see removeGrid */ void addGrid( QgsComposerMapGrid *grid ); /** Removes a grid from the stack and deletes the corresponding QgsComposerMapGrid - * @param gridId id for the QgsComposerMapGrid to remove - * @note after removing a grid from the stack, updateBoundingRect() and update() + * \param gridId id for the QgsComposerMapGrid to remove + * \note after removing a grid from the stack, updateBoundingRect() and update() * should be called for the QgsComposerMap to prevent rendering artifacts - * @see addGrid + * \see addGrid */ void removeGrid( const QString &gridId ); /** Moves a grid up the stack, causing it to be rendered above other grids - * @param gridId id for the QgsComposerMapGrid to move up - * @note after moving a grid within the stack, update() should be + * \param gridId id for the QgsComposerMapGrid to move up + * \note after moving a grid within the stack, update() should be * called for the QgsComposerMap to redraw the map with the new grid stack order - * @see moveGridDown + * \see moveGridDown */ void moveGridUp( const QString &gridId ); /** Moves a grid down the stack, causing it to be rendered below other grids - * @param gridId id for the QgsComposerMapGrid to move down - * @note after moving a grid within the stack, update() should be + * \param gridId id for the QgsComposerMapGrid to move down + * \note after moving a grid within the stack, update() should be * called for the QgsComposerMap to redraw the map with the new grid stack order - * @see moveGridUp + * \see moveGridUp */ void moveGridDown( const QString &gridId ); /** Returns a const reference to a grid within the stack - * @param gridId id for the QgsComposerMapGrid to find - * @returns const reference to grid, if found - * @see grid + * \param gridId id for the QgsComposerMapGrid to find + * \returns const reference to grid, if found + * \see grid */ const QgsComposerMapGrid *constGrid( const QString &gridId ) const; /** Returns a reference to a grid within the stack - * @param gridId id for the QgsComposerMapGrid to find - * @returns reference to grid if found - * @see constGrid + * \param gridId id for the QgsComposerMapGrid to find + * \returns reference to grid if found + * \see constGrid */ QgsComposerMapGrid *grid( const QString &gridId ) const; /** Returns a reference to a grid within the stack - * @param index grid position in the stack - * @returns reference to grid if found - * @see constGrid + * \param index grid position in the stack + * \returns reference to grid if found + * \see constGrid */ QgsComposerMapGrid *grid( const int index ) const; /** Returns a reference to a grid within the stack - * @param idx grid position in the stack - * @returns reference to grid if found - * @see constGrid - * @see grid + * \param idx grid position in the stack + * \returns reference to grid if found + * \see constGrid + * \see grid */ QgsComposerMapGrid &operator[]( int idx ); /** Returns a list of QgsComposerMapGrids contained by the stack - * @returns list of grids + * \returns list of grids */ QList< QgsComposerMapGrid * > asList() const; /** Sets the grid stack's state from a DOM document - * @param elem is DOM node corresponding to 'a ComposerMap' tag - * @param doc DOM document - * @returns true if read was successful - * @see writeXml + * \param elem is DOM node corresponding to 'a ComposerMap' tag + * \param doc DOM document + * \returns true if read was successful + * \see writeXml */ bool readXml( const QDomElement &elem, const QDomDocument &doc ) override; /** Calculates the maximum distance grids within the stack extend * beyond the QgsComposerMap's item rect - * @returns maximum grid extension - * @see calculateMaxGridExtension() + * \returns maximum grid extension + * \see calculateMaxGridExtension() */ double maxGridExtension() const; /** Calculates the maximum distance grids within the stack extend beyond the * QgsComposerMap's item rect. This method calculates the distance for each side of the * map item separately - * @param top storage for top extension - * @param right storage for right extension - * @param bottom storage for bottom extension - * @param left storage for left extension + * \param top storage for top extension + * \param right storage for right extension + * \param bottom storage for bottom extension + * \param left storage for left extension * \since QGIS 2.12 - * @see maxGridExtension() + * \see maxGridExtension() */ void calculateMaxGridExtension( double &top, double &right, double &bottom, double &left ) const; }; @@ -270,53 +270,53 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem }; /** Constructor for QgsComposerMapGrid. - * @param name friendly display name for grid - * @param map QgsComposerMap the grid is attached to + * \param name friendly display name for grid + * \param map QgsComposerMap the grid is attached to */ QgsComposerMapGrid( const QString &name, QgsComposerMap *map ); virtual ~QgsComposerMapGrid(); /** Draws a grid - * @param painter destination QPainter + * \param painter destination QPainter */ void draw( QPainter *painter ) override; /** Stores grid state in DOM element - * @param elem is DOM element corresponding to a 'ComposerMap' tag - * @param doc DOM document - * @see readXml + * \param elem is DOM element corresponding to a 'ComposerMap' tag + * \param doc DOM document + * \see readXml */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; /** Sets grid state from a DOM document - * @param itemElem is DOM node corresponding to a 'ComposerMapGrid' tag - * @param doc is DOM document - * @see writeXml + * \param itemElem is DOM node corresponding to a 'ComposerMapGrid' tag + * \param doc is DOM document + * \see writeXml */ bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override; /** Sets the CRS for the grid. - * @param crs coordinate reference system for grid - * @see crs + * \param crs coordinate reference system for grid + * \see crs */ void setCrs( const QgsCoordinateReferenceSystem &crs ); /** Retrieves the CRS for the grid. - * @returns coordinate reference system for grid - * @see setCrs + * \returns coordinate reference system for grid + * \see setCrs */ QgsCoordinateReferenceSystem crs() const { return mCRS; } /** Sets the blending mode used for drawing the grid. - * @param mode blending mode for grid - * @see blendMode + * \param mode blending mode for grid + * \see blendMode */ void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; } /** Retrieves the blending mode used for drawing the grid. - * @returns blending mode for grid - * @see setBlendMode + * \returns blending mode for grid + * \see setBlendMode */ QPainter::CompositionMode blendMode() const { return mBlendMode; } @@ -324,19 +324,19 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem /** Calculates the maximum distance the grid extends beyond the QgsComposerMap's * item rect - * @returns maximum extension in millimeters + * \returns maximum extension in millimeters */ double maxExtension(); /** Calculates the maximum distance the grid extends beyond the * QgsComposerMap's item rect. This method calculates the distance for each side of the * map item separately - * @param top storage for top extension - * @param right storage for right extension - * @param bottom storage for bottom extension - * @param left storage for left extension + * \param top storage for top extension + * \param right storage for right extension + * \param bottom storage for bottom extension + * \param left storage for left extension * \since QGIS 2.12 - * @see maxExtension() + * \see maxExtension() */ void calculateMaxExtension( double &top, double &right, double &bottom, double &left ); @@ -346,79 +346,79 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem /** Sets the units to use for grid measurements such as the interval * and offset for grid lines. - * @param unit unit for grid measurements - * @see units + * \param unit unit for grid measurements + * \see units */ void setUnits( const GridUnit unit ); /** Gets the units used for grid measurements such as the interval * and offset for grid lines. - * @returns for grid measurements - * @see setUnits + * \returns for grid measurements + * \see setUnits */ GridUnit units() const { return mGridUnit; } /** Sets the interval between grid lines in the x-direction. The units * are controlled through the setUnits method - * @param interval interval between horizontal grid lines - * @see setIntervalY - * @see intervalX + * \param interval interval between horizontal grid lines + * \see setIntervalY + * \see intervalX */ void setIntervalX( const double interval ); /** Gets the interval between grid lines in the x-direction. The units * are retrieved through the units() method. - * @returns interval between horizontal grid lines - * @see setIntervalX - * @see intervalY + * \returns interval between horizontal grid lines + * \see setIntervalX + * \see intervalY */ double intervalX() const { return mGridIntervalX; } /** Sets the interval between grid lines in the y-direction. The units * are controlled through the setUnits method - * @param interval interval between vertical grid lines - * @see setIntervalX - * @see intervalY + * \param interval interval between vertical grid lines + * \see setIntervalX + * \see intervalY */ void setIntervalY( const double interval ); /** Gets the interval between grid lines in the y-direction. The units * are retrieved through the units() method. - * @returns interval between vertical grid lines - * @see setIntervalY - * @see intervalX + * \returns interval between vertical grid lines + * \see setIntervalY + * \see intervalX */ double intervalY() const { return mGridIntervalY; } /** Sets the offset for grid lines in the x-direction. The units * are controlled through the setUnits method - * @param offset offset for horizontal grid lines - * @see setOffsetY - * @see offsetX + * \param offset offset for horizontal grid lines + * \see setOffsetY + * \see offsetX */ void setOffsetX( const double offset ); /** Gets the offset for grid lines in the x-direction. The units * are retrieved through the units() method. - * @returns offset for horizontal grid lines - * @see setOffsetX - * @see offsetY + * \returns offset for horizontal grid lines + * \see setOffsetX + * \see offsetY */ double offsetX() const { return mGridOffsetX; } /** Sets the offset for grid lines in the y-direction. The units * are controlled through the setUnits method - * @param offset offset for vertical grid lines - * @see setOffsetX - * @see offsetY + * \param offset offset for vertical grid lines + * \see setOffsetX + * \see offsetY */ void setOffsetY( const double offset ); /** Gets the offset for grid lines in the y-direction. The units * are retrieved through the units() method. - * @returns offset for vertical grid lines - * @see setOffsetY - * @see offsetX + * \returns offset for vertical grid lines + * \see setOffsetY + * \see offsetX */ double offsetY() const { return mGridOffsetY; } @@ -428,103 +428,103 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem /** Sets the grid style, which controls how the grid is drawn * over the map's contents - * @param style desired grid style - * @see style + * \param style desired grid style + * \see style */ void setStyle( const GridStyle style ); /** Gets the grid's style, which controls how the grid is drawn * over the map's contents - * @returns current grid style - * @see setStyle + * \returns current grid style + * \see setStyle */ GridStyle style() const { return mGridStyle; } /** Sets the length of the cross segments drawn for the grid. This is only used for grids * with QgsComposerMapGrid::Cross styles - * @param length cross length in millimeters - * @see crossLength + * \param length cross length in millimeters + * \see crossLength */ void setCrossLength( const double length ) { mCrossLength = length; } /** Retrieves the length of the cross segments drawn for the grid. This is only used for grids * with QgsComposerMapGrid::Cross styles - * @returns cross length in millimeters - * @see setCrossLength + * \returns cross length in millimeters + * \see setCrossLength */ double crossLength() const { return mCrossLength; } /** Sets width of grid lines. This is only used for grids with QgsComposerMapGrid::Solid * or QgsComposerMapGrid::Cross styles. For more control over grid line appearance, use * setLineSymbol instead. - * @param width grid line width - * @see setLineSymbol - * @see setGridLineColor + * \param width grid line width + * \see setLineSymbol + * \see setGridLineColor */ void setGridLineWidth( const double width ); /** Sets color of grid lines. This is only used for grids with QgsComposerMapGrid::Solid * or QgsComposerMapGrid::Cross styles. For more control over grid line appearance, use * setLineSymbol instead. - * @param color color of grid lines - * @see setLineSymbol - * @see setGridLineWidth + * \param color color of grid lines + * \see setLineSymbol + * \see setGridLineWidth */ void setGridLineColor( const QColor &color ); /** Sets the line symbol used for drawing grid lines. This is only used for grids with * QgsComposerMapGrid::Solid or QgsComposerMapGrid::Cross styles. - * @param symbol line symbol for grid lines - * @see lineSymbol - * @see setMarkerSymbol - * @see setStyle + * \param symbol line symbol for grid lines + * \see lineSymbol + * \see setMarkerSymbol + * \see setStyle */ void setLineSymbol( QgsLineSymbol *symbol ); /** Gets the line symbol used for drawing grid lines. This is only used for grids with * QgsComposerMapGrid::Solid or QgsComposerMapGrid::Cross styles. - * @returns line symbol for grid lines - * @see setLineSymbol - * @see markerSymbol - * @see style - * @note not available in Python bindings + * \returns line symbol for grid lines + * \see setLineSymbol + * \see markerSymbol + * \see style + * \note not available in Python bindings */ const QgsLineSymbol *lineSymbol() const { return mGridLineSymbol; } /** Gets the line symbol used for drawing grid lines. This is only used for grids with * QgsComposerMapGrid::Solid or QgsComposerMapGrid::Cross styles. - * @returns line symbol for grid lines - * @see setLineSymbol - * @see markerSymbol - * @see style + * \returns line symbol for grid lines + * \see setLineSymbol + * \see markerSymbol + * \see style */ QgsLineSymbol *lineSymbol() { return mGridLineSymbol; } /** Sets the marker symbol used for drawing grid points. This is only used for grids with a * QgsComposerMapGrid::Markers style. - * @param symbol marker symbol for grid intersection points - * @see markerSymbol - * @see setLineSymbol - * @see setStyle + * \param symbol marker symbol for grid intersection points + * \see markerSymbol + * \see setLineSymbol + * \see setStyle */ void setMarkerSymbol( QgsMarkerSymbol *symbol ); /** Gets the marker symbol used for drawing grid points. This is only used for grids with a * QgsComposerMapGrid::Markers style. - * @returns marker symbol for grid intersection points - * @see setMarkerSymbol - * @see lineSymbol - * @see style - * @note not available in Python bindings + * \returns marker symbol for grid intersection points + * \see setMarkerSymbol + * \see lineSymbol + * \see style + * \note not available in Python bindings */ const QgsMarkerSymbol *markerSymbol() const { return mGridMarkerSymbol; } /** Gets the marker symbol used for drawing grid points. This is only used for grids with a * QgsComposerMapGrid::Markers style. - * @returns marker symbol for grid intersection points - * @see setMarkerSymbol - * @see lineSymbol - * @see style + * \returns marker symbol for grid intersection points + * \see setMarkerSymbol + * \see lineSymbol + * \see style */ QgsMarkerSymbol *markerSymbol() { return mGridMarkerSymbol; } @@ -533,58 +533,58 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem // /** Sets whether annotations should be shown for the grid. - * @param enabled set to true to draw annotations for the grid - * @see annotationEnabled + * \param enabled set to true to draw annotations for the grid + * \see annotationEnabled */ void setAnnotationEnabled( const bool enabled ) { mShowGridAnnotation = enabled; } /** Gets whether annotations are shown for the grid. - * @returns true if annotations are drawn for the grid - * @see setAnnotationEnabled + * \returns true if annotations are drawn for the grid + * \see setAnnotationEnabled */ bool annotationEnabled() const { return mShowGridAnnotation; } /** Sets the font used for drawing grid annotations - * @param font font for annotations - * @see annotationFont + * \param font font for annotations + * \see annotationFont */ void setAnnotationFont( const QFont &font ) { mGridAnnotationFont = font; } /** Gets the font used for drawing grid annotations - * @returns font for annotations - * @see setAnnotationFont + * \returns font for annotations + * \see setAnnotationFont */ QFont annotationFont() const { return mGridAnnotationFont; } /** Sets the font color used for drawing grid annotations - * @param color font color for annotations - * @see annotationFontColor + * \param color font color for annotations + * \see annotationFontColor */ void setAnnotationFontColor( const QColor &color ) { mGridAnnotationFontColor = color; } /** Gets the font color used for drawing grid annotations - * @returns font color for annotations - * @see setAnnotationFontColor + * \returns font color for annotations + * \see setAnnotationFontColor */ QColor annotationFontColor() const { return mGridAnnotationFontColor; } /** Sets the coordinate precision for grid annotations - * @param precision number of decimal places to show when drawing grid annotations - * @see annotationPrecision + * \param precision number of decimal places to show when drawing grid annotations + * \see annotationPrecision */ void setAnnotationPrecision( const int precision ) { mGridAnnotationPrecision = precision; } /** Returns the coordinate precision for grid annotations - * @returns number of decimal places shown when drawing grid annotations - * @see setAnnotationPrecision + * \returns number of decimal places shown when drawing grid annotations + * \see setAnnotationPrecision */ int annotationPrecision() const { return mGridAnnotationPrecision; } /** Sets what types of grid annotations should be drawn for a specified side of the map frame, * or whether grid annotations should be disabled for the side. - * @param display display mode for annotations - * @param border side of map for annotations - * @see annotationDisplay + * \param display display mode for annotations + * \param border side of map for annotations + * \see annotationDisplay * \since QGIS 2.7 */ void setAnnotationDisplay( const DisplayMode display, const BorderSide border ); @@ -592,85 +592,85 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem /** Gets the display mode for the grid annotations on a specified side of the map * frame. This property also specifies whether annotations have been disabled * from a side of the map frame. - * @param border side of map for annotations - * @returns display mode for grid annotations - * @see setAnnotationDisplay + * \param border side of map for annotations + * \returns display mode for grid annotations + * \see setAnnotationDisplay * \since QGIS 2.7 */ DisplayMode annotationDisplay( const BorderSide border ) const; /** Sets the position for the grid annotations on a specified side of the map * frame. - * @param position position to draw grid annotations - * @param border side of map for annotations - * @see annotationPosition + * \param position position to draw grid annotations + * \param border side of map for annotations + * \see annotationPosition */ void setAnnotationPosition( const AnnotationPosition position, const BorderSide border ); /** Gets the position for the grid annotations on a specified side of the map * frame. - * @param border side of map for annotations - * @returns position that grid annotations are drawn in - * @see setAnnotationPosition + * \param border side of map for annotations + * \returns position that grid annotations are drawn in + * \see setAnnotationPosition */ AnnotationPosition annotationPosition( const BorderSide border ) const; /** Sets the distance between the map frame and annotations. Units are in millimeters. - * @param distance margin between map frame and annotations - * @see annotationFrameDistance + * \param distance margin between map frame and annotations + * \see annotationFrameDistance */ void setAnnotationFrameDistance( const double distance ) { mAnnotationFrameDistance = distance; } /** Gets the distance between the map frame and annotations. Units are in millimeters. - * @returns margin between map frame and annotations - * @see setAnnotationFrameDistance + * \returns margin between map frame and annotations + * \see setAnnotationFrameDistance */ double annotationFrameDistance() const { return mAnnotationFrameDistance; } /** Sets the direction for drawing frame annotations. - * @param direction direction for frame annotations - * @param border side of map for annotations - * @see annotationDirection + * \param direction direction for frame annotations + * \param border side of map for annotations + * \see annotationDirection */ void setAnnotationDirection( const AnnotationDirection direction, const BorderSide border ); /** Sets the direction for drawing all frame annotations. - * @param direction direction for frame annotations - * @see annotationDirection + * \param direction direction for frame annotations + * \see annotationDirection */ void setAnnotationDirection( const AnnotationDirection direction ); /** Gets the direction for drawing frame annotations. - * @param border side of map for annotations - * @returns direction for frame annotations - * @see setAnnotationDirection + * \param border side of map for annotations + * \returns direction for frame annotations + * \see setAnnotationDirection */ AnnotationDirection annotationDirection( const BorderSide border ) const; /** Sets the format for drawing grid annotations. - * @param format format for grid annotations - * @see annotationFormat + * \param format format for grid annotations + * \see annotationFormat */ void setAnnotationFormat( const AnnotationFormat format ) { mGridAnnotationFormat = format; } /** Gets the format for drawing grid annotations. - * @returns format for grid annotations - * @see setAnnotationFormat + * \returns format for grid annotations + * \see setAnnotationFormat */ AnnotationFormat annotationFormat() const { return mGridAnnotationFormat; } /** Sets the expression used for drawing grid annotations. This is only used when annotationFormat() * is QgsComposerMapGrid::CustomFormat. - * @param expression expression for evaluating custom grid annotations - * @see annotationExpression + * \param expression expression for evaluating custom grid annotations + * \see annotationExpression * \since QGIS 2.12 */ void setAnnotationExpression( const QString &expression ) { mGridAnnotationExpressionString = expression; mGridAnnotationExpression.reset(); } /** Returns the expression used for drawing grid annotations. This is only used when annotationFormat() * is QgsComposerMapGrid::CustomFormat. - * @returns expression for evaluating custom grid annotations - * @see setAnnotationExpression + * \returns expression for evaluating custom grid annotations + * \see setAnnotationExpression * \since QGIS 2.12 */ QString annotationExpression() const { return mGridAnnotationExpressionString; } @@ -680,147 +680,147 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem // /** Sets the grid frame style. - * @param style style for grid frame - * @see frameStyle + * \param style style for grid frame + * \see frameStyle */ void setFrameStyle( const FrameStyle style ) { mGridFrameStyle = style; } /** Gets the grid frame style. - * @returns style for grid frame - * @see setFrameStyle + * \returns style for grid frame + * \see setFrameStyle */ FrameStyle frameStyle() const { return mGridFrameStyle; } /** Sets what type of grid divisions should be used for frames on a specified side of the map. - * @param divisions grid divisions for frame - * @param border side of map for frame - * @see frameDivisions + * \param divisions grid divisions for frame + * \param border side of map for frame + * \see frameDivisions * \since QGIS 2.7 */ void setFrameDivisions( const DisplayMode divisions, const BorderSide border ); /** Gets the type of grid divisions which are used for frames on a specified side of the map. - * @param border side of map for frame - * @returns grid divisions for frame - * @see setFrameDivisions + * \param border side of map for frame + * \returns grid divisions for frame + * \see setFrameDivisions * \since QGIS 2.7 */ DisplayMode frameDivisions( const BorderSide border ) const; /** Sets flags for grid frame sides. Setting these flags controls which sides * of the map item the grid frame is drawn on. - * @param flags flags for grid frame sides - * @see setFrameSideFlag - * @see frameSideFlags - * @see testFrameSideFlag + * \param flags flags for grid frame sides + * \see setFrameSideFlag + * \see frameSideFlags + * \see testFrameSideFlag */ void setFrameSideFlags( QgsComposerMapGrid::FrameSideFlags flags ); /** Sets whether the grid frame is drawn for a certain side of the map item. - * @param flag flag for grid frame side - * @param on set to true to draw grid frame on that side of the map - * @see setFrameSideFlags - * @see frameSideFlags - * @see testFrameSideFlag + * \param flag flag for grid frame side + * \param on set to true to draw grid frame on that side of the map + * \see setFrameSideFlags + * \see frameSideFlags + * \see testFrameSideFlag */ void setFrameSideFlag( const FrameSideFlag flag, bool on = true ); /** Returns the flags which control which sides of the map item the grid frame * is drawn on. - * @returns flags for side of map grid is drawn on - * @see setFrameSideFlags - * @see setFrameSideFlag - * @see testFrameSideFlag + * \returns flags for side of map grid is drawn on + * \see setFrameSideFlags + * \see setFrameSideFlag + * \see testFrameSideFlag */ FrameSideFlags frameSideFlags() const; /** Tests whether the grid frame should be drawn on a specified side of the map * item. - * @param flag flag for grid frame side - * @returns true if grid frame should be drawn for that side of the map - * @see setFrameSideFlags - * @see setFrameSideFlag - * @see frameSideFlags + * \param flag flag for grid frame side + * \returns true if grid frame should be drawn for that side of the map + * \see setFrameSideFlags + * \see setFrameSideFlag + * \see frameSideFlags */ bool testFrameSideFlag( const FrameSideFlag flag ) const; /** Sets the grid frame width. This property controls how wide the grid frame is. * The size of the line outlines drawn in the frame is controlled through the * setFramePenSize method. - * @param width width of grid frame in millimeters - * @see frameWidth + * \param width width of grid frame in millimeters + * \see frameWidth */ void setFrameWidth( const double width ) { mGridFrameWidth = width; } /** Gets the grid frame width. This property controls how wide the grid frame is. * The size of the line outlines drawn in the frame can be retrieved via the * framePenSize method. - * @returns width of grid frame in millimeters - * @see setFrameWidth + * \returns width of grid frame in millimeters + * \see setFrameWidth */ double frameWidth() const { return mGridFrameWidth; } /** Sets the width of the stroke drawn in the grid frame. - * @param width width of grid frame stroke - * @see framePenSize - * @see setFramePenColor + * \param width width of grid frame stroke + * \see framePenSize + * \see setFramePenColor */ void setFramePenSize( const double width ) { mGridFramePenThickness = width; } /** Retrieves the width of the stroke drawn in the grid frame. - * @returns width of grid frame stroke - * @see setFramePenSize - * @see framePenColor + * \returns width of grid frame stroke + * \see setFramePenSize + * \see framePenColor */ double framePenSize() const { return mGridFramePenThickness; } /** Sets the color of the stroke drawn in the grid frame. - * @param color color of grid frame stroke - * @see framePenColor - * @see setFramePenSize - * @see setFrameFillColor1 - * @see setFrameFillColor2 + * \param color color of grid frame stroke + * \see framePenColor + * \see setFramePenSize + * \see setFrameFillColor1 + * \see setFrameFillColor2 */ void setFramePenColor( const QColor &color ) { mGridFramePenColor = color; } /** Retrieves the color of the stroke drawn in the grid frame. - * @returns color of grid frame stroke - * @see setFramePenColor - * @see framePenSize - * @see frameFillColor1 - * @see frameFillColor2 + * \returns color of grid frame stroke + * \see setFramePenColor + * \see framePenSize + * \see frameFillColor1 + * \see frameFillColor2 */ QColor framePenColor() const {return mGridFramePenColor;} /** Sets the first fill color used for the grid frame. - * @param color first fill color for grid frame - * @see frameFillColor1 - * @see setFramePenColor - * @see setFrameFillColor2 + * \param color first fill color for grid frame + * \see frameFillColor1 + * \see setFramePenColor + * \see setFrameFillColor2 */ void setFrameFillColor1( const QColor &color ) { mGridFrameFillColor1 = color; } /** Retrieves the first fill color for the grid frame. - * @returns first fill color for grid frame - * @see setFrameFillColor1 - * @see framePenColor - * @see frameFillColor2 + * \returns first fill color for grid frame + * \see setFrameFillColor1 + * \see framePenColor + * \see frameFillColor2 */ QColor frameFillColor1() const { return mGridFrameFillColor1; } /** Sets the second fill color used for the grid frame. - * @param color second fill color for grid frame - * @see frameFillColor2 - * @see setFramePenColor - * @see setFrameFillColor1 + * \param color second fill color for grid frame + * \see frameFillColor2 + * \see setFramePenColor + * \see setFrameFillColor1 */ void setFrameFillColor2( const QColor &color ) { mGridFrameFillColor2 = color; } /** Retrieves the second fill color for the grid frame. - * @returns second fill color for grid frame - * @see setFrameFillColor2 - * @see framePenColor - * @see frameFillColor1 + * \returns second fill color for grid frame + * \see setFrameFillColor2 + * \see framePenColor + * \see frameFillColor1 */ QColor frameFillColor2() const { return mGridFrameFillColor2; } @@ -949,11 +949,11 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem void drawGridFrame( QPainter *p, const QList< QPair< double, QLineF > > &hLines, const QList< QPair< double, QLineF > > &vLines, GridExtension *extension = nullptr ) const; /** Draw coordinates for mGridAnnotationType Coordinate - @param p drawing painter - @param hLines horizontal coordinate lines in item coordinates - @param vLines vertical coordinate lines in item coordinates - @param expressionContext expression context for evaluating custom annotation formats - @param extension optional. If specified, nothing will be drawn and instead the maximum extension for the grid + \param p drawing painter + \param hLines horizontal coordinate lines in item coordinates + \param vLines vertical coordinate lines in item coordinates + \param expressionContext expression context for evaluating custom annotation formats + \param extension optional. If specified, nothing will be drawn and instead the maximum extension for the grid annotations will be stored in this variable. */ void drawCoordinateAnnotations( QPainter *p, const QList< QPair< double, QLineF > > &hLines, const QList< QPair< double, QLineF > > &vLines, QgsExpressionContext &expressionContext, GridExtension *extension = nullptr ) const; @@ -964,21 +964,21 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem void drawCoordinateAnnotation( QPainter *p, QPointF pos, const QString &annotationString, const AnnotationCoordinate coordinateType, GridExtension *extension = nullptr ) const; /** Draws a single annotation - * @param p drawing painter - * @param pos item coordinates where to draw - * @param rotation text rotation - * @param annotationText the text to draw + * \param p drawing painter + * \param pos item coordinates where to draw + * \param rotation text rotation + * \param annotationText the text to draw */ void drawAnnotation( QPainter *p, QPointF pos, int rotation, const QString &annotationText ) const; QString gridAnnotationString( double value, AnnotationCoordinate coord, QgsExpressionContext &expressionContext ) const; /** Returns the grid lines with associated coordinate value - @return 0 in case of success*/ + \returns 0 in case of success*/ int xGridLines( QList< QPair< double, QLineF > > &lines ) const; /** Returns the grid lines for the y-coordinates. Not vertical in case of rotation - @return 0 in case of success*/ + \returns 0 in case of success*/ int yGridLines( QList< QPair< double, QLineF > > &lines ) const; int xGridLinesCrsTransform( const QgsRectangle &bbox, const QgsCoordinateTransform &t, QList< QPair< double, QPolygonF > > &lines ) const; @@ -998,8 +998,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem void drawGridFrameBorder( QPainter *p, const QMap< double, double > &borderPos, BorderSide border, double *extension = nullptr ) const; /** Returns the item border of a point (in item coordinates) - * @param p point - * @param coordinateType coordinate type + * \param p point + * \param coordinateType coordinate type */ BorderSide borderForLineCoord( QPointF p, const AnnotationCoordinate coordinateType ) const; diff --git a/src/core/composer/qgscomposermapitem.h b/src/core/composer/qgscomposermapitem.h index bfc691d17615..19623f8e7058 100644 --- a/src/core/composer/qgscomposermapitem.h +++ b/src/core/composer/qgscomposermapitem.h @@ -33,73 +33,73 @@ class CORE_EXPORT QgsComposerMapItem : public QgsComposerObject public: /** Constructor for QgsComposerMapItem. - * @param name friendly display name for item - * @param map QgsComposerMap the item is attached to + * \param name friendly display name for item + * \param map QgsComposerMap the item is attached to */ QgsComposerMapItem( const QString &name, QgsComposerMap *map ); /** Draws the item on to a painter - * @param painter destination QPainter + * \param painter destination QPainter */ virtual void draw( QPainter *painter ) = 0; /** Stores map item state in DOM element - * @param elem is DOM element corresponding to a 'ComposerMap' tag - * @param doc DOM document - * @see readXml + * \param elem is DOM element corresponding to a 'ComposerMap' tag + * \param doc DOM document + * \see readXml */ virtual bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; /** Sets map item state from a DOM document - * @param itemElem is DOM node corresponding to a 'ComposerMapGrid' tag - * @param doc is DOM document - * @see writeXml + * \param itemElem is DOM node corresponding to a 'ComposerMapGrid' tag + * \param doc is DOM document + * \see writeXml */ virtual bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override; /** Sets composer map for the item - * @param map composer map - * @see composerMap + * \param map composer map + * \see composerMap */ virtual void setComposerMap( QgsComposerMap *map ); /** Get composer map for the item - * @returns composer map - * @see setComposerMap + * \returns composer map + * \see setComposerMap */ virtual const QgsComposerMap *composerMap() const { return mComposerMap; } /** Get the unique id for the map item - * @returns unique id + * \returns unique id */ QString id() const { return mUuid; } /** Sets the friendly display name for the item - * @param name display name - * @see name + * \param name display name + * \see name */ virtual void setName( const QString &name ) { mName = name; } /** Get friendly display name for the item - * @returns display name - * @see setName + * \returns display name + * \see setName */ virtual QString name() const { return mName; } /** Controls whether the item will be drawn - * @param enabled set to true to enable drawing of the item - * @see enabled + * \param enabled set to true to enable drawing of the item + * \see enabled */ virtual void setEnabled( const bool enabled ) { mEnabled = enabled; } /** Returns whether the item will be drawn - * @returns true if item will be drawn on the map - * @see setEnabled + * \returns true if item will be drawn on the map + * \see setEnabled */ virtual bool enabled() const { return mEnabled; } /** Returns true if the item is drawn using advanced effects, such as blend modes. - * @returns true if item uses advanced effects + * \returns true if item uses advanced effects */ virtual bool usesAdvancedEffects() const { return false; } @@ -134,41 +134,41 @@ class CORE_EXPORT QgsComposerMapItemStack public: /** Constructor for QgsComposerMapItemStack. - * @param map QgsComposerMap the item stack is attached to + * \param map QgsComposerMap the item stack is attached to */ QgsComposerMapItemStack( QgsComposerMap *map ); virtual ~QgsComposerMapItemStack(); /** Returns the number of items in the stack - * @returns number of items in the stack + * \returns number of items in the stack */ int size() const { return mItems.size(); } /** Stores the state of the item stack in a DOM node - * @param elem is DOM element corresponding to a 'ComposerMap' tag - * @param doc DOM document - * @returns true if write was successful - * @see readXml + * \param elem is DOM element corresponding to a 'ComposerMap' tag + * \param doc DOM document + * \returns true if write was successful + * \see readXml */ virtual bool writeXml( QDomElement &elem, QDomDocument &doc ) const; /** Sets the item stack's state from a DOM document - * @param elem is DOM node corresponding to 'a ComposerMap' tag - * @param doc DOM document - * @returns true if read was successful - * @see writeXml + * \param elem is DOM node corresponding to 'a ComposerMap' tag + * \param doc DOM document + * \returns true if read was successful + * \see writeXml */ virtual bool readXml( const QDomElement &elem, const QDomDocument &doc ) = 0; /** Draws the items from the stack on a specified painter - * @param painter destination QPainter + * \param painter destination QPainter */ void drawItems( QPainter *painter ); /** Returns whether any items within the stack contain advanced effects, * such as blending modes - * @returns true if item stack contains advanced effects + * \returns true if item stack contains advanced effects */ bool containsAdvancedEffects() const; @@ -177,69 +177,69 @@ class CORE_EXPORT QgsComposerMapItemStack /** Adds a new map item to the stack and takes ownership of the item. * The item will be added to the end of the stack, and rendered * above any existing map items already present in the stack. - * @param item QgsComposerMapItem to add to the stack - * @note after adding an item to the stack update() + * \param item QgsComposerMapItem to add to the stack + * \note after adding an item to the stack update() * should be called for the QgsComposerMap to prevent rendering artifacts - * @see removeItem + * \see removeItem */ void addItem( QgsComposerMapItem *item ); /** Removes an item from the stack and deletes the corresponding QgsComposerMapItem - * @param itemId id for the QgsComposerMapItem to remove - * @note after removing an item from the stack, update() + * \param itemId id for the QgsComposerMapItem to remove + * \note after removing an item from the stack, update() * should be called for the QgsComposerMap to prevent rendering artifacts - * @see addItem + * \see addItem */ void removeItem( const QString &itemId ); /** Moves an item up the stack, causing it to be rendered above other items - * @param itemId id for the QgsComposerMapItem to move up - * @note after moving an item within the stack, update() should be + * \param itemId id for the QgsComposerMapItem to move up + * \note after moving an item within the stack, update() should be * called for the QgsComposerMap to redraw the map with the new item stack order - * @see moveItemDown + * \see moveItemDown */ void moveItemUp( const QString &itemId ); /** Moves an item up the stack, causing it to be rendered above other items - * @param itemId id for the QgsComposerMapItem to move down - * @note after moving an item within the stack, update() should be + * \param itemId id for the QgsComposerMapItem to move down + * \note after moving an item within the stack, update() should be * called for the QgsComposerMap to redraw the map with the new item stack order - * @see moveItemUp + * \see moveItemUp */ void moveItemDown( const QString &itemId ); /** Returns a const reference to an item within the stack - * @param itemId id for the QgsComposerMapItem to find - * @returns const reference to item, if found - * @see item + * \param itemId id for the QgsComposerMapItem to find + * \returns const reference to item, if found + * \see item */ const QgsComposerMapItem *constItem( const QString &itemId ) const; /** Returns a reference to an item within the stack - * @param itemId id for the QgsComposerMapItem to find - * @returns reference to item if found - * @see constItem + * \param itemId id for the QgsComposerMapItem to find + * \returns reference to item if found + * \see constItem */ QgsComposerMapItem *item( const QString &itemId ) const; /** Returns a reference to an item within the stack - * @param index item position in the stack - * @returns reference to item if found - * @see constItem + * \param index item position in the stack + * \returns reference to item if found + * \see constItem */ QgsComposerMapItem *item( const int index ) const; /** Returns a reference to an item within the stack - * @param idx item position in the stack - * @returns reference to item if found - * @see constItem - * @see item - * @note not available in Python bindings + * \param idx item position in the stack + * \returns reference to item if found + * \see constItem + * \see item + * \note not available in Python bindings */ QgsComposerMapItem &operator[]( int idx ); /** Returns a list of QgsComposerMapItems contained by the stack - * @returns list of items + * \returns list of items */ QList< QgsComposerMapItem * > asList() const; diff --git a/src/core/composer/qgscomposermapoverview.h b/src/core/composer/qgscomposermapoverview.h index fb3f518e90bf..81e656c0fd57 100644 --- a/src/core/composer/qgscomposermapoverview.h +++ b/src/core/composer/qgscomposermapoverview.h @@ -42,83 +42,83 @@ class CORE_EXPORT QgsComposerMapOverviewStack : public QgsComposerMapItemStack public: /** Constructor for QgsComposerMapOverviewStack. - * @param map QgsComposerMap the overview stack is attached to + * \param map QgsComposerMap the overview stack is attached to */ QgsComposerMapOverviewStack( QgsComposerMap *map ); /** Adds a new map overview to the stack and takes ownership of the overview. * The overview will be added to the end of the stack, and rendered * above any existing map overviews already present in the stack. - * @param overview QgsComposerMapOverview to add to the stack - * @note after adding a overview to the stack, update() + * \param overview QgsComposerMapOverview to add to the stack + * \note after adding a overview to the stack, update() * should be called for the QgsComposerMap to prevent rendering artifacts - * @see removeOverview + * \see removeOverview */ void addOverview( QgsComposerMapOverview *overview ); /** Removes an overview from the stack and deletes the corresponding QgsComposerMapOverview - * @param overviewId id for the QgsComposerMapOverview to remove - * @note after removing an overview from the stack, update() + * \param overviewId id for the QgsComposerMapOverview to remove + * \note after removing an overview from the stack, update() * should be called for the QgsComposerMap to prevent rendering artifacts - * @see addOverview + * \see addOverview */ void removeOverview( const QString &overviewId ); /** Moves an overview up the stack, causing it to be rendered above other overviews - * @param overviewId id for the QgsComposerMapOverview to move up - * @note after moving an overview within the stack, update() should be + * \param overviewId id for the QgsComposerMapOverview to move up + * \note after moving an overview within the stack, update() should be * called for the QgsComposerMap to redraw the map with the new overview stack order - * @see moveOverviewDown + * \see moveOverviewDown */ void moveOverviewUp( const QString &overviewId ); /** Moves an overview down the stack, causing it to be rendered below other overviews - * @param overviewId id for the QgsComposerMapOverview to move down - * @note after moving an overview within the stack, update() should be + * \param overviewId id for the QgsComposerMapOverview to move down + * \note after moving an overview within the stack, update() should be * called for the QgsComposerMap to redraw the map with the new overview stack order - * @see moveOverviewUp + * \see moveOverviewUp */ void moveOverviewDown( const QString &overviewId ); /** Returns a const reference to an overview within the stack - * @param overviewId id for the QgsComposerMapOverview to find - * @returns const reference to overview, if found - * @see overview + * \param overviewId id for the QgsComposerMapOverview to find + * \returns const reference to overview, if found + * \see overview */ const QgsComposerMapOverview *constOverview( const QString &overviewId ) const; /** Returns a reference to an overview within the stack - * @param overviewId id for the QgsComposerMapOverview to find - * @returns reference to overview if found - * @see constOverview + * \param overviewId id for the QgsComposerMapOverview to find + * \returns reference to overview if found + * \see constOverview */ QgsComposerMapOverview *overview( const QString &overviewId ) const; /** Returns a reference to an overview within the stack - * @param index overview position in the stack - * @returns reference to overview if found - * @see constOverview + * \param index overview position in the stack + * \returns reference to overview if found + * \see constOverview */ QgsComposerMapOverview *overview( const int index ) const; /** Returns a reference to an overview within the stack - * @param idx overview position in the stack - * @returns reference to overview if found - * @see constOverview - * @see overview + * \param idx overview position in the stack + * \returns reference to overview if found + * \see constOverview + * \see overview */ QgsComposerMapOverview &operator[]( int idx ); /** Returns a list of QgsComposerMapOverviews contained by the stack - * @returns list of overviews + * \returns list of overviews */ QList< QgsComposerMapOverview * > asList() const; /** Sets the overview stack's state from a DOM document - * @param elem is DOM node corresponding to a 'ComposerMap' tag - * @param doc DOM document - * @returns true if read was successful - * @see writeXml + * \param elem is DOM node corresponding to a 'ComposerMap' tag + * \param doc DOM document + * \returns true if read was successful + * \see writeXml */ bool readXml( const QDomElement &elem, const QDomDocument &doc ) override; @@ -138,99 +138,99 @@ class CORE_EXPORT QgsComposerMapOverview : public QgsComposerMapItem public: /** Constructor for QgsComposerMapOverview. - * @param name friendly display name for overview - * @param map QgsComposerMap the overview is attached to + * \param name friendly display name for overview + * \param map QgsComposerMap the overview is attached to */ QgsComposerMapOverview( const QString &name, QgsComposerMap *map ); virtual ~QgsComposerMapOverview(); /** Draws an overview - * @param painter destination QPainter + * \param painter destination QPainter */ void draw( QPainter *painter ) override; /** Stores overview state in DOM element - * @param elem is DOM element corresponding to a 'ComposerMap' tag - * @param doc DOM document - * @see readXml + * \param elem is DOM element corresponding to a 'ComposerMap' tag + * \param doc DOM document + * \see readXml */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; /** Sets overview state from a DOM document - * @param itemElem is DOM node corresponding to a 'ComposerMapOverview' tag - * @param doc is DOM document - * @see writeXml + * \param itemElem is DOM node corresponding to a 'ComposerMapOverview' tag + * \param doc is DOM document + * \see writeXml */ bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override; bool usesAdvancedEffects() const override; /** Sets overview frame map. - * @param mapId source map id. -1 disables the overview frame - * @see frameMapId + * \param mapId source map id. -1 disables the overview frame + * \see frameMapId */ void setFrameMap( const int mapId ); /** Returns id of source map. - * @returns source map id, or -1 if no source map set + * \returns source map id, or -1 if no source map set */ int frameMapId() const { return mFrameMapId; } /** Sets the fill symbol used for drawing the overview extent. - * @param symbol fill symbol for overview - * @see frameSymbol + * \param symbol fill symbol for overview + * \see frameSymbol */ void setFrameSymbol( QgsFillSymbol *symbol ); /** Gets the fill symbol used for drawing the overview extent. - * @returns fill symbol for overview - * @see setFrameSymbol + * \returns fill symbol for overview + * \see setFrameSymbol */ QgsFillSymbol *frameSymbol() { return mFrameSymbol; } /** Gets the fill symbol used for drawing the overview extent. - * @returns fill symbol for overview - * @see setFrameSymbol - * @note not available in Python bindings + * \returns fill symbol for overview + * \see setFrameSymbol + * \note not available in Python bindings */ const QgsFillSymbol *frameSymbol() const { return mFrameSymbol; } /** Retrieves the blending mode used for drawing the overview. - * @returns blending mode for overview - * @see setBlendMode + * \returns blending mode for overview + * \see setBlendMode */ QPainter::CompositionMode blendMode() const { return mBlendMode; } /** Sets the blending mode used for drawing the overview. - * @param blendMode blending mode for overview - * @see blendMode + * \param blendMode blending mode for overview + * \see blendMode */ void setBlendMode( const QPainter::CompositionMode blendMode ); /** Returns whether the overview frame is inverted, ie, whether the shaded area is drawn outside * the extent of the overview map. - * @returns true if overview frame is inverted - * @see setInverted + * \returns true if overview frame is inverted + * \see setInverted */ bool inverted() const { return mInverted; } /** Sets whether the overview frame is inverted, ie, whether the shaded area is drawn outside * the extent of the overview map. - * @param inverted set to true if overview frame is to be inverted - * @see inverted + * \param inverted set to true if overview frame is to be inverted + * \see inverted */ void setInverted( const bool inverted ); /** Returns whether the extent of the map is forced to center on the overview - * @returns true if map will be centered on overview - * @see setCentered + * \returns true if map will be centered on overview + * \see setCentered */ bool centered() const { return mCentered; } /** Sets whether the extent of the map is forced to center on the overview - * @param centered set to true if map will be centered on overview - * @see centered + * \param centered set to true if map will be centered on overview + * \see centered */ void setCentered( const bool centered ); diff --git a/src/core/composer/qgscomposermodel.h b/src/core/composer/qgscomposermodel.h index 76af0549fde5..0297a2cb58f0 100644 --- a/src/core/composer/qgscomposermodel.h +++ b/src/core/composer/qgscomposermodel.h @@ -61,8 +61,8 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel }; /** Constructor - * @param composition composition to attach to - * @param parent parent object + * \param composition composition to attach to + * \param parent parent object */ explicit QgsComposerModel( QgsComposition *composition, QObject *parent = nullptr ); @@ -88,7 +88,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel /** Returns the size of the z-order list, which includes items which may * have been removed from the composition. - * @returns size of z-order list + * \returns size of z-order list * \since QGIS 2.5 */ int zOrderListSize() const; @@ -100,58 +100,58 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel void rebuildZList(); /** Adds an item to the top of the composition z stack. - * @param item item to add. The item must not already exist in the z-order list. + * \param item item to add. The item must not already exist in the z-order list. * \since QGIS 2.5 - * @see reorderItemToTop + * \see reorderItemToTop */ void addItemAtTop( QgsComposerItem *item ); /** Removes an item from the z-order list. - * @param item item to remove + * \param item item to remove * \since QGIS 2.5 */ void removeItem( QgsComposerItem *item ); /** Moves an item up the z-order list. - * @param item item to move - * @returns true if item was moved. Returns false if item was not found + * \param item item to move + * \returns true if item was moved. Returns false if item was not found * in z-order list or was already at the top of the z-order list. - * @see reorderItemDown - * @see reorderItemToTop - * @see reorderItemToBottom + * \see reorderItemDown + * \see reorderItemToTop + * \see reorderItemToBottom * \since QGIS 2.5 */ bool reorderItemUp( QgsComposerItem *item ); /** Moves an item down the z-order list. - * @param item item to move - * @returns true if item was moved. Returns false if item was not found + * \param item item to move + * \returns true if item was moved. Returns false if item was not found * in z-order list or was already at the bottom of the z-order list. - * @see reorderItemUp - * @see reorderItemToTop - * @see reorderItemToBottom + * \see reorderItemUp + * \see reorderItemToTop + * \see reorderItemToBottom * \since QGIS 2.5 */ bool reorderItemDown( QgsComposerItem *item ); /** Moves an item to the top of the z-order list. - * @param item item to move - * @returns true if item was moved. Returns false if item was not found + * \param item item to move + * \returns true if item was moved. Returns false if item was not found * in z-order list or was already at the top of the z-order list. - * @see reorderItemUp - * @see reorderItemDown - * @see reorderItemToBottom + * \see reorderItemUp + * \see reorderItemDown + * \see reorderItemToBottom * \since QGIS 2.5 */ bool reorderItemToTop( QgsComposerItem *item ); /** Moves an item to the bottom of the z-order list. - * @param item item to move - * @returns true if item was moved. Returns false if item was not found + * \param item item to move + * \returns true if item was moved. Returns false if item was not found * in z-order list or was already at the bottom of the z-order list. - * @see reorderItemUp - * @see reorderItemDown - * @see reorderItemToTop + * \see reorderItemUp + * \see reorderItemDown + * \see reorderItemToTop * \since QGIS 2.5 */ bool reorderItemToBottom( QgsComposerItem *item ); @@ -159,10 +159,10 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel /** Finds the next composer item above an item. This method only considers * items which are currently in the composition, and ignores items which have been * removed from the composition. - * @param item item to search above - * @returns item above specified item. If no items were found, no item + * \param item item to search above + * \returns item above specified item. If no items were found, no item * will be returned. - * @see getComposerItemBelow + * \see getComposerItemBelow * \since QGIS 2.5 */ QgsComposerItem *getComposerItemAbove( QgsComposerItem *item ) const; @@ -170,84 +170,84 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel /** Finds the next composer item below an item. This method only considers * items which are currently in the composition, and ignores items which have been * removed from the composition. - * @param item item to search above - * @returns item below specified item. If no items were found, no item + * \param item item to search above + * \returns item below specified item. If no items were found, no item * will be returned. - * @see getComposerItemAbove + * \see getComposerItemAbove * \since QGIS 2.5 */ QgsComposerItem *getComposerItemBelow( QgsComposerItem *item ) const; /** Returns the item z-order list. This list includes both items currently in the * composition and items which have been removed from the composition. - * @returns item z-order list + * \returns item z-order list * \since QGIS 2.5 */ QList *zOrderList(); /** Marks an item as removed from the composition. This must be called whenever an item * has been removed from the composition. - * @param item to mark as removed from the composition - * @see setItemRestored + * \param item to mark as removed from the composition + * \see setItemRestored * \since QGIS 2.5 */ void setItemRemoved( QgsComposerItem *item ); /** Restores an item to the composition. This must be called whenever an item removed * from the composition is restored to the composition. - * @param item to mark as restored to the composition - * @see setItemRemoved + * \param item to mark as restored to the composition + * \see setItemRemoved * \since QGIS 2.5 */ void setItemRestored( QgsComposerItem *item ); /** Must be called when an item's display name is modified - * @param item item to update - * @see updateItemLockStatus - * @see updateItemVisibility - * @see updateItemSelectStatus + * \param item item to update + * \see updateItemLockStatus + * \see updateItemVisibility + * \see updateItemSelectStatus * \since QGIS 2.5 */ void updateItemDisplayName( QgsComposerItem *item ); /** Must be called when an item's lock status changes - * @param item item to update - * @see updateItemDisplayName - * @see updateItemVisibility - * @see updateItemSelectStatus + * \param item item to update + * \see updateItemDisplayName + * \see updateItemVisibility + * \see updateItemSelectStatus * \since QGIS 2.5 */ void updateItemLockStatus( QgsComposerItem *item ); /** Must be called when an item's visibility changes - * @param item item to update - * @see updateItemDisplayName - * @see updateItemLockStatus - * @see updateItemSelectStatus + * \param item item to update + * \see updateItemDisplayName + * \see updateItemLockStatus + * \see updateItemSelectStatus * \since QGIS 2.5 */ void updateItemVisibility( QgsComposerItem *item ); /** Must be called when an item's selection status changes - * @param item item to update - * @see updateItemDisplayName - * @see updateItemVisibility - * @see updateItemLockStatus + * \param item item to update + * \see updateItemDisplayName + * \see updateItemVisibility + * \see updateItemLockStatus * \since QGIS 2.5 */ void updateItemSelectStatus( QgsComposerItem *item ); /** Returns the QModelIndex corresponding to a QgsComposerItem, if possible - * @param item QgsComposerItem to find index for - * @param column column number for created QModelIndex - * @returns QModelIndex corresponding to item and specified column + * \param item QgsComposerItem to find index for + * \param column column number for created QModelIndex + * \returns QModelIndex corresponding to item and specified column */ QModelIndex indexForItem( QgsComposerItem *item, const int column = 0 ); public slots: /** Sets an item as the current selection from a QModelIndex - * @param index QModelIndex of item to set as selected + * \param index QModelIndex of item to set as selected * \since QGIS 2.5 */ void setSelected( const QModelIndex &index ); @@ -266,8 +266,8 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel QgsComposition *mComposition = nullptr; /** Returns the QgsComposerItem corresponding to a QModelIndex, if possible - * @param index QModelIndex for item - * @returns item corresponding to index + * \param index QModelIndex for item + * \returns item corresponding to index */ QgsComposerItem *itemFromIndex( const QModelIndex &index ) const; @@ -277,13 +277,13 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel * list and does not emit QAbstractItemModel signals. Accordingly, this method should * only be called when changes to the z-order list are known and QAbstractItemModel begin * signals have already been called. - * @see rebuildSceneItemList + * \see rebuildSceneItemList */ void refreshItemsInScene(); /** Steps through the item z-order list and rebuilds the items in composition list, * emitting QAbstractItemModel signals as required. - * @see refreshItemsInScene + * \see refreshItemsInScene */ void rebuildSceneItemList(); @@ -304,32 +304,32 @@ class CORE_EXPORT QgsComposerProxyModel: public QSortFilterProxyModel public: /** Constructor for QgsComposerProxyModel. - * @param composition composition to attach model to - * @param parent optional parent + * \param composition composition to attach model to + * \param parent optional parent */ QgsComposerProxyModel( QgsComposition *composition, QObject *parent = nullptr ); /** Returns the current item type filter, or QgsComposerItem::ComposerItem if no * item type filter is set. - * @see setFilterType() + * \see setFilterType() */ QgsComposerItem::ItemType filterType() const { return mItemTypeFilter; } /** Sets the item type filter. Only matching item types will be shown. - * @param itemType type to filter. Set to QgsComposerItem::ComposerItem to show all + * \param itemType type to filter. Set to QgsComposerItem::ComposerItem to show all * item types. - * @see filterType() + * \see filterType() */ void setFilterType( QgsComposerItem::ItemType itemType ); /** Sets a list of specific items to exclude from the model - * @param exceptList list of items to exclude - * @see exceptedItemList() + * \param exceptList list of items to exclude + * \see exceptedItemList() */ void setExceptedItemList( const QList< QgsComposerItem * > &exceptList ); /** Returns the list of specific items excluded from the model. - * @see setExceptedItemList() + * \see setExceptedItemList() */ QList< QgsComposerItem * > exceptedItemList() const { return mExceptedList; } @@ -339,8 +339,8 @@ class CORE_EXPORT QgsComposerProxyModel: public QSortFilterProxyModel /** Returns the QgsComposerItem corresponding to an index from the source * QgsComposerModel model. - * @param sourceIndex a QModelIndex - * @returns QgsComposerItem for specified index from QgsComposerModel + * \param sourceIndex a QModelIndex + * \returns QgsComposerItem for specified index from QgsComposerModel */ QgsComposerItem *itemFromSourceIndex( const QModelIndex &sourceIndex ) const; diff --git a/src/core/composer/qgscomposermultiframe.h b/src/core/composer/qgscomposermultiframe.h index d34f41fd821f..75fa7ee25e7e 100644 --- a/src/core/composer/qgscomposermultiframe.h +++ b/src/core/composer/qgscomposermultiframe.h @@ -55,60 +55,60 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject }; /** Construct a new multiframe item. - * @param c parent composition - * @param createUndoCommands + * \param c parent composition + * \param createUndoCommands */ QgsComposerMultiFrame( QgsComposition *c, bool createUndoCommands ); virtual ~QgsComposerMultiFrame(); /** Returns the total size of the multiframe's content. - * @returns total size required for content + * \returns total size required for content */ virtual QSizeF totalSize() const = 0; /** Returns the fixed size for a frame, if desired. If the fixed frame size changes, * the sizes of all frames can be recalculated by calling recalculateFrameRects(). - * @param frameIndex frame number - * @returns fixed size for frame. If the size has a width or height of 0, then + * \param frameIndex frame number + * \returns fixed size for frame. If the size has a width or height of 0, then * the frame size is not fixed in that direction and frames can have variable width * or height accordingly. * \since QGIS 2.5 - * @see minFrameSize - * @see recalculateFrameRects + * \see minFrameSize + * \see recalculateFrameRects */ virtual QSizeF fixedFrameSize( const int frameIndex = -1 ) const { Q_UNUSED( frameIndex ); return QSizeF( 0, 0 ); } /** Returns the minimum size for a frames, if desired. If the minimum * size changes, the sizes of all frames can be recalculated by calling * recalculateFrameRects(). - * @param frameIndex frame number - * @returns minimum size for frame. If the size has a width or height of 0, then + * \param frameIndex frame number + * \returns minimum size for frame. If the size has a width or height of 0, then * the frame size has no minimum in that direction. * \since QGIS 2.5 - * @see fixedFrameSize - * @see recalculateFrameRects + * \see fixedFrameSize + * \see recalculateFrameRects */ virtual QSizeF minFrameSize( const int frameIndex = -1 ) const { Q_UNUSED( frameIndex ); return QSizeF( 0, 0 ); } /** Renders a portion of the multiframe's content into a painter. - * @param painter destination painter - * @param renderExtent visible extent of content to render into the painter. - * @param frameIndex frame number for content + * \param painter destination painter + * \param renderExtent visible extent of content to render into the painter. + * \param frameIndex frame number for content * \since QGIS 2.5 */ virtual void render( QPainter *painter, const QRectF &renderExtent, const int frameIndex ) = 0; /** Adds a frame to the multiframe. - * @param frame frame to add - * @param recalcFrameSizes set to true to force recalculation of all existing frame sizes - * @see removeFrame + * \param frame frame to add + * \param recalcFrameSizes set to true to force recalculation of all existing frame sizes + * \see removeFrame */ virtual void addFrame( QgsComposerFrame *frame, bool recalcFrameSizes = true ) = 0; /** Finds the optimal position to break a frame at. - * @param yPos maximum vertical position for break - * @returns the optimal breakable position which occurs in the multi frame close + * \param yPos maximum vertical position for break + * \returns the optimal breakable position which occurs in the multi frame close * to and before the specified yPos * \since QGIS 2.3 */ @@ -116,115 +116,115 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject /** Removes a frame from the multiframe. This method automatically removes the frame from the * composition. - * @param i index of frame to remove - * @param removeEmptyPages set to true to remove pages which are empty after the frame is removed - * @see addFrame - * @see deleteFrames + * \param i index of frame to remove + * \param removeEmptyPages set to true to remove pages which are empty after the frame is removed + * \see addFrame + * \see deleteFrames */ void removeFrame( int i, const bool removeEmptyPages = false ); /** Removes and deletes all child frames. - * @see removeFrame + * \see removeFrame */ void deleteFrames(); /** Sets the resize mode for the multiframe, and recalculates frame sizes to match. - * @param mode resize mode - * @see resizeMode + * \param mode resize mode + * \see resizeMode */ void setResizeMode( ResizeMode mode ); /** Returns the resize mode for the multiframe. - * @returns resize mode - * @see setResizeMode + * \returns resize mode + * \see setResizeMode */ ResizeMode resizeMode() const { return mResizeMode; } /** Stores state information about multiframe in DOM element. Implementations of writeXml * should also call the _writeXML method to save general multiframe properties. - * @param elem is DOM element - * @param doc is the DOM document - * @param ignoreFrames set to false to avoid writing state information about child frames into DOM - * @see _writeXML + * \param elem is DOM element + * \param doc is the DOM document + * \param ignoreFrames set to false to avoid writing state information about child frames into DOM + * \see _writeXML */ virtual bool writeXml( QDomElement &elem, QDomDocument &doc, bool ignoreFrames = false ) const = 0; /** Stores state information about base multiframe object in DOM element. Implementations of writeXml * should call this method. - * @param elem is DOM element - * @param doc is the DOM document - * @param ignoreFrames set to false to avoid writing state information about child frames into DOM - * @see writeXml + * \param elem is DOM element + * \param doc is the DOM document + * \param ignoreFrames set to false to avoid writing state information about child frames into DOM + * \see writeXml */ bool _writeXml( QDomElement &elem, QDomDocument &doc, bool ignoreFrames = false ) const; /** Reads multiframe state information from a DOM element. Implementations of readXml * should also call the _readXML method to restore general multiframe properties. - * @param itemElem is DOM element - * @param doc is the DOM document - * @param ignoreFrames set to false to avoid read state information about child frames from DOM - * @see _readXML + * \param itemElem is DOM element + * \param doc is the DOM document + * \param ignoreFrames set to false to avoid read state information about child frames from DOM + * \see _readXML */ virtual bool readXml( const QDomElement &itemElem, const QDomDocument &doc, bool ignoreFrames = false ) = 0; /** Restores state information about base multiframe object from a DOM element. Implementations of readXml * should call this method. - * @param itemElem is DOM element - * @param doc is the DOM document - * @param ignoreFrames set to false to avoid reading state information about child frames from DOM - * @see readXml + * \param itemElem is DOM element + * \param doc is the DOM document + * \param ignoreFrames set to false to avoid reading state information about child frames from DOM + * \see readXml */ bool _readXml( const QDomElement &itemElem, const QDomDocument &doc, bool ignoreFrames = false ); /** Returns the parent composition for the multiframe. - * @returns composition + * \returns composition */ QgsComposition *composition() { return mComposition; } /** Returns whether undo commands should be created for interactions with the multiframe. - * @returns true if undo commands should be created - * @see setCreateUndoCommands + * \returns true if undo commands should be created + * \see setCreateUndoCommands */ bool createUndoCommands() const { return mCreateUndoCommands; } /** Sets whether undo commands should be created for interactions with the multiframe. - * @param enabled set to true if undo commands should be created - * @see createUndoCommands + * \param enabled set to true if undo commands should be created + * \see createUndoCommands */ void setCreateUndoCommands( bool enabled ) { mCreateUndoCommands = enabled; } /** Returns the number of frames associated with this multiframe. - * @returns number of child frames + * \returns number of child frames **/ int frameCount() const { return mFrameItems.size(); } /** Returns a child frame from the multiframe. - * @param i index of frame - * @returns child frame if found - * @see frameIndex + * \param i index of frame + * \returns child frame if found + * \see frameIndex */ QgsComposerFrame *frame( int i ) const; /** Returns the index of a frame within the multiframe - * @param frame frame to find index of - * @returns index for frame if found, -1 if frame not found in multiframe + * \param frame frame to find index of + * \returns index for frame if found, -1 if frame not found in multiframe * \since QGIS 2.5 - * @see frame + * \see frame */ int frameIndex( QgsComposerFrame *frame ) const; /** Creates a new frame and adds it to the multi frame and composition. - * @param currentFrame an existing QgsComposerFrame from which to copy the size + * \param currentFrame an existing QgsComposerFrame from which to copy the size * and general frame properties (e.g., frame style, background, rendering settings). - * @param pos position of top-left corner of the new frame - * @param size size of the new frame - * @returns new QgsComposerFrame + * \param pos position of top-left corner of the new frame + * \param size size of the new frame + * \returns new QgsComposerFrame * \since QGIS 2.3 */ QgsComposerFrame *createNewFrame( QgsComposerFrame *currentFrame, QPointF pos, QSizeF size ); /** Get multiframe display name. - * @returns display name for item + * \returns display name for item * \since QGIS 2.5 */ virtual QString displayName() const; @@ -239,7 +239,7 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject * component frames. If the resize mode is set to anything but UseExistingFrames then * this may cause new frames to be added or frames to be removed, in order to fit * the current size of the multiframe's content. - * @see recalculateFrameRects + * \see recalculateFrameRects */ virtual void recalculateFrameSizes(); @@ -247,9 +247,9 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject * method is useful for multiframes which implement a minFrameSize() or * fixedFrameSize() method. * \since QGIS 2.5 - * @see minFrameSize() - * @see fixedFrameSize() - * @see recalculateFrameSizes + * \see minFrameSize() + * \see fixedFrameSize() + * \see recalculateFrameSizes */ void recalculateFrameRects(); diff --git a/src/core/composer/qgscomposernodesitem.h b/src/core/composer/qgscomposernodesitem.h index 9ac7b8390d26..c4ace64a15aa 100644 --- a/src/core/composer/qgscomposernodesitem.h +++ b/src/core/composer/qgscomposernodesitem.h @@ -34,35 +34,35 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem public: /** Constructor - * @param mTagName tag used in XML file - * @param c parent composition + * \param mTagName tag used in XML file + * \param c parent composition */ QgsComposerNodesItem( const QString &mTagName, QgsComposition *c ); /** Constructor - * @param mTagName tag used in XML file - * @param polygon nodes of the shape - * @param c parent composition + * \param mTagName tag used in XML file + * \param polygon nodes of the shape + * \param c parent composition */ QgsComposerNodesItem( const QString &mTagName, const QPolygonF &polygon, QgsComposition *c ); /** Add a node in current shape. - * @param pt is the location of the new node - * @param checkArea is a flag to indicate if there's a space constraint. - * @param radius is the space contraint and is used only if checkArea is + * \param pt is the location of the new node + * \param checkArea is a flag to indicate if there's a space constraint. + * \param radius is the space contraint and is used only if checkArea is * true. Typically, if this flag is true, the new node has to be nearest * than radius to the shape to be added. */ bool addNode( QPointF pt, const bool checkArea = true, const double radius = 10 ); /** Set a tag to indicate if we want to draw or not the shape's nodes. - * @param display + * \param display */ void setDisplayNodes( const bool display = true ) { mDrawNodes = display; } /** Move a node to a new position. - * @param index the index of the node to move - * @param node is the new position in scene coordinate + * \param index the index of the node to move + * \param node is the new position in scene coordinate */ bool moveNode( const int index, QPointF node ); @@ -71,28 +71,28 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem /** Search the nearest node in shape within a maximal area. Returns the * index of the nearest node or -1. - * @param node is where a shape's node is searched - * @param searchInRadius is a flag to indicate if the area of research is + * \param node is where a shape's node is searched + * \param searchInRadius is a flag to indicate if the area of research is * limited in space. - * @param radius is only used if searchInRadius is true + * \param radius is only used if searchInRadius is true */ int nodeAtPosition( QPointF node, const bool searchInRadius = true, const double radius = 10 ); /** Gets the position of a node in scene coordinate. - * @param index of the node - * @param position the position of the node - * @return true if the index is valid and the position is set, false otherwise + * \param index of the node + * \param position the position of the node + * \returns true if the index is valid and the position is set, false otherwise */ bool nodePosition( const int index, QPointF &position ); /** Sets state from Dom document - * @param itemElem is Dom node corresponding to item tag - * @param doc is Dom document + * \param itemElem is Dom node corresponding to item tag + * \param doc is Dom document */ bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override; /** Remove a node from the shape. - * @param index of the node to delete + * \param index of the node to delete */ bool removeNode( const int index ); @@ -100,12 +100,12 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem int nodesSize() { return mPolygon.size(); } /** Select a node. - * @param index the node to select + * \param index the node to select */ bool setSelectedNode( const int index ); /** Returns the currently selected node. - * @return the index of the selected node, -1 otherwise + * \returns the index of the selected node, -1 otherwise */ int selectedNode() { return mSelectedNode; } @@ -114,8 +114,8 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem void deselectNode() { mSelectedNode = -1; } /** Stores state in Dom element - * @param elem is Dom element corresponding to 'Composer' tag - * @param doc write template file + * \param elem is Dom element corresponding to 'Composer' tag + * \param doc write template file */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; diff --git a/src/core/composer/qgscomposerobject.h b/src/core/composer/qgscomposerobject.h index 09d1123262b2..f8fb5d427240 100644 --- a/src/core/composer/qgscomposerobject.h +++ b/src/core/composer/qgscomposerobject.h @@ -105,84 +105,84 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext static const QgsPropertiesDefinition &propertyDefinitions(); /** Constructor - * @param composition parent composition + * \param composition parent composition */ QgsComposerObject( QgsComposition *composition ); virtual ~QgsComposerObject() = default; /** Returns the composition the item is attached to. - * @returns QgsComposition for item. + * \returns QgsComposition for item. */ const QgsComposition *composition() const { return mComposition; } - //! @note not available in Python bindings + //! \note not available in Python bindings QgsComposition *composition() { return mComposition; } /** Stores item state in DOM element - * @param elem is DOM element corresponding to item tag - * @param doc is the DOM document + * \param elem is DOM element corresponding to item tag + * \param doc is the DOM document */ virtual bool writeXml( QDomElement &elem, QDomDocument &doc ) const; /** Sets item state from DOM element - * @param itemElem is DOM node corresponding to item tag - * @param doc is DOM document + * \param itemElem is DOM node corresponding to item tag + * \param doc is DOM document */ virtual bool readXml( const QDomElement &itemElem, const QDomDocument &doc ); /** Returns a reference to the object's property collection, used for data defined overrides. * \since QGIS 3.0 - * @see setDataDefinedProperties() + * \see setDataDefinedProperties() */ QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; } /** Returns a reference to the object's property collection, used for data defined overrides. * \since QGIS 3.0 - * @see setDataDefinedProperties() + * \see setDataDefinedProperties() */ const QgsPropertyCollection &dataDefinedProperties() const { return mDataDefinedProperties; } /** Sets the objects's property collection, used for data defined overrides. - * @param collection property collection. Existing properties will be replaced. + * \param collection property collection. Existing properties will be replaced. * \since QGIS 3.0 - * @see dataDefinedProperties() + * \see dataDefinedProperties() */ void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; } /** Set a custom property for the object. - * @param key property key. If a property with the same key already exists it will be overwritten. - * @param value property value - * @see customProperty() - * @see removeCustomProperty() - * @see customProperties() + * \param key property key. If a property with the same key already exists it will be overwritten. + * \param value property value + * \see customProperty() + * \see removeCustomProperty() + * \see customProperties() * \since QGIS 2.12 */ void setCustomProperty( const QString &key, const QVariant &value ); /** Read a custom property from the object. - * @param key property key - * @param defaultValue default value to return if property with matching key does not exist - * @returns value of matching property - * @see setCustomProperty() - * @see removeCustomProperty() - * @see customProperties() + * \param key property key + * \param defaultValue default value to return if property with matching key does not exist + * \returns value of matching property + * \see setCustomProperty() + * \see removeCustomProperty() + * \see customProperties() * \since QGIS 2.12 */ QVariant customProperty( const QString &key, const QVariant &defaultValue = QVariant() ) const; /** Remove a custom property from the object. - * @param key property key - * @see setCustomProperty() - * @see customProperty() - * @see customProperties() + * \param key property key + * \see setCustomProperty() + * \see customProperty() + * \see customProperties() * \since QGIS 2.12 */ void removeCustomProperty( const QString &key ); /** Return list of keys stored in custom properties for the object. - * @see setCustomProperty() - * @see customProperty() - * @see removeCustomProperty() + * \see setCustomProperty() + * \see customProperty() + * \see removeCustomProperty() * \since QGIS 2.12 */ QStringList customProperties() const; @@ -200,10 +200,10 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext /** Refreshes a data defined property for the item by reevaluating the property's value * and redrawing the item with this new value. - * @param property data defined property to refresh. If property is set to + * \param property data defined property to refresh. If property is set to * QgsComposerItem::AllProperties then all data defined properties for the item will be * refreshed. - * @param context expression context for evaluating data defined expressions + * \param context expression context for evaluating data defined expressions * \since QGIS 2.5 */ virtual void refreshDataDefinedProperty( const DataDefinedProperty property = AllProperties, const QgsExpressionContext *context = nullptr ); diff --git a/src/core/composer/qgscomposerpicture.h b/src/core/composer/qgscomposerpicture.h index 7deb9192ebbf..6c0d94c54cad 100644 --- a/src/core/composer/qgscomposerpicture.h +++ b/src/core/composer/qgscomposerpicture.h @@ -72,18 +72,18 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem /** Sets the source path of the image (may be svg or a raster format). Data defined * picture source may override this value. The path can either be a local path * or a remote (http) path. - * @param path path for the source image - * @see usePictureExpression - * @see picturePath + * \param path path for the source image + * \see usePictureExpression + * \see picturePath * \since QGIS 2.5 */ void setPicturePath( const QString &path ); /** Returns the path of the source image. Data defined picture source may override * this value. The path can either be a local path or a remote (http) path. - * @returns path for the source image - * @see usePictureExpression - * @see setPicturePath + * \returns path for the source image + * \see usePictureExpression + * \see setPicturePath * \since QGIS 2.5 */ QString picturePath() const; @@ -94,22 +94,22 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem void setSceneRect( const QRectF &rectangle ) override; /** Stores state in Dom element - * @param elem is Dom element corresponding to 'Composer' tag - * @param doc is Dom document + * \param elem is Dom element corresponding to 'Composer' tag + * \param doc is Dom document */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; /** Sets state from Dom document - * @param itemElem is Dom node corresponding to item tag - * @param doc is Dom document + * \param itemElem is Dom node corresponding to item tag + * \param doc is Dom document */ bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override; /** Returns the rotation used for drawing the picture within the item's frame - * @returns picture rotation in degrees + * \returns picture rotation in degrees * \since QGIS 2.2 - * @see setPictureRotation - * @see rotationMap + * \see setPictureRotation + * \see rotationMap */ double pictureRotation() const { return mPictureRotation; } @@ -117,137 +117,137 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem * rotation. If this is set then the picture will be rotated by the same * amount as the specified map object. This is useful especially for * syncing north arrows with a map item. - * @param composerMapId composer map id to sync rotation with - * @see setPictureRotation - * @see rotationMap + * \param composerMapId composer map id to sync rotation with + * \see setPictureRotation + * \see rotationMap */ void setRotationMap( int composerMapId ); /** Returns the id of the rotation map. A value of -1 means map rotation is * disabled. If this is set then the picture is rotated by the same amount * as the specified map object. - * @returns id of map object - * @see setRotationMap - * @see useRotationMap + * \returns id of map object + * \see setRotationMap + * \see useRotationMap */ int rotationMap() const; /** True if the picture rotation is matched to a map item. - * @returns true if rotation map is in use - * @see rotationMap - * @see setRotationMap + * \returns true if rotation map is in use + * \see rotationMap + * \see setRotationMap */ bool useRotationMap() const { return mRotationMap; } /** * Returns the mode used to align the picture to a map's North. - * @see setNorthMode() - * @see northOffset() + * \see setNorthMode() + * \see northOffset() * \since QGIS 2.18 */ NorthMode northMode() const { return mNorthMode; } /** * Sets the mode used to align the picture to a map's North. - * @see northMode() - * @see setNorthOffset() + * \see northMode() + * \see setNorthOffset() * \since QGIS 2.18 */ void setNorthMode( NorthMode mode ); /** * Returns the offset added to the picture's rotation from a map's North. - * @see setNorthOffset() - * @see northMode() + * \see setNorthOffset() + * \see northMode() * \since QGIS 2.18 */ double northOffset() const { return mNorthOffset; } /** * Sets the offset added to the picture's rotation from a map's North. - * @see northOffset() - * @see setNorthMode() + * \see northOffset() + * \see setNorthMode() * \since QGIS 2.18 */ void setNorthOffset( double offset ); /** Returns the resize mode used for drawing the picture within the composer * item's frame. - * @returns resize mode of picture + * \returns resize mode of picture * \since QGIS 2.3 - * @see setResizeMode + * \see setResizeMode */ ResizeMode resizeMode() const { return mResizeMode; } /** Sets the picture's anchor point, which controls how it is placed * within the picture item's frame. - * @param anchor anchor point for picture + * \param anchor anchor point for picture * \since QGIS 2.3 - * @see pictureAnchor + * \see pictureAnchor */ void setPictureAnchor( QgsComposerItem::ItemPositionMode anchor ); /** Returns the picture's current anchor, which controls how it is placed * within the picture item's frame. - * @returns anchor point for picture + * \returns anchor point for picture * \since QGIS 2.3 - * @see setPictureAnchor + * \see setPictureAnchor */ ItemPositionMode pictureAnchor() const { return mPictureAnchor; } /** Returns the fill color used for parametrized SVG files. - * @see setSvgFillColor() - * @see svgStrokeColor() + * \see setSvgFillColor() + * \see svgStrokeColor() * \since QGIS 2.14.1 */ QColor svgFillColor() const { return mSvgFillColor; } /** Sets the fill color used for parametrized SVG files. - * @param color fill color. - * @note this setting only has an effect on parametrized SVG files, and is ignored for + * \param color fill color. + * \note this setting only has an effect on parametrized SVG files, and is ignored for * non-parametrized SVG files. - * @see svgFillColor() - * @see setSvgStrokeColor() + * \see svgFillColor() + * \see setSvgStrokeColor() * \since QGIS 2.14.1 */ void setSvgFillColor( const QColor &color ); /** Returns the stroke color used for parametrized SVG files. - * @see setSvgStrokeColor() - * @see svgFillColor() + * \see setSvgStrokeColor() + * \see svgFillColor() * \since QGIS 2.14.1 */ QColor svgStrokeColor() const { return mSvgStrokeColor; } /** Sets the stroke color used for parametrized SVG files. - * @param color stroke color. - * @note this setting only has an effect on parametrized SVG files, and is ignored for + * \param color stroke color. + * \note this setting only has an effect on parametrized SVG files, and is ignored for * non-parametrized SVG files. - * @see svgStrokelColor() - * @see setSvgFillColor() + * \see svgStrokelColor() + * \see setSvgFillColor() * \since QGIS 2.14.1 */ void setSvgStrokeColor( const QColor &color ); /** Returns the stroke width (in mm) used for parametrized SVG files. - * @see setSvgStrokeWidth() - * @see svgStrokeColor() + * \see setSvgStrokeWidth() + * \see svgStrokeColor() * \since QGIS 2.14.1 */ double svgStrokeWidth() const { return mSvgStrokeWidth; } /** Sets the stroke width used for parametrized SVG files. - * @param width stroke width in mm - * @note this setting only has an effect on parametrized SVG files, and is ignored for + * \param width stroke width in mm + * \note this setting only has an effect on parametrized SVG files, and is ignored for * non-parametrized SVG files. - * @see svgStrokeWidth() - * @see setSvgStrokeColor() + * \see svgStrokeWidth() + * \see setSvgStrokeColor() * \since QGIS 2.14.1 */ void setSvgStrokeWidth( double width ); /** Returns the current picture mode (image format). - * @returns picture mode + * \returns picture mode * \since QGIS 2.3 */ Mode mode() const { return mMode; } @@ -256,22 +256,22 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem /** Sets the picture rotation within the item bounds. This does not affect * the item's frame, only the way the picture is drawn within the item. - * @param r rotation in degrees clockwise - * @see pictureRotation + * \param r rotation in degrees clockwise + * \see pictureRotation * \since QGIS 2.2 */ virtual void setPictureRotation( double r ); /** Sets the resize mode used for drawing the picture within the item bounds. - * @param mode ResizeMode to use for image file + * \param mode ResizeMode to use for image file * \since QGIS 2.3 - * @see resizeMode + * \see resizeMode */ virtual void setResizeMode( ResizeMode mode ); /** Recalculates the source image (if using an expression for picture's source) * and reloads and redraws the picture. - * @param context expression context for evaluating data defined picture sources + * \param context expression context for evaluating data defined picture sources * \since QGIS 2.3 */ void refreshPicture( const QgsExpressionContext *context = nullptr ); diff --git a/src/core/composer/qgscomposerpolygon.h b/src/core/composer/qgscomposerpolygon.h index 31fd2827a7fd..152c04c2d21a 100644 --- a/src/core/composer/qgscomposerpolygon.h +++ b/src/core/composer/qgscomposerpolygon.h @@ -37,13 +37,13 @@ class CORE_EXPORT QgsComposerPolygon: public QgsComposerNodesItem public: /** Constructor - * @param c parent composition + * \param c parent composition */ QgsComposerPolygon( QgsComposition *c ); /** Constructor - * @param polygon nodes of the shape - * @param c parent composition + * \param polygon nodes of the shape + * \param c parent composition */ QgsComposerPolygon( const QPolygonF &polygon, QgsComposition *c ); diff --git a/src/core/composer/qgscomposerpolyline.h b/src/core/composer/qgscomposerpolyline.h index 730269f15f99..dadd3a0867a8 100644 --- a/src/core/composer/qgscomposerpolyline.h +++ b/src/core/composer/qgscomposerpolyline.h @@ -36,13 +36,13 @@ class CORE_EXPORT QgsComposerPolyline: public QgsComposerNodesItem public: /** Constructor - * @param c parent composition + * \param c parent composition */ QgsComposerPolyline( QgsComposition *c ); /** Constructor - * @param polyline nodes of the shape - * @param c parent composition + * \param polyline nodes of the shape + * \param c parent composition */ QgsComposerPolyline( const QPolygonF &polyline, QgsComposition *c ); diff --git a/src/core/composer/qgscomposerscalebar.h b/src/core/composer/qgscomposerscalebar.h index 20a3e17b351a..a4e91ab926e3 100644 --- a/src/core/composer/qgscomposerscalebar.h +++ b/src/core/composer/qgscomposerscalebar.h @@ -78,60 +78,60 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem void setNumUnitsPerSegment( double units ); /** Returns the size mode for scale bar segments. - * @see setSegmentSizeMode - * @see minBarWidth - * @see maxBarWidth + * \see setSegmentSizeMode + * \see minBarWidth + * \see maxBarWidth * \since QGIS 2.9 */ SegmentSizeMode segmentSizeMode() const { return mSegmentSizeMode; } /** Sets the size mode for scale bar segments. - * @param mode size mode - * @see segmentSizeMode - * @see setMinBarWidth - * @see setMaxBarWidth + * \param mode size mode + * \see segmentSizeMode + * \see setMinBarWidth + * \see setMaxBarWidth * \since QGIS 2.9 */ void setSegmentSizeMode( SegmentSizeMode mode ); /** Returns the minimum size (in millimeters) for scale bar segments. This - * property is only effective if the @link segmentSizeMode @endlink is set - * to @link SegmentSizeFitWidth @endlink. - * @see segmentSizeMode - * @see setMinBarWidth - * @see maxBarWidth + * property is only effective if the segmentSizeMode() is set + * to SegmentSizeFitWidth. + * \see segmentSizeMode + * \see setMinBarWidth + * \see maxBarWidth * \since QGIS 2.9 */ double minBarWidth() const { return mMinBarWidth; } /** Sets the minimum size (in millimeters) for scale bar segments. This - * property is only effective if the @link segmentSizeMode @endlink is set - * to @link SegmentSizeFitWidth @endlink. - * @param minWidth minimum width in millimeters - * @see minBarWidth - * @see setMaxBarWidth - * @see setSegmentSizeMode + * property is only effective if the segmentSizeMode() is set + * to SegmentSizeFitWidth. + * \param minWidth minimum width in millimeters + * \see minBarWidth + * \see setMaxBarWidth + * \see setSegmentSizeMode * \since QGIS 2.9 */ void setMinBarWidth( double minWidth ); /** Returns the maximum size (in millimeters) for scale bar segments. This - * property is only effective if the @link segmentSizeMode @endlink is set - * to @link SegmentSizeFitWidth @endlink. - * @see segmentSizeMode - * @see setMaxBarWidth - * @see minBarWidth + * property is only effective if the segmentSizeMode() is set + * to SegmentSizeFitWidth. + * \see segmentSizeMode + * \see setMaxBarWidth + * \see minBarWidth * \since QGIS 2.9 */ double maxBarWidth() const { return mMaxBarWidth; } /** Sets the maximum size (in millimeters) for scale bar segments. This - * property is only effective if the @link segmentSizeMode @endlink is set - * to @link SegmentSizeFitWidth @endlink. - * @param maxWidth maximum width in millimeters - * @see minBarWidth - * @see setMaxBarWidth - * @see setSegmentSizeMode + * property is only effective if the segmentSizeMode() is set + * to SegmentSizeFitWidth. + * \param maxWidth maximum width in millimeters + * \see minBarWidth + * \see setMaxBarWidth + * \see setSegmentSizeMode * \since QGIS 2.9 */ void setMaxBarWidth( double maxWidth ); @@ -146,91 +146,91 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem void setFont( const QFont &font ); /** Returns the color used for drawing text in the scalebar. - * @returns font color for scalebar. - * @see setFontColor - * @see font + * \returns font color for scalebar. + * \see setFontColor + * \see font */ QColor fontColor() const {return mFontColor;} /** Sets the color used for drawing text in the scalebar. - * @param c font color for scalebar. - * @see fontColor - * @see setFont + * \param c font color for scalebar. + * \see fontColor + * \see setFont */ void setFontColor( const QColor &c ) {mFontColor = c;} /** Returns the color used for fills in the scalebar. - * @see setFillColor() - * @see fillColor2() + * \see setFillColor() + * \see fillColor2() * \since QGIS 3.0 */ QColor fillColor() const {return mFillColor;} /** Sets the color used for fills in the scalebar. - * @see fillColor() - * @see setFillColor2() + * \see fillColor() + * \see setFillColor2() * \since QGIS 3.0 */ void setFillColor( const QColor &color ) {mFillColor = color; mBrush.setColor( color ); } /** Returns the secondary color used for fills in the scalebar. - * @see setFillColor2() - * @see fillColor() + * \see setFillColor2() + * \see fillColor() * \since QGIS 3.0 */ QColor fillColor2() const {return mFillColor2;} /** Sets the secondary color used for fills in the scalebar. - * @see fillColor2() - * @see setFillColor2() + * \see fillColor2() + * \see setFillColor2() * \since QGIS 3.0 */ void setFillColor2( const QColor &color ) {mFillColor2 = color; mBrush2.setColor( color ); } /** Returns the color used for lines in the scalebar. - * @see setLineColor() + * \see setLineColor() * \since QGIS 3.0 */ QColor lineColor() const {return mLineColor;} /** Sets the color used for lines in the scalebar. - * @see lineColor() + * \see lineColor() * \since QGIS 3.0 */ void setLineColor( const QColor &color ) { mLineColor = color; mPen.setColor( mLineColor ); } /** Returns the line width in millimeters for lines in the scalebar. - * @see setLineWidth() + * \see setLineWidth() * \since QGIS 3.0 */ double lineWidth() const {return mLineWidth;} /** Sets the line width in millimeters for lines in the scalebar. - * @see lineWidth() + * \see lineWidth() * \since QGIS 3.0 */ void setLineWidth( double width ) { mLineWidth = width; mPen.setWidthF( width ); } /** Returns the pen used for drawing the scalebar. - * @returns QPen used for drawing the scalebar outlines. - * @see setPen - * @see brush + * \returns QPen used for drawing the scalebar outlines. + * \see setPen + * \see brush */ QPen pen() const {return mPen;} /** Returns the primary brush for the scalebar. - * @returns QBrush used for filling the scalebar - * @see setBrush - * @see brush2 - * @see pen + * \returns QBrush used for filling the scalebar + * \see setBrush + * \see brush2 + * \see pen */ QBrush brush() const {return mBrush;} /** Returns the secondary brush for the scalebar. This is used for alternating color style scalebars, such * as single and double box styles. - * @returns QBrush used for secondary color areas - * @see setBrush2 - * @see brush + * \returns QBrush used for secondary color areas + * \see setBrush2 + * \see brush */ QBrush brush2() const {return mBrush2;} @@ -258,32 +258,32 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem void setUnits( ScaleBarUnits u ); /** Returns the join style used for drawing lines in the scalebar - * @returns Join style for lines - * @note introduced in 2.3 - * @see setLineJoinStyle + * \returns Join style for lines + * \since QGIS 2.3 + * \see setLineJoinStyle */ Qt::PenJoinStyle lineJoinStyle() const { return mLineJoinStyle; } /** Sets join style used when drawing the lines in the scalebar - * @param style Join style for lines - * @returns nothing - * @note introduced in 2.3 - * @see lineJoinStyle + * \param style Join style for lines + * \returns nothing + * \since QGIS 2.3 + * \see lineJoinStyle */ void setLineJoinStyle( Qt::PenJoinStyle style ); /** Returns the cap style used for drawing lines in the scalebar - * @returns Cap style for lines - * @note introduced in 2.3 - * @see setLineCapStyle + * \returns Cap style for lines + * \since QGIS 2.3 + * \see setLineCapStyle */ Qt::PenCapStyle lineCapStyle() const { return mLineCapStyle; } /** Sets cap style used when drawing the lines in the scalebar - * @param style Cap style for lines - * @returns nothing - * @note introduced in 2.3 - * @see lineCapStyle + * \param style Cap style for lines + * \returns nothing + * \since QGIS 2.3 + * \see lineCapStyle */ void setLineCapStyle( Qt::PenCapStyle style ); @@ -293,7 +293,7 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem void applyDefaultSize( ScaleBarUnits u = Meters ); /** Sets style by name - @param styleName (untranslated) style name. Possibilities are: 'Single Box', 'Double Box', 'Line Ticks Middle', 'Line Ticks Down', 'Line Ticks Up', 'Numeric'*/ + \param styleName (untranslated) style name. Possibilities are: 'Single Box', 'Double Box', 'Line Ticks Middle', 'Line Ticks Down', 'Line Ticks Up', 'Numeric'*/ void setStyle( const QString &styleName ); //! Returns style name @@ -301,7 +301,7 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem /** Returns the x - positions of the segment borders (in item coordinates) and the width * of the segment - * @note not available in Python bindings + * \note not available in Python bindings */ void segmentPositions( QList > &posWidthList ) const; @@ -315,14 +315,14 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem QString firstLabelString() const; /** Stores state in Dom element - * @param elem is Dom element corresponding to 'Composer' tag - * @param doc Dom document + * \param elem is Dom element corresponding to 'Composer' tag + * \param doc Dom document */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; /** Sets state from Dom document - * @param itemElem is Dom node corresponding to item tag - * @param doc is Dom document + * \param itemElem is Dom node corresponding to item tag + * \param doc is Dom document */ bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override; diff --git a/src/core/composer/qgscomposershape.h b/src/core/composer/qgscomposershape.h index 0ca33d7bd434..0cd9d31ee826 100644 --- a/src/core/composer/qgscomposershape.h +++ b/src/core/composer/qgscomposershape.h @@ -50,14 +50,14 @@ class CORE_EXPORT QgsComposerShape: public QgsComposerItem void paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget ) override; /** Stores state in Dom element - * @param elem is Dom element corresponding to 'Composer' tag - * @param doc write template file + * \param elem is Dom element corresponding to 'Composer' tag + * \param doc write template file */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; /** Sets state from Dom document - * @param itemElem is Dom node corresponding to item tag - * @param doc is Dom document + * \param itemElem is Dom node corresponding to item tag + * \param doc is Dom document */ bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override; diff --git a/src/core/composer/qgscomposertablecolumn.h b/src/core/composer/qgscomposertablecolumn.h index 99a02e80326d..99891003eb13 100644 --- a/src/core/composer/qgscomposertablecolumn.h +++ b/src/core/composer/qgscomposertablecolumn.h @@ -36,126 +36,126 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject public: /** Constructor for QgsComposerTableColumn. - * @param heading column heading + * \param heading column heading */ QgsComposerTableColumn( const QString &heading = QString() ); /** Writes the column's properties to xml for storage. - * @param columnElem an existing QDomElement in which to store the column's properties. - * @param doc QDomDocument for the destination xml. + * \param columnElem an existing QDomElement in which to store the column's properties. + * \param doc QDomDocument for the destination xml. * \since QGIS 2.3 - * @see readXml + * \see readXml */ virtual bool writeXml( QDomElement &columnElem, QDomDocument &doc ) const; /** Reads the column's properties from xml. - * @param columnElem a QDomElement holding the column's desired properties. + * \param columnElem a QDomElement holding the column's desired properties. * \since QGIS 2.3 - * @see writeXml + * \see writeXml */ virtual bool readXml( const QDomElement &columnElem ); /** Returns the width for a column. - * @returns column width in mm, or 0 if column width is automatically calculated. + * \returns column width in mm, or 0 if column width is automatically calculated. * \since QGIS 2.5 - * @see setWidth + * \see setWidth */ double width() const { return mWidth; } /** Sets the width for a column. - * @param width column width in mm, or 0 if column width is to be automatically calculated. + * \param width column width in mm, or 0 if column width is to be automatically calculated. * \since QGIS 2.5 - * @see width + * \see width */ void setWidth( const double width ) { mWidth = width; } /** Returns the heading for a column, which is the value displayed in the columns * header cell. - * @returns Heading for column. + * \returns Heading for column. * \since QGIS 2.3 - * @see setHeading + * \see setHeading */ QString heading() const { return mHeading; } /** Sets the heading for a column, which is the value displayed in the columns * header cell. - * @param heading Heading for column. + * \param heading Heading for column. * \since QGIS 2.3 - * @see heading + * \see heading */ void setHeading( const QString &heading ) { mHeading = heading; } /** Returns the horizontal alignment for a column, which controls the alignment * used for drawing column values within cells. - * @returns horizontal alignment. + * \returns horizontal alignment. * \since QGIS 2.3 - * @see setHAlignment - * @see vAlignment + * \see setHAlignment + * \see vAlignment */ Qt::AlignmentFlag hAlignment() const { return mHAlignment; } /** Sets the horizontal alignment for a column, which controls the alignment * used for drawing column values within cells. - * @param alignment horizontal alignment for cell. + * \param alignment horizontal alignment for cell. * \since QGIS 2.3 - * @see hAlignment - * @see setVAlignment + * \see hAlignment + * \see setVAlignment */ void setHAlignment( Qt::AlignmentFlag alignment ) { mHAlignment = alignment; } /** Returns the vertical alignment for a column, which controls the alignment * used for drawing column values within cells. - * @returns vertical alignment. + * \returns vertical alignment. * \since QGIS 2.12 - * @see setVAlignment - * @see hAlignment + * \see setVAlignment + * \see hAlignment */ Qt::AlignmentFlag vAlignment() const { return mVAlignment; } /** Sets the vertical alignment for a column, which controls the alignment * used for drawing column values within cells. - * @param alignment vertical alignment for cell. + * \param alignment vertical alignment for cell. * \since QGIS 2.12 - * @see vAlignment - * @see setHAlignment + * \see vAlignment + * \see setHAlignment */ void setVAlignment( Qt::AlignmentFlag alignment ) { mVAlignment = alignment; } /** Returns the attribute name or expression used for the column's values. This property * is only used when the column is part of a QgsComposerAttributeTable. - * @returns attribute name or expression text for column + * \returns attribute name or expression text for column * \since QGIS 2.3 - * @note only applicable when used in a QgsComposerAttributeTable - * @see setAttribute + * \note only applicable when used in a QgsComposerAttributeTable + * \see setAttribute */ QString attribute() const { return mAttribute; } /** Sets the attribute name or expression used for the column's values. This property * is only used when the column is part of a QgsComposerAttributeTable. - * @param attribute attribute name or expression text for column + * \param attribute attribute name or expression text for column * \since QGIS 2.3 - * @note only applicable when used in a QgsComposerAttributeTable - * @see attribute + * \note only applicable when used in a QgsComposerAttributeTable + * \see attribute */ void setAttribute( const QString &attribute ) { mAttribute = attribute; } /** Returns the sort order for the column. This property is only used when the column * is part of a QgsComposerAttributeTable and when sortByRank is > 0. - * @returns sort order for column + * \returns sort order for column * \since QGIS 2.3 - * @note only applicable when used in a QgsComposerAttributeTable - * @see setSortOrder - * @see sortByRank + * \note only applicable when used in a QgsComposerAttributeTable + * \see setSortOrder + * \see sortByRank */ Qt::SortOrder sortOrder() const { return mSortOrder; } /** Sets the sort order for the column. This property is only used when the column * is part of a QgsComposerAttributeTable and when sortByRank is > 0. - * @param sortOrder sort order for column + * \param sortOrder sort order for column * \since QGIS 2.3 - * @note only applicable when used in a QgsComposerAttributeTable - * @see sortOrder - * @see setSortByRank + * \note only applicable when used in a QgsComposerAttributeTable + * \see sortOrder + * \see setSortByRank */ void setSortOrder( Qt::SortOrder sortOrder ) { mSortOrder = sortOrder; } @@ -164,12 +164,12 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject * column when the table is sorted by multiple columns, with lower sort ranks * having higher priority. This property is only used when the column * is part of a QgsComposerAttributeTable. - * @returns sort rank for column. If sort rank is <= 0 then the column is not being + * \returns sort rank for column. If sort rank is <= 0 then the column is not being * sorted. * \since QGIS 2.3 - * @note only applicable when used in a QgsComposerAttributeTable - * @see setSortByRank - * @see sortOrder + * \note only applicable when used in a QgsComposerAttributeTable + * \see setSortByRank + * \see sortOrder */ int sortByRank() const { return mSortByRank; } @@ -178,17 +178,17 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject * column when the table is sorted by multiple columns, with lower sort ranks * having higher priority. This property is only used when the column * is part of a QgsComposerAttributeTable. - * @param sortByRank sort rank for column. If sort rank is <= 0 then the column is not being + * \param sortByRank sort rank for column. If sort rank is <= 0 then the column is not being * sorted. * \since QGIS 2.3 - * @note only applicable when used in a QgsComposerAttributeTable - * @see sortByRank - * @see setSortOrder + * \note only applicable when used in a QgsComposerAttributeTable + * \see sortByRank + * \see setSortOrder */ void setSortByRank( int sortByRank ) { mSortByRank = sortByRank; } /** Creates a duplicate column which is a deep copy of this column. - * @returns a new QgsComposerTableColumn with same properties as this column. + * \returns a new QgsComposerTableColumn with same properties as this column. * \since QGIS 2.3 */ QgsComposerTableColumn *clone(); diff --git a/src/core/composer/qgscomposertablev2.h b/src/core/composer/qgscomposertablev2.h index 938404fbe83e..8e8740a96453 100644 --- a/src/core/composer/qgscomposertablev2.h +++ b/src/core/composer/qgscomposertablev2.h @@ -69,15 +69,15 @@ class CORE_EXPORT QgsComposerTableStyle QColor cellBackgroundColor; /** Writes the style's properties to XML for storage. - * @param styleElem an existing QDomElement in which to store the style's properties. - * @param doc QDomDocument for the destination XML. - * @see readXml + * \param styleElem an existing QDomElement in which to store the style's properties. + * \param doc QDomDocument for the destination XML. + * \see readXml */ bool writeXml( QDomElement &styleElem, QDomDocument &doc ) const; /** Reads the style's properties from XML. - * @param styleElem a QDomElement holding the style's desired properties. - * @see writeXml + * \param styleElem a QDomElement holding the style's desired properties. + * \see writeXml */ bool readXml( const QDomElement &styleElem ); @@ -151,308 +151,308 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame virtual ~QgsComposerTableV2(); /** Sets the margin distance between cell borders and their contents. - * @param margin margin for cell contents - * @see cellMargin + * \param margin margin for cell contents + * \see cellMargin */ void setCellMargin( const double margin ); /** Returns the margin distance between cell borders and their contents. - * @returns margin for cell contents - * @see setCellMargin + * \returns margin for cell contents + * \see setCellMargin */ double cellMargin() const { return mCellMargin; } /** Sets the behavior for empty tables with no content rows. - * @param mode behavior mode for empty tables - * @see emptyTableBehavior + * \param mode behavior mode for empty tables + * \see emptyTableBehavior */ void setEmptyTableBehavior( const EmptyTableMode mode ); /** Returns the behavior mode for empty tables. This property controls * how the table is drawn if it contains no content rows. - * @returns behavior mode for empty tables - * @see setEmptyTableBehavior + * \returns behavior mode for empty tables + * \see setEmptyTableBehavior */ EmptyTableMode emptyTableBehavior() const { return mEmptyTableMode; } /** Sets the message for empty tables with no content rows. This message * is displayed in the table body if the empty table behavior is * set to ShowMessage - * @param message message to show for empty tables - * @see emptyTableMessage - * @see setEmptyTableBehavior + * \param message message to show for empty tables + * \see emptyTableMessage + * \see setEmptyTableBehavior */ void setEmptyTableMessage( const QString &message ); /** Returns the message for empty tables with no content rows. This message * is displayed in the table body if the empty table behavior is * set to ShowMessage - * @returns message to show for empty tables - * @see setEmptyTableMessage - * @see emptyTableBehavior + * \returns message to show for empty tables + * \see setEmptyTableMessage + * \see emptyTableBehavior */ QString emptyTableMessage() const { return mEmptyTableMessage; } /** Sets whether empty rows should be drawn. Tables default to hiding empty rows. - * @param showEmpty set to true to show empty rows in the table - * @see showEmptyRows + * \param showEmpty set to true to show empty rows in the table + * \see showEmptyRows */ void setShowEmptyRows( const bool showEmpty ); /** Returns whether empty rows are drawn in the table - * @returns true if empty rows are drawn - * @see setShowEmptyRows + * \returns true if empty rows are drawn + * \see setShowEmptyRows */ bool showEmptyRows() const { return mShowEmptyRows; } /** Sets the font used to draw header text in the table. - * @param font font for header cells - * @see headerFont - * @see setContentFont + * \param font font for header cells + * \see headerFont + * \see setContentFont */ void setHeaderFont( const QFont &font ); /** Returns the font used to draw header text in the table. - * @returns font for header cells - * @see setHeaderFont - * @see contentFont + * \returns font for header cells + * \see setHeaderFont + * \see contentFont */ QFont headerFont() const { return mHeaderFont; } /** Sets the color used to draw header text in the table. - * @param color header text color - * @see headerFontColor - * @see setHeaderFont - * @see setContentFontColor + * \param color header text color + * \see headerFontColor + * \see setHeaderFont + * \see setContentFontColor */ void setHeaderFontColor( const QColor &color ); /** Returns the color used to draw header text in the table. - * @returns color for header text - * @see setHeaderFontColor - * @see headerFont - * @see contentFontColor + * \returns color for header text + * \see setHeaderFontColor + * \see headerFont + * \see contentFontColor */ QColor headerFontColor() const { return mHeaderFontColor; } /** Sets the horizontal alignment for table headers - * @param alignment Horizontal alignment for table header cells - * @see headerHAlignment + * \param alignment Horizontal alignment for table header cells + * \see headerHAlignment */ void setHeaderHAlignment( const HeaderHAlignment alignment ); /** Returns the horizontal alignment for table headers - * @returns Horizontal alignment for table header cells - * @see setHeaderHAlignment + * \returns Horizontal alignment for table header cells + * \see setHeaderHAlignment */ HeaderHAlignment headerHAlignment() const { return mHeaderHAlignment; } /** Sets the display mode for headers in the table. This property controls * if and where headers are shown in the table. - * @param mode display mode for headers - * @see headerMode + * \param mode display mode for headers + * \see headerMode */ void setHeaderMode( const HeaderMode mode ); /** Returns the display mode for headers in the table. This property controls * if and where headers are shown in the table. - * @returns display mode for headers - * @see setHeaderMode + * \returns display mode for headers + * \see setHeaderMode */ HeaderMode headerMode() const { return mHeaderMode; } /** Sets the font used to draw text in table body cells. - * @param font font for table cells - * @see contentFont - * @see setHeaderFont + * \param font font for table cells + * \see contentFont + * \see setHeaderFont */ void setContentFont( const QFont &font ); /** Returns the font used to draw text in table body cells. - * @returns font for table cells - * @see setContentFont - * @see headerFont + * \returns font for table cells + * \see setContentFont + * \see headerFont */ QFont contentFont() const { return mContentFont; } /** Sets the color used to draw text in table body cells. - * @param color table cell text color - * @see contentFontColor - * @see setContentFont - * @see setHeaderFontColor + * \param color table cell text color + * \see contentFontColor + * \see setContentFont + * \see setHeaderFontColor */ void setContentFontColor( const QColor &color ); /** Returns the color used to draw text in table body cells. - * @returns text color for table cells - * @see setContentFontColor - * @see contentFont - * @see headerFontColor + * \returns text color for table cells + * \see setContentFontColor + * \see contentFont + * \see headerFontColor */ QColor contentFontColor() const { return mContentFontColor; } /** Sets whether grid lines should be drawn in the table - * @param showGrid set to true to show grid lines - * @see showGrid - * @see setGridStrokeWidth - * @see setGridColor + * \param showGrid set to true to show grid lines + * \see showGrid + * \see setGridStrokeWidth + * \see setGridColor */ void setShowGrid( const bool showGrid ); /** Returns whether grid lines are drawn in the table - * @returns true if grid lines are shown - * @see setShowGrid - * @see gridStrokeWidth - * @see gridColor + * \returns true if grid lines are shown + * \see setShowGrid + * \see gridStrokeWidth + * \see gridColor */ bool showGrid() const { return mShowGrid; } /** Sets the width for grid lines in the table. - * @param width grid line width - * @see gridStrokeWidth - * @see setShowGrid - * @see setGridColor + * \param width grid line width + * \see gridStrokeWidth + * \see setShowGrid + * \see setGridColor */ void setGridStrokeWidth( const double width ); /** Returns the width of grid lines in the table. - * @returns grid line width - * @see setGridStrokeWidth - * @see showGrid - * @see gridColor + * \returns grid line width + * \see setGridStrokeWidth + * \see showGrid + * \see gridColor */ double gridStrokeWidth() const { return mGridStrokeWidth; } /** Sets color used for grid lines in the table. - * @param color grid line color - * @see gridColor - * @see setShowGrid - * @see setGridStrokeWidth + * \param color grid line color + * \see gridColor + * \see setShowGrid + * \see setGridStrokeWidth */ void setGridColor( const QColor &color ); /** Returns the color used for grid lines in the table. - * @returns grid line color - * @see setGridColor - * @see showGrid - * @see gridStrokeWidth + * \returns grid line color + * \see setGridColor + * \see showGrid + * \see gridStrokeWidth */ QColor gridColor() const { return mGridColor; } /** Sets whether the grid's horizontal lines should be drawn in the table - * @param horizontalGrid set to true to draw grid's horizontal lines - * @see setShowGrid - * @see setGridStrokeWidth - * @see setGridColor - * @see setVerticalGrid + * \param horizontalGrid set to true to draw grid's horizontal lines + * \see setShowGrid + * \see setGridStrokeWidth + * \see setGridColor + * \see setVerticalGrid * \since QGIS 3.0 */ void setHorizontalGrid( const bool horizontalGrid ); /** Returns whether the grid's horizontal lines are drawn in the table - * @returns true if grid's horizontal lines are drawn - * @see setShowGrid - * @see setGridStrokeWidth - * @see setGridColor - * @see setVerticalGrid + * \returns true if grid's horizontal lines are drawn + * \see setShowGrid + * \see setGridStrokeWidth + * \see setGridColor + * \see setVerticalGrid * \since QGIS 3.0 */ bool horizontalGrid() const { return mHorizontalGrid; } /** Sets whether the grid's vertical lines should be drawn in the table - * @param verticalGrid set to true to draw grid's vertical lines - * @see setShowGrid - * @see setGridStrokeWidth - * @see setGridColor - * @see setHorizontalGrid + * \param verticalGrid set to true to draw grid's vertical lines + * \see setShowGrid + * \see setGridStrokeWidth + * \see setGridColor + * \see setHorizontalGrid * \since QGIS 3.0 */ void setVerticalGrid( const bool verticalGrid ); /** Returns whether the grid's vertical lines are drawn in the table - * @returns true if grid's vertical lines are drawn - * @see setShowGrid - * @see setGridStrokeWidth - * @see setGridColor - * @see setHorizontalGrid + * \returns true if grid's vertical lines are drawn + * \see setShowGrid + * \see setGridStrokeWidth + * \see setGridColor + * \see setHorizontalGrid * \since QGIS 3.0 */ bool verticalGrid() const { return mVerticalGrid; } /** Sets color used for background of table. - * @param color table background color - * @see backgroundColor - * @see setGridColor + * \param color table background color + * \see backgroundColor + * \see setGridColor */ void setBackgroundColor( const QColor &color ); /** Returns the color used for the background of the table. - * @returns table background color - * @see setBackgroundColor - * @see gridColor + * \returns table background color + * \see setBackgroundColor + * \see gridColor */ QColor backgroundColor() const { return mBackgroundColor; } /** Sets the wrap behavior for the table, which controls how text within cells is * automatically wrapped. - * @param behavior wrap behavior - * @see wrapBehavior + * \param behavior wrap behavior + * \see wrapBehavior * \since QGIS 2.12 */ void setWrapBehavior( WrapBehavior behavior ); /** Returns the wrap behavior for the table, which controls how text within cells is * automatically wrapped. - * @returns current wrap behavior - * @see setWrapBehavior + * \returns current wrap behavior + * \see setWrapBehavior * \since QGIS 2.12 */ WrapBehavior wrapBehavior() const { return mWrapBehavior; } /** Returns a pointer to the list of QgsComposerTableColumns shown in the table - * @returns pointer to list of columns in table - * @see setColumns + * \returns pointer to list of columns in table + * \see setColumns */ QgsComposerTableColumns *columns() { return &mColumns; } /** Replaces the columns in the table with a specified list of QgsComposerTableColumns. - * @param columns list of QgsComposerTableColumns to show in table. Ownership of columns + * \param columns list of QgsComposerTableColumns to show in table. Ownership of columns * is transferred to the table. - * @see columns + * \see columns */ void setColumns( const QgsComposerTableColumns &columns ); /** Sets the cell style for a cell group. - * @param group group to set style for - * @param style new cell style - * @see cellStyle() + * \param group group to set style for + * \param style new cell style + * \see cellStyle() * \since QGIS 2.12 */ void setCellStyle( CellStyleGroup group, const QgsComposerTableStyle &style ); /** Returns the cell style for a cell group. - * @param group group to retrieve style for - * @see setCellStyle() + * \param group group to retrieve style for + * \see setCellStyle() * \since QGIS 2.12 */ const QgsComposerTableStyle *cellStyle( CellStyleGroup group ) const; /** Returns the text used in the column headers for the table. - * @returns QMap of int to QString, where the int is the column index (starting at 0), + * \returns QMap of int to QString, where the int is the column index (starting at 0), * and the string is the text to use for the column's header - * @note not available in Python bindings + * \note not available in Python bindings */ virtual QMap headerLabels() const; /** Fetches the contents used for the cells in the table. - * @returns true if table contents were successfully retrieved. - * @param contents QgsComposerTableContents to store retrieved row data in - * @note not available in Python bindings + * \returns true if table contents were successfully retrieved. + * \param contents QgsComposerTableContents to store retrieved row data in + * \note not available in Python bindings */ virtual bool getTableContents( QgsComposerTableContents &contents ) = 0; /** Returns the current contents of the table. Excludes header cells. - * @returns table contents + * \returns table contents */ QgsComposerTableContents *contents() { return &mTableContents; } @@ -472,7 +472,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame /** Refreshes the contents shown in the table by querying for new data. * This also causes the column widths and size of the table to change to accommodate the * new data. - * @see adjustFrameToSize + * \see adjustFrameToSize */ virtual void refreshAttributes(); @@ -555,74 +555,74 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame virtual bool calculateMaxRowHeights(); /** Returns total width of table contents. - * @returns table width - * @see totalHeight + * \returns table width + * \see totalHeight */ //not const, as needs to call calculateMaxColumnWidths() double totalWidth(); /** Returns total height of table contents. - * @returns total height - * @see totalWidth + * \returns total height + * \see totalWidth */ //not const, as needs to call calculateMaxRowHeights() double totalHeight(); /** Calculates how many content rows would be visible within a frame of the specified * height. - * @param frameHeight height of frame - * @param firstRow index of first row visible in frame (where 0 = first row in table) - * @param includeHeader set to true if frame would include a header row - * @param includeEmptyRows set to true to also include rows which would be empty in the returned count. For instance, + * \param frameHeight height of frame + * \param firstRow index of first row visible in frame (where 0 = first row in table) + * \param includeHeader set to true if frame would include a header row + * \param includeEmptyRows set to true to also include rows which would be empty in the returned count. For instance, * if the frame would include all table content rows and have space left for extra rows then setting this parameter * to true would also include a count of these extra blank rows. - * @returns number of visible content rows (excluding header row) + * \returns number of visible content rows (excluding header row) * \since QGIS 2.12 */ int rowsVisible( double frameHeight, int firstRow, bool includeHeader, bool includeEmptyRows ) const; /** Calculates how many content rows are visible within a given frame. - * @param frameIndex index number for frame - * @param firstRow index of first row visible in frame (where 0 = first row in table) - * @param includeEmptyRows set to true to also include rows which would be empty in the returned count. For instance, + * \param frameIndex index number for frame + * \param firstRow index of first row visible in frame (where 0 = first row in table) + * \param includeEmptyRows set to true to also include rows which would be empty in the returned count. For instance, * if the frame would include all table content rows and have space left for extra rows then setting this parameter * to true would also include a count of these extra blank rows. - * @returns number of visible content rows (excludes header rows) + * \returns number of visible content rows (excludes header rows) * \since QGIS 2.12 */ int rowsVisible( int frameIndex, int firstRow, bool includeEmptyRows ) const; /** Calculates a range of rows which should be visible in a given frame. - * @param frameIndex index number for frame - * @returns row range + * \param frameIndex index number for frame + * \returns row range * \since QGIS 2.12 */ QPair rowRange( const int frameIndex ) const; /** Draws the horizontal grid lines for the table. - * @param painter destination painter for grid lines - * @param firstRow index corresponding to first row shown in frame - * @param lastRow index corresponding to last row shown in frame. If greater than the number of content rows in the + * \param painter destination painter for grid lines + * \param firstRow index corresponding to first row shown in frame + * \param lastRow index corresponding to last row shown in frame. If greater than the number of content rows in the * table, then the default row height will be used for the remaining rows. - * @param drawHeaderLines set to true to include for the table header - * @see drawVerticalGridLines + * \param drawHeaderLines set to true to include for the table header + * \see drawVerticalGridLines * \since QGIS 2.12 */ void drawHorizontalGridLines( QPainter *painter, int firstRow, int lastRow, bool drawHeaderLines ) const; /** Draws the vertical grid lines for the table. - * @param painter destination painter for grid lines - * @param maxWidthMap QMap of int to double, where the int contains the column number and the double is the + * \param painter destination painter for grid lines + * \param maxWidthMap QMap of int to double, where the int contains the column number and the double is the * maximum width of text present in the column. - * @param firstRow index corresponding to first row shown in frame - * @param lastRow index corresponding to last row shown in frame. If greater than the number of content rows in the + * \param firstRow index corresponding to first row shown in frame + * \param lastRow index corresponding to last row shown in frame. If greater than the number of content rows in the * table, then the default row height will be used for the remaining rows. - * @param hasHeader set to true if table frame includes header cells - * @param mergeCells set to true to merge table content cells - * @note not available in Python bindings - * @see drawVerticalGridLines - * @see calculateMaxColumnWidths - * @note not available in Python bindings + * \param hasHeader set to true if table frame includes header cells + * \param mergeCells set to true to merge table content cells + * \note not available in Python bindings + * \see drawVerticalGridLines + * \see calculateMaxColumnWidths + * \note not available in Python bindings * \since QGIS 2.12 */ void drawVerticalGridLines( QPainter *painter, const QMap &maxWidthMap, int firstRow, int lastRow, bool hasHeader, bool mergeCells = false ) const; @@ -632,9 +632,9 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame void recalculateTableSize(); /** Checks whether a table contents contains a given row - * @param contents table contents to check - * @param row row to check for - * @returns true if contents contains rows + * \param contents table contents to check + * \param row row to check for + * \returns true if contents contains rows */ bool contentsContainsRow( const QgsComposerTableContents &contents, const QgsComposerTableRow &row ) const; @@ -650,9 +650,9 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame QString wrappedText( const QString &value, double columnWidth, const QFont &font ) const; /** Returns the calculated background color for a row and column combination. - * @param row row number, where -1 is the header row, and 0 is the first body row - * @param column column number, where 0 is the first column - * @returns background color, or invalid QColor if no background should be drawn + * \param row row number, where -1 is the header row, and 0 is the first body row + * \param column column number, where 0 is the first column + * \returns background color, or invalid QColor if no background should be drawn */ QColor backgroundColor( int row, int column ) const; diff --git a/src/core/composer/qgscomposertexttable.h b/src/core/composer/qgscomposertexttable.h index ad455fa6c55a..ad7235f11ce8 100644 --- a/src/core/composer/qgscomposertexttable.h +++ b/src/core/composer/qgscomposertexttable.h @@ -34,17 +34,17 @@ class CORE_EXPORT QgsComposerTextTableV2 : public QgsComposerTableV2 QgsComposerTextTableV2( QgsComposition *c, bool createUndoCommands ); /** Adds a row to the table - * @param row list of strings to use for each cell's value in the newly added row - * @note If row is shorter than the number of columns in the table than blank cells + * \param row list of strings to use for each cell's value in the newly added row + * \note If row is shorter than the number of columns in the table than blank cells * will be inserted at the end of the row. If row contains more strings then the number * of columns in the table then these extra strings will be ignored. - * @note if adding many rows, @link setContents @endlink is much faster + * \note if adding many rows, setContents() is much faster */ void addRow( const QStringList &row ); /** Sets the contents of the text table. - * @param contents list of table rows - * @see addRow + * \param contents list of table rows + * \see addRow */ void setContents( const QList< QStringList > &contents ); diff --git a/src/core/composer/qgscomposerutils.h b/src/core/composer/qgscomposerutils.h index 2082e207a630..4c709dfeb85d 100644 --- a/src/core/composer/qgscomposerutils.h +++ b/src/core/composer/qgscomposerutils.h @@ -33,214 +33,214 @@ class CORE_EXPORT QgsComposerUtils public: /** Draws an arrow head on to a QPainter. - * @param p destination painter - * @param x x-coordinate of arrow center - * @param y y-coordinate of arrow center - * @param angle angle in degrees which arrow should point toward, measured + * \param p destination painter + * \param x x-coordinate of arrow center + * \param y y-coordinate of arrow center + * \param angle angle in degrees which arrow should point toward, measured * clockwise from pointing vertical upward - * @param arrowHeadWidth size of arrow head + * \param arrowHeadWidth size of arrow head */ static void drawArrowHead( QPainter *p, const double x, const double y, const double angle, const double arrowHeadWidth ); /** Calculates the angle of the line from p1 to p2 (counter clockwise, * starting from a line from north to south) - * @param p1 start point of line - * @param p2 end point of line - * @returns angle in degrees, clockwise from south + * \param p1 start point of line + * \param p2 end point of line + * \returns angle in degrees, clockwise from south */ static double angle( QPointF p1, QPointF p2 ); /** Rotates a point / vector around the origin. - * @param angle rotation angle in degrees, counterclockwise - * @param x in/out: x coordinate before / after the rotation - * @param y in/out: y cooreinate before / after the rotation + * \param angle rotation angle in degrees, counterclockwise + * \param x in/out: x coordinate before / after the rotation + * \param y in/out: y cooreinate before / after the rotation */ static void rotate( const double angle, double &x, double &y ); /** Ensures that an angle is in the range 0 <= angle < 360 - * @param angle angle in degrees - * @returns equivalent angle within the range [0, 360) - * @see snappedAngle + * \param angle angle in degrees + * \returns equivalent angle within the range [0, 360) + * \see snappedAngle */ static double normalizedAngle( const double angle ); /** Snaps an angle to its closest 45 degree angle - * @param angle angle in degrees - * @returns angle snapped to 0, 45/90/135/180/225/270 or 315 degrees + * \param angle angle in degrees + * \returns angle snapped to 0, 45/90/135/180/225/270 or 315 degrees */ static double snappedAngle( const double angle ); /** Calculates the largest scaled version of originalRect which fits within boundsRect, when it is rotated by * a specified amount. - * @param originalRect QRectF to be rotated and scaled - * @param boundsRect QRectF specifying the bounds which the rotated and scaled rectangle must fit within - * @param rotation the rotation in degrees to be applied to the rectangle - * @returns largest scaled version of the rectangle possible + * \param originalRect QRectF to be rotated and scaled + * \param boundsRect QRectF specifying the bounds which the rotated and scaled rectangle must fit within + * \param rotation the rotation in degrees to be applied to the rectangle + * \returns largest scaled version of the rectangle possible */ static QRectF largestRotatedRectWithinBounds( const QRectF &originalRect, const QRectF &boundsRect, const double rotation ); /** Returns the size in mm corresponding to a font point size - * @param pointSize font size in points - * @see mmToPoints + * \param pointSize font size in points + * \see mmToPoints */ static double pointsToMM( const double pointSize ); /** Returns the size in mm corresponding to a font point size - * @param mmSize font size in mm - * @see pointsToMM + * \param mmSize font size in mm + * \see pointsToMM */ static double mmToPoints( const double mmSize ); /** Resizes a QRectF relative to a resized bounding rectangle. - * @param rectToResize QRectF to resize, contained within boundsBefore. The + * \param rectToResize QRectF to resize, contained within boundsBefore. The * rectangle is linearly scaled to retain its relative position and size within * boundsAfter. - * @param boundsBefore QRectF of bounds before resize - * @param boundsAfter QRectF of bounds after resize + * \param boundsBefore QRectF of bounds before resize + * \param boundsAfter QRectF of bounds after resize */ static void relativeResizeRect( QRectF &rectToResize, const QRectF &boundsBefore, const QRectF &boundsAfter ); /** Returns a scaled position given a before and after range - * @param position initial position within before range to scale - * @param beforeMin minimum value in before range - * @param beforeMax maximum value in before range - * @param afterMin minimum value in after range - * @param afterMax maximum value in after range - * @returns position scaled to range specified by afterMin and afterMax + * \param position initial position within before range to scale + * \param beforeMin minimum value in before range + * \param beforeMax maximum value in before range + * \param afterMin minimum value in after range + * \param afterMax maximum value in after range + * \returns position scaled to range specified by afterMin and afterMax */ static double relativePosition( const double position, const double beforeMin, const double beforeMax, const double afterMin, const double afterMax ); /** Decodes a string representing a paper orientation - * @param orientationString string to decode - * @param ok will be true if string could be decoded - * @returns decoded paper orientation + * \param orientationString string to decode + * \param ok will be true if string could be decoded + * \returns decoded paper orientation */ static QgsComposition::PaperOrientation decodePaperOrientation( const QString &orientationString, bool &ok ); /** Decodes a string representing a preset page size - * @param presetString string to decode - * @param width double for decoded paper width - * @param height double for decoded paper height - * @returns true if string could be decoded successfully + * \param presetString string to decode + * \param width double for decoded paper width + * \param height double for decoded paper height + * \returns true if string could be decoded successfully */ static bool decodePresetPaperSize( const QString &presetString, double &width, double &height ); /** Reads all pre 3.0 data defined properties from an XML element. * \since QGIS 3.0 - * @see readDataDefinedProperty - * @see writeDataDefinedPropertyMap + * \see readDataDefinedProperty + * \see writeDataDefinedPropertyMap */ static void readOldDataDefinedPropertyMap( const QDomElement &itemElem, QgsPropertyCollection &dataDefinedProperties ); /** Reads a pre 3.0 data defined property from an XML DOM element. * \since QGIS 3.0 - * @see readDataDefinedPropertyMap + * \see readDataDefinedPropertyMap */ static QgsProperty readOldDataDefinedProperty( const QgsComposerObject::DataDefinedProperty property, const QDomElement &ddElem ); /** Returns a font where size is set in pixels and the size has been upscaled with FONT_WORKAROUND_SCALE * to workaround QT font rendering bugs - * @param font source font with size set in points - * @returns font with size set in pixels + * \param font source font with size set in points + * \returns font with size set in pixels * \since QGIS 2.5 */ static QFont scaledFontPixelSize( const QFont &font ); /** Calculate font ascent in millimeters, including workarounds for QT font rendering issues - * @param font input font - * @returns font ascent in millimeters + * \param font input font + * \returns font ascent in millimeters * \since QGIS 2.5 - * @see fontDescentMM - * @see fontHeightMM - * @see fontHeightCharacterMM - * @see textWidthMM + * \see fontDescentMM + * \see fontHeightMM + * \see fontHeightCharacterMM + * \see textWidthMM */ static double fontAscentMM( const QFont &font ); /** Calculate font descent in millimeters, including workarounds for QT font rendering issues - * @param font input font - * @returns font descent in millimeters + * \param font input font + * \returns font descent in millimeters * \since QGIS 2.5 - * @see fontAscentMM - * @see fontHeightMM - * @see fontHeightCharacterMM - * @see textWidthMM + * \see fontAscentMM + * \see fontHeightMM + * \see fontHeightCharacterMM + * \see textWidthMM */ static double fontDescentMM( const QFont &font ); /** Calculate font height in millimeters, including workarounds for QT font rendering issues * The font height is the font ascent + descent + 1 (for the baseline). - * @param font input font - * @returns font height in millimeters + * \param font input font + * \returns font height in millimeters * \since QGIS 2.5 - * @see fontAscentMM - * @see fontDescentMM - * @see fontHeightCharacterMM - * @see textWidthMM + * \see fontAscentMM + * \see fontDescentMM + * \see fontHeightCharacterMM + * \see textWidthMM */ static double fontHeightMM( const QFont &font ); /** Calculate font height in millimeters of a single character, including workarounds for QT font * rendering issues - * @param font input font - * @param character character to calculate height for - * @returns character height in millimeters + * \param font input font + * \param character character to calculate height for + * \returns character height in millimeters * \since QGIS 2.5 - * @see fontAscentMM - * @see fontDescentMM - * @see fontHeightMM - * @see textWidthMM + * \see fontAscentMM + * \see fontDescentMM + * \see fontHeightMM + * \see textWidthMM */ static double fontHeightCharacterMM( const QFont &font, QChar character ); /** Calculate font width in millimeters for a string, including workarounds for QT font * rendering issues - * @param font input font - * @param text string to calculate width of - * @returns string width in millimeters + * \param font input font + * \param text string to calculate width of + * \returns string width in millimeters * \since QGIS 2.5 - * @see fontAscentMM - * @see fontDescentMM - * @see fontHeightMM - * @see fontHeightCharacterMM - * @see textHeightMM + * \see fontAscentMM + * \see fontDescentMM + * \see fontHeightMM + * \see fontHeightCharacterMM + * \see textHeightMM */ static double textWidthMM( const QFont &font, const QString &text ); /** Calculate font height in millimeters for a string, including workarounds for QT font * rendering issues. Note that this method uses a non-standard measure of text height, * where only the font ascent is considered for the first line of text. - * @param font input font - * @param text string to calculate height of - * @param multiLineHeight line spacing factor - * @returns string height in millimeters + * \param font input font + * \param text string to calculate height of + * \param multiLineHeight line spacing factor + * \returns string height in millimeters * \since QGIS 2.12 - * @see textWidthMM + * \see textWidthMM */ static double textHeightMM( const QFont &font, const QString &text, double multiLineHeight = 1.0 ); /** Draws text on a painter at a specific position, taking care of composer specific issues (calculation to pixel, * scaling of font and painter to work around Qt font bugs) - * @param painter destination QPainter - * @param pos position to draw text - * @param text string to draw - * @param font font to use for drawing text - * @param color color to draw text + * \param painter destination QPainter + * \param pos position to draw text + * \param text string to draw + * \param font font to use for drawing text + * \param color color to draw text * \since QGIS 2.5 */ static void drawText( QPainter *painter, QPointF pos, const QString &text, const QFont &font, const QColor &color = QColor() ); /** Draws text on a painter within a rectangle, taking care of composer specific issues (calculation to pixel, * scaling of font and painter to work around Qt font bugs) - * @param painter destination QPainter - * @param rect rectangle to draw into - * @param text string to draw - * @param font font to use for drawing text - * @param color color to draw text - * @param halignment optional horizontal alignment - * @param valignment optional vertical alignment - * @param flags allows for passing Qt::TextFlags to control appearance of rendered text + * \param painter destination QPainter + * \param rect rectangle to draw into + * \param text string to draw + * \param font font to use for drawing text + * \param color color to draw text + * \param halignment optional horizontal alignment + * \param valignment optional vertical alignment + * \param flags allows for passing Qt::TextFlags to control appearance of rendered text * \since QGIS 2.5 */ static void drawText( QPainter *painter, const QRectF &rect, const QString &text, const QFont &font, const QColor &color = QColor(), const Qt::AlignmentFlag halignment = Qt::AlignLeft, const Qt::AlignmentFlag valignment = Qt::AlignTop, const int flags = Qt::TextWordWrap ); @@ -251,7 +251,7 @@ class CORE_EXPORT QgsComposerUtils * target map. If the \a dpi argument is not specified then the dpi will be taken from the destinatation * painter device. * \since QGIS 3.0 - * @see createRenderContextForComposition() + * \see createRenderContextForComposition() */ static QgsRenderContext createRenderContextForMap( QgsComposerMap *map, QPainter *painter, double dpi = -1 ); @@ -260,7 +260,7 @@ class CORE_EXPORT QgsComposerUtils * This method returns a new QgsRenderContext which matches the scale and settings from the composition's * QgsComposition::referenceMap(). * \since QGIS 3.0 - * @see createRenderContextForMap() + * \see createRenderContextForMap() */ static QgsRenderContext createRenderContextForComposition( QgsComposition *composition, QPainter *painter ); diff --git a/src/core/composer/qgscomposition.h b/src/core/composer/qgscomposition.h index 42b14ee081e6..f03b952956bb 100644 --- a/src/core/composer/qgscomposition.h +++ b/src/core/composer/qgscomposition.h @@ -131,40 +131,40 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo /** * Returns the composition's name. - * @see setName() + * \see setName() * \since QGIS 3.0 */ QString name() const { return mName; } /** * Sets the composition's name. - * @see name() + * \see name() * \since QGIS 3.0 */ void setName( const QString &name ); /** Changes size of paper item. - * @param width page width in mm - * @param height page height in mm - * @param keepRelativeItemPosition if true, all items and guides will be moved so that they retain + * \param width page width in mm + * \param height page height in mm + * \param keepRelativeItemPosition if true, all items and guides will be moved so that they retain * their same relative position to the top left corner of their current page. - * @see paperHeight - * @see paperWidth + * \see paperHeight + * \see paperWidth */ void setPaperSize( double width, double height, bool keepRelativeItemPosition = true ); /** Height of paper item - * @returns height in mm - * @see paperWidth - * @see setPaperSize + * \returns height in mm + * \see paperWidth + * \see setPaperSize */ double paperHeight() const; /** Width of paper item - * @returns width in mm - * @see paperHeight - * @see setPaperSize + * \returns width in mm + * \see paperHeight + * \see setPaperSize */ double paperWidth() const; @@ -173,77 +173,77 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo * minimum size required to fit all existing composer items. Items will also be * repositioned so that the new top-left bounds of the composition is at the point * (marginLeft, marginTop). An optional margin can be specified. - * @param marginTop top margin (millimeters) - * @param marginRight right margin (millimeters) - * @param marginBottom bottom margin (millimeters) - * @param marginLeft left margin (millimeters) + * \param marginTop top margin (millimeters) + * \param marginRight right margin (millimeters) + * \param marginBottom bottom margin (millimeters) + * \param marginLeft left margin (millimeters) * \since QGIS 2.12 - * @see setResizeToContentsMargins() - * @see resizeToContentsMargins() + * \see setResizeToContentsMargins() + * \see resizeToContentsMargins() */ void resizePageToContents( double marginTop = 0.0, double marginRight = 0.0, double marginBottom = 0.0, double marginLeft = 0.0 ); /** Sets the resize to contents margins. These margins are saved in the composition * so that they can be restored with the composer. - * @param marginTop top margin (millimeters) - * @param marginRight right margin (millimeters) - * @param marginBottom bottom margin (millimeters) - * @param marginLeft left margin (millimeters) + * \param marginTop top margin (millimeters) + * \param marginRight right margin (millimeters) + * \param marginBottom bottom margin (millimeters) + * \param marginLeft left margin (millimeters) * \since QGIS 2.12 - * @see resizePageToContents() - * @see resizeToContentsMargins() + * \see resizePageToContents() + * \see resizeToContentsMargins() */ void setResizeToContentsMargins( double marginTop, double marginRight, double marginBottom, double marginLeft ); /** Returns the resize to contents margins. These margins are saved in the composition * so that they can be restored with the composer. - * @param marginTop reference for top margin (millimeters) - * @param marginRight reference for right margin (millimeters) - * @param marginBottom reference for bottom margin (millimeters) - * @param marginLeft reference for left margin (millimeters) + * \param marginTop reference for top margin (millimeters) + * \param marginRight reference for right margin (millimeters) + * \param marginBottom reference for bottom margin (millimeters) + * \param marginLeft reference for left margin (millimeters) * \since QGIS 2.12 - * @see resizePageToContents() - * @see setResizeToContentsMargins() + * \see resizePageToContents() + * \see setResizeToContentsMargins() */ void resizeToContentsMargins( double &marginTop, double &marginRight, double &marginBottom, double &marginLeft ) const; /** Returns the vertical space between pages in a composer view - * @returns space between pages in mm + * \returns space between pages in mm */ double spaceBetweenPages() const { return mSpaceBetweenPages; } /** Sets the number of pages for the composition. - * @param pages number of pages - * @see numPages + * \param pages number of pages + * \see numPages */ void setNumPages( const int pages ); /** Returns the number of pages in the composition. - * @returns number of pages - * @see setNumPages + * \returns number of pages + * \see setNumPages */ int numPages() const; /** Returns whether a page is empty, ie, it contains no items except for the background * paper item. - * @param page page number, starting with 1 - * @returns true if page is empty + * \param page page number, starting with 1 + * \returns true if page is empty * \since QGIS 2.5 - * @see numPages - * @see setNumPages - * @see shouldExportPage + * \see numPages + * \see setNumPages + * \see shouldExportPage */ bool pageIsEmpty( const int page ) const; /** Returns whether a specified page number should be included in exports of the composition. - * @param page page number, starting with 1 - * @returns true if page should be exported + * \param page page number, starting with 1 + * \returns true if page should be exported * \since QGIS 2.5 - * @see numPages - * @see pageIsEmpty + * \see numPages + * \see pageIsEmpty */ bool shouldExportPage( const int page ) const; @@ -291,9 +291,9 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo /** Sets whether the page items should be visible in the composition. Removing * them will prevent both display of the page boundaries in composer views and * will also prevent them from being rendered in composition exports. - * @param visible set to true to show pages, false to hide pages + * \param visible set to true to show pages, false to hide pages * \since QGIS 2.12 - * @see pagesVisible() + * \see pagesVisible() */ void setPagesVisible( bool visible ); @@ -301,7 +301,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo * effects both display of the page boundaries in composer views and * whether they will be rendered in composition exports. * \since QGIS 2.12 - * @see setPagesVisible() + * \see setPagesVisible() */ bool pagesVisible() const { return mPagesVisible; } @@ -325,30 +325,30 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo /** Sets the snap tolerance to use when automatically snapping items during movement and resizing to guides * and the edges and centers of other items. - * @param snapTolerance snap tolerance in pixels - * @see alignmentSnapTolerance + * \param snapTolerance snap tolerance in pixels + * \see alignmentSnapTolerance * \since QGIS 2.5 */ void setSnapTolerance( const int snapTolerance ) { mSnapTolerance = snapTolerance; } /** Returns the snap tolerance to use when automatically snapping items during movement and resizing to guides * and the edges and centers of other items. - * @returns snap tolerance in pixels - * @see setAlignmentSnapTolerance + * \returns snap tolerance in pixels + * \see setAlignmentSnapTolerance * \since QGIS 2.5 */ int snapTolerance() const { return mSnapTolerance; } /** Sets whether selection bounding boxes should be shown in the composition - * @param boundsVisible set to true to show selection bounding box - * @see boundingBoxesVisible + * \param boundsVisible set to true to show selection bounding box + * \see boundingBoxesVisible * \since QGIS 2.7 */ void setBoundingBoxesVisible( const bool boundsVisible ); /** Returns whether selection bounding boxes should be shown in the composition - * @returns true if selection bounding boxes should be shown - * @see setBoundingBoxesVisible + * \returns true if selection bounding boxes should be shown + * \see setBoundingBoxesVisible * \since QGIS 2.7 */ bool boundingBoxesVisible() const { return mBoundingBoxesVisible; } @@ -357,17 +357,17 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo QUndoStack *undoStack() { return mUndoStack; } /** Returns the topmost composer item at a specified position. Ignores paper items. - * @param position point to search for item at - * @param ignoreLocked set to true to ignore locked items - * @returns composer item at position + * \param position point to search for item at + * \param ignoreLocked set to true to ignore locked items + * \returns composer item at position */ QgsComposerItem *composerItemAt( QPointF position, const bool ignoreLocked = false ) const; /** Returns the topmost composer item at a specified position which is below a specified item. Ignores paper items. - * @param position point to search for item at - * @param belowItem item to search below - * @param ignoreLocked set to true to ignore locked items - * @returns composer item at position which is below specified item + * \param position point to search for item at + * \param belowItem item to search below + * \param ignoreLocked set to true to ignore locked items + * \returns composer item at position which is below specified item */ QgsComposerItem *composerItemAt( QPointF position, const QgsComposerItem *belowItem, const bool ignoreLocked = false ) const; @@ -378,44 +378,44 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo int itemPageNumber( const QgsComposerItem * ) const; /** Returns list of selected composer items - * @param includeLockedItems set to true to include locked items in list - * @returns list of selected items + * \param includeLockedItems set to true to include locked items in list + * \returns list of selected items */ QList selectedComposerItems( const bool includeLockedItems = true ); /** Returns pointers to all composer maps in the scene - @note available in Python bindings only with PyQt >= 4.8.4 + \note available in Python bindings only with PyQt >= 4.8.4 */ QList composerMapItems() const; /** Return composer items of a specific type - * @param itemList list of item type to store matching items in - * @note not available in Python bindings + * \param itemList list of item type to store matching items in + * \note not available in Python bindings */ template void composerItems( QList &itemList ); /** Return composer items of a specific type on a specified page - * @param itemList list of item type to store matching items in - * @param pageNumber page number (0 based) - * @note not available in Python bindings + * \param itemList list of item type to store matching items in + * \param pageNumber page number (0 based) + * \note not available in Python bindings * \since QGIS 2.5 */ template void composerItemsOnPage( QList &itemList, const int pageNumber ) const; /** Returns the composer map with specified id - * @return QgsComposerMap or 0 pointer if the composer map item does not exist + * \returns QgsComposerMap or 0 pointer if the composer map item does not exist */ const QgsComposerMap *getComposerMapById( const int id ) const; /** Returns a composer item given its text identifier. * Ids are not necessarely unique, but this function returns only one element. - * @param id - A QString representing the identifier of the item to retrieve. - * @return QgsComposerItem pointer or 0 pointer if no such item exists. + * \param id - A QString representing the identifier of the item to retrieve. + * \returns QgsComposerItem pointer or 0 pointer if no such item exists. */ const QgsComposerItem *getComposerItemById( const QString &id ) const; /** Returns a composer item given its unique identifier. - * @param uuid A QString representing the UUID of the item to + * \param uuid A QString representing the UUID of the item to */ const QgsComposerItem *getComposerItemByUuid( const QString &uuid ) const; @@ -427,32 +427,32 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo /** Returns true if the composition will generate corresponding world files when pages * are exported. - * @see setGenerateWorldFile() - * @see referenceMap() + * \see setGenerateWorldFile() + * \see referenceMap() */ bool generateWorldFile() const { return mGenerateWorldFile; } /** Sets whether the composition will generate corresponding world files when pages * are exported. - * @param enabled set to true to generate world files - * @see generateWorldFile() - * @see setReferenceMap() + * \param enabled set to true to generate world files + * \see generateWorldFile() + * \see setReferenceMap() */ void setGenerateWorldFile( bool enabled ) { mGenerateWorldFile = enabled; } /** Returns the map item which will be used to generate corresponding world files when the * composition is exported. If no map was explicitly set via setReferenceMap(), the largest * map in the composition will be returned (or nullptr if there are no maps in the composition). - * @see setReferenceMap() - * @see generateWorldFile() + * \see setReferenceMap() + * \see generateWorldFile() */ QgsComposerMap *referenceMap() const; /** Sets the map item which will be used to generate corresponding world files when the * composition is exported. - * @param map composer map item - * @see referenceMap() - * @see setGenerateWorldFile() + * \param map composer map item + * \see referenceMap() + * \see setGenerateWorldFile() */ void setReferenceMap( QgsComposerMap *map ); @@ -471,10 +471,10 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo bool readXml( const QDomElement &compositionElem, const QDomDocument &doc ); /** Load a template document - * @param doc template document - * @param substitutionMap map with text to replace. Text needs to be enclosed by brackets (e.g. '[text]' ) - * @param addUndoCommands whether or not to add undo commands - * @param clearComposition set to true to clear the existing composition and read all composition and + * \param doc template document + * \param substitutionMap map with text to replace. Text needs to be enclosed by brackets (e.g. '[text]' ) + * \param addUndoCommands whether or not to add undo commands + * \param clearComposition set to true to clear the existing composition and read all composition and * atlas properties from the template. Set to false to only add new items from the template, without * overwriting the existing items or composition settings. */ @@ -482,12 +482,12 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo bool addUndoCommands = false, const bool clearComposition = true ); /** Add items from XML representation to the graphics scene (for project file reading, pasting items from clipboard) - * @param elem items parent element, e.g. \verbatim \endverbatim or \verbatim \endverbatim - * @param doc xml document - * @param addUndoCommands insert AddItem commands if true (e.g. for copy/paste) - * @param pos item position. Optional, take position from xml if 0 - * @param pasteInPlace whether the position should be kept but mapped to the page origin. (the page is the page under to the mouse cursor) - * @note parameters mapsToRestore, addUndoCommands pos and pasteInPlace not available in Python bindings + * \param elem items parent element, e.g. \verbatim \endverbatim or \verbatim \endverbatim + * \param doc xml document + * \param addUndoCommands insert AddItem commands if true (e.g. for copy/paste) + * \param pos item position. Optional, take position from xml if 0 + * \param pasteInPlace whether the position should be kept but mapped to the page origin. (the page is the page under to the mouse cursor) + * \note parameters mapsToRestore, addUndoCommands pos and pasteInPlace not available in Python bindings */ void addItemsFromXml( const QDomElement &elem, const QDomDocument &doc, bool addUndoCommands = false, QPointF *pos = nullptr, bool pasteInPlace = false ); @@ -532,16 +532,16 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo void unlockAllItems(); /** Creates a new group from a list of composer items and adds it to the composition. - * @param items items to include in group - * @returns QgsComposerItemGroup of grouped items, if grouping was possible + * \param items items to include in group + * \returns QgsComposerItemGroup of grouped items, if grouping was possible * \since QGIS 2.6 */ QgsComposerItemGroup *groupItems( QList items ); /** Ungroups items by removing them from an item group and removing the group from the * composition. - * @param group item group to ungroup - * @returns list of items removed from the group, or an empty list if ungrouping + * \param group item group to ungroup + * \returns list of items removed from the group, or an empty list if ungrouping * was not successful * \since QGIS 2.6 */ @@ -559,7 +559,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo QList< QGraphicsLineItem * > *snapLines() {return &mSnapLines;} /** Returns pointer to selection handles - * @note not available in Python bindings + * \note not available in Python bindings */ QgsComposerMouseHandles *selectionHandles() {return mSelectionHandles;} @@ -569,14 +569,14 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo void removeSnapLine( QGraphicsLineItem *line ); /** Get nearest snap line - * @note not available in Python bindings + * \note not available in Python bindings */ QGraphicsLineItem *nearestSnapLine( const bool horizontal, const double x, const double y, const double tolerance, QList< QPair< QgsComposerItem *, QgsComposerItem::ItemPositionMode > > &snappedItems ) const; /** Allocates new item command and saves initial state in it - * @param item target item - * @param commandText descriptive command text - * @param c context for merge commands (unknown for non-mergeable commands) + * \param item target item + * \param commandText descriptive command text + * \param c context for merge commands (unknown for non-mergeable commands) */ void beginCommand( QgsComposerItem *item, const QString &commandText, const QgsComposerMergeCommand::Context c = QgsComposerMergeCommand::Unknown ); @@ -596,7 +596,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo void removeMultiFrame( QgsComposerMultiFrame *multiFrame ); /** Adds an arrow item to the graphics scene and advises composer to create a widget for it (through signal) - @note not available in Python bindings*/ + \note not available in Python bindings*/ void addComposerArrow( QgsComposerArrow *arrow ); //! Adds label to the graphics scene and advises composer to create a widget for it (through signal) void addComposerLabel( QgsComposerLabel *label ); @@ -639,76 +639,76 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo void beginPrintAsPDF( QPrinter &printer, const QString &file ); /** Print on a preconfigured printer - * @param printer QPrinter destination - * @param painter QPainter source - * @param startNewPage set to true to begin the print on a new page + * \param printer QPrinter destination + * \param painter QPainter source + * \param startNewPage set to true to begin the print on a new page */ void doPrint( QPrinter &printer, QPainter &painter, bool startNewPage = false ); /** Convenience function that prepares the printer and prints - * @returns true if print was successful + * \returns true if print was successful */ bool print( QPrinter &printer, const bool evaluateDDPageSize = false ); /** Convenience function that prepares the printer for printing in PDF and prints - * @returns true if export was successful + * \returns true if export was successful */ bool exportAsPDF( const QString &file ); #endif /** Renders a composer page to an image. - * @param page page number, 0 based such that the first page is page 0 - * @param imageSize optional target image size, in pixels. It is the caller's responsibility + * \param page page number, 0 based such that the first page is page 0 + * \param imageSize optional target image size, in pixels. It is the caller's responsibility * to ensure that the ratio of the target image size matches the ratio of the composition * page size. - * @param dpi optional dpi override, or 0 to use default composition print resolution. This + * \param dpi optional dpi override, or 0 to use default composition print resolution. This * parameter has no effect if imageSize is specified. - * @returns rendered image, or null image if image does not fit into available memory - * @see renderRectAsRaster() - * @see renderPage() + * \returns rendered image, or null image if image does not fit into available memory + * \see renderRectAsRaster() + * \see renderPage() */ QImage printPageAsRaster( int page, QSize imageSize = QSize(), int dpi = 0 ); /** Renders a portion of the composition to an image. This method can be used to render * sections of pages rather than full pages. - * @param rect region of composition to render - * @param imageSize optional target image size, in pixels. It is the caller's responsibility + * \param rect region of composition to render + * \param imageSize optional target image size, in pixels. It is the caller's responsibility * to ensure that the ratio of the target image size matches the ratio of the specified * region of the composition. - * @param dpi optional dpi override, or 0 to use default composition print resolution. This + * \param dpi optional dpi override, or 0 to use default composition print resolution. This * parameter has no effect if imageSize is specified. - * @returns rendered image, or null image if image does not fit into available memory + * \returns rendered image, or null image if image does not fit into available memory * \since QGIS 2.12 - * @see printPageAsRaster() - * @see renderRect() + * \see printPageAsRaster() + * \see renderRect() */ QImage renderRectAsRaster( const QRectF &rect, QSize imageSize = QSize(), int dpi = 0 ); /** Renders a full page to a paint device. - * @param p destination painter - * @param page page number, 0 based such that the first page is page 0 - * @see renderRect() - * @see printPageAsRaster() + * \param p destination painter + * \param page page number, 0 based such that the first page is page 0 + * \see renderRect() + * \see printPageAsRaster() */ void renderPage( QPainter *p, int page ); /** Renders a portion of the composition to a paint device. This method can be used * to render sections of pages rather than full pages. - * @param p destination painter - * @param rect region of composition to render + * \param p destination painter + * \param rect region of composition to render * \since QGIS 2.12 - * @see renderPage() - * @see renderRectAsRaster() + * \see renderPage() + * \see renderRectAsRaster() */ void renderRect( QPainter *p, const QRectF &rect ); /** Georeferences a file (image of PDF) exported from the composition. - * @param file filename of exported file - * @param referenceMap map item to use for georeferencing, or leave as nullptr to use the + * \param file filename of exported file + * \param referenceMap map item to use for georeferencing, or leave as nullptr to use the * currently defined referenceMap(). - * @param exportRegion set to a valid rectangle to indicate that only part of the composition was + * \param exportRegion set to a valid rectangle to indicate that only part of the composition was * exported - * @param dpi set to DPI of exported file, or leave as -1 to use composition's DPI. + * \param dpi set to DPI of exported file, or leave as -1 to use composition's DPI. * \since QGIS 2.16 */ void georeferenceOutput( const QString &file, QgsComposerMap *referenceMap = nullptr, @@ -720,13 +720,13 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo void computeWorldFileParameters( double &a, double &b, double &c, double &d, double &e, double &f ) const; /** Computes the world file parameters for a specified region of the composition. - * @param exportRegion region of the composition which will be associated with world file - * @param a - * @param b - * @param c - * @param d - * @param e - * @param f + * \param exportRegion region of the composition which will be associated with world file + * \param a + * \param b + * \param c + * \param d + * \param e + * \param f * \since QGIS 2.12 */ void computeWorldFileParameters( const QRectF &exportRegion, double &a, double &b, double &c, double &d, double &e, double &f ) const; @@ -734,78 +734,78 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo QgsAtlasComposition &atlasComposition() { return mAtlasComposition; } /** Returns the current atlas mode of the composition - * @returns current atlas mode - * @see setAtlasMode + * \returns current atlas mode + * \see setAtlasMode */ QgsComposition::AtlasMode atlasMode() const { return mAtlasMode; } /** Sets the current atlas mode of the composition. - * @param mode atlas mode to switch to - * @returns false if the mode could not be changed. - * @see atlasMode + * \param mode atlas mode to switch to + * \returns false if the mode could not be changed. + * \see atlasMode */ bool setAtlasMode( const QgsComposition::AtlasMode mode ); /** Return pages in the correct order - * @note composerItems(QList< QgsPaperItem* > &) may not return pages in the correct order + * \note composerItems(QList< QgsPaperItem* > &) may not return pages in the correct order * \since QGIS 2.4 */ QList< QgsPaperItem * > pages() { return mPages; } /** Returns the items model attached to the composition - * @returns QgsComposerModel for composition + * \returns QgsComposerModel for composition * \since QGIS 2.5 */ QgsComposerModel *itemsModel() { return mItemsModel; } /** Set a custom property for the composition. - * @param key property key. If a property with the same key already exists it will be overwritten. - * @param value property value - * @see customProperty() - * @see removeCustomProperty() - * @see customProperties() + * \param key property key. If a property with the same key already exists it will be overwritten. + * \param value property value + * \see customProperty() + * \see removeCustomProperty() + * \see customProperties() * \since QGIS 2.12 */ void setCustomProperty( const QString &key, const QVariant &value ); /** Read a custom property from the composition. - * @param key property key - * @param defaultValue default value to return if property with matching key does not exist - * @returns value of matching property - * @see setCustomProperty() - * @see removeCustomProperty() - * @see customProperties() + * \param key property key + * \param defaultValue default value to return if property with matching key does not exist + * \returns value of matching property + * \see setCustomProperty() + * \see removeCustomProperty() + * \see customProperties() * \since QGIS 2.12 */ QVariant customProperty( const QString &key, const QVariant &defaultValue = QVariant() ) const; /** Remove a custom property from the composition. - * @param key property key - * @see setCustomProperty() - * @see customProperty() - * @see customProperties() + * \param key property key + * \see setCustomProperty() + * \see customProperty() + * \see customProperties() * \since QGIS 2.12 */ void removeCustomProperty( const QString &key ); /** Return list of keys stored in custom properties for composition. - * @see setCustomProperty() - * @see customProperty() - * @see removeCustomProperty() + * \see setCustomProperty() + * \see customProperty() + * \see removeCustomProperty() * \since QGIS 2.12 */ QStringList customProperties() const; /** Returns the bounding box of the items contained on a specified page. - * @param pageNumber page number, where 0 is the first page - * @param visibleOnly set to true to only include visible items + * \param pageNumber page number, where 0 is the first page + * \param visibleOnly set to true to only include visible items * \since QGIS 2.12 */ QRectF pageItemBounds( int pageNumber, bool visibleOnly = false ) const; /** Calculates the bounds of all non-gui items in the composition. Ignores snap lines and mouse handles. - * @param ignorePages set to true to ignore page items - * @param margin optional marginal (in percent, e.g., 0.05 = 5% ) to add around items + * \param ignorePages set to true to ignore page items + * \param margin optional marginal (in percent, e.g., 0.05 = 5% ) to add around items */ QRectF compositionBounds( bool ignorePages = false, double margin = 0.0 ) const; @@ -825,7 +825,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo void refreshItems(); /** Clears any selected items and sets an item as the current selection. - * @param item item to set as selected + * \param item item to set as selected * \since QGIS 2.3*/ void setSelectedItem( QgsComposerItem *item ); @@ -837,10 +837,10 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo /** Refreshes a data defined property for the composition by reevaluating the property's value * and redrawing the composition with this new value. - * @param property data defined property to refresh. If property is set to + * \param property data defined property to refresh. If property is set to * QgsComposerItem::AllProperties then all data defined properties for the composition will be * refreshed. - * @param context expression context for evaluating data defined expressions + * \param context expression context for evaluating data defined expressions * \since QGIS 2.5 */ void refreshDataDefinedProperty( const QgsComposerObject::DataDefinedProperty property = QgsComposerObject::AllProperties, const QgsExpressionContext *context = nullptr ); @@ -853,20 +853,20 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo /** Returns a reference to the composition's property collection, used for data defined overrides. * \since QGIS 3.0 - * @see setDataDefinedProperties() + * \see setDataDefinedProperties() */ QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; } /** Returns a reference to the composition's property collection, used for data defined overrides. * \since QGIS 3.0 - * @see setDataDefinedProperties() + * \see setDataDefinedProperties() */ const QgsPropertyCollection &dataDefinedProperties() const { return mDataDefinedProperties; } /** Sets the composition's property collection, used for data defined overrides. - * @param collection property collection. Existing properties will be replaced. + * \param collection property collection. Existing properties will be replaced. * \since QGIS 3.0 - * @see dataDefinedProperties() + * \see dataDefinedProperties() */ void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; } @@ -960,7 +960,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo void updateZValues( const bool addUndoCommands = true ); /** Returns the bounding rectangle of the selected items in scene coordinates - @return 0 in case of success*/ + \returns 0 in case of success*/ int boundingRectOfSelectedItems( QRectF &bRect ); //! Loads default composer settings @@ -985,22 +985,22 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo QGraphicsView *graphicsView() const; /** Recalculates the page size using data defined page settings - * @param context expression context for data defined page sizes + * \param context expression context for data defined page sizes */ void refreshPageSize( const QgsExpressionContext *context = nullptr ); /** Check whether any data defined page settings are active. - * @returns true if any data defined page settings are active. + * \returns true if any data defined page settings are active. * \since QGIS 2.5 */ bool ddPageSizeActive() const; /** Computes a GDAL style geotransform for georeferencing a composition. - * @param referenceMap map item to use for georeferencing, or leave as nullptr to use the + * \param referenceMap map item to use for georeferencing, or leave as nullptr to use the * currently defined referenceMap(). - * @param exportRegion set to a valid rectangle to indicate that only part of the composition is + * \param exportRegion set to a valid rectangle to indicate that only part of the composition is * being exported - * @param dpi allows overriding the default composition DPI, or leave as -1 to use composition's DPI. + * \param dpi allows overriding the default composition DPI, or leave as -1 to use composition's DPI. * \since QGIS 2.16 */ double *computeGeoTransform( const QgsComposerMap *referenceMap = nullptr, const QRectF &exportRegion = QRectF(), double dpi = -1 ) const; @@ -1015,7 +1015,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo /** * Emitted when the composition's name is changed. * \since QGIS 3.0 - * @see setName() + * \see setName() */ void nameChanged( const QString &name ); diff --git a/src/core/composer/qgsgroupungroupitemscommand.h b/src/core/composer/qgsgroupungroupitemscommand.h index e0a03812f6e5..b33e26158850 100644 --- a/src/core/composer/qgsgroupungroupitemscommand.h +++ b/src/core/composer/qgsgroupungroupitemscommand.h @@ -45,11 +45,11 @@ class CORE_EXPORT QgsGroupUngroupItemsCommand: public QObject, public QUndoComma /** Create a group or ungroup command * - * @param s command kind (@see State) - * @param item the group item being created or ungrouped - * @param c the composition including this group - * @param text command label - * @param parent parent command, if any + * \param s command kind (\see State) + * \param item the group item being created or ungrouped + * \param c the composition including this group + * \param text command label + * \param parent parent command, if any * */ QgsGroupUngroupItemsCommand( State s, QgsComposerItemGroup *item, QgsComposition *c, const QString &text, QUndoCommand *parent = nullptr ); diff --git a/src/core/composer/qgslayoutmanager.h b/src/core/composer/qgslayoutmanager.h index 1f3465c3b265..f5c25f72b7f4 100644 --- a/src/core/composer/qgslayoutmanager.h +++ b/src/core/composer/qgslayoutmanager.h @@ -54,8 +54,8 @@ class CORE_EXPORT QgsLayoutManager : public QObject * Adds a composition to the manager. Ownership of the composition is transferred to the manager. * Returns true if the addition was successful, or false if the composition could not be added (eg * as a result of a duplicate composition name). - * @see removeComposition() - * @see compositionAdded() + * \see removeComposition() + * \see compositionAdded() */ bool addComposition( QgsComposition *composition ); @@ -63,16 +63,16 @@ class CORE_EXPORT QgsLayoutManager : public QObject * Removes a composition from the manager. The composition is deleted. * Returns true if the removal was successful, or false if the removal failed (eg as a result * of removing a composition which is not contained in the manager). - * @see addComposition() - * @see compositionRemoved() - * @see compositionAboutToBeRemoved() - * @see clear() + * \see addComposition() + * \see compositionRemoved() + * \see compositionAboutToBeRemoved() + * \see clear() */ bool removeComposition( QgsComposition *composition ); /** * Removes and deletes all compositions from the manager. - * @see removeComposition() + * \see removeComposition() */ void clear(); @@ -90,13 +90,13 @@ class CORE_EXPORT QgsLayoutManager : public QObject /** * Reads the manager's state from a DOM element, restoring all compositions * present in the XML document. - * @see writeXml() + * \see writeXml() */ bool readXml( const QDomElement &element, const QDomDocument &doc ); /** * Returns a DOM element representing the state of the manager. - * @see readXml() + * \see readXml() */ QDomElement writeXml( QDomDocument &doc ) const; diff --git a/src/core/composer/qgspaperitem.h b/src/core/composer/qgspaperitem.h index fb6713693a97..558e85669cf2 100644 --- a/src/core/composer/qgspaperitem.h +++ b/src/core/composer/qgspaperitem.h @@ -55,14 +55,14 @@ class CORE_EXPORT QgsPaperItem : public QgsComposerItem void paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget ) override; /** Stores state in Dom element - * @param elem is Dom element corresponding to 'Composer' tag - * @param doc Dom document + * \param elem is Dom element corresponding to 'Composer' tag + * \param doc Dom document */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; /** Sets state from Dom document - * @param itemElem is Dom node corresponding to item tag - * @param doc is the Dom document + * \param itemElem is Dom node corresponding to item tag + * \param doc is the Dom document */ bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override; diff --git a/src/core/composer/qgsscalebarstyle.h b/src/core/composer/qgsscalebarstyle.h index 6ef757ff8b47..f44fc19832a8 100644 --- a/src/core/composer/qgsscalebarstyle.h +++ b/src/core/composer/qgsscalebarstyle.h @@ -36,8 +36,8 @@ class CORE_EXPORT QgsScaleBarStyle virtual ~QgsScaleBarStyle() = default; /** Draws the style - @param p painter object - @param xOffset offset to account for centered labeling*/ + \param p painter object + \param xOffset offset to account for centered labeling*/ virtual void draw( QPainter *p, double xOffset = 0 ) const = 0; //to do by every subclass virtual void drawLabels( QPainter *p ) const; //default implementation provided virtual QRectF calculateBoxSize() const; //default implementation provided diff --git a/src/core/composer/qgssingleboxscalebarstyle.h b/src/core/composer/qgssingleboxscalebarstyle.h index 5fe3d7309e6c..0ba2104e1cca 100644 --- a/src/core/composer/qgssingleboxscalebarstyle.h +++ b/src/core/composer/qgssingleboxscalebarstyle.h @@ -33,8 +33,8 @@ class CORE_EXPORT QgsSingleBoxScaleBarStyle: public QgsScaleBarStyle QString name() const override; /** Draw method - @param p painter object - @param xOffset x offset + \param p painter object + \param xOffset x offset */ void draw( QPainter *p, double xOffset = 0 ) const override; diff --git a/src/core/composer/qgsticksscalebarstyle.h b/src/core/composer/qgsticksscalebarstyle.h index d357e83c1d66..76cbbe6ce654 100644 --- a/src/core/composer/qgsticksscalebarstyle.h +++ b/src/core/composer/qgsticksscalebarstyle.h @@ -38,8 +38,8 @@ class CORE_EXPORT QgsTicksScaleBarStyle: public QgsScaleBarStyle QString name() const override; /** Draw method - @param p painter object - @param xOffset offset + \param p painter object + \param xOffset offset */ void draw( QPainter *p, double xOffset = 0 ) const override; diff --git a/src/core/diagram/qgsdiagram.h b/src/core/diagram/qgsdiagram.h index c8007992466b..14a4a7a89f1b 100644 --- a/src/core/diagram/qgsdiagram.h +++ b/src/core/diagram/qgsdiagram.h @@ -45,8 +45,8 @@ class CORE_EXPORT QgsDiagram void clearCache(); /** Returns a prepared expression for the specified context. - * @param expression expression string - * @param context expression context + * \param expression expression string + * \param context expression context * \since QGIS 2.12 */ QgsExpression *getExpression( const QString &expression, const QgsExpressionContext &context ); @@ -64,9 +64,9 @@ class CORE_EXPORT QgsDiagram virtual QSizeF diagramSize( const QgsFeature &feature, const QgsRenderContext &c, const QgsDiagramSettings &s, const QgsDiagramInterpolationSettings &is ) = 0; /** Returns the size of the legend item for the diagram corresponding to a specified value. - * @param value value to return legend item size for - * @param s diagram settings - * @param is interpolation settings + * \param value value to return legend item size for + * \param s diagram settings + * \param is interpolation settings * \since QGIS 2.16 */ virtual double legendSize( double value, const QgsDiagramSettings &s, const QgsDiagramInterpolationSettings &is ) const = 0; @@ -76,42 +76,42 @@ class CORE_EXPORT QgsDiagram QgsDiagram( const QgsDiagram &other ); /** Changes the pen width to match the current settings and rendering context - * @param pen The pen to modify - * @param s The settings that specify the pen width - * @param c The rendering specifying the proper scale units for pixel conversion + * \param pen The pen to modify + * \param s The settings that specify the pen width + * \param c The rendering specifying the proper scale units for pixel conversion */ void setPenWidth( QPen &pen, const QgsDiagramSettings &s, const QgsRenderContext &c ); /** Calculates a size to match the current settings and rendering context - * @param size The size to convert - * @param s The settings that specify the size type - * @param c The rendering specifying the proper scale units for pixel conversion + * \param size The size to convert + * \param s The settings that specify the size type + * \param c The rendering specifying the proper scale units for pixel conversion * - * @return The converted size for rendering + * \returns The converted size for rendering */ QSizeF sizePainterUnits( QSizeF size, const QgsDiagramSettings &s, const QgsRenderContext &c ); /** Calculates a length to match the current settings and rendering context - * @param l The length to convert - * @param s Unused - * @param c The rendering specifying the proper scale units for pixel conversion + * \param l The length to convert + * \param s Unused + * \param c The rendering specifying the proper scale units for pixel conversion * - * @return The converted length for rendering + * \returns The converted length for rendering */ double sizePainterUnits( double l, const QgsDiagramSettings &s, const QgsRenderContext &c ); /** Calculates a size to match the current settings and rendering context - * @param s The settings that contain the font size and size type - * @param c The rendering specifying the proper scale units for pixel conversion + * \param s The settings that contain the font size and size type + * \param c The rendering specifying the proper scale units for pixel conversion * - * @return The properly scaled font for rendering + * \returns The properly scaled font for rendering */ QFont scaledFont( const QgsDiagramSettings &s, const QgsRenderContext &c ); /** Returns the scaled size of a diagram for a value, respecting the specified diagram interpolation settings. - * @param value value to calculate corresponding circular size for - * @param s diagram settings - * @param is interpolation settings + * \param value value to calculate corresponding circular size for + * \param s diagram settings + * \param is interpolation settings * \since QGIS 2.16 */ QSizeF sizeForValue( double value, const QgsDiagramSettings &s, const QgsDiagramInterpolationSettings &is ) const; diff --git a/src/core/diagram/qgstextdiagram.h b/src/core/diagram/qgstextdiagram.h index a715634669fd..9df6419d9ac3 100644 --- a/src/core/diagram/qgstextdiagram.h +++ b/src/core/diagram/qgstextdiagram.h @@ -66,7 +66,7 @@ class CORE_EXPORT QgsTextDiagram: public QgsDiagram QPen mPen; /** Calculates intersection points between a line and an ellipse - @return intersection points*/ + \returns intersection points*/ void lineEllipseIntersection( QPointF lineStart, QPointF lineEnd, QPointF ellipseMid, double r1, double r2, QList &result ) const; }; diff --git a/src/core/dxf/qgsdxfexport.h b/src/core/dxf/qgsdxfexport.h index 5f712c06e096..090cdb8d9be6 100644 --- a/src/core/dxf/qgsdxfexport.h +++ b/src/core/dxf/qgsdxfexport.h @@ -57,214 +57,214 @@ class CORE_EXPORT QgsDxfExport /** * Set map settings and assign layer name attributes - * @param settings map settings to apply + * \param settings map settings to apply */ void setMapSettings( const QgsMapSettings &settings ); /** * Add layers to export - * @param layers list of layers and corresponding attribute indexes that determine the layer name (-1 for original layer name or title) - * @see setLayerTitleAsName + * \param layers list of layers and corresponding attribute indexes that determine the layer name (-1 for original layer name or title) + * \see setLayerTitleAsName */ void addLayers( const QList< QPair > &layers ); /** * Export to a dxf file in the given encoding - * @param d device - * @param codec encoding - * @returns 0 on success, 1 on invalid device, 2 when devices is not writable + * \param d device + * \param codec encoding + * \returns 0 on success, 1 on invalid device, 2 when devices is not writable */ int writeToFile( QIODevice *d, const QString &codec ); //maybe add progress dialog? other parameters (e.g. scale, dpi)? /** * Set reference scale for output - * @param d scale denominator + * \param d scale denominator */ void setSymbologyScaleDenominator( double d ) { mSymbologyScaleDenominator = d; } /** * Retrieve reference scale for output - * @returns reference scale - * @see setSymbologyScaleDenominator + * \returns reference scale + * \see setSymbologyScaleDenominator */ double symbologyScaleDenominator() const { return mSymbologyScaleDenominator; } /** * Retrieve map units - * @returns unit + * \returns unit */ QgsUnitTypes::DistanceUnit mapUnits() const; /** * Set destination CRS - * @see destinationCrs() + * \see destinationCrs() * \since QGIS 3.0 */ void setDestinationCrs( const QgsCoordinateReferenceSystem &crs ); /** * Returns the destination CRS, or an invalid CRS if no reprojection will be done. - * @see setDestinationCrs() + * \see setDestinationCrs() * \since QGIS 3.0 */ QgsCoordinateReferenceSystem destinationCrs() const; /** * Set symbology export mode - * @param e the mode + * \param e the mode */ void setSymbologyExport( SymbologyExport e ) { mSymbologyExport = e; } /** * Get symbology export mode - * @returns mode - * @see setSymbologyExport + * \returns mode + * \see setSymbologyExport */ SymbologyExport symbologyExport() const { return mSymbologyExport; } /** * Set extent of area to export - * @param r area to export + * \param r area to export */ void setExtent( const QgsRectangle &r ) { mExtent = r; } /** * Get extent of area to export - * @returns area to export - * @see setExtent + * \returns area to export + * \see setExtent */ QgsRectangle extent() const { return mExtent; } /** * Enable use of title (where set) instead of layer name, * when attribute index of corresponding layer index is -1 - * @param layerTitleAsName flag - * @see addLayers + * \param layerTitleAsName flag + * \see addLayers */ void setLayerTitleAsName( bool layerTitleAsName ) { mLayerTitleAsName = layerTitleAsName; } /** * Retrieve whether layer title (where set) instead of name shall be use - * @returns flag - * @see setLayerTitleAsName + * \returns flag + * \see setLayerTitleAsName */ bool layerTitleAsName() { return mLayerTitleAsName; } /** * Get DXF palette index of nearest entry for given color - * @param color + * \param color */ static int closestColorMatch( QRgb color ); /** * Get layer name for feature - * @param id layer id of layer - * @param f feature of layer - * @returns layer name for feature + * \param id layer id of layer + * \param f feature of layer + * \returns layer name for feature */ QString layerName( const QString &id, const QgsFeature &f ) const; /** * Get name for layer respecting the use layer title as layer name mode - * @param vl the vector layer - * @returns name of layer - * @see setLayerTitleAsName + * \param vl the vector layer + * \returns name of layer + * \see setLayerTitleAsName */ QString layerName( QgsVectorLayer *vl ) const; /** * Write a tuple of group code and integer value - * @param code group code - * @param i integer value - * @note available in Python bindings as writeGroupInt + * \param code group code + * \param i integer value + * \note available in Python bindings as writeGroupInt */ void writeGroup( int code, int i ); /** * Write a group code with a floating point value - * @param code group code - * @param d floating point value - * @note available in Python bindings as writeGroupDouble + * \param code group code + * \param d floating point value + * \note available in Python bindings as writeGroupDouble */ void writeGroup( int code, double d ); /** * Write a group code with a string value - * @param code group code - * @param s string value + * \param code group code + * \param s string value */ void writeGroup( int code, const QString &s ); /** * Write a group code with a point - * @param code group code - * @param p point value - * @note available in Python bindings as writeGroupPointV2 + * \param code group code + * \param p point value + * \note available in Python bindings as writeGroupPointV2 * \since QGIS 2.15 */ void writeGroup( int code, const QgsPointV2 &p ); /** * Write a group code with color value - * @param color color - * @param exactMatch group code to use if the color has an exact match in the dxf palette - * @param rgbCode group code to use if the color doesn't have an exact match or has a transparency component - * @param transparencyCode group code to use for transparency component - * @note available in Python bindings as writeGroupPoint + * \param color color + * \param exactMatch group code to use if the color has an exact match in the dxf palette + * \param rgbCode group code to use if the color doesn't have an exact match or has a transparency component + * \param transparencyCode group code to use for transparency component + * \note available in Python bindings as writeGroupPoint */ void writeGroup( const QColor &color, int exactMatch = 62, int rgbCode = 420, int transparencyCode = 440 ); /** * Write a group code - * @param code group code value + * \param code group code value */ void writeGroupCode( int code ); /** * Write an integer value - * @param i integer value + * \param i integer value */ void writeInt( int i ); /** * Write a floating point value - * @param d floating point value + * \param d floating point value */ void writeDouble( double d ); /** * Write a string value - * @param s string value + * \param s string value */ void writeString( const QString &s ); /** * Write a tuple of group code and a handle - * @param code group code to use - * @param handle handle to use (0 generates a new handle) - * @returns the used handle + * \param code group code to use + * \param handle handle to use (0 generates a new handle) + * \returns the used handle */ int writeHandle( int code = 5, int handle = 0 ); /** * Draw dxf primitives (LWPOLYLINE) - * @param line polyline - * @param layer layer name to use - * @param lineStyleName line type to use - * @param color color to use - * @param width line width to use - * @note not available in Python bindings + * \param line polyline + * \param layer layer name to use + * \param lineStyleName line type to use + * \param color color to use + * \param width line width to use + * \note not available in Python bindings * \since QGIS 2.15 */ void writePolyline( const QgsPointSequence &line, const QString &layer, const QString &lineStyleName, const QColor &color, double width = -1 ); /** * Draw dxf filled polygon (HATCH) - * @param polygon polygon - * @param layer layer name to use - * @param hatchPattern hatchPattern to use - * @param color color to use - * @note not available in Python bindings + * \param polygon polygon + * \param layer layer name to use + * \param hatchPattern hatchPattern to use + * \param color color to use + * \note not available in Python bindings * \since QGIS 2.15 */ void writePolygon( const QgsRingSequence &polygon, const QString &layer, const QString &hatchPattern, const QColor &color ); @@ -274,27 +274,27 @@ class CORE_EXPORT QgsDxfExport void writeLine( const QgsPointV2 &pt1, const QgsPointV2 &pt2, const QString &layer, const QString &lineStyleName, const QColor &color, double width = -1 ); //! Write point - //! @note available in Python bindings as writePointV2 + //! \note available in Python bindings as writePointV2 //! \since QGIS 2.15 void writePoint( const QString &layer, const QColor &color, const QgsPointV2 &pt ); //! Write filled circle (as hatch) - //! @note available in Python bindings as writePointV2 + //! \note available in Python bindings as writePointV2 //! \since QGIS 2.15 void writeFilledCircle( const QString &layer, const QColor &color, const QgsPointV2 &pt, double radius ); //! Write circle (as polyline) - //! @note available in Python bindings as writeCircleV2 + //! \note available in Python bindings as writeCircleV2 //! \since QGIS 2.15 void writeCircle( const QString &layer, const QColor &color, const QgsPointV2 &pt, double radius, const QString &lineStyleName, double width ); //! Write text (TEXT) - //! @note available in Python bindings as writeTextV2 + //! \note available in Python bindings as writeTextV2 //! \since QGIS 2.15 void writeText( const QString &layer, const QString &text, const QgsPointV2 &pt, double size, double angle, const QColor &color ); //! Write mtext (MTEXT) - //! @note available in Python bindings as writeMTextV2 + //! \note available in Python bindings as writeMTextV2 //! \since QGIS 2.15 void writeMText( const QString &layer, const QString &text, const QgsPointV2 &pt, double width, double angle, const QColor &color ); @@ -311,18 +311,18 @@ class CORE_EXPORT QgsDxfExport static QStringList encodings(); /** Output the label - * @param layerId id of the layer - * @param context render context - * @param label position of label - * @param settings label settings - * @note not available in Python bindings + * \param layerId id of the layer + * \param context render context + * \param label position of label + * \param settings label settings + * \note not available in Python bindings */ void drawLabel( const QString &layerId, QgsRenderContext &context, pal::LabelPosition *label, const QgsPalLayerSettings &settings ); /** Register name of layer for feature - * @param layerId id of layer - * @param fid id of feature - * @param layer dxf layer of feature + * \param layerId id of layer + * \param fid id of feature + * \param layer dxf layer of feature */ void registerDxfLayer( const QString &layerId, QgsFeatureId fid, const QString &layer ); diff --git a/src/core/dxf/qgsdxfpaintdevice.h b/src/core/dxf/qgsdxfpaintdevice.h index ef50b1aeb76d..6565087931ec 100644 --- a/src/core/dxf/qgsdxfpaintdevice.h +++ b/src/core/dxf/qgsdxfpaintdevice.h @@ -28,7 +28,7 @@ class QPaintEngine; /** \ingroup core * A paint device for drawing into dxf files. - * @note not available in Python bindings + * \note not available in Python bindings */ class CORE_EXPORT QgsDxfPaintDevice: public QPaintDevice diff --git a/src/core/dxf/qgsdxfpallabeling.h b/src/core/dxf/qgsdxfpallabeling.h index 21a1fab8d9a6..502b86c05a19 100644 --- a/src/core/dxf/qgsdxfpallabeling.h +++ b/src/core/dxf/qgsdxfpallabeling.h @@ -30,7 +30,7 @@ class QgsRuleBasedLabeling; * Implements a derived label provider internally used for DXF export * * Internal class, not in public API. Added in QGIS 2.12 - * @note not available in Python bindings + * \note not available in Python bindings */ class QgsDxfLabelProvider : public QgsVectorLayerLabelProvider { @@ -39,15 +39,15 @@ class QgsDxfLabelProvider : public QgsVectorLayerLabelProvider explicit QgsDxfLabelProvider( QgsVectorLayer *layer, const QString &providerId, QgsDxfExport *dxf, const QgsPalLayerSettings *settings ); /** Re-implementation that writes to DXF file instead of drawing with QPainter - * @param context render context - * @param label label + * \param context render context + * \param label label */ void drawLabel( QgsRenderContext &context, pal::LabelPosition *label ) const override; /** Registration method that keeps track of DXF layer names of individual features - * @param feature feature - * @param context render context - * @param dxfLayerName name of dxf layer + * \param feature feature + * \param context render context + * \param dxfLayerName name of dxf layer */ void registerDxfFeature( QgsFeature &feature, QgsRenderContext &context, const QString &dxfLayerName ); @@ -61,7 +61,7 @@ class QgsDxfLabelProvider : public QgsVectorLayerLabelProvider * for DXF export * * Internal class, not in public API. Added in QGIS 2.15 - * @note not available in Python bindings + * \note not available in Python bindings */ class QgsDxfRuleBasedLabelProvider : public QgsRuleBasedLabelProvider { @@ -70,20 +70,20 @@ class QgsDxfRuleBasedLabelProvider : public QgsRuleBasedLabelProvider explicit QgsDxfRuleBasedLabelProvider( const QgsRuleBasedLabeling &rules, QgsVectorLayer *layer, QgsDxfExport *dxf ); /** Reinitialize the subproviders with QgsDxfLabelProviders - * @param layer layer + * \param layer layer */ void reinit( QgsVectorLayer *layer ); /** Re-implementation that writes to DXF file instead of drawing with QPainter - * @param context render context - * @param label label + * \param context render context + * \param label label */ void drawLabel( QgsRenderContext &context, pal::LabelPosition *label ) const override; /** Registration method that keeps track of DXF layer names of individual features - * @param feature feature - * @param context render context - * @param dxfLayerName name of dxf layer + * \param feature feature + * \param context render context + * \param dxfLayerName name of dxf layer */ void registerDxfFeature( QgsFeature &feature, QgsRenderContext &context, const QString &dxfLayerName ); diff --git a/src/core/effects/qgsblureffect.h b/src/core/effects/qgsblureffect.h index c52a8a76cc00..351d63e9ee2b 100644 --- a/src/core/effects/qgsblureffect.h +++ b/src/core/effects/qgsblureffect.h @@ -43,8 +43,8 @@ class CORE_EXPORT QgsBlurEffect : public QgsPaintEffect }; /** Creates a new QgsBlurEffect effect from a properties string map. - * @param map encoded properties string map - * @returns new QgsBlurEffect + * \param map encoded properties string map + * \returns new QgsBlurEffect */ static QgsPaintEffect *create( const QgsStringMap &map ); @@ -56,58 +56,58 @@ class CORE_EXPORT QgsBlurEffect : public QgsPaintEffect virtual QgsBlurEffect *clone() const override; /** Sets blur level (strength) - * @param level blur level. Depending on the current @link blurMethod @endlink, this parameter + * \param level blur level. Depending on the current blurMethod(), this parameter * has different effects - * @see blurLevel - * @see blurMethod + * \see blurLevel + * \see blurMethod */ void setBlurLevel( const int level ) { mBlurLevel = level; } /** Returns the blur level (strength) - * @returns blur level. Depending on the current @link blurMethod @endlink, this parameter + * \returns blur level. Depending on the current blurMethod(), this parameter * has different effects - * @see setBlurLevel - * @see blurMethod + * \see setBlurLevel + * \see blurMethod */ int blurLevel() const { return mBlurLevel; } /** Sets the blur method (algorithm) to use for performing the blur. - * @param method blur method - * @see blurMethod + * \param method blur method + * \see blurMethod */ void setBlurMethod( const BlurMethod method ) { mBlurMethod = method; } /** Returns the blur method (algorithm) used for performing the blur. - * @returns blur method - * @see setBlurMethod + * \returns blur method + * \see setBlurMethod */ BlurMethod blurMethod() const { return mBlurMethod; } /** Sets the transparency for the effect - * @param transparency double between 0 and 1 inclusive, where 0 is fully opaque + * \param transparency double between 0 and 1 inclusive, where 0 is fully opaque * and 1 is fully transparent - * @see transparency + * \see transparency */ void setTransparency( const double transparency ) { mTransparency = transparency; } /** Returns the transparency for the effect - * @returns transparency value between 0 and 1 inclusive, where 0 is fully opaque + * \returns transparency value between 0 and 1 inclusive, where 0 is fully opaque * and 1 is fully transparent - * @see setTransparency + * \see setTransparency */ double transparency() const { return mTransparency; } /** Sets the blend mode for the effect - * @param mode blend mode used for drawing the effect on to a destination + * \param mode blend mode used for drawing the effect on to a destination * paint device - * @see blendMode + * \see blendMode */ void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; } /** Returns the blend mode for the effect - * @returns blend mode used for drawing the effect on to a destination + * \returns blend mode used for drawing the effect on to a destination * paint device - * @see setBlendMode + * \see setBlendMode */ QPainter::CompositionMode blendMode() const { return mBlendMode; } diff --git a/src/core/effects/qgscoloreffect.h b/src/core/effects/qgscoloreffect.h index 3e5d8a6bcc26..133f4dca58c7 100644 --- a/src/core/effects/qgscoloreffect.h +++ b/src/core/effects/qgscoloreffect.h @@ -37,8 +37,8 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect public: /** Creates a new QgsColorEffect effect from a properties string map. - * @param map encoded properties string map - * @returns new QgsColorEffect + * \param map encoded properties string map + * \returns new QgsColorEffect */ static QgsPaintEffect *create( const QgsStringMap &map ); @@ -50,142 +50,142 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect virtual QgsColorEffect *clone() const override; /** Sets the brightness modification for the effect. - * @param brightness Valid values are between -255 and 255, where 0 represents + * \param brightness Valid values are between -255 and 255, where 0 represents * no change, negative values indicate darkening and positive values indicate * lightening - * @see setBrightness + * \see setBrightness */ void setBrightness( int brightness ) { mBrightness = qBound( -255, brightness, 255 ); } /** Returns the brightness modification for the effect. - * @returns brightness value. Values are between -255 and 255, where 0 represents + * \returns brightness value. Values are between -255 and 255, where 0 represents * no change, negative values indicate darkening and positive values indicate * lightening - * @see setBrightness + * \see setBrightness */ int brightness() const { return mBrightness; } /** Sets the contrast modification for the effect. - * @param contrast Valid values are between -100 and 100, where 0 represents + * \param contrast Valid values are between -100 and 100, where 0 represents * no change, negative values indicate less contrast and positive values indicate * greater contrast - * @see setContrast + * \see setContrast */ void setContrast( int contrast ) { mContrast = qBound( -100, contrast, 100 ); } /** Returns the contrast modification for the effect. - * @returns contrast value. Values are between -100 and 100, where 0 represents + * \returns contrast value. Values are between -100 and 100, where 0 represents * no change, negative values indicate less contrast and positive values indicate * greater contrast - * @see setContrast + * \see setContrast */ int contrast() const { return mContrast; } /** Sets the saturation modification for the effect. - * @param saturation Valid values are between 0 and 2.0, where 1.0 represents + * \param saturation Valid values are between 0 and 2.0, where 1.0 represents * no change, 0.0 represents totally desaturated (grayscale), and positive values indicate * greater saturation - * @see saturation + * \see saturation */ void setSaturation( double saturation ) { mSaturation = saturation; } /** Returns the saturation modification for the effect. - * @returns saturation value. Values are between 0 and 2.0, where 1.0 represents + * \returns saturation value. Values are between 0 and 2.0, where 1.0 represents * no change, 0.0 represents totally desaturated (grayscale), and positive values indicate * greater saturation - * @see setSaturation + * \see setSaturation */ double saturation() const { return mSaturation; } /** Sets whether the effect should convert a picture to grayscale. - * @param grayscaleMode method for grayscale conversion - * @see grayscaleMode + * \param grayscaleMode method for grayscale conversion + * \see grayscaleMode */ void setGrayscaleMode( QgsImageOperation::GrayscaleMode grayscaleMode ) { mGrayscaleMode = grayscaleMode; } /** Returns whether the effect will convert a picture to grayscale. - * @returns method for grayscale conversion - * @see setGrayscaleMode + * \returns method for grayscale conversion + * \see setGrayscaleMode */ QgsImageOperation::GrayscaleMode grayscaleMode() const { return mGrayscaleMode; } /** Sets whether the effect should colorize a picture. - * @param colorizeOn set to true to enable colorization - * @see colorizeOn - * @see setColorizeColor - * @see setColorizeStrength + * \param colorizeOn set to true to enable colorization + * \see colorizeOn + * \see setColorizeColor + * \see setColorizeStrength */ void setColorizeOn( bool colorizeOn ) { mColorizeOn = colorizeOn; } /** Returns whether the effect will colorize a picture. - * @returns true if colorization is enableds - * @see setColorizeOn - * @see colorizeColor - * @see colorizeStrength + * \returns true if colorization is enableds + * \see setColorizeOn + * \see colorizeColor + * \see colorizeStrength */ bool colorizeOn() const { return mColorizeOn; } /** Sets the color used for colorizing a picture. This is only used if - * @link setColorizeOn @endlink is set to true. - * @param colorizeColor colorization color - * @see colorizeColor - * @see setColorizeOn - * @see setColorizeStrength + * setColorizeOn() is set to true. + * \param colorizeColor colorization color + * \see colorizeColor + * \see setColorizeOn + * \see setColorizeStrength */ void setColorizeColor( const QColor &colorizeColor ); /** Returns the color used for colorizing a picture. This is only used if - * @link colorizeOn @endlink is set to true. - * @returns colorization color - * @see setColorizeColor - * @see colorizeOn - * @see colorizeStrength + * colorizeOn() is set to true. + * \returns colorization color + * \see setColorizeColor + * \see colorizeOn + * \see colorizeStrength */ QColor colorizeColor() const { return mColorizeColor; } /** Sets the strength for colorizing a picture. This is only used if - * @link setColorizeOn @endlink is set to true. - * @param colorizeStrength colorization strength, between 0 and 100 - * @see colorizeStrength - * @see setColorizeOn - * @see setColorizeColor + * setColorizeOn() is set to true. + * \param colorizeStrength colorization strength, between 0 and 100 + * \see colorizeStrength + * \see setColorizeOn + * \see setColorizeColor */ void setColorizeStrength( int colorizeStrength ) { mColorizeStrength = colorizeStrength; } /** Returns the strength used for colorizing a picture. This is only used if - * @link setColorizeOn @endlink is set to true. - * @returns colorization strength, between 0 and 100 - * @see setColorizeStrengths - * @see colorizeOn - * @see colorizeColor + * setColorizeOn() is set to true. + * \returns colorization strength, between 0 and 100 + * \see setColorizeStrengths + * \see colorizeOn + * \see colorizeColor */ int colorizeStrength() const { return mColorizeStrength; } /** Sets the transparency for the effect - * @param transparency double between 0 and 1 inclusive, where 0 is fully opaque + * \param transparency double between 0 and 1 inclusive, where 0 is fully opaque * and 1 is fully transparent - * @see transparency + * \see transparency */ void setTransparency( const double transparency ) { mTransparency = transparency; } /** Returns the transparency for the effect - * @returns transparency value between 0 and 1 inclusive, where 0 is fully opaque + * \returns transparency value between 0 and 1 inclusive, where 0 is fully opaque * and 1 is fully transparent - * @see setTransparency + * \see setTransparency */ double transparency() const { return mTransparency; } /** Sets the blend mode for the effect - * @param mode blend mode used for drawing the effect on to a destination + * \param mode blend mode used for drawing the effect on to a destination * paint device - * @see blendMode + * \see blendMode */ void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; } /** Returns the blend mode for the effect - * @returns blend mode used for drawing the effect on to a destination + * \returns blend mode used for drawing the effect on to a destination * paint device - * @see setBlendMode + * \see setBlendMode */ QPainter::CompositionMode blendMode() const { return mBlendMode; } diff --git a/src/core/effects/qgseffectstack.h b/src/core/effects/qgseffectstack.h index 92c85b81e3e2..ca170c53cbe5 100644 --- a/src/core/effects/qgseffectstack.h +++ b/src/core/effects/qgseffectstack.h @@ -46,8 +46,8 @@ class CORE_EXPORT QgsEffectStack : public QgsPaintEffect /** Creates a new QgsEffectStack effect. This method ignores * the map parameter, and always returns an empty effect stack. - * @param map unused encoded properties string map - * @returns new QgsEffectStack + * \param map unused encoded properties string map + * \returns new QgsEffectStack */ static QgsPaintEffect *create( const QgsStringMap &map ); @@ -55,9 +55,9 @@ class CORE_EXPORT QgsEffectStack : public QgsPaintEffect QgsEffectStack( const QgsEffectStack &other ); /** Creates a new QgsEffectStack effect from a single initial effect. - * @param effect initial effect to add to the stack. The effect will + * \param effect initial effect to add to the stack. The effect will * be cloned, so ownership is not transferred to the stack. - * @returns new QgsEffectStack containing initial effect + * \returns new QgsEffectStack containing initial effect */ explicit QgsEffectStack( const QgsPaintEffect &effect ); @@ -77,46 +77,46 @@ class CORE_EXPORT QgsEffectStack : public QgsPaintEffect virtual void readProperties( const QgsStringMap &props ) override; /** Appends an effect to the end of the stack. - * @param effect QgsPaintEffect to append. Ownership of the effect will be + * \param effect QgsPaintEffect to append. Ownership of the effect will be * transferred to the stack object. - * @see insertEffect + * \see insertEffect */ void appendEffect( QgsPaintEffect *effect ); /** Inserts an effect at a specified index within the stack. - * @param index position to insert the effect - * @param effect QgsPaintEffect to insert. Ownership of the effect will be + * \param index position to insert the effect + * \param effect QgsPaintEffect to insert. Ownership of the effect will be * transferred to the stack object. - * @see appendEffect + * \see appendEffect */ bool insertEffect( const int index, QgsPaintEffect *effect ); /** Replaces the effect at a specified position within the stack. - * @param index position of effect to replace - * @param effect QgsPaintEffect to replace with. Ownership of the effect will be + * \param index position of effect to replace + * \param effect QgsPaintEffect to replace with. Ownership of the effect will be * transferred to the stack object. */ bool changeEffect( const int index, QgsPaintEffect *effect ); /** Removes an effect from the stack and returns a pointer to it. - * @param index position of effect to take + * \param index position of effect to take */ QgsPaintEffect *takeEffect( const int index ); /** Returns a pointer to the list of effects currently contained by * the stack - * @returns list of QgsPaintEffects within the stack + * \returns list of QgsPaintEffects within the stack */ QList< QgsPaintEffect * > *effectList(); /** Returns count of effects contained by the stack - * @returns count of effects + * \returns count of effects */ int count() const { return mEffectList.count(); } /** Returns a pointer to the effect at a specified index within the stack - * @param index position of effect to return - * @returns QgsPaintEffect at specified position + * \param index position of effect to return + * \returns QgsPaintEffect at specified position */ QgsPaintEffect *effect( int index ) const; diff --git a/src/core/effects/qgsgloweffect.h b/src/core/effects/qgsgloweffect.h index a5158c82161c..612e105402b4 100644 --- a/src/core/effects/qgsgloweffect.h +++ b/src/core/effects/qgsgloweffect.h @@ -53,146 +53,146 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect virtual void readProperties( const QgsStringMap &props ) override; /** Sets the spread distance for drawing the glow effect. - * @param spread spread distance. Units are specified via @link setSpreadUnit @endlink - * @see spread - * @see setSpreadUnit - * @see setSpreadMapUnitScale + * \param spread spread distance. Units are specified via setSpreadUnit() + * \see spread + * \see setSpreadUnit + * \see setSpreadMapUnitScale */ void setSpread( const double spread ) { mSpread = spread; } /** Returns the spread distance used for drawing the glow effect. - * @returns spread distance. Units are retrieved via @link spreadUnit @endlink - * @see setSpread - * @see spreadUnit - * @see spreadMapUnitScale + * \returns spread distance. Units are retrieved via spreadUnit() + * \see setSpread + * \see spreadUnit + * \see spreadMapUnitScale */ double spread() const { return mSpread; } /** Sets the units used for the glow spread distance. - * @param unit units for spread distance - * @see spreadUnit - * @see setSpread - * @see setSpreadMapUnitScale + * \param unit units for spread distance + * \see spreadUnit + * \see setSpread + * \see setSpreadMapUnitScale */ void setSpreadUnit( const QgsUnitTypes::RenderUnit unit ) { mSpreadUnit = unit; } /** Returns the units used for the glow spread distance. - * @returns units for spread distance - * @see setSpreadUnit - * @see spread - * @see spreadMapUnitScale + * \returns units for spread distance + * \see setSpreadUnit + * \see spread + * \see spreadMapUnitScale */ QgsUnitTypes::RenderUnit spreadUnit() const { return mSpreadUnit; } /** Sets the map unit scale used for the spread distance. - * @param scale map unit scale for spread distance - * @see spreadMapUnitScale - * @see setSpread - * @see setSpreadUnit + * \param scale map unit scale for spread distance + * \see spreadMapUnitScale + * \see setSpread + * \see setSpreadUnit */ void setSpreadMapUnitScale( const QgsMapUnitScale &scale ) { mSpreadMapUnitScale = scale; } /** Returns the map unit scale used for the spread distance. - * @returns map unit scale for spread distance - * @see setSpreadMapUnitScale - * @see spread - * @see spreadUnit + * \returns map unit scale for spread distance + * \see setSpreadMapUnitScale + * \see spread + * \see spreadUnit */ const QgsMapUnitScale &spreadMapUnitScale() const { return mSpreadMapUnitScale; } /** Sets blur level (strength) for the glow. This can be used to smooth the * output from the glow effect. - * @param level blur level. Values between 0 and 16 are valid, with larger + * \param level blur level. Values between 0 and 16 are valid, with larger * values indicating greater blur strength. - * @see blurLevel + * \see blurLevel */ void setBlurLevel( const int level ) { mBlurLevel = level; } /** Returns the blur level (strength) for the glow. - * @returns blur level. Value will be between 0 and 16, with larger + * \returns blur level. Value will be between 0 and 16, with larger * values indicating greater blur strength. - * @see setBlurLevel + * \see setBlurLevel */ int blurLevel() const { return mBlurLevel; } /** Sets the transparency for the effect - * @param transparency double between 0 and 1 inclusive, where 0 is fully opaque + * \param transparency double between 0 and 1 inclusive, where 0 is fully opaque * and 1 is fully transparent - * @see transparency + * \see transparency */ void setTransparency( const double transparency ) { mTransparency = transparency; } /** Returns the transparency for the effect - * @returns transparency value between 0 and 1 inclusive, where 0 is fully opaque + * \returns transparency value between 0 and 1 inclusive, where 0 is fully opaque * and 1 is fully transparent - * @see setTransparency + * \see setTransparency */ double transparency() const { return mTransparency; } - /** Sets the color for the glow. This only applies if the @link colorType @endlink + /** Sets the color for the glow. This only applies if the colorType() * is set to SingleColor. The glow will fade between the specified color and * a totally transparent version of the color. - * @param color glow color - * @see color - * @see setColorType + * \param color glow color + * \see color + * \see setColorType */ void setColor( const QColor &color ) { mColor = color; } - /** Returns the color for the glow. This only applies if the @link colorType @endlink + /** Returns the color for the glow. This only applies if the colorType() * is set to SingleColor. The glow will fade between the specified color and * a totally transparent version of the color. - * @returns glow color - * @see setColor - * @see colorType + * \returns glow color + * \see setColor + * \see colorType */ QColor color() const { return mColor; } - /** Sets the color ramp for the glow. This only applies if the @link colorType @endlink + /** Sets the color ramp for the glow. This only applies if the colorType() * is set to ColorRamp. The glow will utilize colors from the ramp. - * @param ramp color ramp for glow. Ownership of the ramp is transferred to the effect. - * @see ramp - * @see setColorType + * \param ramp color ramp for glow. Ownership of the ramp is transferred to the effect. + * \see ramp + * \see setColorType */ void setRamp( QgsColorRamp *ramp ); - /** Returns the color ramp used for the glow. This only applies if the @link colorType @endlink + /** Returns the color ramp used for the glow. This only applies if the colorType() * is set to ColorRamp. The glow will utilize colors from the ramp. - * @returns color ramp for glow - * @see setRamp - * @see colorType + * \returns color ramp for glow + * \see setRamp + * \see colorType */ QgsColorRamp *ramp() const { return mRamp; } /** Sets the blend mode for the effect - * @param mode blend mode used for drawing the effect on to a destination + * \param mode blend mode used for drawing the effect on to a destination * paint device - * @see blendMode + * \see blendMode */ void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; } /** Returns the blend mode for the effect - * @returns blend mode used for drawing the effect on to a destination + * \returns blend mode used for drawing the effect on to a destination * paint device - * @see setBlendMode + * \see setBlendMode */ QPainter::CompositionMode blendMode() const { return mBlendMode; } /** Sets the color mode to use for the glow. The glow can either be drawn using a QgsColorRamp * color ramp or by simply specificing a single color. setColorType is used to specify which mode to use * for the glow. - * @param colorType color type to use for glow - * @see colorType - * @see setColor - * @see setRamp + * \param colorType color type to use for glow + * \see colorType + * \see setColor + * \see setRamp */ void setColorType( GlowColorType colorType ) { mColorType = colorType; } /** Returns the color mode used for the glow. The glow can either be drawn using a QgsColorRamp * color ramp or by specificing a single color. - * @returns current color mode used for the glow - * @see setColorType - * @see color - * @see ramp + * \returns current color mode used for the glow + * \see setColorType + * \see color + * \see ramp */ GlowColorType colorType() const { return mColorType; } @@ -205,7 +205,7 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect /** Specifies whether the glow is drawn outside the picture or within * the picture. - * @returns true if glow is to be drawn outside the picture, or false + * \returns true if glow is to be drawn outside the picture, or false * to draw glow within the picture */ virtual bool shadeExterior() const = 0; @@ -236,8 +236,8 @@ class CORE_EXPORT QgsOuterGlowEffect : public QgsGlowEffect public: /** Creates a new QgsOuterGlowEffect effect from a properties string map. - * @param map encoded properties string map - * @returns new QgsOuterGlowEffect + * \param map encoded properties string map + * \returns new QgsOuterGlowEffect */ static QgsPaintEffect *create( const QgsStringMap &map ); @@ -266,8 +266,8 @@ class CORE_EXPORT QgsInnerGlowEffect : public QgsGlowEffect public: /** Creates a new QgsInnerGlowEffect effect from a properties string map. - * @param map encoded properties string map - * @returns new QgsInnerGlowEffect + * \param map encoded properties string map + * \returns new QgsInnerGlowEffect */ static QgsPaintEffect *create( const QgsStringMap &map ); diff --git a/src/core/effects/qgsimageoperation.h b/src/core/effects/qgsimageoperation.h index efc72f569bdb..bdc5b084da34 100644 --- a/src/core/effects/qgsimageoperation.h +++ b/src/core/effects/qgsimageoperation.h @@ -64,42 +64,42 @@ class CORE_EXPORT QgsImageOperation }; /** Convert a QImage to a grayscale image. Alpha channel is preserved. - * @param image QImage to convert - * @param mode mode to use during grayscale conversion + * \param image QImage to convert + * \param mode mode to use during grayscale conversion */ static void convertToGrayscale( QImage &image, const GrayscaleMode mode = GrayscaleLuminosity ); /** Alter the brightness or contrast of a QImage. - * @param image QImage to alter - * @param brightness brightness value, in the range -255 to 255. A brightness value of 0 indicates + * \param image QImage to alter + * \param brightness brightness value, in the range -255 to 255. A brightness value of 0 indicates * no change to brightness, a negative value will darken the image, and a positive value will brighten * the image. - * @param contrast contrast value. Must be a positive or zero value. A value of 1.0 indicates no change + * \param contrast contrast value. Must be a positive or zero value. A value of 1.0 indicates no change * to the contrast, a value of 0 represents an image with 0 contrast, and a value > 1.0 will increase the * contrast of the image. */ static void adjustBrightnessContrast( QImage &image, const int brightness, const double contrast ); /** Alter the hue or saturation of a QImage. - * @param image QImage to alter - * @param saturation double between 0 and 2 inclusive, where 0 = desaturate and 1.0 = no change - * @param colorizeColor color to use for colorizing image. Set to an invalid QColor to disable + * \param image QImage to alter + * \param saturation double between 0 and 2 inclusive, where 0 = desaturate and 1.0 = no change + * \param colorizeColor color to use for colorizing image. Set to an invalid QColor to disable * colorization. - * @param colorizeStrength double between 0 and 1, where 0 = no colorization and 1.0 = full colorization + * \param colorizeStrength double between 0 and 1, where 0 = no colorization and 1.0 = full colorization */ static void adjustHueSaturation( QImage &image, const double saturation, const QColor &colorizeColor = QColor(), const double colorizeStrength = 1.0 ); /** Multiplies opacity of image pixel values by a factor. - * @param image QImage to alter - * @param factor factor to multiple pixel's opacity by + * \param image QImage to alter + * \param factor factor to multiple pixel's opacity by */ static void multiplyOpacity( QImage &image, const double factor ); /** Overlays a color onto an image. This operation retains the alpha channel of the * original image, but replaces all image pixel colors with the specified color. - * @param image QImage to alter - * @param color color to overlay (any alpha component of the color is ignored) + * \param image QImage to alter + * \param color color to overlay (any alpha component of the color is ignored) */ static void overlayColor( QImage &image, const QColor &color ); @@ -136,54 +136,54 @@ class CORE_EXPORT QgsImageOperation /** Performs a distance transform on the source image and shades the result * using a color ramp. - * @param image QImage to alter - * @param properties DistanceTransformProperties object with parameters + * \param image QImage to alter + * \param properties DistanceTransformProperties object with parameters * for the distance transform operation */ static void distanceTransform( QImage &image, const DistanceTransformProperties &properties ); /** Performs a stack blur on an image. Stack blur represents a good balance between * speed and blur quality. - * @param image QImage to blur - * @param radius blur radius in pixels, maximum value of 16 - * @param alphaOnly set to true to blur only the alpha component of the image - * @note for fastest operation, ensure the source image is ARGB32_Premultiplied if + * \param image QImage to blur + * \param radius blur radius in pixels, maximum value of 16 + * \param alphaOnly set to true to blur only the alpha component of the image + * \note for fastest operation, ensure the source image is ARGB32_Premultiplied if * alphaOnly is set to false, or ARGB32 if alphaOnly is true */ static void stackBlur( QImage &image, const int radius, const bool alphaOnly = false ); /** Performs a gaussian blur on an image. Gaussian blur is slower but results in a high * quality blur. - * @param image QImage to blur - * @param radius blur radius in pixels - * @returns blurred image - * @note for fastest operation, ensure the source image is ARGB32_Premultiplied + * \param image QImage to blur + * \param radius blur radius in pixels + * \returns blurred image + * \note for fastest operation, ensure the source image is ARGB32_Premultiplied */ static QImage *gaussianBlur( QImage &image, const int radius ); /** Flips an image horizontally or vertically - * @param image QImage to flip - * @param type type of flip to perform (horizontal or vertical) + * \param image QImage to flip + * \param type type of flip to perform (horizontal or vertical) */ static void flipImage( QImage &image, FlipType type ); /** Calculates the non-transparent region of an image. - * @param image source image - * @param minSize minimum size for returned region, if desired. If the + * \param image source image + * \param minSize minimum size for returned region, if desired. If the * non-transparent region of the image is smaller than this minimum size, * it will be centered in the returned rectangle. - * @param center return rectangle will be centered on the center of the original image if set to true + * \param center return rectangle will be centered on the center of the original image if set to true * \since QGIS 2.9 - * @see cropTransparent + * \see cropTransparent */ static QRect nonTransparentImageRect( const QImage &image, QSize minSize = QSize(), bool center = false ); /** Crop any transparent border from around an image. - * @param image source image - * @param minSize minimum size for cropped image, if desired. If the + * \param image source image + * \param minSize minimum size for cropped image, if desired. If the * cropped image is smaller than the minimum size, it will be centered * in the returned image. - * @param center cropped image will be centered on the center of the original image if set to true + * \param center cropped image will be centered on the center of the original image if set to true * \since QGIS 2.9 */ static QImage cropTransparent( const QImage &image, QSize minSize = QSize(), bool center = false ); diff --git a/src/core/effects/qgspainteffect.h b/src/core/effects/qgspainteffect.h index d4b41fb62fdf..aee3732a6b11 100644 --- a/src/core/effects/qgspainteffect.h +++ b/src/core/effects/qgspainteffect.h @@ -34,13 +34,13 @@ class QgsRenderContext; * either drawing a picture directly, or by intercepting drawing operations to a * render context. * - * To directly draw a picture, use the @link render @endlink method with a source + * To directly draw a picture, use the render() method with a source * QPicture and destination render context. * * Intercepting drawing operations to a render context is achieved by first calling - * the @link begin @endlink method, passing a render context. Any drawing operations + * the begin() method, passing a render context. Any drawing operations * performed on the render context will not directly affect the context's paint - * device. When the drawing operations have been completed, call the @link end @endlink + * device. When the drawing operations have been completed, call the end() * method. This will perform the paint effect on the intercepted drawing operations * and render the result to the render context's paint device. * @@ -55,7 +55,7 @@ class CORE_EXPORT QgsPaintEffect /** Drawing modes for effects. These modes are used only when effects are * drawn as part of an effects stack - * @see QgsEffectStack + * \see QgsEffectStack */ enum DrawMode { @@ -69,93 +69,93 @@ class CORE_EXPORT QgsPaintEffect virtual ~QgsPaintEffect(); /** Returns the effect type. - * @returns unique string representation of the effect type + * \returns unique string representation of the effect type */ virtual QString type() const = 0; /** Duplicates an effect by creating a deep copy of the effect - * @returns clone of paint effect + * \returns clone of paint effect */ virtual QgsPaintEffect *clone() const = 0; /** Returns the properties describing the paint effect encoded in a * string format. - * @returns string map of properties, in the form property key, value - * @see readProperties - * @see saveProperties + * \returns string map of properties, in the form property key, value + * \see readProperties + * \see saveProperties */ virtual QgsStringMap properties() const = 0; /** Reads a string map of an effect's properties and restores the effect * to the state described by the properties map. - * @param props effect properties encoded in a string map - * @see properties + * \param props effect properties encoded in a string map + * \see properties */ virtual void readProperties( const QgsStringMap &props ) = 0; /** Saves the current state of the effect to a DOM element. The default * behavior is to save the properties string map returned by - * @link properties @endlink. - * @param doc destination DOM document - * @param element destination DOM element - * @returns true if save was successful - * @see readProperties + * properties(). + * \param doc destination DOM document + * \param element destination DOM element + * \returns true if save was successful + * \see readProperties */ virtual bool saveProperties( QDomDocument &doc, QDomElement &element ) const; /** Restores the effect to the state described by a DOM element. - * @param element DOM element describing an effect's state - * @returns true if read was successful - * @see saveProperties + * \param element DOM element describing an effect's state + * \returns true if read was successful + * \see saveProperties */ virtual bool readProperties( const QDomElement &element ); /** Renders a picture using the effect. - * @param picture source QPicture to render - * @param context destination render context - * @see begin + * \param picture source QPicture to render + * \param context destination render context + * \see begin */ virtual void render( QPicture &picture, QgsRenderContext &context ); /** Begins intercepting paint operations to a render context. When the corresponding - * @link end @endlink member is called all intercepted paint operations will be + * end() member is called all intercepted paint operations will be * drawn to the render context after being modified by the effect. - * @param context destination render context - * @see end - * @see render + * \param context destination render context + * \see end + * \see render */ virtual void begin( QgsRenderContext &context ); /** Ends interception of paint operations to a render context, and draws the result * to the render context after being modified by the effect. - * @param context destination render context - * @see begin + * \param context destination render context + * \see begin */ virtual void end( QgsRenderContext &context ); /** Returns whether the effect is enabled - * @returns true if effect is enabled - * @see setEnabled + * \returns true if effect is enabled + * \see setEnabled */ bool enabled() const { return mEnabled; } /** Sets whether the effect is enabled - * @param enabled set to false to disable the effect - * @see enabled + * \param enabled set to false to disable the effect + * \see enabled */ void setEnabled( const bool enabled ); /** Returns the draw mode for the effect. This property only has an - * effect if the paint effect is used in a @link QgsEffectStack @endlink - * @returns draw mode for effect - * @see setDrawMode + * effect if the paint effect is used in a QgsEffectStack. + * \returns draw mode for effect + * \see setDrawMode */ DrawMode drawMode() const { return mDrawMode; } /** Sets the draw mode for the effect. This property only has an - * effect if the paint effect is used in a @link QgsEffectStack @endlink - * @param drawMode draw mode for effect - * @see drawMode + * effect if the paint effect is used in a QgsEffectStack. + * \param drawMode draw mode for effect + * \see drawMode */ void setDrawMode( const DrawMode drawMode ); @@ -168,61 +168,61 @@ class CORE_EXPORT QgsPaintEffect /** Handles drawing of the effect's result on to the specified render context. * Derived classes must reimplement this method to apply any transformations to * the source QPicture and draw the result using the context's painter. - * @param context destination render context - * @see drawSource + * \param context destination render context + * \see drawSource */ virtual void draw( QgsRenderContext &context ) = 0; /** Draws the source QPicture onto the specified painter. Handles scaling of the picture * to account for the destination painter's DPI. - * @param painter destination painter - * @see source - * @see sourceAsImage + * \param painter destination painter + * \see source + * \see sourceAsImage */ void drawSource( QPainter &painter ); - /** Returns the source QPicture. The @link draw @endlink member can utilize this when + /** Returns the source QPicture. The draw() member can utilize this when * drawing the effect. - * @returns source QPicture - * @see drawSource - * @see sourceAsImage + * \returns source QPicture + * \see drawSource + * \see sourceAsImage */ const QPicture *source() const { return mPicture; } - /** Returns the source QPicture rendered to a new QImage. The @link draw @endlink member can + /** Returns the source QPicture rendered to a new QImage. The draw() member can * utilize this when drawing the effect. The image will be padded or cropped from the original - * source QPicture by the results of the @link boundingRect @endlink method. + * source QPicture by the results of the boundingRect() method. * The result is cached to speed up subsequent calls to sourceAsImage. - * @returns source QPicture rendered to an image - * @see drawSource - * @see source - * @see imageOffset - * @see boundingRect + * \returns source QPicture rendered to an image + * \see drawSource + * \see source + * \see imageOffset + * \see boundingRect */ QImage *sourceAsImage( QgsRenderContext &context ); /** Returns the offset which should be used when drawing the source image on to a destination * render context. - * @param context destination render context - * @returns point offset for image top left corner - * @see sourceAsImage + * \param context destination render context + * \returns point offset for image top left corner + * \see sourceAsImage */ QPointF imageOffset( const QgsRenderContext &context ) const; /** Returns the bounding rect required for drawing the effect. This method can be used * to expand the bounding rect of a source picture to account for offset or blurring * effects. - * @param rect original source bounding rect - * @param context destination render context - * @returns modified bounding rect - * @see sourceAsImage + * \param rect original source bounding rect + * \param context destination render context + * \returns modified bounding rect + * \see sourceAsImage */ virtual QRectF boundingRect( const QRectF &rect, const QgsRenderContext &context ) const; /** Applies a workaround to a QPainter to avoid an issue with incorrect scaling * when drawing QPictures. This may need to be called by derived classes prior * to rendering results onto a painter. - * @param painter destination painter + * \param painter destination painter */ void fixQPictureDpi( QPainter *painter ) const; @@ -261,8 +261,8 @@ class CORE_EXPORT QgsDrawSourceEffect : public QgsPaintEffect QgsDrawSourceEffect(); /** Creates a new QgsDrawSource effect from a properties string map. - * @param map encoded properties string map - * @returns new QgsDrawSourceEffect + * \param map encoded properties string map + * \returns new QgsDrawSourceEffect */ static QgsPaintEffect *create( const QgsStringMap &map ); @@ -272,30 +272,30 @@ class CORE_EXPORT QgsDrawSourceEffect : public QgsPaintEffect virtual void readProperties( const QgsStringMap &props ) override; /** Sets the transparency for the effect - * @param transparency double between 0 and 1 inclusive, where 0 is fully opaque + * \param transparency double between 0 and 1 inclusive, where 0 is fully opaque * and 1 is fully transparent - * @see transparency + * \see transparency */ void setTransparency( const double transparency ) { mTransparency = transparency; } /** Returns the transparency for the effect - * @returns transparency value between 0 and 1 inclusive, where 0 is fully opaque + * \returns transparency value between 0 and 1 inclusive, where 0 is fully opaque * and 1 is fully transparent - * @see setTransparency + * \see setTransparency */ double transparency() const { return mTransparency; } /** Sets the blend mode for the effect - * @param mode blend mode used for drawing the source on to a destination + * \param mode blend mode used for drawing the source on to a destination * paint device - * @see blendMode + * \see blendMode */ void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; } /** Returns the blend mode for the effect - * @returns blend mode used for drawing the source on to a destination + * \returns blend mode used for drawing the source on to a destination * paint device - * @see setBlendMode + * \see setBlendMode */ QPainter::CompositionMode blendMode() const { return mBlendMode; } @@ -322,7 +322,7 @@ class CORE_EXPORT QgsEffectPainter /** * QgsEffectPainter constructor * - * @param renderContext the QgsRenderContext object + * \param renderContext the QgsRenderContext object * \since QGIS 3.0 */ QgsEffectPainter( QgsRenderContext &renderContext ); @@ -330,8 +330,8 @@ class CORE_EXPORT QgsEffectPainter /** * QgsEffectPainter constructor alternative if no painter translation is needed * - * @param renderContext the QgsRenderContext object - * @param effect the QgsPaintEffect object + * \param renderContext the QgsRenderContext object + * \param effect the QgsPaintEffect object * \since QGIS 3.0 */ QgsEffectPainter( QgsRenderContext &renderContext, QgsPaintEffect *effect ); @@ -340,7 +340,7 @@ class CORE_EXPORT QgsEffectPainter /** * Sets the effect to be painted * - * @param effect the QgsPaintEffect object + * \param effect the QgsPaintEffect object */ void setEffect( QgsPaintEffect *effect ); diff --git a/src/core/effects/qgspainteffectregistry.h b/src/core/effects/qgspainteffectregistry.h index 0a9a232138d3..268fa76b0098 100644 --- a/src/core/effects/qgspainteffectregistry.h +++ b/src/core/effects/qgspainteffectregistry.h @@ -39,34 +39,34 @@ class CORE_EXPORT QgsPaintEffectAbstractMetadata public: /** Construct a new QgsPaintEffectAbstractMetadata - * @param name unique string representing paint effect class - * @param visibleName user visible name representing paint effect class + * \param name unique string representing paint effect class + * \param visibleName user visible name representing paint effect class */ QgsPaintEffectAbstractMetadata( const QString &name, const QString &visibleName ); virtual ~QgsPaintEffectAbstractMetadata() = default; /** Returns the unique string representing the paint effect class - * @returns unique string - * @see visibleName + * \returns unique string + * \see visibleName */ QString name() const { return mName; } /** Returns the user visible string representing the paint effect class - * @returns friendly user visible string - * @see name + * \returns friendly user visible string + * \see name */ QString visibleName() const { return mVisibleName; } /** Create a paint effect of this class given an encoded map of properties. - * @param map properties string map - * @returns new paint effect + * \param map properties string map + * \returns new paint effect */ virtual QgsPaintEffect *createPaintEffect( const QgsStringMap &map ) = 0; /** Create configuration widget for paint effect of this class. Can return nullptr * if there's no GUI for the paint effect class. - * @returns configuration widget + * \returns configuration widget */ virtual QgsPaintEffectWidget *createWidget() { return nullptr; } @@ -91,11 +91,11 @@ class CORE_EXPORT QgsPaintEffectMetadata : public QgsPaintEffectAbstractMetadata public: /** Create effect metadata from static functions - * @param name unique string representing paint effect class - * @param visibleName user visible name representing paint effect class - * @param pfCreate paint effect creation function - * @param pfWidget widget creation function - * @note not available in Python bindings + * \param name unique string representing paint effect class + * \param visibleName user visible name representing paint effect class + * \param pfCreate paint effect creation function + * \param pfWidget widget creation function + * \note not available in Python bindings */ QgsPaintEffectMetadata( const QString &name, const QString &visibleName, QgsPaintEffectCreateFunc pfCreate, @@ -106,37 +106,37 @@ class CORE_EXPORT QgsPaintEffectMetadata : public QgsPaintEffectAbstractMetadata {} /** Returns the paint effect creation function for the paint effect class - * @returns creation function - * @note not available in Python bindings + * \returns creation function + * \note not available in Python bindings */ QgsPaintEffectCreateFunc createFunction() const { return mCreateFunc; } /** Returns the paint effect properties widget creation function for the paint effect class - * @returns widget creation function - * @note not available in Python bindings - * @see setWidgetFunction + * \returns widget creation function + * \note not available in Python bindings + * \see setWidgetFunction */ QgsPaintEffectWidgetFunc widgetFunction() const { return mWidgetFunc; } /** Sets the paint effect properties widget creation function for the paint effect class - * @param f widget creation function - * @note not available in Python bindings - * @see widgetFunction + * \param f widget creation function + * \note not available in Python bindings + * \see widgetFunction */ void setWidgetFunction( QgsPaintEffectWidgetFunc f ) { mWidgetFunc = f; } /** Creates a new paint effect of the metadata's effect class - * @param map string map of effect properties - * @returns new paint effect - * @note not available in Python bindings - * @see createWidget + * \param map string map of effect properties + * \returns new paint effect + * \note not available in Python bindings + * \see createWidget */ virtual QgsPaintEffect *createPaintEffect( const QgsStringMap &map ) override { return mCreateFunc ? mCreateFunc( map ) : nullptr; } /** Creates a new paint effect properties widget for the metadata's effect class - * @returns effect properties widget - * @note not available in Python bindings - * @see createWidget + * \returns effect properties widget + * \note not available in Python bindings + * \see createWidget */ virtual QgsPaintEffectWidget *createWidget() override { return mWidgetFunc ? mWidgetFunc() : nullptr; } @@ -168,51 +168,51 @@ class CORE_EXPORT QgsPaintEffectRegistry QgsPaintEffectRegistry &operator=( const QgsPaintEffectRegistry &rh ) = delete; /** Returns the metadata for a specific effect. - * @param name unique string name for paint effect class - * @returns paint effect metadata if found, otherwise nullptr + * \param name unique string name for paint effect class + * \returns paint effect metadata if found, otherwise nullptr */ QgsPaintEffectAbstractMetadata *effectMetadata( const QString &name ) const; /** Registers a new effect type. - * @param metadata effect metadata. Ownership is transferred to the registry. - * @returns true if add was successful. + * \param metadata effect metadata. Ownership is transferred to the registry. + * \returns true if add was successful. */ bool addEffectType( QgsPaintEffectAbstractMetadata *metadata ); /** Creates a new paint effect given the effect name and properties map. - * @param name unique name representing paint effect class - * @param properties encoded string map of effect properties - * @returns new paint effect of specified class, or nullptr if matching + * \param name unique name representing paint effect class + * \param properties encoded string map of effect properties + * \returns new paint effect of specified class, or nullptr if matching * paint effect could not be created */ QgsPaintEffect *createEffect( const QString &name, const QgsStringMap &properties = QgsStringMap() ) const; /** Creates a new paint effect given a DOM element storing paint effect * properties. - * @param element encoded DOM element of effect properties - * @returns new paint effect, or nullptr if matching + * \param element encoded DOM element of effect properties + * \returns new paint effect, or nullptr if matching * paint effect could not be created */ QgsPaintEffect *createEffect( const QDomElement &element ) const; /** Returns a list of known paint effects. - * @returns list of paint effect names + * \returns list of paint effect names */ QStringList effects() const; /** Returns a new effect stack consisting of a sensible selection of default * effects. All effects except the standard draw source effect are disabled, * but are included so that they can be easily drawn just by enabling the effect. - * @returns default effects stack - * @see isDefaultStack() + * \returns default effects stack + * \see isDefaultStack() */ static QgsPaintEffect *defaultStack(); /** Tests whether a paint effect matches the default effects stack. - * @param effect paint effect to test - * @returns true if effect is default stack + * \param effect paint effect to test + * \returns true if effect is default stack * \since QGIS 2.12 - * @see defaultStack() + * \see defaultStack() */ static bool isDefaultStack( QgsPaintEffect *effect ); diff --git a/src/core/effects/qgsshadoweffect.h b/src/core/effects/qgsshadoweffect.h index b21c553c4f87..95a8e964a44a 100644 --- a/src/core/effects/qgsshadoweffect.h +++ b/src/core/effects/qgsshadoweffect.h @@ -41,118 +41,118 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect virtual void readProperties( const QgsStringMap &props ) override; /** Sets blur level (strength) for the shadow. - * @param level blur level. Values between 0 and 16 are valid, with larger + * \param level blur level. Values between 0 and 16 are valid, with larger * values indicating greater blur strength. - * @see blurLevel + * \see blurLevel */ void setBlurLevel( const int level ) { mBlurLevel = level; } /** Returns the blur level (strength) for the shadow. - * @returns blur level. Value will be between 0 and 16, with larger + * \returns blur level. Value will be between 0 and 16, with larger * values indicating greater blur strength. - * @see setBlurLevel + * \see setBlurLevel */ int blurLevel() const { return mBlurLevel; } /** Sets the angle for offsetting the shadow. - * @param angle offset angle in degrees clockwise from North - * @see offsetAngle - * @see setOffsetDistance + * \param angle offset angle in degrees clockwise from North + * \see offsetAngle + * \see setOffsetDistance */ void setOffsetAngle( const int angle ) { mOffsetAngle = angle; } /** Returns the angle used for offsetting the shadow. - * @returns offset angle in degrees clockwise from North - * @see setOffsetAngle - * @see offsetDistance + * \returns offset angle in degrees clockwise from North + * \see setOffsetAngle + * \see offsetDistance */ int offsetAngle() const { return mOffsetAngle; } /** Sets the distance for offsetting the shadow. - * @param distance offset distance. Units are specified via @link setOffsetUnit @endlink - * @see offsetDistance - * @see setOffsetUnit - * @see setOffsetMapUnitScale + * \param distance offset distance. Units are specified via setOffsetUnit() + * \see offsetDistance + * \see setOffsetUnit + * \see setOffsetMapUnitScale */ void setOffsetDistance( const double distance ) { mOffsetDist = distance; } /** Returns the distance used for offsetting the shadow. - * @returns offset distance. Distance units are retrieved via @link offsetUnit @endlink - * @see setOffsetDistance - * @see offsetUnit - * @see offsetMapUnitScale + * \returns offset distance. Distance units are retrieved via offsetUnit() + * \see setOffsetDistance + * \see offsetUnit + * \see offsetMapUnitScale */ double offsetDistance() const { return mOffsetDist; } /** Sets the units used for the shadow offset distance. - * @param unit units for offset distance - * @see offsetUnit - * @see setOffsetDistance - * @see setOffsetMapUnitScale + * \param unit units for offset distance + * \see offsetUnit + * \see setOffsetDistance + * \see setOffsetMapUnitScale */ void setOffsetUnit( const QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; } /** Returns the units used for the shadow offset distance. - * @returns units for offset distance - * @see setOffsetUnit - * @see offsetDistance - * @see offsetMapUnitScale + * \returns units for offset distance + * \see setOffsetUnit + * \see offsetDistance + * \see offsetMapUnitScale */ QgsUnitTypes::RenderUnit offsetUnit() const { return mOffsetUnit; } /** Sets the map unit scale used for the shadow offset distance. - * @param scale map unit scale for offset distance - * @see offsetMapUnitScale - * @see setOffsetDistance - * @see setOffsetUnit + * \param scale map unit scale for offset distance + * \see offsetMapUnitScale + * \see setOffsetDistance + * \see setOffsetUnit */ void setOffsetMapUnitScale( const QgsMapUnitScale &scale ) { mOffsetMapUnitScale = scale; } /** Returns the map unit scale used for the shadow offset distance. - * @returns map unit scale for offset distance - * @see setOffsetMapUnitScale - * @see offsetDistance - * @see offsetUnit + * \returns map unit scale for offset distance + * \see setOffsetMapUnitScale + * \see offsetDistance + * \see offsetUnit */ const QgsMapUnitScale &offsetMapUnitScale() const { return mOffsetMapUnitScale; } /** Sets the color for the shadow. - * @param color shadow color - * @see color + * \param color shadow color + * \see color */ void setColor( const QColor &color ) { mColor = color; } /** Returns the color used for the shadow. - * @returns shadow color - * @see setColor + * \returns shadow color + * \see setColor */ QColor color() const { return mColor; } /** Sets the transparency for the effect - * @param transparency double between 0 and 1 inclusive, where 0 is fully opaque + * \param transparency double between 0 and 1 inclusive, where 0 is fully opaque * and 1 is fully transparent - * @see transparency + * \see transparency */ void setTransparency( const double transparency ) { mTransparency = transparency; } /** Returns the transparency for the effect - * @returns transparency value between 0 and 1 inclusive, where 0 is fully opaque + * \returns transparency value between 0 and 1 inclusive, where 0 is fully opaque * and 1 is fully transparent - * @see setTransparency + * \see setTransparency */ double transparency() const { return mTransparency; } /** Sets the blend mode for the effect - * @param mode blend mode used for drawing the effect on to a destination + * \param mode blend mode used for drawing the effect on to a destination * paint device - * @see blendMode + * \see blendMode */ void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; } /** Returns the blend mode for the effect - * @returns blend mode used for drawing the effect on to a destination + * \returns blend mode used for drawing the effect on to a destination * paint device - * @see setBlendMode + * \see setBlendMode */ QPainter::CompositionMode blendMode() const { return mBlendMode; } @@ -163,7 +163,7 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect /** Specifies whether the shadow is drawn outside the picture or within * the picture. - * @returns true if shadow is to be drawn outside the picture, or false + * \returns true if shadow is to be drawn outside the picture, or false * to draw shadow within the picture */ virtual bool exteriorShadow() const = 0; @@ -192,8 +192,8 @@ class CORE_EXPORT QgsDropShadowEffect : public QgsShadowEffect public: /** Creates a new QgsDropShadowEffect effect from a properties string map. - * @param map encoded properties string map - * @returns new QgsDropShadowEffect + * \param map encoded properties string map + * \returns new QgsDropShadowEffect */ static QgsPaintEffect *create( const QgsStringMap &map ); @@ -221,8 +221,8 @@ class CORE_EXPORT QgsInnerShadowEffect : public QgsShadowEffect public: /** Creates a new QgsInnerShadowEffect effect from a properties string map. - * @param map encoded properties string map - * @returns new QgsInnerShadowEffect + * \param map encoded properties string map + * \returns new QgsInnerShadowEffect */ static QgsPaintEffect *create( const QgsStringMap &map ); diff --git a/src/core/effects/qgstransformeffect.h b/src/core/effects/qgstransformeffect.h index 009fd0c2d1c3..1fed60c86daf 100644 --- a/src/core/effects/qgstransformeffect.h +++ b/src/core/effects/qgstransformeffect.h @@ -38,8 +38,8 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect public: /** Creates a new QgsTransformEffect effect from a properties string map. - * @param map encoded properties string map - * @returns new QgsTransformEffect + * \param map encoded properties string map + * \returns new QgsTransformEffect */ static QgsPaintEffect *create( const QgsStringMap &map ); @@ -51,169 +51,169 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect virtual QgsTransformEffect *clone() const override; /** Sets the transform x translation. - * @param translateX distance to translate along the x axis - * @see translateX - * @see setTranslateY - * @see setTranslateUnit - * @see setTranslateMapUnitScale + * \param translateX distance to translate along the x axis + * \see translateX + * \see setTranslateY + * \see setTranslateUnit + * \see setTranslateMapUnitScale */ void setTranslateX( const double translateX ) { mTranslateX = translateX; } /** Returns the transform x translation. - * @returns X distance translated along the x axis - * @see setTranslateX - * @see translateY - * @see translateUnit - * @see translateMapUnitScale + * \returns X distance translated along the x axis + * \see setTranslateX + * \see translateY + * \see translateUnit + * \see translateMapUnitScale */ double translateX() const { return mTranslateX; } /** Sets the transform y translation. - * @param translateY distance to translate along the y axis - * @see translateY - * @see setTranslateX - * @see setTranslateUnit - * @see setTranslateMapUnitScale + * \param translateY distance to translate along the y axis + * \see translateY + * \see setTranslateX + * \see setTranslateUnit + * \see setTranslateMapUnitScale */ void setTranslateY( const double translateY ) { mTranslateY = translateY; } /** Returns the transform y translation. - * @returns Y distance translated along the y axis - * @see setTranslateY - * @see translateX - * @see translateUnit - * @see translateMapUnitScale + * \returns Y distance translated along the y axis + * \see setTranslateY + * \see translateX + * \see translateUnit + * \see translateMapUnitScale */ double translateY() const { return mTranslateY; } /** Sets the units used for the transform translation. - * @param unit units for translation - * @see translateUnit - * @see setTranslateX - * @see setTranslateY - * @see setTranslateMapUnitScale + * \param unit units for translation + * \see translateUnit + * \see setTranslateX + * \see setTranslateY + * \see setTranslateMapUnitScale */ void setTranslateUnit( const QgsUnitTypes::RenderUnit unit ) { mTranslateUnit = unit; } /** Returns the units used for the transform translation. - * @returns units for translation - * @see setTranslateUnit - * @see translateX - * @see translateY - * @see translateMapUnitScale + * \returns units for translation + * \see setTranslateUnit + * \see translateX + * \see translateY + * \see translateMapUnitScale */ QgsUnitTypes::RenderUnit translateUnit() const { return mTranslateUnit; } /** Sets the map unit scale used for the transform translation. - * @param scale map unit scale for translation - * @see translateMapUnitScale - * @see setTranslateX - * @see setTranslateY - * @see setTranslateUnit + * \param scale map unit scale for translation + * \see translateMapUnitScale + * \see setTranslateX + * \see setTranslateY + * \see setTranslateUnit */ void setTranslateMapUnitScale( const QgsMapUnitScale &scale ) { mTranslateMapUnitScale = scale; } /** Returns the map unit scale used for the transform translation. - * @returns map unit scale for translation - * @see setTranslateMapUnitScale - * @see translateX - * @see translateY - * @see translateUnit + * \returns map unit scale for translation + * \see setTranslateMapUnitScale + * \see translateX + * \see translateY + * \see translateUnit */ const QgsMapUnitScale &translateMapUnitScale() const { return mTranslateMapUnitScale; } /** Sets the x axis scaling factor. - * @param scaleX factor to scale x axis by, where 1.0 = no scaling - * @see scaleX - * @see setScaleY + * \param scaleX factor to scale x axis by, where 1.0 = no scaling + * \see scaleX + * \see setScaleY */ void setScaleX( const double scaleX ) { mScaleX = scaleX; } /** Returns the x axis scaling factor. - * @returns x axis scaling factor, where 1.0 = no scaling - * @see setScaleX - * @see scaleY + * \returns x axis scaling factor, where 1.0 = no scaling + * \see setScaleX + * \see scaleY */ double scaleX() const { return mScaleX; } /** Sets the y axis scaling factor. - * @param scaleY factor to scale y axis by, where 1.0 = no scaling - * @see scaleX + * \param scaleY factor to scale y axis by, where 1.0 = no scaling + * \see scaleX */ void setScaleY( const double scaleY ) { mScaleY = scaleY; } /** Returns the y axis scaling factor. - * @returns y axis scaling factor, where 1.0 = no scaling - * @see setScaleY - * @see scaleX + * \returns y axis scaling factor, where 1.0 = no scaling + * \see setScaleY + * \see scaleX */ double scaleY() const { return mScaleY; } /** Sets the transform rotation. - * @param rotation degrees to rotate, clockwise - * @see rotation + * \param rotation degrees to rotate, clockwise + * \see rotation */ void setRotation( const double rotation ) { mRotation = rotation; } /** Returns the transform rotation. - * @returns rotation in degrees clockwise - * @see setRotation + * \returns rotation in degrees clockwise + * \see setRotation */ double rotation() const { return mRotation; } /** Sets the x axis shearing factor. - * @param shearX x axis shearing - * @see shearX - * @see setShearY + * \param shearX x axis shearing + * \see shearX + * \see setShearY */ void setShearX( const double shearX ) { mShearX = shearX; } /** Returns the x axis shearing factor. - * @returns x axis shearing - * @see setShearX - * @see shearY + * \returns x axis shearing + * \see setShearX + * \see shearY */ double shearX() const { return mShearX; } /** Sets the y axis shearing factor. - * @param shearY y axis shearing - * @see shearY - * @see setShearX + * \param shearY y axis shearing + * \see shearY + * \see setShearX */ void setShearY( const double shearY ) { mShearY = shearY; } /** Returns the y axis shearing factor. - * @returns y axis shearing - * @see setShearY - * @see shearX + * \returns y axis shearing + * \see setShearY + * \see shearX */ double shearY() const { return mShearY; } /** Sets whether to reflect along the x-axis - * @param reflectX true to reflect horizontally - * @see reflectX - * @see setReflectY + * \param reflectX true to reflect horizontally + * \see reflectX + * \see setReflectY */ void setReflectX( const bool reflectX ) { mReflectX = reflectX; } /** Returns whether transform will be reflected along the x-axis - * @returns true if transform will reflect horizontally - * @see setReflectX - * @see reflectY + * \returns true if transform will reflect horizontally + * \see setReflectX + * \see reflectY */ bool reflectX() const { return mReflectX; } /** Sets whether to reflect along the y-axis - * @param reflectY true to reflect horizontally - * @see reflectY - * @see setReflectX + * \param reflectY true to reflect horizontally + * \see reflectY + * \see setReflectX */ void setReflectY( const bool reflectY ) { mReflectY = reflectY; } /** Returns whether transform will be reflected along the y-axis - * @returns true if transform will reflect horizontally - * @see setReflectY - * @see reflectX + * \returns true if transform will reflect horizontally + * \see setReflectY + * \see reflectX */ bool reflectY() const { return mReflectY; } diff --git a/src/core/geometry/qgsabstractgeometry.h b/src/core/geometry/qgsabstractgeometry.h index 67c072773f9d..1d0dedc953c7 100644 --- a/src/core/geometry/qgsabstractgeometry.h +++ b/src/core/geometry/qgsabstractgeometry.h @@ -79,30 +79,30 @@ class CORE_EXPORT QgsAbstractGeometry //virtual int coordDim() const { return mCoordDimension; } /** Returns a unique string representing the geometry type. - * @see wkbType - * @see wktTypeStr + * \see wkbType + * \see wktTypeStr */ virtual QString geometryType() const = 0; /** Returns the WKB type of the geometry. - * @see geometryType - * @see wktTypeStr + * \see geometryType + * \see wktTypeStr */ QgsWkbTypes::Type wkbType() const { return mWkbType; } /** Returns the WKT type string of the geometry. - * @see geometryType - * @see wkbType + * \see geometryType + * \see wkbType */ QString wktTypeStr() const; /** Returns true if the geometry is 3D and contains a z-value. - * @see isMeasure + * \see isMeasure */ bool is3D() const; /** Returns true if the geometry contains m values. - * @see is3D + * \see is3D */ bool isMeasure() const; @@ -118,7 +118,7 @@ class CORE_EXPORT QgsAbstractGeometry /** Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry). * For instance, a polygon geometry will have a boundary consisting of the linestrings for each ring in the polygon. - * @returns boundary for geometry. May be null for some geometry types. + * \returns boundary for geometry. May be null for some geometry types. * \since QGIS 3.0 */ virtual QgsAbstractGeometry *boundary() const = 0; @@ -127,72 +127,72 @@ class CORE_EXPORT QgsAbstractGeometry /** Sets the geometry from a WKB string. * After successful read the wkb argument will be at the position where the reading has stopped. - * @see fromWkt + * \see fromWkt */ virtual bool fromWkb( QgsConstWkbPtr &wkb ) = 0; /** Sets the geometry from a WKT string. - * @see fromWkb + * \see fromWkb */ virtual bool fromWkt( const QString &wkt ) = 0; //export /** Returns a WKB representation of the geometry. - * @see asWkt - * @see asGML2 - * @see asGML3 - * @see asJSON + * \see asWkt + * \see asGML2 + * \see asGML3 + * \see asJSON * \since QGIS 3.0 */ virtual QByteArray asWkb() const = 0; /** Returns a WKT representation of the geometry. - * @param precision number of decimal places for coordinates - * @see asWkb - * @see asGML2 - * @see asGML3 - * @see asJSON + * \param precision number of decimal places for coordinates + * \see asWkb + * \see asGML2 + * \see asGML3 + * \see asJSON */ virtual QString asWkt( int precision = 17 ) const = 0; /** Returns a GML2 representation of the geometry. - * @param doc DOM document - * @param precision number of decimal places for coordinates - * @param ns XML namespace - * @see asWkb - * @see asWkt - * @see asGML3 - * @see asJSON + * \param doc DOM document + * \param precision number of decimal places for coordinates + * \param ns XML namespace + * \see asWkb + * \see asWkt + * \see asGML3 + * \see asJSON */ virtual QDomElement asGML2( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const = 0; /** Returns a GML3 representation of the geometry. - * @param doc DOM document - * @param precision number of decimal places for coordinates - * @param ns XML namespace - * @see asWkb - * @see asWkt - * @see asGML2 - * @see asJSON + * \param doc DOM document + * \param precision number of decimal places for coordinates + * \param ns XML namespace + * \see asWkb + * \see asWkt + * \see asGML2 + * \see asJSON */ virtual QDomElement asGML3( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const = 0; /** Returns a GeoJSON representation of the geometry. - * @param precision number of decimal places for coordinates - * @see asWkb - * @see asWkt - * @see asGML2 - * @see asGML3 + * \param precision number of decimal places for coordinates + * \see asWkb + * \see asWkt + * \see asGML2 + * \see asGML3 */ virtual QString asJSON( int precision = 17 ) const = 0; //render pipeline /** Transforms the geometry using a coordinate transform - * @param ct coordinate transform - * @param d transformation direction - * @param transformZ set to true to also transform z coordinates. This requires that + * \param ct coordinate transform + * \param d transformation direction + * \param transformZ set to true to also transform z coordinates. This requires that * the z coordinates in the geometry represent height relative to the vertical datum * of the source CRS (generally ellipsoidal heights) and are expressed in its vertical * units (generally meters). If false, then z coordinates will not be changed by the @@ -202,7 +202,7 @@ class CORE_EXPORT QgsAbstractGeometry bool transformZ = false ) = 0; /** Transforms the geometry using a QTransform object - * @param t QTransform transformation + * \param t QTransform transformation */ virtual void transform( const QTransform &t ) = 0; @@ -211,20 +211,20 @@ class CORE_EXPORT QgsAbstractGeometry #endif /** Draws the geometry using the specified QPainter. - * @param p destination QPainter + * \param p destination QPainter */ virtual void draw( QPainter &p ) const = 0; /** Returns next vertex id and coordinates - * @param id initial value should be the starting vertex id. The next vertex id will be stored + * \param id initial value should be the starting vertex id. The next vertex id will be stored * in this variable if found. - * @param vertex container for found node - * @return false if at end + * \param vertex container for found node + * \returns false if at end */ virtual bool nextVertex( QgsVertexId &id, QgsPointV2 &vertex ) const = 0; /** Retrieves the sequence of geometries, rings and nodes. - * @return coordinate sequence + * \returns coordinate sequence */ virtual QgsCoordinateSequence coordinateSequence() const = 0; @@ -237,59 +237,59 @@ class CORE_EXPORT QgsAbstractGeometry virtual QgsPointV2 vertexAt( QgsVertexId id ) const = 0; /** Searches for the closest segment of the geometry to a given point. - * @param pt specifies the point to find closest segment to - * @param segmentPt storage for the closest point within the geometry - * @param vertexAfter storage for the ID of the vertex at the end of the closest segment - * @param leftOf returns whether the point lies on the left side of the nearest segment (true if point is to left of segment, + * \param pt specifies the point to find closest segment to + * \param segmentPt storage for the closest point within the geometry + * \param vertexAfter storage for the ID of the vertex at the end of the closest segment + * \param leftOf returns whether the point lies on the left side of the nearest segment (true if point is to left of segment, * false if point is to right of segment) - * @param epsilon epsilon for segment snapping - * @returns squared distance to closest segment or negative value on error + * \param epsilon epsilon for segment snapping + * \returns squared distance to closest segment or negative value on error */ virtual double closestSegment( const QgsPointV2 &pt, QgsPointV2 &segmentPt, QgsVertexId &vertexAfter, bool *leftOf, double epsilon ) const = 0; //low-level editing /** Inserts a vertex into the geometry - * @param position vertex id for position of inserted vertex - * @param vertex vertex to insert - * @returns true if insert was successful - * @see moveVertex - * @see deleteVertex + * \param position vertex id for position of inserted vertex + * \param vertex vertex to insert + * \returns true if insert was successful + * \see moveVertex + * \see deleteVertex */ virtual bool insertVertex( QgsVertexId position, const QgsPointV2 &vertex ) = 0; /** Moves a vertex within the geometry - * @param position vertex id for vertex to move - * @param newPos new position of vertex - * @returns true if move was successful - * @see insertVertex - * @see deleteVertex + * \param position vertex id for vertex to move + * \param newPos new position of vertex + * \returns true if move was successful + * \see insertVertex + * \see deleteVertex */ virtual bool moveVertex( QgsVertexId position, const QgsPointV2 &newPos ) = 0; /** Deletes a vertex within the geometry - * @param position vertex id for vertex to delete - * @returns true if delete was successful - * @see insertVertex - * @see moveVertex + * \param position vertex id for vertex to delete + * \returns true if delete was successful + * \see insertVertex + * \see moveVertex */ virtual bool deleteVertex( QgsVertexId position ) = 0; /** Returns the length of the geometry. - * @see area() - * @see perimeter() + * \see area() + * \see perimeter() */ virtual double length() const { return 0.0; } /** Returns the perimeter of the geometry. - * @see area() - * @see length() + * \see area() + * \see length() */ virtual double perimeter() const { return 0.0; } /** Returns the area of the geometry. - * @see length() - * @see perimeter() + * \see length() + * \see perimeter() */ virtual double area() const { return 0.0; } @@ -306,22 +306,22 @@ class CORE_EXPORT QgsAbstractGeometry /** Returns a version of the geometry without curves. Caller takes ownership of * the returned geometry. - * @param tolerance segmentation tolerance - * @param toleranceType maximum segmentation angle or maximum difference between approximation and curve + * \param tolerance segmentation tolerance + * \param toleranceType maximum segmentation angle or maximum difference between approximation and curve */ virtual QgsAbstractGeometry *segmentize( double tolerance = M_PI / 180., SegmentationToleranceType toleranceType = MaximumAngle ) const; /** Returns the geometry converted to the more generic curve type. E.g. QgsLineString -> QgsCompoundCurve, QgsPolygonV2 -> QgsCurvePolygon, QgsMultiLineString -> QgsMultiCurve, QgsMultiPolygonV2 -> QgsMultiSurface - @return the converted geometry. Caller takes ownership*/ + \returns the converted geometry. Caller takes ownership*/ virtual QgsAbstractGeometry *toCurveType() const { return 0; } /** Returns approximate angle at a vertex. This is usually the average angle between adjacent * segments, and can be pictured as the orientation of a line following the curvature of the * geometry at the specified vertex. - * @param vertex the vertex id - * @return rotation in radians, clockwise from north + * \param vertex the vertex id + * \returns rotation in radians, clockwise from north */ virtual double vertexAngle( QgsVertexId vertex ) const = 0; @@ -336,47 +336,47 @@ class CORE_EXPORT QgsAbstractGeometry virtual int ringCount( int part = 0 ) const = 0; /** Returns count of parts contained in the geometry. - * @see vertexCount - * @see ringCount + * \see vertexCount + * \see ringCount */ virtual int partCount() const = 0; /** Adds a z-dimension to the geometry, initialized to a preset value. - * @param zValue initial z-value for all nodes - * @returns true on success + * \param zValue initial z-value for all nodes + * \returns true on success * \since QGIS 2.12 - * @see dropZValue() - * @see addMValue() + * \see dropZValue() + * \see addMValue() */ virtual bool addZValue( double zValue = 0 ) = 0; /** Adds a measure to the geometry, initialized to a preset value. - * @param mValue initial m-value for all nodes - * @returns true on success + * \param mValue initial m-value for all nodes + * \returns true on success * \since QGIS 2.12 - * @see dropMValue() - * @see addZValue() + * \see dropMValue() + * \see addZValue() */ virtual bool addMValue( double mValue = 0 ) = 0; /** Drops any z-dimensions which exist in the geometry. - * @returns true if Z values were present and have been removed - * @see addZValue() - * @see dropMValue() + * \returns true if Z values were present and have been removed + * \see addZValue() + * \see dropMValue() * \since QGIS 2.14 */ virtual bool dropZValue() = 0; /** Drops any measure values which exist in the geometry. - * @returns true if m-values were present and have been removed - * @see addMValue() - * @see dropZValue() + * \returns true if m-values were present and have been removed + * \see addMValue() + * \see dropZValue() * \since QGIS 2.14 */ virtual bool dropMValue() = 0; /** Converts the geometry to a specified type. - * @returns true if conversion was successful + * \returns true if conversion was successful * \since QGIS 2.14 */ virtual bool convertTo( QgsWkbTypes::Type type ); diff --git a/src/core/geometry/qgscircularstring.h b/src/core/geometry/qgscircularstring.h index 1252f3114477..ce20561b7c8d 100644 --- a/src/core/geometry/qgscircularstring.h +++ b/src/core/geometry/qgscircularstring.h @@ -57,34 +57,20 @@ class CORE_EXPORT QgsCircularString: public QgsCurve */ QgsPointV2 pointN( int i ) const; - /** - * @copydoc QgsCurve::points() - */ void points( QgsPointSequence &pts ) const override; /** Sets the circular string's points */ void setPoints( const QgsPointSequence &points ); - /** - * @copydoc QgsAbstractGeometry::length() - */ virtual double length() const override; - - /** - * @copydoc QgsCurve::startPoint() - */ virtual QgsPointV2 startPoint() const override; - - /** - * @copydoc QgsCurve::endPoint() - */ virtual QgsPointV2 endPoint() const override; /** Returns a new line string geometry corresponding to a segmentized approximation * of the curve. - * @param tolerance segmentation tolerance - * @param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ + * \param tolerance segmentation tolerance + * \param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ virtual QgsLineString *curveToLine( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override; void draw( QPainter &p ) const override; @@ -93,9 +79,6 @@ class CORE_EXPORT QgsCircularString: public QgsCurve void transform( const QTransform &t ) override; void addToPainterPath( QPainterPath &path ) const override; - /** - * @copydoc QgsCurve::drawAsPolygon() - */ void drawAsPolygon( QPainter &p ) const override; virtual bool insertVertex( QgsVertexId position, const QgsPointV2 &vertex ) override; @@ -104,24 +87,13 @@ class CORE_EXPORT QgsCircularString: public QgsCurve double closestSegment( const QgsPointV2 &pt, QgsPointV2 &segmentPt, QgsVertexId &vertexAfter, bool *leftOf, double epsilon ) const override; - /** - * @copydoc QgsCurve::pointAt() - */ bool pointAt( int node, QgsPointV2 &point, QgsVertexId::VertexType &type ) const override; - - /** - * @copydoc QgsCurve::sumUpArea() - */ void sumUpArea( double &sum ) const override; - - /** - * @copydoc QgsAbstractGeometry::hasCurvedSegments() - */ bool hasCurvedSegments() const override { return true; } /** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments. - @param vertex the vertex id - @return rotation in radians, clockwise from north*/ + \param vertex the vertex id + \returns rotation in radians, clockwise from north*/ double vertexAngle( QgsVertexId vertex ) const override; virtual QgsCircularString *reversed() const override; diff --git a/src/core/geometry/qgscompoundcurve.h b/src/core/geometry/qgscompoundcurve.h index 33b73fdc52b4..0a2f95146758 100644 --- a/src/core/geometry/qgscompoundcurve.h +++ b/src/core/geometry/qgscompoundcurve.h @@ -62,8 +62,8 @@ class CORE_EXPORT QgsCompoundCurve: public QgsCurve /** Returns a new line string geometry corresponding to a segmentized approximation * of the curve. - * @param tolerance segmentation tolerance - * @param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ + * \param tolerance segmentation tolerance + * \param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ virtual QgsLineString *curveToLine( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override; /** Returns the number of curves in the geometry. @@ -79,7 +79,7 @@ class CORE_EXPORT QgsCompoundCurve: public QgsCurve void addCurve( QgsCurve *c ); /** Removes a curve from the geometry. - * @param i index of curve to remove + * \param i index of curve to remove */ void removeCurve( int i ); @@ -109,8 +109,8 @@ class CORE_EXPORT QgsCompoundCurve: public QgsCurve bool hasCurvedSegments() const override; /** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments. - @param vertex the vertex id - @return rotation in radians, clockwise from north*/ + \param vertex the vertex id + \returns rotation in radians, clockwise from north*/ double vertexAngle( QgsVertexId vertex ) const override; virtual QgsCompoundCurve *reversed() const override; @@ -132,7 +132,7 @@ class CORE_EXPORT QgsCompoundCurve: public QgsCurve QList< QgsCurve * > mCurves; /** Turns a vertex id for the compound curve into one or more ids for the subcurves - @return the index of the subcurve or -1 in case of error*/ + \returns the index of the subcurve or -1 in case of error*/ QList< QPair > curveVertexId( QgsVertexId id ) const; }; diff --git a/src/core/geometry/qgscurve.h b/src/core/geometry/qgscurve.h index 58f6b5679ea1..f5d809a4c2aa 100644 --- a/src/core/geometry/qgscurve.h +++ b/src/core/geometry/qgscurve.h @@ -41,12 +41,12 @@ class CORE_EXPORT QgsCurve: public QgsAbstractGeometry virtual QgsCurve *clone() const override = 0; /** Returns the starting point of the curve. - * @see endPoint + * \see endPoint */ virtual QgsPointV2 startPoint() const = 0; /** Returns the end point of the curve. - * @see startPoint + * \see startPoint */ virtual QgsPointV2 endPoint() const = 0; @@ -60,8 +60,8 @@ class CORE_EXPORT QgsCurve: public QgsAbstractGeometry /** Returns a new line string geometry corresponding to a segmentized approximation * of the curve. - * @param tolerance segmentation tolerance - * @param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ + * \param tolerance segmentation tolerance + * \param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ virtual QgsLineString *curveToLine( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const = 0; /** Adds a curve to a painter path. @@ -69,7 +69,7 @@ class CORE_EXPORT QgsCurve: public QgsAbstractGeometry virtual void addToPainterPath( QPainterPath &path ) const = 0; /** Draws the curve as a polygon on the specified QPainter. - * @param p destination QPainter + * \param p destination QPainter */ virtual void drawAsPolygon( QPainter &p ) const = 0; @@ -89,10 +89,10 @@ class CORE_EXPORT QgsCurve: public QgsAbstractGeometry virtual bool nextVertex( QgsVertexId &id, QgsPointV2 &vertex ) const override; /** Returns the point and vertex id of a point within the curve. - * @param node node number, where the first node is 0 - * @param point will be set to point at corresponding node in the curve - * @param type will be set to the vertex type of the node - * @returns true if node exists within the curve + * \param node node number, where the first node is 0 + * \param point will be set to point at corresponding node in the curve + * \param type will be set to the vertex type of the node + * \returns true if node exists within the curve */ virtual bool pointAt( int node, QgsPointV2 &point, QgsVertexId::VertexType &type ) const = 0; @@ -104,8 +104,8 @@ class CORE_EXPORT QgsCurve: public QgsAbstractGeometry virtual QgsAbstractGeometry *boundary() const override; /** Returns a geometry without curves. Caller takes ownership - * @param tolerance segmentation tolerance - * @param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ + * \param tolerance segmentation tolerance + * \param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ QgsCurve *segmentize( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override; virtual int vertexCount( int part = 0, int ring = 0 ) const override { Q_UNUSED( part ); Q_UNUSED( ring ); return numPoints(); } @@ -116,16 +116,16 @@ class CORE_EXPORT QgsCurve: public QgsAbstractGeometry virtual QgsRectangle boundingBox() const override; /** Returns the x-coordinate of the specified node in the line string. - * @param index index of node, where the first node in the line is 0 - * @returns x-coordinate of node, or 0.0 if index is out of bounds - * @see setXAt() + * \param index index of node, where the first node in the line is 0 + * \returns x-coordinate of node, or 0.0 if index is out of bounds + * \see setXAt() */ virtual double xAt( int index ) const = 0; /** Returns the y-coordinate of the specified node in the line string. - * @param index index of node, where the first node in the line is 0 - * @returns y-coordinate of node, or 0.0 if index is out of bounds - * @see setYAt() + * \param index index of node, where the first node in the line is 0 + * \returns y-coordinate of node, or 0.0 if index is out of bounds + * \see setYAt() */ virtual double yAt( int index ) const = 0; diff --git a/src/core/geometry/qgscurvepolygon.h b/src/core/geometry/qgscurvepolygon.h index df51743e0e91..be70645f58c6 100644 --- a/src/core/geometry/qgscurvepolygon.h +++ b/src/core/geometry/qgscurvepolygon.h @@ -64,16 +64,16 @@ class CORE_EXPORT QgsCurvePolygon: public QgsSurface /** Returns a new polygon geometry corresponding to a segmentized approximation * of the curve. - * @param tolerance segmentation tolerance - * @param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ + * \param tolerance segmentation tolerance + * \param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ virtual QgsPolygonV2 *toPolygon( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const; /** Sets the exterior ring of the polygon. The CurvePolygon type will be updated to match the dimensionality * of the exterior ring. For instance, setting a 2D exterior ring on a 3D CurvePolygon will drop the z dimension * from the CurvePolygon and all interior rings. - * @param ring new exterior ring. Ownership is transferred to the CurvePolygon. - * @see setInteriorRings() - * @see exteriorRing() + * \param ring new exterior ring. Ownership is transferred to the CurvePolygon. + * \see setInteriorRings() + * \see exteriorRing() */ virtual void setExteriorRing( QgsCurve *ring ); @@ -86,7 +86,7 @@ class CORE_EXPORT QgsCurvePolygon: public QgsSurface * Removes an interior ring from the polygon. The first interior ring has index 0. * The corresponding ring is removed from the polygon and deleted. If a ring was successfully removed * the function will return true. It is not possible to remove the exterior ring using this method. - * @see removeInteriorRings() + * \see removeInteriorRings() */ bool removeInteriorRing( int ringIndex ); @@ -95,7 +95,7 @@ class CORE_EXPORT QgsCurvePolygon: public QgsSurface * parameter is specified then only rings smaller than this minimum * area will be removed. * \since QGIS 3.0 - * @see removeInteriorRing() + * \see removeInteriorRing() */ void removeInteriorRings( double minimumAllowedArea = -1 ); @@ -117,13 +117,13 @@ class CORE_EXPORT QgsCurvePolygon: public QgsSurface bool hasCurvedSegments() const override; /** Returns a geometry without curves. Caller takes ownership - * @param tolerance segmentation tolerance - * @param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ + * \param tolerance segmentation tolerance + * \param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ QgsAbstractGeometry *segmentize( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override; /** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments. - * @param vertex the vertex id - * @return rotation in radians, clockwise from north + * \param vertex the vertex id + * \returns rotation in radians, clockwise from north */ double vertexAngle( QgsVertexId vertex ) const override; diff --git a/src/core/geometry/qgsgeometry.cpp b/src/core/geometry/qgsgeometry.cpp index 8c4e90dd8483..e3a912df027f 100644 --- a/src/core/geometry/qgsgeometry.cpp +++ b/src/core/geometry/qgsgeometry.cpp @@ -816,7 +816,6 @@ int QgsGeometry::splitGeometry( const QList &splitLine, QList &reshapeWithLine ) { if ( !d->geometry ) diff --git a/src/core/geometry/qgsgeometry.h b/src/core/geometry/qgsgeometry.h index 5aa640e97c72..e1a2548adfd1 100644 --- a/src/core/geometry/qgsgeometry.h +++ b/src/core/geometry/qgsgeometry.h @@ -72,8 +72,8 @@ struct QgsGeometryPrivate; * for geometry objects. QgsGeometry is implicitly shared, so making copies of geometries is inexpensive. The geometry * container class can also be stored inside a QVariant object. * - * The actual geometry representation is stored as a @link QgsAbstractGeometry @endlink within the container, and - * can be accessed via the @link geometry @endlink method or set using the @link setGeometry @endlink method. + * The actual geometry representation is stored as a QgsAbstractGeometry within the container, and + * can be accessed via the geometry() method or set using the setGeometry() method. */ class CORE_EXPORT QgsGeometry @@ -86,7 +86,7 @@ class CORE_EXPORT QgsGeometry QgsGeometry( const QgsGeometry & ); /** Assignments will prompt a deep copy of the object - * @note not available in Python bindings + * \note not available in Python bindings */ QgsGeometry &operator=( QgsGeometry const &rhs ); @@ -101,21 +101,21 @@ class CORE_EXPORT QgsGeometry /** Returns the underlying geometry store. * \since QGIS 2.10 - * @see setGeometry + * \see setGeometry */ QgsAbstractGeometry *geometry() const; /** Sets the underlying geometry store. Ownership of geometry is transferred. * \since QGIS 2.10 - * @see geometry + * \see geometry */ void setGeometry( QgsAbstractGeometry *geometry ); /** Returns true if the geometry is null (ie, contains no underlying geometry - * accessible via @link geometry @endlink). - * @see geometry + * accessible via geometry() ). + * \see geometry * \since QGIS 2.10 - * @see isEmpty() + * \see isEmpty() */ bool isNull() const; @@ -141,14 +141,14 @@ class CORE_EXPORT QgsGeometry /** * Set the geometry, feeding in a geometry in GEOS format. * This class will take ownership of the buffer. - * @note not available in Python bindings + * \note not available in Python bindings */ void fromGeos( GEOSGeometry *geos ); /** Set the geometry, feeding in the buffer containing OGC Well-Known Binary and the buffer's length. This class will take ownership of the buffer. - @note not available in Python bindings + \note not available in Python bindings */ void fromWkb( unsigned char *wkb, int length ); @@ -159,19 +159,19 @@ class CORE_EXPORT QgsGeometry void fromWkb( const QByteArray &wkb ); /** Returns a geos geometry - caller takes ownership of the object (should be deleted with GEOSGeom_destroy_r) - * @param precision The precision of the grid to which to snap the geometry vertices. If 0, no snapping is performed. + * \param precision The precision of the grid to which to snap the geometry vertices. If 0, no snapping is performed. * \since QGIS 3.0 - * @note not available in Python bindings + * \note not available in Python bindings */ GEOSGeometry *exportToGeos( double precision = 0 ) const; /** Returns type of the geometry as a WKB type (point / linestring / polygon etc.) - * @see type + * \see type */ QgsWkbTypes::Type wkbType() const; /** Returns type of the geometry as a QgsWkbTypes::GeometryType - * @see wkbType + * \see wkbType */ QgsWkbTypes::GeometryType type() const; @@ -179,7 +179,7 @@ class CORE_EXPORT QgsGeometry * Returns true if the geometry is empty (eg a linestring with no vertices, * or a collection with no geometries). A null geometry will always * return true for isEmpty(). - * @see isNull() + * \see isNull() */ bool isEmpty() const; @@ -210,39 +210,39 @@ class CORE_EXPORT QgsGeometry * Returns the minimum distance between this geometry and another geometry, using GEOS. * Will return a negative value if a geometry is missing. * - * @param geom geometry to find minimum distance to + * \param geom geometry to find minimum distance to */ double distance( const QgsGeometry &geom ) const; /** * Returns the vertex closest to the given point, the corresponding vertex index, squared distance snap point / target point * and the indices of the vertices before and after the closest vertex. - * @param point point to search for - * @param atVertex will be set to the vertex index of the closest found vertex - * @param beforeVertex will be set to the vertex index of the previous vertex from the closest one. Will be set to -1 if + * \param point point to search for + * \param atVertex will be set to the vertex index of the closest found vertex + * \param beforeVertex will be set to the vertex index of the previous vertex from the closest one. Will be set to -1 if * not present. - * @param afterVertex will be set to the vertex index of the next vertex after the closest one. Will be set to -1 if + * \param afterVertex will be set to the vertex index of the next vertex after the closest one. Will be set to -1 if * not present. - * @param sqrDist will be set to the square distance between the closest vertex and the specified point - * @returns closest point in geometry. If not found (empty geometry), returns null point nad sqrDist is negative. + * \param sqrDist will be set to the square distance between the closest vertex and the specified point + * \returns closest point in geometry. If not found (empty geometry), returns null point nad sqrDist is negative. */ //TODO QGIS 3.0 - rename beforeVertex to previousVertex, afterVertex to nextVertex QgsPoint closestVertex( const QgsPoint &point, int &atVertex, int &beforeVertex, int &afterVertex, double &sqrDist ) const; /** * Returns the distance along this geometry from its first vertex to the specified vertex. - * @param vertex vertex index to calculate distance to - * @returns distance to vertex (following geometry), or -1 for invalid vertex numbers + * \param vertex vertex index to calculate distance to + * \returns distance to vertex (following geometry), or -1 for invalid vertex numbers * \since QGIS 2.16 */ double distanceToVertex( int vertex ) const; /** * Returns the bisector angle for this geometry at the specified vertex. - * @param vertex vertex index to calculate bisector angle at - * @returns bisector angle, in radians clockwise from north + * \param vertex vertex index to calculate bisector angle at + * \returns bisector angle, in radians clockwise from north * \since QGIS 3.0 - * @see interpolateAngle() + * \see interpolateAngle() */ double angleAtVertex( int vertex ) const; @@ -316,8 +316,8 @@ class CORE_EXPORT QgsGeometry /** * Returns coordinates of a vertex. - * @param atVertex index of the vertex - * @return Coordinates of the vertex or QgsPoint(0,0) on error + * \param atVertex index of the vertex + * \returns Coordinates of the vertex or QgsPoint(0,0) on error */ QgsPoint vertexAt( int atVertex ) const; @@ -330,86 +330,86 @@ class CORE_EXPORT QgsGeometry /** Returns the nearest point on this geometry to another geometry. * \since QGIS 2.14 - * @see shortestLine() + * \see shortestLine() */ QgsGeometry nearestPoint( const QgsGeometry &other ) const; /** Returns the shortest line joining this geometry to another geometry. * \since QGIS 2.14 - * @see nearestPoint() + * \see nearestPoint() */ QgsGeometry shortestLine( const QgsGeometry &other ) const; /** * Searches for the closest vertex in this geometry to the given point. - * @param point Specifiest the point for search - * @param atVertex Receives index of the closest vertex - * @return The squared cartesian distance is also returned in sqrDist, negative number on error + * \param point Specifiest the point for search + * \param atVertex Receives index of the closest vertex + * \returns The squared cartesian distance is also returned in sqrDist, negative number on error */ double closestVertexWithContext( const QgsPoint &point, int &atVertex ) const; /** * Searches for the closest segment of geometry to the given point - * @param point Specifies the point for search - * @param minDistPoint Receives the nearest point on the segment - * @param afterVertex Receives index of the vertex after the closest segment. The vertex + * \param point Specifies the point for search + * \param minDistPoint Receives the nearest point on the segment + * \param afterVertex Receives index of the vertex after the closest segment. The vertex * before the closest segment is always afterVertex - 1 - * @param leftOf Out: Returns if the point lies on the left of right side of the segment ( < 0 means left, > 0 means right ) - * @param epsilon epsilon for segment snapping (added in 1.8) - * @return The squared cartesian distance is also returned in sqrDist, negative number on error + * \param leftOf Out: Returns if the point lies on the left of right side of the segment ( < 0 means left, > 0 means right ) + * \param epsilon epsilon for segment snapping (added in 1.8) + * \returns The squared cartesian distance is also returned in sqrDist, negative number on error */ double closestSegmentWithContext( const QgsPoint &point, QgsPoint &minDistPoint, int &afterVertex, double *leftOf = nullptr, double epsilon = DEFAULT_SEGMENT_EPSILON ) const; /** Adds a new ring to this geometry. This makes only sense for polygon and multipolygons. - @return 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed, + \returns 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed, 3 ring is not valid geometry, 4 ring not disjoint with existing rings, 5 no polygon found which contained the ring*/ // TODO QGIS 3.0 returns an enum instead of a magic constant int addRing( const QList &ring ); /** Adds a new ring to this geometry. This makes only sense for polygon and multipolygons. - @return 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed, + \returns 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed, 3 ring is not valid geometry, 4 ring not disjoint with existing rings, 5 no polygon found which contained the ring*/ // TODO QGIS 3.0 returns an enum instead of a magic constant int addRing( QgsCurve *ring ); /** Adds a new part to a the geometry. - * @param points points describing part to add - * @param geomType default geometry type to create if no existing geometry - * @returns 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring + * \param points points describing part to add + * \param geomType default geometry type to create if no existing geometry + * \returns 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring * not disjoint with existing polygons of the feature */ // TODO QGIS 3.0 returns an enum instead of a magic constant int addPart( const QList &points, QgsWkbTypes::GeometryType geomType = QgsWkbTypes::UnknownGeometry ); /** Adds a new part to a the geometry. - * @param points points describing part to add - * @param geomType default geometry type to create if no existing geometry - * @returns 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring + * \param points points describing part to add + * \param geomType default geometry type to create if no existing geometry + * \returns 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring * not disjoint with existing polygons of the feature */ // TODO QGIS 3.0 returns an enum instead of a magic constant int addPart( const QgsPointSequence &points, QgsWkbTypes::GeometryType geomType = QgsWkbTypes::UnknownGeometry ); /** Adds a new part to this geometry. - * @param part part to add (ownership is transferred) - * @param geomType default geometry type to create if no existing geometry - * @returns 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring + * \param part part to add (ownership is transferred) + * \param geomType default geometry type to create if no existing geometry + * \returns 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring * not disjoint with existing polygons of the feature */ // TODO QGIS 3.0 returns an enum instead of a magic constant int addPart( QgsAbstractGeometry *part, QgsWkbTypes::GeometryType geomType = QgsWkbTypes::UnknownGeometry ); /** Adds a new island polygon to a multipolygon feature - * @param newPart part to add. Ownership is NOT transferred. - * @return 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring + * \param newPart part to add. Ownership is NOT transferred. + * \returns 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring * not disjoint with existing polygons of the feature - * @note not available in Python bindings + * \note not available in Python bindings */ // TODO QGIS 3.0 returns an enum instead of a magic constant int addPart( GEOSGeometry *newPart ); /** Adds a new island polygon to a multipolygon feature - @return 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring + \returns 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring not disjoint with existing polygons of the feature \note available in Python bindings as addPartGeometry \since QGIS 2.2 @@ -426,31 +426,31 @@ class CORE_EXPORT QgsGeometry QgsGeometry removeInteriorRings( double minimumAllowedArea = -1 ) const; /** Translate this geometry by dx, dy - @return 0 in case of success*/ + \returns 0 in case of success*/ int translate( double dx, double dy ); /** Transform this geometry as described by CoordinateTransform ct - @return 0 in case of success*/ + \returns 0 in case of success*/ int transform( const QgsCoordinateTransform &ct ); /** Transform this geometry as described by QTransform ct \since QGIS 2.8 - @return 0 in case of success*/ + \returns 0 in case of success*/ int transform( const QTransform &ct ); /** Rotate this geometry around the Z axis \since QGIS 2.8 - @param rotation clockwise rotation in degrees - @param center rotation center - @return 0 in case of success*/ + \param rotation clockwise rotation in degrees + \param center rotation center + \returns 0 in case of success*/ int rotate( double rotation, const QgsPoint ¢er ); /** Splits this geometry according to a given line. - @param splitLine the line that splits the geometry - @param[out] newGeometries list of new geometries that have been created with the split - @param topological true if topological editing is enabled - @param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset - @return 0 in case of success, 1 if geometry has not been split, error else*/ + \param splitLine the line that splits the geometry + \param[out] newGeometries list of new geometries that have been created with the split + \param topological true if topological editing is enabled + \param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset + \returns 0 in case of success, 1 if geometry has not been split, error else*/ // TODO QGIS 3.0 returns an enum instead of a magic constant int splitGeometry( const QList &splitLine, QList &newGeometries, @@ -458,28 +458,28 @@ class CORE_EXPORT QgsGeometry QList &topologyTestPoints ); /** Replaces a part of this geometry with another line - * @return 0 in case of success + * \returns 0 in case of success * \since QGIS 1.3 */ int reshapeGeometry( const QList &reshapeWithLine ); /** Changes this geometry such that it does not intersect the other geometry - * @param other geometry that should not be intersect - * @return 0 in case of success + * \param other geometry that should not be intersect + * \returns 0 in case of success */ int makeDifference( const QgsGeometry *other ); /** Returns the geometry formed by modifying this geometry such that it does not * intersect the other geometry. - * @param other geometry that should not be intersect - * @return difference geometry, or empty geometry if difference could not be calculated + * \param other geometry that should not be intersect + * \returns difference geometry, or empty geometry if difference could not be calculated * \since QGIS 3.0 */ QgsGeometry makeDifference( const QgsGeometry &other ) const; /** * Returns the bounding box of the geometry. - * @see orientedMinimumBoundingBox() + * \see orientedMinimumBoundingBox() */ QgsRectangle boundingBox() const; @@ -488,7 +488,7 @@ class CORE_EXPORT QgsGeometry * rotated rectangle which fully encompasses the geometry. The area, angle (clockwise in degrees from North), * width and height of the rotated bounding box will also be returned. * \since QGIS 3.0 - * @see boundingBox() + * \see boundingBox() */ QgsGeometry orientedMinimumBoundingBox( double &area, double &angle, double &width, double &height ) const; @@ -567,20 +567,20 @@ class CORE_EXPORT QgsGeometry QgsGeometry buffer( double distance, int segments ) const; /** Returns a buffer region around the geometry, with additional style options. - * @param distance buffer distance - * @param segments for round joins, number of segments to approximate quarter-circle - * @param endCapStyle end cap style - * @param joinStyle join style for corners in geometry - * @param mitreLimit limit on the mitre ratio used for very sharp corners (JoinStyleMitre only) + * \param distance buffer distance + * \param segments for round joins, number of segments to approximate quarter-circle + * \param endCapStyle end cap style + * \param joinStyle join style for corners in geometry + * \param mitreLimit limit on the mitre ratio used for very sharp corners (JoinStyleMitre only) * \since QGIS 2.4 */ QgsGeometry buffer( double distance, int segments, EndCapStyle endCapStyle, JoinStyle joinStyle, double mitreLimit ) const; /** Returns an offset line at a given distance and side from an input line. - * @param distance buffer distance - * @param segments for round joins, number of segments to approximate quarter-circle - * @param joinStyle join style for corners in geometry - * @param mitreLimit limit on the mitre ratio used for very sharp corners (JoinStyleMitre only) + * \param distance buffer distance + * \param segments for round joins, number of segments to approximate quarter-circle + * \param joinStyle join style for corners in geometry + * \param mitreLimit limit on the mitre ratio used for very sharp corners (JoinStyleMitre only) * \since QGIS 2.4 */ QgsGeometry offsetCurve( double distance, int segments, JoinStyle joinStyle, double mitreLimit ) const; @@ -588,12 +588,12 @@ class CORE_EXPORT QgsGeometry /** * Returns a single sided buffer for a (multi)line geometry. The buffer is only * applied to one side of the line. - * @param distance buffer distance - * @param segments for round joins, number of segments to approximate quarter-circle - * @param side side of geometry to buffer - * @param joinStyle join style for corners - * @param mitreLimit limit on the mitre ratio used for very sharp corners - * @return buffered geometry, or an empty geometry if buffer could not be + * \param distance buffer distance + * \param segments for round joins, number of segments to approximate quarter-circle + * \param side side of geometry to buffer + * \param joinStyle join style for corners + * \param mitreLimit limit on the mitre ratio used for very sharp corners + * \returns buffered geometry, or an empty geometry if buffer could not be * calculated * \since QGIS 3.0 */ @@ -619,7 +619,7 @@ class CORE_EXPORT QgsGeometry * at the added nodes. * Curved geometry types are automatically segmentized by this routine. * \since QGIS 3.0 - * @see densifyByDistance() + * \see densifyByDistance() */ QgsGeometry densifyByCount( int extraNodesPerSegment ) const; @@ -635,16 +635,16 @@ class CORE_EXPORT QgsGeometry * at the added nodes. * Curved geometry types are automatically segmentized by this routine. * \since QGIS 3.0 - * @see densifyByCount() + * \see densifyByCount() */ QgsGeometry densifyByDistance( double distance ) const; /** * Returns the center of mass of a geometry. - * @note for line based geometries, the center point of the line is returned, + * \note for line based geometries, the center point of the line is returned, * and for point based geometries, the point itself is returned - * @see pointOnSurface() - * @see poleOfInaccessibility() + * \see pointOnSurface() + * \see poleOfInaccessibility() */ QgsGeometry centroid() const; @@ -652,8 +652,8 @@ class CORE_EXPORT QgsGeometry * Returns a point guaranteed to lie on the surface of a geometry. While the centroid() * of a geometry may be located outside of the geometry itself (e.g., for concave shapes), * the point on surface will always be inside the geometry. - * @see centroid() - * @see poleOfInaccessibility() + * \see centroid() + * \see poleOfInaccessibility() */ QgsGeometry pointOnSurface() const; @@ -665,8 +665,8 @@ class CORE_EXPORT QgsGeometry * tolerance. More precise tolerances require more iterations and will take longer * to calculate. * Optionally, the distance to the polygon boundary from the pole can be stored. - * @see centroid() - * @see pointOnSurface() + * \see centroid() + * \see pointOnSurface() * \since QGIS 3.0 */ QgsGeometry poleOfInaccessibility( double precision, double *distanceToBoundary = nullptr ) const; @@ -705,7 +705,7 @@ class CORE_EXPORT QgsGeometry /** * Return interpolated point on line at distance * \since QGIS 1.9 - * @see lineLocatePoint() + * \see lineLocatePoint() */ QgsGeometry interpolate( double distance ) const; @@ -713,10 +713,10 @@ class CORE_EXPORT QgsGeometry * on this linestring geometry to the specified point. Ie, the returned value indicates * how far along this linestring you need to traverse to get to the closest location * where this linestring comes to the specified point. - * @param point point to seek proximity to - * @return distance along line, or -1 on error - * @note only valid for linestring geometries - * @see interpolate() + * \param point point to seek proximity to + * \returns distance along line, or -1 on error + * \note only valid for linestring geometries + * \see interpolate() * \since QGIS 3.0 */ double lineLocatePoint( const QgsGeometry &point ) const; @@ -725,9 +725,9 @@ class CORE_EXPORT QgsGeometry * along the geometry. Angles are in radians, clockwise from north. * If the distance coincides precisely at a node then the average angle from the segment either side * of the node is returned. - * @param distance distance along geometry + * \param distance distance along geometry * \since QGIS 3.0 - * @see angleAtVertex() + * \see angleAtVertex() */ double interpolateAngle( double distance ) const; @@ -736,13 +736,13 @@ class CORE_EXPORT QgsGeometry /** Returns a geometry representing all the points in this geometry and other (a * union geometry operation). - * @note this operation is not called union since its a reserved word in C++. + * \note this operation is not called union since its a reserved word in C++. */ QgsGeometry combine( const QgsGeometry &geometry ) const; /** Merges any connected lines in a LineString/MultiLineString geometry and * converts them to single line strings. - * @returns a LineString or MultiLineString geometry, with any connected lines + * \returns a LineString or MultiLineString geometry, with any connected lines * joined. An empty geometry will be returned if the input geometry was not a * MultiLineString geometry. * \since QGIS 3.0 @@ -765,12 +765,12 @@ class CORE_EXPORT QgsGeometry /** Exports the geometry to WKT * \note precision parameter added in QGIS 2.4 - * @return true in case of success and false else + * \returns true in case of success and false else */ QString exportToWkt( int precision = 17 ) const; /** Exports the geometry to GeoJSON - * @return a QString representing the geometry as GeoJSON + * \returns a QString representing the geometry as GeoJSON * \since QGIS 1.8 * \note Available in Python bindings since QGIS 1.9 * \note precision parameter added in QGIS 2.4 @@ -778,9 +778,9 @@ class CORE_EXPORT QgsGeometry QString exportToGeoJSON( int precision = 17 ) const; /** Try to convert the geometry to the requested type - * @param destType the geometry type to be converted to - * @param destMultipart determines if the output geometry will be multipart or not - * @return the converted geometry or nullptr if the conversion fails. + * \param destType the geometry type to be converted to + * \param destMultipart determines if the output geometry will be multipart or not + * \returns the converted geometry or nullptr if the conversion fails. * \since QGIS 2.2 */ QgsGeometry convertToType( QgsWkbTypes::GeometryType destType, bool destMultipart = false ) const; @@ -833,12 +833,12 @@ class CORE_EXPORT QgsGeometry /** Delete a ring in polygon or multipolygon. Ring 0 is outer ring and can't be deleted. - @return true on success + \returns true on success \since QGIS 1.2 */ bool deleteRing( int ringNum, int partNum = 0 ); /** Delete part identified by the part number - @return true on success + \returns true on success \since QGIS 1.2 */ bool deletePart( int partNum ); @@ -848,7 +848,7 @@ class CORE_EXPORT QgsGeometry * If it is already a multipart geometry, it will return true and * not change the geometry. * - * @return true in case of success and false else + * \returns true in case of success and false else */ bool convertToMultiType(); @@ -859,17 +859,17 @@ class CORE_EXPORT QgsGeometry * If it is already a single part geometry, it will return true and * not change the geometry. * - * @return true in case of success and false else + * \returns true in case of success and false else */ bool convertToSingleType(); /** Modifies geometry to avoid intersections with the layers specified in project properties - * @return 0 in case of success, + * \returns 0 in case of success, * 1 if geometry is not of polygon type, * 2 if avoid intersection would change the geometry type, * 3 other error during intersection removal - * @param avoidIntersectionsLayers list of layers to check for intersections - * @param ignoreFeatures possibility to give a list of features where intersections should be ignored (not available in Python bindings) + * \param avoidIntersectionsLayers list of layers to check for intersections + * \param ignoreFeatures possibility to give a list of features where intersections should be ignored (not available in Python bindings) * \since QGIS 1.5 */ int avoidIntersections( const QList &avoidIntersectionsLayers, @@ -878,13 +878,13 @@ class CORE_EXPORT QgsGeometry /** * Attempts to make an invalid geometry valid without losing vertices. * - * @note Ported from PostGIS ST_MakeValid() and it should return equivalent results. + * \note Ported from PostGIS ST_MakeValid() and it should return equivalent results. * Already-valid geometries are returned without further intervention. * In case of full or partial dimensional collapses, the output geometry may be a collection * of lower-to-equal dimension geometries or a geometry of lower dimension. * Single polygons may become multi-geometries in case of self-intersections. * It preserves Z values, but M values will be dropped. - * @return new valid QgsGeometry or null geometry on error + * \returns new valid QgsGeometry or null geometry on error * \since QGIS 3.0 */ QgsGeometry makeValid(); @@ -930,61 +930,61 @@ class CORE_EXPORT QgsGeometry /** Converts the geometry to straight line segments, if it is a curved geometry type. * \since QGIS 2.10 - * @see requiresConversionToStraightSegments + * \see requiresConversionToStraightSegments */ void convertToStraightSegment(); /** Returns true if the geometry is a curved geometry type which requires conversion to * display as straight line segments. * \since QGIS 2.10 - * @see convertToStraightSegment + * \see convertToStraightSegment */ bool requiresConversionToStraightSegments() const; /** Transforms the geometry from map units to pixels in place. - * @param mtp map to pixel transform + * \param mtp map to pixel transform * \since QGIS 2.10 */ void mapToPixel( const QgsMapToPixel &mtp ); // not implemented for 2.10 /* Clips the geometry using the specified rectangle - * @param rect clip rectangle + * \param rect clip rectangle * \since QGIS 2.10 */ // void clip( const QgsRectangle& rect ); /** Draws the geometry onto a QPainter - * @param p destination QPainter + * \param p destination QPainter * \since QGIS 2.10 */ void draw( QPainter &p ) const; /** Calculates the vertex ID from a vertex number - * @param nr vertex number - * @param id reference to QgsVertexId for storing result - * @returns true if vertex was found + * \param nr vertex number + * \param id reference to QgsVertexId for storing result + * \returns true if vertex was found * \since QGIS 2.10 - * @see vertexNrFromVertexId + * \see vertexNrFromVertexId */ bool vertexIdFromVertexNr( int nr, QgsVertexId &id ) const; /** Returns the vertex number corresponding to a vertex idd - * @param i vertex id - * @returns vertex number + * \param i vertex id + * \returns vertex number * \since QGIS 2.10 - * @see vertexIdFromVertexNr + * \see vertexIdFromVertexNr */ int vertexNrFromVertexId( QgsVertexId i ) const; /** Return GEOS context handle * \since QGIS 2.6 - * @note not available in Python + * \note not available in Python */ static GEOSContextHandle_t getGEOSHandler(); /** Construct geometry from a QPointF - * @param point source QPointF + * \param point source QPointF * \since QGIS 2.7 */ static QgsGeometry fromQPointF( QPointF point ); @@ -992,50 +992,50 @@ class CORE_EXPORT QgsGeometry /** Construct geometry from a QPolygonF. If the polygon is closed than * the resultant geometry will be a polygon, if it is open than the * geometry will be a polyline. - * @param polygon source QPolygonF + * \param polygon source QPolygonF * \since QGIS 2.7 */ static QgsGeometry fromQPolygonF( const QPolygonF &polygon ); /** Creates a QgsPolyline from a QPolygonF. - * @param polygon source polygon - * @returns QgsPolyline - * @see createPolygonFromQPolygonF + * \param polygon source polygon + * \returns QgsPolyline + * \see createPolygonFromQPolygonF */ static QgsPolyline createPolylineFromQPolygonF( const QPolygonF &polygon ); /** Creates a QgsPolygon from a QPolygonF. - * @param polygon source polygon - * @returns QgsPolygon - * @see createPolylineFromQPolygonF + * \param polygon source polygon + * \returns QgsPolygon + * \see createPolylineFromQPolygonF */ static QgsPolygon createPolygonFromQPolygonF( const QPolygonF &polygon ); /** Compares two polylines for equality within a specified tolerance. - * @param p1 first polyline - * @param p2 second polyline - * @param epsilon maximum difference for coordinates between the polylines - * @returns true if polylines have the same number of points and all + * \param p1 first polyline + * \param p2 second polyline + * \param epsilon maximum difference for coordinates between the polylines + * \returns true if polylines have the same number of points and all * points are equal within the specified tolerance * \since QGIS 2.9 */ static bool compare( const QgsPolyline &p1, const QgsPolyline &p2, double epsilon = 4 * std::numeric_limits::epsilon() ); /** Compares two polygons for equality within a specified tolerance. - * @param p1 first polygon - * @param p2 second polygon - * @param epsilon maximum difference for coordinates between the polygons - * @returns true if polygons have the same number of rings, and each ring has the same + * \param p1 first polygon + * \param p2 second polygon + * \param epsilon maximum difference for coordinates between the polygons + * \returns true if polygons have the same number of rings, and each ring has the same * number of points and all points are equal within the specified tolerance * \since QGIS 2.9 */ static bool compare( const QgsPolygon &p1, const QgsPolygon &p2, double epsilon = 4 * std::numeric_limits::epsilon() ); /** Compares two multipolygons for equality within a specified tolerance. - * @param p1 first multipolygon - * @param p2 second multipolygon - * @param epsilon maximum difference for coordinates between the multipolygons - * @returns true if multipolygons have the same number of polygons, the polygons have the same number + * \param p1 first multipolygon + * \param p2 second multipolygon + * \param epsilon maximum difference for coordinates between the multipolygons + * \returns true if multipolygons have the same number of polygons, the polygons have the same number * of rings, and each ring has the same number of points and all points are equal within the specified * tolerance * \since QGIS 2.9 @@ -1044,13 +1044,13 @@ class CORE_EXPORT QgsGeometry /** Smooths a geometry by rounding off corners using the Chaikin algorithm. This operation * roughly doubles the number of vertices in a geometry. - * @param iterations number of smoothing iterations to run. More iterations results + * \param iterations number of smoothing iterations to run. More iterations results * in a smoother geometry - * @param offset fraction of line to create new vertices along, between 0 and 1.0, + * \param offset fraction of line to create new vertices along, between 0 and 1.0, * e.g., the default value of 0.25 will create new vertices 25% and 75% along each line segment * of the geometry for each iteration. Smaller values result in "tighter" smoothing. - * @param minimumDistance minimum segment length to apply smoothing to - * @param maxAngle maximum angle at node (0-180) at which smoothing will be applied + * \param minimumDistance minimum segment length to apply smoothing to + * \param maxAngle maximum angle at node (0-180) at which smoothing will be applied * \since QGIS 2.9 */ QgsGeometry smooth( const unsigned int iterations = 1, const double offset = 0.25, @@ -1061,14 +1061,14 @@ class CORE_EXPORT QgsGeometry static QgsGeometryEngine *createGeometryEngine( const QgsAbstractGeometry *geometry ); /** Upgrades a point list from QgsPoint to QgsPointV2 - * @param input list of QgsPoint objects to be upgraded - * @param output destination for list of points converted to QgsPointV2 + * \param input list of QgsPoint objects to be upgraded + * \param output destination for list of points converted to QgsPointV2 */ static void convertPointList( const QList &input, QgsPointSequence &output ); /** Downgrades a point list from QgsPointV2 to QgsPoint - * @param input list of QgsPointV2 objects to be downgraded - * @param output destination for list of points converted to QgsPoint + * \param input list of QgsPointV2 objects to be downgraded + * \param output destination for list of points converted to QgsPoint */ static void convertPointList( const QgsPointSequence &input, QList &output ); @@ -1101,27 +1101,27 @@ class CORE_EXPORT QgsGeometry QgsGeometry convertToPolygon( bool destMultipart ) const; /** Smooths a polyline using the Chaikin algorithm - * @param line line to smooth - * @param iterations number of smoothing iterations to run. More iterations results + * \param line line to smooth + * \param iterations number of smoothing iterations to run. More iterations results * in a smoother geometry - * @param offset fraction of line to create new vertices along, between 0 and 1.0, + * \param offset fraction of line to create new vertices along, between 0 and 1.0, * e.g., the default value of 0.25 will create new vertices 25% and 75% along each line segment * of the geometry for each iteration. Smaller values result in "tighter" smoothing. - * @param minimumDistance minimum segment length to apply smoothing to - * @param maxAngle maximum angle at node (0-180) at which smoothing will be applied + * \param minimumDistance minimum segment length to apply smoothing to + * \param maxAngle maximum angle at node (0-180) at which smoothing will be applied */ QgsLineString *smoothLine( const QgsLineString &line, const unsigned int iterations = 1, const double offset = 0.25, double minimumDistance = -1, double maxAngle = 180.0 ) const; /** Smooths a polygon using the Chaikin algorithm - * @param polygon polygon to smooth - * @param iterations number of smoothing iterations to run. More iterations results + * \param polygon polygon to smooth + * \param iterations number of smoothing iterations to run. More iterations results * in a smoother geometry - * @param offset fraction of segment to create new vertices along, between 0 and 1.0, + * \param offset fraction of segment to create new vertices along, between 0 and 1.0, * e.g., the default value of 0.25 will create new vertices 25% and 75% along each line segment * of the geometry for each iteration. Smaller values result in "tighter" smoothing. - * @param minimumDistance minimum segment length to apply smoothing to - * @param maxAngle maximum angle at node (0-180) at which smoothing will be applied + * \param minimumDistance minimum segment length to apply smoothing to + * \param maxAngle maximum angle at node (0-180) at which smoothing will be applied */ QgsPolygonV2 *smoothPolygon( const QgsPolygonV2 &polygon, const unsigned int iterations = 1, const double offset = 0.25, double minimumDistance = -1, double maxAngle = 180.0 ) const; diff --git a/src/core/geometry/qgsgeometrycollection.h b/src/core/geometry/qgsgeometrycollection.h index 85fff0407f4b..b9bacb6143d2 100644 --- a/src/core/geometry/qgsgeometrycollection.h +++ b/src/core/geometry/qgsgeometrycollection.h @@ -42,12 +42,12 @@ class CORE_EXPORT QgsGeometryCollection: public QgsAbstractGeometry int numGeometries() const; /** Returns a const reference to a geometry from within the collection. - * @param n index of geometry to return + * \param n index of geometry to return */ const QgsAbstractGeometry *geometryN( int n ) const; /** Returns a geometry from within the collection. - * @param n index of geometry to return + * \param n index of geometry to return */ QgsAbstractGeometry *geometryN( int n ); @@ -62,14 +62,14 @@ class CORE_EXPORT QgsGeometryCollection: public QgsAbstractGeometry virtual bool addGeometry( QgsAbstractGeometry *g ); /** Inserts a geometry before a specified index and takes ownership. Returns true in case of success. - * @param g geometry to insert. Ownership is transferred to the collection. - * @param index position to insert geometry before + * \param g geometry to insert. Ownership is transferred to the collection. + * \param index position to insert geometry before */ virtual bool insertGeometry( QgsAbstractGeometry *g, int index ); /** Removes a geometry from the collection. - * @param nr index of geometry to remove - * @returns true if removal was successful. + * \param nr index of geometry to remove + * \returns true if removal was successful. */ virtual bool removeGeometry( int nr ); @@ -109,13 +109,13 @@ class CORE_EXPORT QgsGeometryCollection: public QgsAbstractGeometry bool hasCurvedSegments() const override; /** Returns a geometry without curves. Caller takes ownership - * @param tolerance segmentation tolerance - * @param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ + * \param tolerance segmentation tolerance + * \param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ QgsAbstractGeometry *segmentize( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override; /** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments. - * @param vertex the vertex id - * @return rotation in radians, clockwise from north + * \param vertex the vertex id + * \returns rotation in radians, clockwise from north */ double vertexAngle( QgsVertexId vertex ) const override; diff --git a/src/core/geometry/qgsgeometryeditutils.h b/src/core/geometry/qgsgeometryeditutils.h index c4553c9bf109..51125f9e67f5 100644 --- a/src/core/geometry/qgsgeometryeditutils.h +++ b/src/core/geometry/qgsgeometryeditutils.h @@ -36,31 +36,31 @@ class QgsGeometryEditUtils public: /** Adds interior ring (taking ownership). - @return 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed, + \returns 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed, 3 ring is not valid geometry, 4 ring not disjoint with existing rings, 5 no polygon found which contained the ring*/ // TODO QGIS 3.0 returns an enum instead of a magic constant static int addRing( QgsAbstractGeometry *geom, QgsCurve *ring ); /** Adds part to multi type geometry (taking ownership) - @return 0 in case of success, 1 if not a multigeometry, 2 if part is not a valid geometry, 3 if new polygon ring + \returns 0 in case of success, 1 if not a multigeometry, 2 if part is not a valid geometry, 3 if new polygon ring not disjoint with existing polygons of the feature*/ // TODO QGIS 3.0 returns an enum instead of a magic constant static int addPart( QgsAbstractGeometry *geom, QgsAbstractGeometry *part ); /** Deletes a ring from a geometry. - * @returns true if delete was successful + * \returns true if delete was successful */ static bool deleteRing( QgsAbstractGeometry *geom, int ringNum, int partNum = 0 ); /** Deletes a part from a geometry. - * @returns true if delete was successful + * \returns true if delete was successful */ static bool deletePart( QgsAbstractGeometry *geom, int partNum ); /** Alters a geometry so that it avoids intersections with features from all open vector layers. - * @param geom geometry to alter - * @param avoidIntersectionsLayers list of layers to check for intersections - * @param ignoreFeatures map of layer to feature id of features to ignore + * \param geom geometry to alter + * \param avoidIntersectionsLayers list of layers to check for intersections + * \param ignoreFeatures map of layer to feature id of features to ignore */ static QgsAbstractGeometry *avoidIntersections( const QgsAbstractGeometry &geom, const QList &avoidIntersectionsLayers, diff --git a/src/core/geometry/qgsgeometryengine.h b/src/core/geometry/qgsgeometryengine.h index d320898c90c8..8ed8fca557f4 100644 --- a/src/core/geometry/qgsgeometryengine.h +++ b/src/core/geometry/qgsgeometryengine.h @@ -62,19 +62,19 @@ class CORE_EXPORT QgsGeometryEngine /** Returns the Dimensional Extended 9 Intersection Model (DE-9IM) representation of the * relationship between the geometries. - * @param geom geometry to relate to - * @param errorMsg destination storage for any error message - * @returns DE-9IM string for relationship, or an empty string if an error occurred + * \param geom geometry to relate to + * \param errorMsg destination storage for any error message + * \returns DE-9IM string for relationship, or an empty string if an error occurred * \since QGIS 2.12 */ virtual QString relate( const QgsAbstractGeometry &geom, QString *errorMsg = nullptr ) const = 0; /** Tests whether two geometries are related by a specified Dimensional Extended 9 Intersection Model (DE-9IM) * pattern. - * @param geom geometry to relate to - * @param pattern DE-9IM pattern for match - * @param errorMsg destination storage for any error message - * @returns true if geometry relationship matches with pattern + * \param geom geometry to relate to + * \param pattern DE-9IM pattern for match + * \param errorMsg destination storage for any error message + * \returns true if geometry relationship matches with pattern * \since QGIS 2.14 */ virtual bool relatePattern( const QgsAbstractGeometry &geom, const QString &pattern, QString *errorMsg = nullptr ) const = 0; diff --git a/src/core/geometry/qgsgeometryutils.h b/src/core/geometry/qgsgeometryutils.h index 6804853b05a4..32f421e8280d 100644 --- a/src/core/geometry/qgsgeometryutils.h +++ b/src/core/geometry/qgsgeometryutils.h @@ -42,21 +42,21 @@ class CORE_EXPORT QgsGeometryUtils static QgsPointV2 closestVertex( const QgsAbstractGeometry &geom, const QgsPointV2 &pt, QgsVertexId &id ); /** Returns the distance along a geometry from its first vertex to the specified vertex. - * @param geom geometry - * @param id vertex id to find distance to - * @returns distance to vertex (following geometry) + * \param geom geometry + * \param id vertex id to find distance to + * \returns distance to vertex (following geometry) * \since QGIS 2.16 */ static double distanceToVertex( const QgsAbstractGeometry &geom, QgsVertexId id ); /** Retrieves the vertices which are before and after the interpolated point at a specified distance along a linestring * (or polygon boundary). - * @param geometry line or polygon geometry - * @param distance distance to traverse along geometry - * @param previousVertex will be set to previous vertex ID - * @param nextVertex will be set to next vertex ID - * @note if the distance coincides exactly with a vertex, then both previousVertex and nextVertex will be set to this vertex - * @returns true if vertices were successfully retrieved + * \param geometry line or polygon geometry + * \param distance distance to traverse along geometry + * \param previousVertex will be set to previous vertex ID + * \param nextVertex will be set to next vertex ID + * \note if the distance coincides exactly with a vertex, then both previousVertex and nextVertex will be set to this vertex + * \returns true if vertices were successfully retrieved * \since QGIS 3.0 */ static bool verticesAtDistance( const QgsAbstractGeometry &geometry, @@ -77,34 +77,34 @@ class CORE_EXPORT QgsGeometryUtils static double sqrDistToLine( double ptX, double ptY, double x1, double y1, double x2, double y2, double &minDistX, double &minDistY, double epsilon ); /** - * @brief Compute the intersection between two lines - * @param p1 Point on the first line - * @param v Direction vector of the first line - * @param q1 Point on the second line - * @param w Direction vector of the second line - * @param inter Output parameter, the intersection point - * @return Whether the lines intersect + * \brief Compute the intersection between two lines + * \param p1 Point on the first line + * \param v Direction vector of the first line + * \param q1 Point on the second line + * \param w Direction vector of the second line + * \param inter Output parameter, the intersection point + * \returns Whether the lines intersect */ static bool lineIntersection( const QgsPointV2 &p1, QgsVector v, const QgsPointV2 &q1, QgsVector w, QgsPointV2 &inter ); /** - * @brief Compute the intersection between two segments - * @param p1 First segment start point - * @param p2 First segment end point - * @param q1 Second segment start point - * @param q2 Second segment end point - * @param inter Output parameter, the intersection point - * @param tolerance The tolerance to use - * @return Whether the segments intersect + * \brief Compute the intersection between two segments + * \param p1 First segment start point + * \param p2 First segment end point + * \param q1 Second segment start point + * \param q2 Second segment end point + * \param inter Output parameter, the intersection point + * \param tolerance The tolerance to use + * \returns Whether the segments intersect */ static bool segmentIntersection( const QgsPointV2 &p1, const QgsPointV2 &p2, const QgsPointV2 &q1, const QgsPointV2 &q2, QgsPointV2 &inter, double tolerance ); /** - * @brief Project the point on a segment - * @param p The point - * @param s1 The segment start point - * @param s2 The segment end point - * @return The projection of the point on the segment + * \brief Project the point on a segment + * \param p The point + * \param s1 The segment start point + * \param s2 The segment end point + * \returns The projection of the point on the segment */ static QgsPointV2 projPointOnSegment( const QgsPointV2 &p, const QgsPointV2 &s1, const QgsPointV2 &s2 ) { @@ -114,7 +114,7 @@ class CORE_EXPORT QgsGeometryUtils return t < 0. ? s1 : t > 1. ? s2 : QgsPointV2( s1.x() + ( s2.x() - s1.x() ) * t, s1.y() + ( s2.y() - s1.y() ) * t ); } - //! @note not available in Python bindings + //! \note not available in Python bindings struct SelfIntersection { int segment1; @@ -123,13 +123,13 @@ class CORE_EXPORT QgsGeometryUtils }; /** - * @brief Find self intersections in a polyline - * @param geom The geometry to check - * @param part The part of the geometry to check - * @param ring The ring of the geometry part to check - * @param tolerance The tolerance to use - * @return The list of self intersections - * @note not available in Python bindings + * \brief Find self intersections in a polyline + * \param geom The geometry to check + * \param part The part of the geometry to check + * \param ring The ring of the geometry part to check + * \param tolerance The tolerance to use + * \returns The list of self intersections + * \note not available in Python bindings * \since QGIS 2.12 */ static QList getSelfIntersections( const QgsAbstractGeometry *geom, int part, int ring, double tolerance ); @@ -172,75 +172,75 @@ class CORE_EXPORT QgsGeometryUtils static double circleTangentDirection( const QgsPointV2 &tangentPoint, const QgsPointV2 &cp1, const QgsPointV2 &cp2, const QgsPointV2 &cp3 ); /** Returns a list of points contained in a WKT string. - * @note not available in Python bindings + * \note not available in Python bindings */ static QgsPointSequence pointsFromWKT( const QString &wktCoordinateList, bool is3D, bool isMeasure ); /** * Returns a LinearRing { uint32 numPoints; Point points[numPoints]; } - * @note not available in Python bindings + * \note not available in Python bindings */ static void pointsToWKB( QgsWkbPtr &wkb, const QgsPointSequence &points, bool is3D, bool isMeasure ); /** * Returns a WKT coordinate list - * @note not available in Python bindings + * \note not available in Python bindings */ static QString pointsToWKT( const QgsPointSequence &points, int precision, bool is3D, bool isMeasure ); /** * Returns a gml::coordinates DOM element. - * @note not available in Python bindings + * \note not available in Python bindings */ static QDomElement pointsToGML2( const QgsPointSequence &points, QDomDocument &doc, int precision, const QString &ns ); /** * Returns a gml::posList DOM element. - * @note not available in Python bindings + * \note not available in Python bindings */ static QDomElement pointsToGML3( const QgsPointSequence &points, QDomDocument &doc, int precision, const QString &ns, bool is3D ); /** * Returns a geoJSON coordinates string. - * @note not available in Python bindings + * \note not available in Python bindings */ static QString pointsToJSON( const QgsPointSequence &points, int precision ); /** Ensures that an angle is in the range 0 <= angle < 2 pi. - * @param angle angle in radians - * @returns equivalent angle within the range [0, 2 pi) + * \param angle angle in radians + * \returns equivalent angle within the range [0, 2 pi) */ static double normalizedAngle( double angle ); /** Calculates the direction of line joining two points in radians, clockwise from the north direction. - * @param x1 x-coordinate of line start - * @param y1 y-coordinate of line start - * @param x2 x-coordinate of line end - * @param y2 y-coordinate of line end - * @returns angle in radians. Returned value is undefined if start and end point are the same. + * \param x1 x-coordinate of line start + * \param y1 y-coordinate of line start + * \param x2 x-coordinate of line end + * \param y2 y-coordinate of line end + * \returns angle in radians. Returned value is undefined if start and end point are the same. */ static double lineAngle( double x1, double y1, double x2, double y2 ); /** Calculates the angle between the lines AB and BC, where AB and BC described * by points a, b and b, c. - * @param x1 x-coordinate of point a - * @param y1 y-coordinate of point a - * @param x2 x-coordinate of point b - * @param y2 y-coordinate of point b - * @param x3 x-coordinate of point c - * @param y3 y-coordinate of point c - * @returns angle between lines in radians. Returned value is undefined if two or more points are equal. + * \param x1 x-coordinate of point a + * \param y1 y-coordinate of point a + * \param x2 x-coordinate of point b + * \param y2 y-coordinate of point b + * \param x3 x-coordinate of point c + * \param y3 y-coordinate of point c + * \returns angle between lines in radians. Returned value is undefined if two or more points are equal. */ static double angleBetweenThreePoints( double x1, double y1, double x2, double y2, double x3, double y3 ); /** Calculates the perpendicular angle to a line joining two points. Returned angle is in radians, * clockwise from the north direction. - * @param x1 x-coordinate of line start - * @param y1 y-coordinate of line start - * @param x2 x-coordinate of line end - * @param y2 y-coordinate of line end - * @returns angle in radians. Returned value is undefined if start and end point are the same. + * \param x1 x-coordinate of line start + * \param y1 y-coordinate of line start + * \param x2 x-coordinate of line end + * \param y2 y-coordinate of line end + * \returns angle in radians. Returned value is undefined if start and end point are the same. */ static double linePerpendicularAngle( double x1, double y1, double x2, double y2 ); @@ -248,33 +248,33 @@ class CORE_EXPORT QgsGeometryUtils static double averageAngle( double x1, double y1, double x2, double y2, double x3, double y3 ); /** Averages two angles, correctly handling negative angles and ensuring the result is between 0 and 2 pi. - * @param a1 first angle (in radians) - * @param a2 second angle (in radians) - * @returns average angle (in radians) + * \param a1 first angle (in radians) + * \param a2 second angle (in radians) + * \returns average angle (in radians) */ static double averageAngle( double a1, double a2 ); /** * Parses a WKT block of the format "TYPE( contents )" and returns a pair of geometry type to contents ("Pair(wkbType, "contents")") - * @note not available in Python bindings + * \note not available in Python bindings */ static QPair wktReadBlock( const QString &wkt ); /** * Parses a WKT string and returns of list of blocks contained in the WKT. - * @param wkt WKT string in the format "TYPE1 (contents1), TYPE2 (TYPE3 (contents3), TYPE4 (contents4))" - * @param defaultType default geometry type for children - * @returns list of WKT child block strings, e.g., List("TYPE1 (contents1)", "TYPE2 (TYPE3 (contents3), TYPE4 (contents4))") - * @note not available in Python bindings + * \param wkt WKT string in the format "TYPE1 (contents1), TYPE2 (TYPE3 (contents3), TYPE4 (contents4))" + * \param defaultType default geometry type for children + * \returns list of WKT child block strings, e.g., List("TYPE1 (contents1)", "TYPE2 (TYPE3 (contents3), TYPE4 (contents4))") + * \note not available in Python bindings */ static QStringList wktGetChildBlocks( const QString &wkt, const QString &defaultType = "" ); /** Returns a middle point between points pt1 and pt2. * Z value is computed if one of this point have Z. * M value is computed if one of this point have M. - * @param pt1 first point. - * @param pt2 second point. - * @return New point at middle between points pt1 and pt2. + * \param pt1 first point. + * \param pt2 second point. + * \returns New point at middle between points pt1 and pt2. * * Example: * \code{.py} * p = QgsPointV2( 4, 6 ) # 2D point @@ -292,33 +292,33 @@ class CORE_EXPORT QgsGeometryUtils static QgsPointV2 midpoint( const QgsPointV2 &pt1, const QgsPointV2 &pt2 ); /** Return the gradient of a line defined by points \a pt1 and \a pt2. - * @param pt1 first point. - * @param pt2 second point. - * @return The gradient of this linear entity, or infinity if vertical + * \param pt1 first point. + * \param pt2 second point. + * \returns The gradient of this linear entity, or infinity if vertical * \since QGIS 3.0 */ static double gradient( const QgsPointV2 &pt1, const QgsPointV2 &pt2 ); /** Return the coefficients (a, b, c for equation "ax + by + c = 0") of a line defined by points \a pt1 and \a pt2. - * @param pt1 first point. - * @param pt2 second point. - * @param a Output parameter, a coefficient of the equation. - * @param b Output parameter, b coefficient of the equation. - * @param c Output parameter, c coefficient of the equation. + * \param pt1 first point. + * \param pt2 second point. + * \param a Output parameter, a coefficient of the equation. + * \param b Output parameter, b coefficient of the equation. + * \param c Output parameter, c coefficient of the equation. * \since QGIS 3.0 */ static void coefficients( const QgsPointV2 &pt1, const QgsPointV2 &pt2, double &a, double &b, double &c ); /** - * @brief Create a perpendicular line segment from p to segment [s1, s2] - * @param p The point - * @param s1 The segment start point - * @param s2 The segment end point - * @return A line (segment) from p to perpendicular point on segment [s1, s2] + * \brief Create a perpendicular line segment from p to segment [s1, s2] + * \param p The point + * \param s1 The segment start point + * \param s2 The segment end point + * \returns A line (segment) from p to perpendicular point on segment [s1, s2] */ static QgsLineString perpendicularSegment( const QgsPointV2 &p, const QgsPointV2 &s1, const QgsPointV2 &s2 ); - //! @note not available in Python bindings + //! \note not available in Python bindings enum ComponentType { Vertex, @@ -326,7 +326,7 @@ class CORE_EXPORT QgsGeometryUtils Part }; - //! @note not available in Python bindings + //! \note not available in Python bindings template static double closestSegmentFromComponents( T &container, ComponentType ctype, const QgsPointV2 &pt, QgsPointV2 &segmentPt, QgsVertexId &vertexAfter, bool *leftOf, double epsilon ) { double minDist = std::numeric_limits::max(); diff --git a/src/core/geometry/qgsgeos.h b/src/core/geometry/qgsgeos.h index 43ac8b5f61ad..660cf9c34c02 100644 --- a/src/core/geometry/qgsgeos.h +++ b/src/core/geometry/qgsgeos.h @@ -34,8 +34,8 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine public: /** GEOS geometry engine constructor - * @param geometry The geometry - * @param precision The precision of the grid to which to snap the geometry vertices. If 0, no snapping is performed. + * \param geometry The geometry + * \param precision The precision of the grid to which to snap the geometry vertices. If 0, no snapping is performed. */ QgsGeos( const QgsAbstractGeometry *geometry, double precision = 0 ); ~QgsGeos(); @@ -74,12 +74,12 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine bool isEmpty( QString *errorMsg = nullptr ) const override; /** Splits this geometry according to a given line. - @param splitLine the line that splits the geometry - @param[out] newGeometries list of new geometries that have been created with the split - @param topological true if topological editing is enabled - @param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset - @param[out] errorMsg error messages emitted, if any - @return 0 in case of success, 1 if geometry has not been split, error else*/ + \param splitLine the line that splits the geometry + \param[out] newGeometries list of new geometries that have been created with the split + \param topological true if topological editing is enabled + \param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset + \param[out] errorMsg error messages emitted, if any + \returns 0 in case of success, 1 if geometry has not been split, error else*/ int splitGeometry( const QgsLineString &splitLine, QList &newGeometries, bool topological, @@ -91,13 +91,13 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine /** * Returns a single sided buffer for a geometry. The buffer is only * applied to one side of the geometry. - * @param distance buffer distance - * @param segments for round joins, number of segments to approximate quarter-circle - * @param side side of geometry to buffer (0 = left, 1 = right) - * @param joinStyle join style for corners ( Round (1) / Mitre (2) / Bevel (3) ) - * @param mitreLimit limit on the mitre ratio used for very sharp corners - * @param errorMsg error messages emitted, if any - * @return buffered geometry, or an nullptr if buffer could not be + * \param distance buffer distance + * \param segments for round joins, number of segments to approximate quarter-circle + * \param side side of geometry to buffer (0 = left, 1 = right) + * \param joinStyle join style for corners ( Round (1) / Mitre (2) / Bevel (3) ) + * \param mitreLimit limit on the mitre ratio used for very sharp corners + * \param errorMsg error messages emitted, if any + * \returns buffered geometry, or an nullptr if buffer could not be * calculated * \since QGIS 3.0 */ @@ -110,8 +110,8 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine /** Merges any connected lines in a LineString/MultiLineString geometry and * converts them to single line strings. - * @param errorMsg if specified, will be set to any reported GEOS errors - * @returns a LineString or MultiLineString geometry, with any connected lines + * \param errorMsg if specified, will be set to any reported GEOS errors + * \returns a LineString or MultiLineString geometry, with any connected lines * joined. An empty geometry will be returned if the input geometry was not a * LineString/MultiLineString geometry. * \since QGIS 3.0 @@ -120,13 +120,13 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine /** Returns the closest point on the geometry to the other geometry. * \since QGIS 2.14 - * @see shortestLine() + * \see shortestLine() */ QgsGeometry closestPoint( const QgsGeometry &other, QString *errorMsg = nullptr ) const; /** Returns the shortest line joining this geometry to the other geometry. * \since QGIS 2.14 - * @see closestPoint() + * \see closestPoint() */ QgsGeometry shortestLine( const QgsGeometry &other, QString *errorMsg = nullptr ) const; @@ -134,10 +134,10 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine * on this linestring geometry to the specified point. Ie, the returned value indicates * how far along this linestring you need to traverse to get to the closest location * where this linestring comes to the specified point. - * @param point point to seek proximity to - * @param errorMsg error messages emitted, if any - * @note only valid for linestring geometries - * @return distance along line, or -1 on error + * \param point point to seek proximity to + * \param errorMsg error messages emitted, if any + * \note only valid for linestring geometries + * \returns distance along line, or -1 on error */ double lineLocatePoint( const QgsPointV2 &point, QString *errorMsg = nullptr ) const; @@ -181,7 +181,7 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine QgsGeometry delaunayTriangulation( double tolerance = 0.0, bool edgesOnly = false, QString *errorMsg = nullptr ) const; /** Create a geometry from a GEOSGeometry - * @param geos GEOSGeometry. Ownership is NOT transferred. + * \param geos GEOSGeometry. Ownership is NOT transferred. */ static QgsAbstractGeometry *fromGeos( const GEOSGeometry *geos ); static QgsPolygonV2 *fromGeosPolygon( const GEOSGeometry *geos ); diff --git a/src/core/geometry/qgsinternalgeometryengine.h b/src/core/geometry/qgsinternalgeometryengine.h index d576287bb926..de4813313432 100644 --- a/src/core/geometry/qgsinternalgeometryengine.h +++ b/src/core/geometry/qgsinternalgeometryengine.h @@ -26,7 +26,7 @@ class QgsAbstractGeometry; * The methods are available via QgsGeometry::[geometryfunction] * and therefore this does not need to be accessed directly. * - * @note not available in Python bindings + * \note not available in Python bindings */ class QgsInternalGeometryEngine @@ -36,7 +36,7 @@ class QgsInternalGeometryEngine /** * The caller is responsible that the geometry is available and unchanged * for the whole lifetime of this object. - * @param geometry + * \param geometry */ explicit QgsInternalGeometryEngine( const QgsGeometry &geometry ); @@ -44,9 +44,9 @@ class QgsInternalGeometryEngine * Will extrude a line or (segmentized) curve by a given offset and return a polygon * representation of it. * - * @param x offset in x direction - * @param y offset in y direction - * @return an extruded polygon + * \param x offset in x direction + * \param y offset in y direction + * \returns an extruded polygon */ QgsGeometry extrude( double x, double y ) const; diff --git a/src/core/geometry/qgslinestring.h b/src/core/geometry/qgslinestring.h index 37a0c7b75fae..bf7d82d48f23 100644 --- a/src/core/geometry/qgslinestring.h +++ b/src/core/geometry/qgslinestring.h @@ -62,7 +62,7 @@ class CORE_EXPORT QgsLineString: public QgsCurve bool operator!=( const QgsCurve &other ) const override; /** Returns the specified point from inside the line string. - * @param i index of point, starting at 0 for the first point + * \param i index of point, starting at 0 for the first point */ QgsPointV2 pointN( int i ) const; @@ -70,66 +70,66 @@ class CORE_EXPORT QgsLineString: public QgsCurve double yAt( int index ) const override; /** Returns the z-coordinate of the specified node in the line string. - * @param index index of node, where the first node in the line is 0 - * @returns z-coordinate of node, or 0.0 if index is out of bounds or the line + * \param index index of node, where the first node in the line is 0 + * \returns z-coordinate of node, or 0.0 if index is out of bounds or the line * does not have a z dimension - * @see setZAt() + * \see setZAt() */ double zAt( int index ) const; /** Returns the m value of the specified node in the line string. - * @param index index of node, where the first node in the line is 0 - * @returns m value of node, or 0.0 if index is out of bounds or the line + * \param index index of node, where the first node in the line is 0 + * \returns m value of node, or 0.0 if index is out of bounds or the line * does not have m values - * @see setMAt() + * \see setMAt() */ double mAt( int index ) const; /** Sets the x-coordinate of the specified node in the line string. - * @param index index of node, where the first node in the line is 0. Corresponding + * \param index index of node, where the first node in the line is 0. Corresponding * node must already exist in line string. - * @param x x-coordinate of node - * @see xAt() + * \param x x-coordinate of node + * \see xAt() */ void setXAt( int index, double x ); /** Sets the y-coordinate of the specified node in the line string. - * @param index index of node, where the first node in the line is 0. Corresponding + * \param index index of node, where the first node in the line is 0. Corresponding * node must already exist in line string. - * @param y y-coordinate of node - * @see yAt() + * \param y y-coordinate of node + * \see yAt() */ void setYAt( int index, double y ); /** Sets the z-coordinate of the specified node in the line string. - * @param index index of node, where the first node in the line is 0. Corresponding + * \param index index of node, where the first node in the line is 0. Corresponding * node must already exist in line string, and the line string must have z-dimension. - * @param z z-coordinate of node - * @see zAt() + * \param z z-coordinate of node + * \see zAt() */ void setZAt( int index, double z ); /** Sets the m value of the specified node in the line string. - * @param index index of node, where the first node in the line is 0. Corresponding + * \param index index of node, where the first node in the line is 0. Corresponding * node must already exist in line string, and the line string must have m values. - * @param m m value of node - * @see mAt() + * \param m m value of node + * \see mAt() */ void setMAt( int index, double m ); /** Resets the line string to match the specified list of points. The line string will * inherit the dimensionality of the first point in the list. - * @param points new points for line string. If empty, line string will be cleared. + * \param points new points for line string. If empty, line string will be cleared. */ void setPoints( const QgsPointSequence &points ); /** Appends the contents of another line string to the end of this line string. - * @param line line to append. Ownership is not transferred. + * \param line line to append. Ownership is not transferred. */ void append( const QgsLineString *line ); /** Adds a new vertex to the end of the line string. - * @param pt vertex to add + * \param pt vertex to add */ void addVertex( const QgsPointV2 &pt ); @@ -137,7 +137,7 @@ class CORE_EXPORT QgsLineString: public QgsCurve void close(); /** Returns the geometry converted to the more generic curve type QgsCompoundCurve - @return the converted geometry. Caller takes ownership*/ + \returns the converted geometry. Caller takes ownership*/ QgsAbstractGeometry *toCurveType() const override; /** @@ -172,8 +172,8 @@ class CORE_EXPORT QgsLineString: public QgsCurve /** Returns a new line string geometry corresponding to a segmentized approximation * of the curve. - * @param tolerance segmentation tolerance - * @param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ + * \param tolerance segmentation tolerance + * \param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ virtual QgsLineString *curveToLine( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override; int numPoints() const override; @@ -224,8 +224,8 @@ class CORE_EXPORT QgsLineString: public QgsCurve void importVerticesFromWkb( const QgsConstWkbPtr &wkb ); /** Resets the line string to match the line string in a WKB geometry. - * @param type WKB type - * @param wkb WKB representation of line geometry + * \param type WKB type + * \param wkb WKB representation of line geometry */ void fromWkbPoints( QgsWkbTypes::Type type, const QgsConstWkbPtr &wkb ); diff --git a/src/core/geometry/qgsmultilinestring.h b/src/core/geometry/qgsmultilinestring.h index e914ed91e37d..86399158e4d3 100644 --- a/src/core/geometry/qgsmultilinestring.h +++ b/src/core/geometry/qgsmultilinestring.h @@ -45,7 +45,7 @@ class CORE_EXPORT QgsMultiLineString: public QgsMultiCurve virtual bool addGeometry( QgsAbstractGeometry *g ) override; /** Returns the geometry converted to the more generic curve type QgsMultiCurve - @return the converted geometry. Caller takes ownership*/ + \returns the converted geometry. Caller takes ownership*/ QgsAbstractGeometry *toCurveType() const override; protected: diff --git a/src/core/geometry/qgsmultipolygon.h b/src/core/geometry/qgsmultipolygon.h index 8f6cc3847e47..3c70f947e95b 100644 --- a/src/core/geometry/qgsmultipolygon.h +++ b/src/core/geometry/qgsmultipolygon.h @@ -45,7 +45,7 @@ class CORE_EXPORT QgsMultiPolygonV2: public QgsMultiSurface virtual bool addGeometry( QgsAbstractGeometry *g ) override; /** Returns the geometry converted to the more generic curve type QgsMultiSurface - @return the converted geometry. Caller takes ownership*/ + \returns the converted geometry. Caller takes ownership*/ QgsAbstractGeometry *toCurveType() const override; virtual QgsAbstractGeometry *boundary() const override; diff --git a/src/core/geometry/qgspointv2.h b/src/core/geometry/qgspointv2.h index 3e4444bdc6b3..51612c11a2cc 100644 --- a/src/core/geometry/qgspointv2.h +++ b/src/core/geometry/qgspointv2.h @@ -38,8 +38,8 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry public: /** Construct a 2 dimensional point with an initial x and y coordinate. - * @param x x-coordinate of point - * @param y y-coordinate of point + * \param x x-coordinate of point + * \param y y-coordinate of point */ QgsPointV2( double x = 0.0, double y = 0.0 ); @@ -52,11 +52,11 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry explicit QgsPointV2( QPointF p ); /** Construct a point with a specified type (e.g., PointZ, PointM) and initial x, y, z, and m values. - * @param type point type - * @param x x-coordinate of point - * @param y y-coordinate of point - * @param z z-coordinate of point, for PointZ or PointZM types - * @param m m-value of point, for PointM or PointZM types + * \param type point type + * \param x x-coordinate of point + * \param y y-coordinate of point + * \param z z-coordinate of point, for PointZ or PointZM types + * \param m m-value of point, for PointM or PointZM types */ QgsPointV2( QgsWkbTypes::Type type, double x = 0.0, double y = 0.0, double z = 0.0, double m = 0.0 ); @@ -64,86 +64,86 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry bool operator!=( const QgsPointV2 &pt ) const; /** Returns the point's x-coordinate. - * @see setX() - * @see rx() + * \see setX() + * \see rx() */ double x() const { return mX; } /** Returns the point's y-coordinate. - * @see setY() - * @see ry() + * \see setY() + * \see ry() */ double y() const { return mY; } /** Returns the point's z-coordinate. - * @see setZ() - * @see rz() + * \see setZ() + * \see rz() */ double z() const { return mZ; } /** Returns the point's m value. - * @see setM() - * @see rm() + * \see setM() + * \see rm() */ double m() const { return mM; } /** Returns a reference to the x-coordinate of this point. * Using a reference makes it possible to directly manipulate x in place. - * @see x() - * @see setX() - * @note not available in Python bindings + * \see x() + * \see setX() + * \note not available in Python bindings */ double &rx() { clearCache(); return mX; } /** Returns a reference to the y-coordinate of this point. * Using a reference makes it possible to directly manipulate y in place. - * @see y() - * @see setY() - * @note not available in Python bindings + * \see y() + * \see setY() + * \note not available in Python bindings */ double &ry() { clearCache(); return mY; } /** Returns a reference to the z-coordinate of this point. * Using a reference makes it possible to directly manipulate z in place. - * @see z() - * @see setZ() - * @note not available in Python bindings + * \see z() + * \see setZ() + * \note not available in Python bindings */ double &rz() { clearCache(); return mZ; } /** Returns a reference to the m value of this point. * Using a reference makes it possible to directly manipulate m in place. - * @see m() - * @see setM() - * @note not available in Python bindings + * \see m() + * \see setM() + * \note not available in Python bindings */ double &rm() { clearCache(); return mM; } /** Sets the point's x-coordinate. - * @see x() - * @see rx() + * \see x() + * \see rx() */ void setX( double x ) { clearCache(); mX = x; } /** Sets the point's y-coordinate. - * @see y() - * @see ry() + * \see y() + * \see ry() */ void setY( double y ) { clearCache(); mY = y; } /** Sets the point's z-coordinate. - * @note calling this will have no effect if the point does not contain a z-dimension. Use addZValue() to + * \note calling this will have no effect if the point does not contain a z-dimension. Use addZValue() to * add a z value and force the point to have a z dimension. - * @see z() - * @see rz() + * \see z() + * \see rz() */ void setZ( double z ) { clearCache(); mZ = z; } /** Sets the point's m-value. - * @note calling this will have no effect if the point does not contain a m-dimension. Use addMValue() to + * \note calling this will have no effect if the point does not contain a m-dimension. Use addMValue() to * add a m value and force the point to have an m dimension. - * @see m() - * @see rm() + * \see m() + * \see rm() */ void setM( double m ) { clearCache(); mM = m; } @@ -157,7 +157,7 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry * cases it may be more appropriate to call the faster distanceSquared() method, e.g., * when comparing distances. * \since QGIS 3.0 - * @see distanceSquared() + * \see distanceSquared() */ double distance( double x, double y ) const; @@ -173,7 +173,7 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry * Returns the squared distance between this point a specified x, y coordinate. Calling * this is faster than calling distance(), and may be useful in use cases such as comparing * distances where the extra expense of calling distance() is not required. - * @see distance() + * \see distance() * \since QGIS 3.0 */ double distanceSquared( double x, double y ) const; @@ -182,7 +182,7 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry * Returns the squared distance between this point another point. Calling * this is faster than calling distance(), and may be useful in use cases such as comparing * distances where the extra expense of calling distance() is not required. - * @see distance() + * \see distance() * \since QGIS 3.0 */ double distanceSquared( const QgsPointV2 &other ) const; @@ -192,7 +192,7 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry * cases it may be more appropriate to call the faster distanceSquared() method, e.g., * when comparing distances. * \since QGIS 3.0 - * @see distanceSquared() + * \see distanceSquared() */ double distance3D( double x, double y, double z ) const; @@ -208,7 +208,7 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry * Returns the 3D squared distance between this point a specified x, y, z coordinate. Calling * this is faster than calling distance(), and may be useful in use cases such as comparing * distances where the extra expense of calling distance() is not required. - * @see distance() + * \see distance() * \since QGIS 3.0 */ double distanceSquared3D( double x, double y, double z ) const; @@ -217,7 +217,7 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry * Returns the 3D squared distance between this point another point. Calling * this is faster than calling distance(), and may be useful in use cases such as comparing * distances where the extra expense of calling distance() is not required. - * @see distance() + * \see distance() * \since QGIS 3.0 */ double distanceSquared3D( const QgsPointV2 &other ) const; @@ -231,10 +231,10 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry /** Returns a new point which correspond to this point projected by a specified distance * with specified angles (azimuth and inclination). * M value is preserved. - * @param distance distance to project - * @param azimuth angle to project in X Y, clockwise in degrees starting from north - * @param inclination angle to project in Z (3D) - * @return The point projected. If a 2D point is projected a 3D point will be returned except if + * \param distance distance to project + * \param azimuth angle to project in X Y, clockwise in degrees starting from north + * \param inclination angle to project in Z (3D) + * \returns The point projected. If a 2D point is projected a 3D point will be returned except if * inclination is 90. A 3D point is always returned if a 3D point is projected. * Example: * \code{.py} @@ -318,8 +318,8 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry bool nextVertex( QgsVertexId &id, QgsPointV2 &vertex ) const override; /** Angle undefined. Always returns 0.0 - @param vertex the vertex id - @return 0.0*/ + \param vertex the vertex id + \returns 0.0*/ double vertexAngle( QgsVertexId vertex ) const override { Q_UNUSED( vertex ); return 0.0; } virtual int vertexCount( int /*part*/ = 0, int /*ring*/ = 0 ) const override { return 1; } diff --git a/src/core/geometry/qgspolygon.h b/src/core/geometry/qgspolygon.h index 479aae98f057..fae2c6808848 100644 --- a/src/core/geometry/qgspolygon.h +++ b/src/core/geometry/qgspolygon.h @@ -52,7 +52,7 @@ class CORE_EXPORT QgsPolygonV2: public QgsCurvePolygon QgsPolygonV2 *surfaceToPolygon() const override; /** Returns the geometry converted to the more generic curve type QgsCurvePolygon - @return the converted geometry. Caller takes ownership*/ + \returns the converted geometry. Caller takes ownership*/ QgsAbstractGeometry *toCurveType() const override; void addInteriorRing( QgsCurve *ring ) override; diff --git a/src/core/geometry/qgstriangle.h b/src/core/geometry/qgstriangle.h index f67125a6f571..8242f33a0998 100644 --- a/src/core/geometry/qgstriangle.h +++ b/src/core/geometry/qgstriangle.h @@ -34,25 +34,25 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** Construct a QgsTriangle from three QgsPointV2. * An empty triangle is returned if there are identical points or if the points are collinear. - * @param p1 first point - * @param p2 second point - * @param p3 third point + * \param p1 first point + * \param p2 second point + * \param p3 third point */ QgsTriangle( const QgsPointV2 &p1, const QgsPointV2 &p2, const QgsPointV2 &p3 ); /** Construct a QgsTriangle from three QgsPoint. * An empty triangle is returned if there are identical points or if the points are collinear. - * @param p1 first point - * @param p2 second point - * @param p3 third point + * \param p1 first point + * \param p2 second point + * \param p3 third point */ explicit QgsTriangle( const QgsPoint &p1, const QgsPoint &p2, const QgsPoint &p3 ); /** Construct a QgsTriangle from three QPointF. * An empty triangle is returned if there are identical points or if the points are collinear. - * @param p1 first point - * @param p2 second point - * @param p3 third point + * \param p1 first point + * \param p2 second point + * \param p3 third point */ explicit QgsTriangle( const QPointF p1, const QPointF p2, const QPointF p3 ); @@ -80,7 +80,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 void addInteriorRing( QgsCurve *ring ) override; /** Inherited method not used. You cannot add an interior ring into a triangle. - * @note not available in Python bindings + * \note not available in Python bindings */ void setInteriorRings( const QList< QgsCurve *> &rings ) = delete; //! Inherited method not used. You cannot delete or insert a vertex directly. Returns always false. @@ -97,14 +97,14 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Returns coordinates of a vertex. - * @param atVertex index of the vertex - * @return Coordinates of the vertex or QgsPointV2(0,0) on error (\a atVertex < 0 or > 3). + * \param atVertex index of the vertex + * \returns Coordinates of the vertex or QgsPointV2(0,0) on error (\a atVertex < 0 or > 3). */ QgsPointV2 vertexAt( int atVertex ) const; /** * Returns the three lengths of the triangle. - * @return Lengths of triangle ABC where [AB] is at 0, [BC] is at 1, [CA] is at 2 + * \returns Lengths of triangle ABC where [AB] is at 0, [BC] is at 1, [CA] is at 2 * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -116,7 +116,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Returns the three angles of the triangle. - * @return Angles in radians of triangle ABC where angle BAC is at 0, angle ABC is at 1, angle BCA is at 2 + * \returns Angles in radians of triangle ABC where angle BAC is at 0, angle ABC is at 1, angle BCA is at 2 * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -128,8 +128,8 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Is the triangle isocele (two sides with the same length)? - * @param lengthTolerance The tolerance to use - * @return True or False + * \param lengthTolerance The tolerance to use + * \returns True or False * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -144,8 +144,8 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Is the triangle equilateral (three sides with the same length)? - * @param lengthTolerance The tolerance to use - * @return True or False + * \param lengthTolerance The tolerance to use + * \returns True or False * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 10, 10 ), QgsPointV2( 16, 10 ), QgsPointV2( 13, 15.1962 ) ) @@ -160,8 +160,8 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Is the triangle right-angled? - * @param angleTolerance The tolerance to use - * @return True or False + * \param angleTolerance The tolerance to use + * \returns True or False * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -176,9 +176,9 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Is the triangle scalene (all sides have differen lengths)? - * @param lengthTolerance The tolerance to use - * @return True or False - * @return True or False + * \param lengthTolerance The tolerance to use + * \returns True or False + * \returns True or False * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 7.2825, 4.2368 ), QgsPointV2( 13.0058, 3.3218 ), QgsPointV2( 9.2145, 6.5242 ) ) @@ -193,7 +193,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * An altitude is a segment (defined by a QgsLineString) from a vertex to the opposite side (or, if necessary, to the extension of the opposite side). - * @return Three altitudes from this triangle + * \returns Three altitudes from this triangle * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -205,7 +205,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * A median is a segment (defined by a QgsLineString) from a vertex to the midpoint of the opposite side. - * @return Three medians from this triangle + * \returns Three medians from this triangle * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -217,8 +217,8 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * The segment (defined by a QgsLineString) returned bisect the angle of a vertex to the opposite side. - * @param lengthTolerance The tolerance to use - * @return Three angle bisector from this triangle + * \param lengthTolerance The tolerance to use + * \returns Three angle bisector from this triangle * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -230,7 +230,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Medial (or midpoint) triangle of a triangle ABC is the triangle with vertices at the midpoints of the triangle's sides. - * @return The medial from this triangle + * \returns The medial from this triangle * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -242,8 +242,8 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * An orthocenter is the point of intersection of the altitudes of a triangle. - * @param lengthTolerance The tolerance to use - * @return The orthocenter of the triangle. + * \param lengthTolerance The tolerance to use + * \returns The orthocenter of the triangle. * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -255,7 +255,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Center of the circumscribed circle of the triangle. - * @return The center of the circumscribed circle of the triangle + * \returns The center of the circumscribed circle of the triangle * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -267,7 +267,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Radius of the circumscribed circle of the triangle. - * @return The radius of the circumscribed circle of the triangle + * \returns The radius of the circumscribed circle of the triangle * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -282,7 +282,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Center of the inscribed circle of the triangle. - * @return The center of the inscribed circle of the triangle + * \returns The center of the inscribed circle of the triangle * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -294,7 +294,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Radius of the inscribed circle of the triangle. - * @return The radius of the inscribed circle of the triangle + * \returns The radius of the inscribed circle of the triangle * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -309,12 +309,12 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 private: /** - * @brief Convenient method checking the validity of geometry (no duplicate point(s), no colinearity). - * @param p1 first point - * @param p2 second point - * @param p3 third point - * @return True if the points can create a triangle, otherwise false. - * @note not available in Python bindings + * \brief Convenient method checking the validity of geometry (no duplicate point(s), no colinearity). + * \param p1 first point + * \param p2 second point + * \param p3 third point + * \returns True if the points can create a triangle, otherwise false. + * \note not available in Python bindings */ bool validateGeom( const QgsPointV2 &p1, const QgsPointV2 &p2, const QgsPointV2 &p3 ); diff --git a/src/core/geometry/qgswkbtypes.h b/src/core/geometry/qgswkbtypes.h index 5f761997368f..29424fa70425 100644 --- a/src/core/geometry/qgswkbtypes.h +++ b/src/core/geometry/qgswkbtypes.h @@ -130,7 +130,7 @@ class CORE_EXPORT QgsWkbTypes * The geometry types are used to group QgsWkbTypes::Type in a * coarse way. * - * @see geometryType( QgsWkbTypes::Type ) + * \see geometryType( QgsWkbTypes::Type ) */ enum GeometryType { @@ -142,9 +142,9 @@ class CORE_EXPORT QgsWkbTypes }; /** Returns the single type for a WKB type. For example, for MultiPolygon WKB types the single type would be Polygon. - * @see isSingleType() - * @see multiType() - * @see flatType() + * \see isSingleType() + * \see multiType() + * \see flatType() */ static Type singleType( Type type ) { @@ -285,9 +285,9 @@ class CORE_EXPORT QgsWkbTypes } /** Returns the multi type for a WKB type. For example, for Polygon WKB types the multi type would be MultiPolygon. - * @see isMultiType() - * @see singleType() - * @see flatType() + * \see isMultiType() + * \see singleType() + * \see flatType() */ static Type multiType( Type type ) { @@ -416,8 +416,8 @@ class CORE_EXPORT QgsWkbTypes /** Returns the flat type for a WKB type. This is the WKB type minus any Z or M dimensions. * For example, for PolygonZM WKB types the single type would be Polygon. - * @see singleType() - * @see multiType() + * \see singleType() + * \see multiType() */ static Type flatType( Type type ) { @@ -529,13 +529,13 @@ class CORE_EXPORT QgsWkbTypes } /** Attempts to extract the WKB type from a WKT string. - * @param wktStr a valid WKT string + * \param wktStr a valid WKT string */ static Type parseType( const QString &wktStr ); /** Returns true if the WKB type is a single type. - * @see isMultiType() - * @see singleType() + * \see isMultiType() + * \see singleType() */ static bool isSingleType( Type type ) { @@ -543,8 +543,8 @@ class CORE_EXPORT QgsWkbTypes } /** Returns true if the WKB type is a multi type. - * @see isSingleType() - * @see multiType() + * \see isSingleType() + * \see multiType() */ static bool isMultiType( Type type ) { @@ -612,9 +612,9 @@ class CORE_EXPORT QgsWkbTypes /** Returns the inherent dimension of the geometry type as an integer. Returned value will * always be less than or equal to the coordinate dimension. - * @returns 0 for point geometries, 1 for line geometries, 2 for polygon geometries + * \returns 0 for point geometries, 1 for line geometries, 2 for polygon geometries * Invalid geometry types will return a dimension of 0. - * @see coordDimensions() + * \see coordDimensions() */ static int wkbDimensions( Type type ) { @@ -634,7 +634,7 @@ class CORE_EXPORT QgsWkbTypes * be between 2-4, depending on whether the geometry type contains the Z or M dimensions. * Invalid geometry types will return a dimension of 0. * \since QGIS 2.14 - * @see wkbDimensions() + * \see wkbDimensions() */ static int coordDimensions( Type type ) { @@ -747,9 +747,9 @@ class CORE_EXPORT QgsWkbTypes static QString geometryDisplayString( GeometryType type ); /** Tests whether a WKB type contains the z-dimension. - * @returns true if type has z values - * @see addZ() - * @see hasM() + * \returns true if type has z values + * \see addZ() + * \see hasM() */ static bool hasZ( Type type ) { @@ -796,9 +796,9 @@ class CORE_EXPORT QgsWkbTypes } /** Tests whether a WKB type contains m values. - * @returns true if type has m values - * @see addM() - * @see hasZ() + * \returns true if type has m values + * \see addM() + * \see hasZ() */ static bool hasM( Type type ) { @@ -839,11 +839,11 @@ class CORE_EXPORT QgsWkbTypes } /** Adds the z dimension to a WKB type and returns the new type - * @param type original type + * \param type original type * \since QGIS 2.12 - * @see addM() - * @see dropZ() - * @see hasZ() + * \see addM() + * \see dropZ() + * \see hasZ() */ static Type addZ( Type type ) { @@ -863,11 +863,11 @@ class CORE_EXPORT QgsWkbTypes } /** Adds the m dimension to a WKB type and returns the new type - * @param type original type + * \param type original type * \since QGIS 2.12 - * @see addZ() - * @see dropM() - * @see hasM() + * \see addZ() + * \see dropM() + * \see hasM() */ static Type addM( Type type ) { @@ -894,10 +894,10 @@ class CORE_EXPORT QgsWkbTypes } /** Drops the z dimension (if present) for a WKB type and returns the new type. - * @param type original type + * \param type original type * \since QGIS 2.14 - * @see dropM() - * @see addZ() + * \see dropM() + * \see addZ() */ static Type dropZ( Type type ) { @@ -911,10 +911,10 @@ class CORE_EXPORT QgsWkbTypes } /** Drops the m dimension (if present) for a WKB type and returns the new type. - * @param type original type + * \param type original type * \since QGIS 2.14 - * @see dropZ() - * @see addM() + * \see dropZ() + * \see addM() */ static Type dropM( Type type ) { @@ -929,8 +929,8 @@ class CORE_EXPORT QgsWkbTypes /** * Will convert the 25D version of the flat type if supported or Unknown if not supported. - * @param type The type to convert - * @return the 25D version of the type or Unknown + * \param type The type to convert + * \returns the 25D version of the type or Unknown */ static Type to25D( Type type ) { diff --git a/src/core/gps/info.h b/src/core/gps/info.h index 6d17474add77..3f3976a919ff 100644 --- a/src/core/gps/info.h +++ b/src/core/gps/info.h @@ -64,8 +64,8 @@ typedef struct _nmeaPOS /** * Information about satellite - * @see nmeaSATINFO - * @see nmeaGPGSV + * \see nmeaSATINFO + * \see nmeaGPGSV */ typedef struct _nmeaSATELLITE { @@ -79,8 +79,8 @@ typedef struct _nmeaSATELLITE /** * Information about all satellites in view - * @see nmeaINFO - * @see nmeaGPGSV + * \see nmeaINFO + * \see nmeaGPGSV */ typedef struct _nmeaSATINFO { @@ -93,8 +93,8 @@ typedef struct _nmeaSATINFO /** * Summary GPS information from all parsed packets, * used also for generating NMEA stream - * @see nmea_parse - * @see nmea_GPGGA2info, nmea_...2info + * \see nmea_parse + * \see nmea_GPGGA2info, nmea_...2info */ typedef struct _nmeaINFO { diff --git a/src/core/gps/nmeatime.h b/src/core/gps/nmeatime.h index 73d2beed1843..c3717bc141f6 100644 --- a/src/core/gps/nmeatime.h +++ b/src/core/gps/nmeatime.h @@ -38,7 +38,7 @@ extern "C" /** * Date and time data - * @see nmea_time_now + * \see nmea_time_now */ typedef struct _nmeaTIME { diff --git a/src/core/gps/qextserialport/qextserialenumerator.h b/src/core/gps/qextserialport/qextserialenumerator.h index fcdeb652cd37..d87ae20caa53 100644 --- a/src/core/gps/qextserialport/qextserialenumerator.h +++ b/src/core/gps/qextserialport/qextserialenumerator.h @@ -117,7 +117,7 @@ Q_OBJECT * Get value of specified property from the registry. * \param key handle to an open key. * \param property property name. - * \return property value. + * \returns property value. */ static QString getRegKeyValue(HKEY key, LPCTSTR property); @@ -128,7 +128,7 @@ Q_OBJECT * \param devData pointer to an SP_DEVINFO_DATA structure that defines the device instance. * this is returned by SetupDiGetDeviceInterfaceDetail() function. * \param property registry property. One of defined SPDRP_* constants. - * \return property string. + * \returns property string. */ static QString getDeviceProperty(HDEVINFO devInfo, PSP_DEVINFO_DATA devData, DWORD property); @@ -178,7 +178,7 @@ Q_OBJECT public: /*! Get list of ports. - \return list of ports currently available in the system. + \returns list of ports currently available in the system. */ static QList getPorts(); /*! diff --git a/src/core/gps/qextserialport/qextserialport.h b/src/core/gps/qextserialport/qextserialport.h index dee04bf8bf3c..142c9d1ada29 100644 --- a/src/core/gps/qextserialport/qextserialport.h +++ b/src/core/gps/qextserialport/qextserialport.h @@ -200,7 +200,7 @@ class QextSerialPort: public QIODevice /**! * Get query mode. - * \return query mode. + * \returns query mode. */ inline QueryMode queryMode() const { return _queryMode; } diff --git a/src/core/gps/qgsgpsconnection.h b/src/core/gps/qgsgpsconnection.h index 0b92a746dbcd..e8e5b7c93411 100644 --- a/src/core/gps/qgsgpsconnection.h +++ b/src/core/gps/qgsgpsconnection.h @@ -74,7 +74,7 @@ class CORE_EXPORT QgsGPSConnection : public QObject }; /** Constructor - @param dev input device for the connection (e.g. serial device). The class takes ownership of the object + \param dev input device for the connection (e.g. serial device). The class takes ownership of the object */ QgsGPSConnection( QIODevice *dev ); virtual ~QgsGPSConnection(); diff --git a/src/core/gps/qgsqtlocationconnection.h b/src/core/gps/qgsqtlocationconnection.h index a7ea21125787..343223191caa 100644 --- a/src/core/gps/qgsqtlocationconnection.h +++ b/src/core/gps/qgsqtlocationconnection.h @@ -55,17 +55,17 @@ class CORE_EXPORT QgsQtLocationConnection: public QgsGPSConnection void parseData(); /** Called when the position updated. - * @note not available in Python binding + * \note not available in Python binding */ void positionUpdated( const QGeoPositionInfo &info ); /** Called when the number of satellites in view is updated. - * @note not available in Python bindings on android + * \note not available in Python bindings on android */ void satellitesInViewUpdated( const QList &satellites ); /** Called when the number of satellites in use is updated. - * @note not available in Python bindings on android + * \note not available in Python bindings on android */ void satellitesInUseUpdated( const QList &satellites ); diff --git a/src/core/layertree/qgslayertree.h b/src/core/layertree/qgslayertree.h index f15e1de0e452..adb082ef6dd9 100644 --- a/src/core/layertree/qgslayertree.h +++ b/src/core/layertree/qgslayertree.h @@ -58,7 +58,7 @@ class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup * Cast node to a group. No type checking is done - use isGroup() to find out whether this operation is legal. * * \since QGIS 2.4 - * @note Not available in Python bindings, because cast is automatic. + * \note Not available in Python bindings, because cast is automatic. */ static inline QgsLayerTreeGroup *toGroup( QgsLayerTreeNode *node ) { @@ -69,7 +69,7 @@ class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup * Cast node to a layer. No type checking is done - use isLayer() to find out whether this operation is legal. * * \since QGIS 2.4 - * @note Not available in Python bindings, because cast is automatic. + * \note Not available in Python bindings, because cast is automatic. */ static inline QgsLayerTreeLayer *toLayer( QgsLayerTreeNode *node ) { @@ -80,7 +80,7 @@ class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup * Cast node to a layer. No type checking is done - use isLayer() to find out whether this operation is legal. * * \since QGIS 2.4 - * @note Not available in Python bindings, because cast is automatic. + * \note Not available in Python bindings, because cast is automatic. */ static inline const QgsLayerTreeLayer *toLayer( const QgsLayerTreeNode *node ) { @@ -102,9 +102,9 @@ class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup * Will only be used if the property hasCustomLayerOrder is true. * If you need the current layer order that is active, prefer using layerOrder(). * - * @see setCustomLayerOrder - * @see layerOrder - * @see hasCustomLayerOrder + * \see setCustomLayerOrder + * \see layerOrder + * \see hasCustomLayerOrder * * \since QGIS 3.0 */ @@ -115,9 +115,9 @@ class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup * Will only be used if the property hasCustomLayerOrder is true. * If you need the current layer order that is active, prefer using layerOrder(). * - * @see customLayerOrder - * @see layerOrder - * @see hasCustomLayerOrder + * \see customLayerOrder + * \see layerOrder + * \see hasCustomLayerOrder * * \since QGIS 3.0 */ @@ -128,9 +128,9 @@ class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup * Will only be used if the property hasCustomLayerOrder is true. * If you need the current layer order that is active, prefer using layerOrder(). * - * @see customLayerOrder - * @see layerOrder - * @see hasCustomLayerOrder + * \see customLayerOrder + * \see layerOrder + * \see hasCustomLayerOrder * * \since QGIS 3.0 */ @@ -142,7 +142,7 @@ class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup * customLayerOrder or the layer order derived from the tree. * This property is read only. * - * @see customLayerOrder + * \see customLayerOrder * * \since QGIS 3.0 */ @@ -152,7 +152,7 @@ class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup * Determines if the layer order should be derived from the layer tree * or if a custom override order shall be used instead. * - * @see customLayerOrder + * \see customLayerOrder * * \since QGIS 3.0 */ @@ -162,7 +162,7 @@ class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup * Determines if the layer order should be derived from the layer tree * or if a custom override order shall be used instead. * - * @see setCustomLayerOrder + * \see setCustomLayerOrder * * \since QGIS 3.0 */ @@ -216,7 +216,7 @@ class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup /** * Emitted when the hasCustomLayerOrder flag changes. * - * @see hasCustomLayerOrder + * \see hasCustomLayerOrder * * \since QGIS 3.0 */ diff --git a/src/core/layertree/qgslayertreemodel.h b/src/core/layertree/qgslayertreemodel.h index 7846cfaa3f7d..5100c795296e 100644 --- a/src/core/layertree/qgslayertreemodel.h +++ b/src/core/layertree/qgslayertreemodel.h @@ -48,7 +48,7 @@ class QgsLayerTree; * Behavior of the model can be customized with flags. For example, whether to show legend or * whether to allow changes to the layer tree. * - * @see QgsLayerTreeView + * \see QgsLayerTreeView * \since QGIS 2.4 */ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel @@ -127,12 +127,12 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel //! (by default it returns also legend node embedded in parent layer node (if any) unless skipNodeEmbeddedInParent is true) //! \since QGIS 2.6 //! \note Parameter skipNodeEmbeddedInParent added in QGIS 2.18 - //! @see layerOriginalLegendNodes() + //! \see layerOriginalLegendNodes() QList layerLegendNodes( QgsLayerTreeLayer *nodeLayer, bool skipNodeEmbeddedInParent = false ); //! Return original (unfiltered) list of legend nodes attached to a particular layer node //! \since QGIS 2.14 - //! @see layerLegendNodes() + //! \see layerLegendNodes() QList layerOriginalLegendNodes( QgsLayerTreeLayer *nodeLayer ); //! Return legend node that may be embedded in parent (i.e. its icon will be used for layer's icon). @@ -141,9 +141,9 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel /** Searches through the layer tree to find a legend node with a matching layer ID * and rule key. - * @param layerId map layer ID - * @param ruleKey legend node rule key - * @returns QgsLayerTreeModelLegendNode if found + * \param layerId map layer ID + * \param ruleKey legend node rule key + * \returns QgsLayerTreeModelLegendNode if found * \since QGIS 2.14 */ QgsLayerTreeModelLegendNode *findLegendNode( const QString &layerId, const QString &ruleKey ) const; @@ -186,10 +186,10 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel void setLegendFilterByMap( const QgsMapSettings *settings ); //! Filter display of legend nodes for given map settings - //! @param settings Map settings. Setting a null pointer or invalid settings will disable any filter. Ownership is not changed, a copy is made - //! @param useExtent Whether to use the extent of the map settings as a first spatial filter on legend nodes - //! @param polygon If not empty, this polygon will be used instead of the map extent to filter legend nodes - //! @param useExpressions Whether to use legend node filter expressions + //! \param settings Map settings. Setting a null pointer or invalid settings will disable any filter. Ownership is not changed, a copy is made + //! \param useExtent Whether to use the extent of the map settings as a first spatial filter on legend nodes + //! \param polygon If not empty, this polygon will be used instead of the map extent to filter legend nodes + //! \param useExpressions Whether to use legend node filter expressions //! \since QGIS 2.14 void setLegendFilter( const QgsMapSettings *settings, bool useExtent = true, const QgsGeometry &polygon = QgsGeometry(), bool useExpressions = true ); @@ -291,7 +291,7 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel //! 1. tree legend representation is enabled in model (ShowLegendAsTree flag) //! 2. some legend nodes have non-null parent rule key (accessible via data(ParentRuleKeyRole) method) //! The tree structure (parents and children of each node) is extracted by analyzing nodes' parent rules. - //! @note not available in Python bindings + //! \note not available in Python bindings struct LayerLegendTree { //! Pointer to parent for each active node. Top-level nodes have null parent. Pointers are not owned. @@ -301,7 +301,7 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel }; //! Structure that stores all data associated with one map layer - //! @note not available in Python bindings + //! \note not available in Python bindings struct LayerLegendData { LayerLegendData() @@ -324,7 +324,7 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel LayerLegendTree *tree = nullptr; }; - //! @note not available in Python bindings + //! \note not available in Python bindings LayerLegendTree *tryBuildLegendTree( const QList &nodes ); //! Overrides of map layers' styles: key = layer ID, value = style XML. diff --git a/src/core/layertree/qgslayertreemodellegendnode.h b/src/core/layertree/qgslayertreemodellegendnode.h index 183e702dbff4..17d17b6594ca 100644 --- a/src/core/layertree/qgslayertreemodellegendnode.h +++ b/src/core/layertree/qgslayertreemodellegendnode.h @@ -104,19 +104,19 @@ class CORE_EXPORT QgsLayerTreeModelLegendNode : public QObject /** * Draws symbol on the left side of the item - * @param settings Legend layout configuration - * @param ctx Context for rendering - may be null if only doing layout without actual rendering - * @param itemHeight Minimal height of the legend item - used for correct positioning when rendering - * @return Real size of the symbol (may be bigger than "normal" symbol size from settings) + * \param settings Legend layout configuration + * \param ctx Context for rendering - may be null if only doing layout without actual rendering + * \param itemHeight Minimal height of the legend item - used for correct positioning when rendering + * \returns Real size of the symbol (may be bigger than "normal" symbol size from settings) */ virtual QSizeF drawSymbol( const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight ) const; /** * Draws label on the right side of the item - * @param settings Legend layout configuration - * @param ctx Context for rendering - may be null if only doing layout without actual rendering - * @param symbolSize Real size of the associated symbol - used for correct positioning when rendering - * @return Size of the label (may span multiple lines) + * \param settings Legend layout configuration + * \param ctx Context for rendering - may be null if only doing layout without actual rendering + * \param symbolSize Real size of the associated symbol - used for correct positioning when rendering + * \returns Size of the label (may span multiple lines) */ virtual QSizeF drawSymbolText( const QgsLegendSettings &settings, ItemContext *ctx, QSizeF symbolSize ) const; @@ -187,15 +187,15 @@ class CORE_EXPORT QgsSymbolLegendNode : public QgsLayerTreeModelLegendNode QSize minimumIconSize( QgsRenderContext *context ) const; /** Returns the symbol used by the legend node. - * @see setSymbol() + * \see setSymbol() * \since QGIS 2.14 */ const QgsSymbol *symbol() const; /** Sets the symbol to be used by the legend node. The symbol change is also propagated * to the associated vector layer's renderer. - * @param symbol new symbol for node. Ownership is transferred. - * @see symbol() + * \param symbol new symbol for node. Ownership is transferred. + * \see symbol() * \since QGIS 2.14 */ void setSymbol( QgsSymbol *symbol ); @@ -204,13 +204,13 @@ class CORE_EXPORT QgsSymbolLegendNode : public QgsLayerTreeModelLegendNode /** Checks all items belonging to the same layer as this node. * \since QGIS 2.14 - * @see uncheckAllItems() + * \see uncheckAllItems() */ void checkAllItems(); /** Unchecks all items belonging to the same layer as this node. * \since QGIS 2.14 - * @see checkAllItems() + * \see checkAllItems() */ void uncheckAllItems(); @@ -231,7 +231,7 @@ class CORE_EXPORT QgsSymbolLegendNode : public QgsLayerTreeModelLegendNode QgsRenderContext *createTemporaryRenderContext() const; /** Sets all items belonging to the same layer as this node to the same check state. - * @param state check state + * \param state check state */ void checkAll( bool state ); }; @@ -314,8 +314,8 @@ class CORE_EXPORT QgsWmsLegendNode : public QgsLayerTreeModelLegendNode public: /** Constructor for QgsWmsLegendNode. - * @param nodeLayer layer node - * @param parent parent object + * \param nodeLayer layer node + * \param parent parent object */ QgsWmsLegendNode( QgsLayerTreeLayer *nodeLayer, QObject *parent = nullptr ); diff --git a/src/core/layertree/qgslayertreenode.h b/src/core/layertree/qgslayertreenode.h index d2c648cf4845..ed5e1f960443 100644 --- a/src/core/layertree/qgslayertreenode.h +++ b/src/core/layertree/qgslayertreenode.h @@ -63,7 +63,7 @@ class QgsMapLayer; * - "legend/..." - properties for legend appearance customization * - "expandedLegendNodes" - list of layer's legend nodes' rules in expanded state * - * @see also QgsLayerTree, QgsLayerTreeLayer, QgsLayerTreeGroup + * \see also QgsLayerTree, QgsLayerTreeLayer, QgsLayerTreeGroup * \since QGIS 2.4 */ class CORE_EXPORT QgsLayerTreeNode : public QObject diff --git a/src/core/layertree/qgslayertreeutils.h b/src/core/layertree/qgslayertreeutils.h index 9bbe09e156c8..5cb858ea78da 100644 --- a/src/core/layertree/qgslayertreeutils.h +++ b/src/core/layertree/qgslayertreeutils.h @@ -63,7 +63,7 @@ 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 + //! \note not available in Python bindings static void updateEmbeddedGroupsProjectPath( QgsLayerTreeGroup *group, const QgsProject *project ); //! get invisible layers @@ -77,10 +77,10 @@ class CORE_EXPORT QgsLayerTreeUtils static bool hasLegendFilterExpression( const QgsLayerTreeGroup &group ); //! Insert a QgsMapLayer just below another one - //! @param group the tree group where layers are (can be the root group) - //! @param refLayer the reference layer - //! @param layerToInsert the new layer to insert just below the reference layer - //! @returns the new tree layer + //! \param group the tree group where layers are (can be the root group) + //! \param refLayer the reference layer + //! \param layerToInsert the new layer to insert just below the reference layer + //! \returns the new tree layer static QgsLayerTreeLayer *insertLayerBelow( QgsLayerTreeGroup *group, const QgsMapLayer *refLayer, QgsMapLayer *layerToInsert ); }; diff --git a/src/core/pal/feature.h b/src/core/pal/feature.h index 8caa98905e8a..49e54deea408 100644 --- a/src/core/pal/feature.h +++ b/src/core/pal/feature.h @@ -95,8 +95,8 @@ namespace pal public: /** Creates a new generic feature. - * @param lf a pointer for a feature which contains the spatial entites - * @param geom a pointer to a GEOS geometry + * \param lf a pointer for a feature which contains the spatial entites + * \param geom a pointer to a GEOS geometry */ FeaturePart( QgsLabelFeature *lf, const GEOSGeometry *geom ); @@ -124,93 +124,93 @@ namespace pal * \param bboxMax max values of the map extent * \param mapShape generate candidates for this spatial entity * \param candidates index for candidates - * \return the number of candidates generated in lPos + * \returns the number of candidates generated in lPos */ int createCandidates( QList &lPos, double bboxMin[2], double bboxMax[2], PointSet *mapShape, RTree *candidates ); /** Generate candidates for point feature, located around a specified point. - * @param x x coordinate of the point - * @param y y coordinate of the point - * @param lPos pointer to an array of candidates, will be filled by generated candidates - * @param angle orientation of the label - * @returns the number of generated candidates + * \param x x coordinate of the point + * \param y y coordinate of the point + * \param lPos pointer to an array of candidates, will be filled by generated candidates + * \param angle orientation of the label + * \returns the number of generated candidates */ int createCandidatesAroundPoint( double x, double y, QList &lPos, double angle ); /** Generate one candidate over or offset the specified point. - * @param x x coordinate of the point - * @param y y coordinate of the point - * @param lPos pointer to an array of candidates, will be filled by generated candidate - * @param angle orientation of the label - * @returns the number of generated candidates (always 1) + * \param x x coordinate of the point + * \param y y coordinate of the point + * \param lPos pointer to an array of candidates, will be filled by generated candidate + * \param angle orientation of the label + * \returns the number of generated candidates (always 1) */ int createCandidatesOverPoint( double x, double y, QList &lPos, double angle ); /** Generates candidates following a prioritized list of predefined positions around a point. - * @param x x coordinate of the point - * @param y y coordinate of the point - * @param lPos pointer to an array of candidates, will be filled by generated candidate - * @param angle orientation of the label - * @returns the number of generated candidates + * \param x x coordinate of the point + * \param y y coordinate of the point + * \param lPos pointer to an array of candidates, will be filled by generated candidate + * \param angle orientation of the label + * \returns the number of generated candidates */ int createCandidatesAtOrderedPositionsOverPoint( double x, double y, QList &lPos, double angle ); /** Generate candidates for line feature. - * @param lPos pointer to an array of candidates, will be filled by generated candidates - * @param mapShape a pointer to the line - * @returns the number of generated candidates + * \param lPos pointer to an array of candidates, will be filled by generated candidates + * \param mapShape a pointer to the line + * \returns the number of generated candidates */ int createCandidatesAlongLine( QList &lPos, PointSet *mapShape ); /** Generate candidates for line feature, by trying to place candidates towards the middle of the longest * straightish segments of the line. Segments closer to horizontal are preferred over vertical segments. - * @param lPos pointer to an array of candidates, will be filled by generated candidates - * @param mapShape a pointer to the line - * @returns the number of generated candidates + * \param lPos pointer to an array of candidates, will be filled by generated candidates + * \param mapShape a pointer to the line + * \returns the number of generated candidates */ int createCandidatesAlongLineNearStraightSegments( QList &lPos, PointSet *mapShape ); /** Generate candidates for line feature, by trying to place candidates as close as possible to the line's midpoint. * Candidates can "cut corners" if it helps them place near this mid point. - * @param lPos pointer to an array of candidates, will be filled by generated candidates - * @param mapShape a pointer to the line - * @param initialCost initial cost for candidates generated using this method. If set, cost can be increased + * \param lPos pointer to an array of candidates, will be filled by generated candidates + * \param mapShape a pointer to the line + * \param initialCost initial cost for candidates generated using this method. If set, cost can be increased * by a preset amount. - * @returns the number of generated candidates + * \returns the number of generated candidates */ int createCandidatesAlongLineNearMidpoint( QList &lPos, PointSet *mapShape, double initialCost = 0.0 ); /** Returns the label position for a curved label at a specific offset along a path. - * @param path_positions line path to place label on - * @param path_distances array of distances to each segment on path - * @param orientation can be 0 for automatic calculation of orientation, or -1/+1 for a specific label orientation - * @param index - * @param distance distance to offset label along curve by - * @param reversed if true label is reversed from lefttoright to righttoleft - * @param flip if true label is placed on the other side of the line - * @returns calculated label position + * \param path_positions line path to place label on + * \param path_distances array of distances to each segment on path + * \param orientation can be 0 for automatic calculation of orientation, or -1/+1 for a specific label orientation + * \param index + * \param distance distance to offset label along curve by + * \param reversed if true label is reversed from lefttoright to righttoleft + * \param flip if true label is placed on the other side of the line + * \returns calculated label position */ LabelPosition *curvedPlacementAtOffset( PointSet *path_positions, double *path_distances, int &orientation, int index, double distance, bool &reversed, bool &flip ); /** Generate curved candidates for line features. - * @param lPos pointer to an array of candidates, will be filled by generated candidates - * @param mapShape a pointer to the line - * @returns the number of generated candidates + * \param lPos pointer to an array of candidates, will be filled by generated candidates + * \param mapShape a pointer to the line + * \returns the number of generated candidates */ int createCurvedCandidatesAlongLine( QList &lPos, PointSet *mapShape ); /** Generate candidates for polygon features. * \param lPos pointer to an array of candidates, will be filled by generated candidates * \param mapShape a pointer to the polygon - * \return the number of generated candidates + * \returns the number of generated candidates */ int createCandidatesForPolygon( QList &lPos, PointSet *mapShape ); /** Tests whether this feature part belongs to the same QgsLabelFeature as another * feature part. - * @param part part to compare to - * @returns true if both parts belong to same QgsLabelFeature + * \param part part to compare to + * \returns true if both parts belong to same QgsLabelFeature */ bool hasSameLabelFeatureAs( FeaturePart *part ) const; @@ -266,8 +266,8 @@ namespace pal /** Calculates the priority for the feature. This will be the feature's priority if set, * otherwise the layer's default priority. - * @see Feature::setPriority - * @see Feature::priority + * \see Feature::setPriority + * \see Feature::priority */ double calculatePriority() const; diff --git a/src/core/pal/geomfunction.h b/src/core/pal/geomfunction.h index cf9d43ad960d..4234203111d2 100644 --- a/src/core/pal/geomfunction.h +++ b/src/core/pal/geomfunction.h @@ -81,7 +81,7 @@ namespace pal * \param y y coordinates * \param n Size of subset (vector id) * \param cHull returns the point id (id of id's vector...) whom are parts of the convex hull - * \return convexHull's size + * \returns convexHull's size */ static int convexHullId( int *id, const double *const x, const double *const y, int n, int *&cHull ); @@ -103,13 +103,13 @@ namespace pal static int reorderPolygon( int nbPoints, double *x, double *y ); /** Returns true if a GEOS prepared geometry totally contains a label candidate. - * @param geom GEOS prepared geometry - * @param x candidate x - * @param y candidate y - * @param width candidate width - * @param height candidate height - * @param alpha candidate angle - * @returns true if candidate is totally contained + * \param geom GEOS prepared geometry + * \param x candidate x + * \param y candidate y + * \param width candidate width + * \param height candidate height + * \param alpha candidate angle + * \returns true if candidate is totally contained */ static bool containsCandidate( const GEOSPreparedGeometry *geom, double x, double y, double width, double height, double alpha ); diff --git a/src/core/pal/labelposition.h b/src/core/pal/labelposition.h index 43c351b58161..b616cc4619b7 100644 --- a/src/core/pal/labelposition.h +++ b/src/core/pal/labelposition.h @@ -121,7 +121,7 @@ namespace pal * \brief Check whether or not this overlap with another labelPosition * * \param ls other labelposition - * \return true or false + * \returns true or false */ bool isInConflict( LabelPosition *ls ); @@ -150,13 +150,13 @@ namespace pal void offsetPosition( double xOffset, double yOffset ); /** \brief return id - * \return id + * \returns id */ int getId() const; /** \brief return the feature corresponding to this labelposition - * \return the feature + * \returns the feature */ FeaturePart *getFeaturePart(); @@ -175,25 +175,25 @@ namespace pal } /** Returns the candidate label position's geographical cost. - * @see setCost + * \see setCost */ double cost() const { return mCost; } /** Sets the candidate label position's geographical cost. - * @param newCost new cost for position - * @see cost + * \param newCost new cost for position + * \see cost */ void setCost( double newCost ) { mCost = newCost; } /** Sets whether the position is marked as conflicting with an obstacle feature. - * @param conflicts set to true to mark candidate as being in conflict - * @note This method applies to all label parts for the candidate position. - * @see conflictsWithObstacle + * \param conflicts set to true to mark candidate as being in conflict + * \note This method applies to all label parts for the candidate position. + * \see conflictsWithObstacle */ void setConflictsWithObstacle( bool conflicts ); /** Returns whether the position is marked as conflicting with an obstacle feature. - * @see setConflictsWithObstacle + * \see setConflictsWithObstacle */ bool conflictsWithObstacle() const { return mHasObstacleConflict; } @@ -202,13 +202,13 @@ namespace pal /** * \brief get the down-left x coordinate - * \return x coordinate + * \returns x coordinate */ double getX( int i = 0 ) const; /** * \brief get the down-left y coordinate - * \return y coordinate + * \returns y coordinate */ double getY( int i = 0 ) const; @@ -217,7 +217,7 @@ namespace pal /** * \brief get alpha - * \return alpha to rotate text (in rad) + * \returns alpha to rotate text (in rad) */ double getAlpha() const; bool getReversed() const { return reversed; } @@ -311,7 +311,7 @@ namespace pal int partCount() const; /** Calculates the polygon intersection cost for a single label position part - * @returns double between 0 - 12 + * \returns double between 0 - 12 */ double polygonIntersectionCostForParts( PointSet *polygon ) const; diff --git a/src/core/pal/layer.h b/src/core/pal/layer.h index dbab2fcc6a4d..6c99b73a755f 100644 --- a/src/core/pal/layer.h +++ b/src/core/pal/layer.h @@ -91,7 +91,7 @@ namespace pal QString name() const { return mName; } /** Returns the layer's arrangement policy. - * @see setArrangement + * \see setArrangement */ QgsPalLayerSettings::Placement arrangement() const { return mArrangement; } @@ -100,19 +100,19 @@ namespace pal bool isCurved() const { return mArrangement == QgsPalLayerSettings::Curved || mArrangement == QgsPalLayerSettings::PerimeterCurved; } /** Sets the layer's arrangement policy. - * @param arrangement arrangement policy - * @see arrangement + * \param arrangement arrangement policy + * \see arrangement */ void setArrangement( QgsPalLayerSettings::Placement arrangement ) { mArrangement = arrangement; } /** Returns the layer's arrangement flags. - * @see setArrangementFlags + * \see setArrangementFlags */ LineArrangementFlags arrangementFlags() const { return mArrangementFlags; } /** Sets the layer's arrangement flags. - * @param flags arrangement flags - * @see arrangementFlags + * \param flags arrangement flags + * \see arrangementFlags */ void setArrangementFlags( LineArrangementFlags flags ) { mArrangementFlags = flags; } @@ -123,99 +123,99 @@ namespace pal * deactivated then feature of this layer will not be used for either * labeling or as obstacles. * - * @param active set to true to make the layer active, or false to deactivate the layer - * @see active + * \param active set to true to make the layer active, or false to deactivate the layer + * \see active */ void setActive( bool active ) { mActive = active; } /** Returns whether the layer is currently active. - * @see setActive + * \see setActive */ bool active() const { return mActive; } /** Sets whether the layer will be labeled. - * @note Layers are labelled if and only if labelLayer and active are true - * @param toLabel set to false disable labeling this layer - * @see labelLayer - * @see setActive + * \note Layers are labelled if and only if labelLayer and active are true + * \param toLabel set to false disable labeling this layer + * \see labelLayer + * \see setActive */ void setLabelLayer( bool toLabel ) { mLabelLayer = toLabel; } /** Returns whether the layer will be labeled or not. - * @see setLabelLayer + * \see setLabelLayer */ bool labelLayer() const { return mLabelLayer; } /** Returns the obstacle type, which controls how features within the layer * act as obstacles for labels. - * @see setObstacleType + * \see setObstacleType */ QgsPalLayerSettings::ObstacleType obstacleType() const { return mObstacleType; } /** Sets the obstacle type, which controls how features within the layer * act as obstacles for labels. - * @param obstacleType new obstacle type - * @see obstacleType + * \param obstacleType new obstacle type + * \see obstacleType */ void setObstacleType( QgsPalLayerSettings::ObstacleType obstacleType ) { mObstacleType = obstacleType; } /** Sets the layer's priority. - * @param priority layer priority, between 0 and 1. 0 corresponds to highest priority, + * \param priority layer priority, between 0 and 1. 0 corresponds to highest priority, * 1 to lowest priority. - * @see priority + * \see priority */ void setPriority( double priority ); /** Returns the layer's priority, between 0 and 1. 0 corresponds to highest priority, * 1 to lowest priority. - * @see setPriority + * \see setPriority */ double priority() const { return mDefaultPriority; } /** Sets the layer's labeling mode. - * @param mode label mode - * @see labelMode + * \param mode label mode + * \see labelMode */ void setLabelMode( LabelMode mode ) { mMode = mode; } /** Returns the layer's labeling mode. - * @see setLabelMode + * \see setLabelMode */ LabelMode labelMode() const { return mMode; } /** Sets whether connected lines should be merged before labeling - * @param merge set to true to merge connected lines - * @see mergeConnectedLines + * \param merge set to true to merge connected lines + * \see mergeConnectedLines */ void setMergeConnectedLines( bool merge ) { mMergeLines = merge; } /** Returns whether connected lines will be merged before labeling. - * @see setMergeConnectedLines + * \see setMergeConnectedLines */ bool mergeConnectedLines() const { return mMergeLines; } /** Sets how upside down labels will be handled within the layer. - * @param ud upside down label handling mode - * @see upsideDownLabels + * \param ud upside down label handling mode + * \see upsideDownLabels */ void setUpsidedownLabels( UpsideDownLabels ud ) { mUpsidedownLabels = ud; } /** Returns how upside down labels are handled within the layer. - * @see setUpsidedownLabels + * \see setUpsidedownLabels */ UpsideDownLabels upsidedownLabels() const { return mUpsidedownLabels; } /** Sets whether labels placed at the centroid of features within the layer * are forced to be placed inside the feature's geometry. - * @param forceInside set to true to force centroid labels to be within the + * \param forceInside set to true to force centroid labels to be within the * feature. If set to false then the centroid may fall outside the feature. - * @see centroidInside + * \see centroidInside */ void setCentroidInside( bool forceInside ) { mCentroidInside = forceInside; } /** Returns whether labels placed at the centroid of features within the layer * are forced to be placed inside the feature's geometry. - * @see setCentroidInside + * \see setCentroidInside */ bool centroidInside() const { return mCentroidInside; } @@ -223,9 +223,9 @@ namespace pal * * Does not take ownership of the label feature (it is owned by its provider). * - * @throws PalException::FeatureExists + * \throws PalException::FeatureExists * - * @return true on success (i.e. valid geometry) + * \returns true on success (i.e. valid geometry) */ bool registerFeature( QgsLabelFeature *label ); @@ -234,7 +234,7 @@ namespace pal /** Returns the connected feature ID for a label feature ID, which is unique for all features * which have been joined as a result of joinConnectedFeatures() - * @returns connected feature ID, or -1 if feature was not joined + * \returns connected feature ID, or -1 if feature was not joined */ int connectedFeatureId( QgsFeatureId featureId ) const; @@ -286,14 +286,14 @@ namespace pal /** * \brief Create a new layer * - * @param provider Associated provider - * @param name Name of the layer (for stats, debugging - does not need to be unique) - * @param arrangement Arrangement mode : how to place candidates - * @param defaultPriority layer's prioriry (0 is the best, 1 the worst) - * @param active is the layer is active (currently displayed) - * @param toLabel the layer will be labeled whether toLablel is true - * @param pal pointer to the pal object - * @param displayAll if true, all features will be labelled even though overlaps occur + * \param provider Associated provider + * \param name Name of the layer (for stats, debugging - does not need to be unique) + * \param arrangement Arrangement mode : how to place candidates + * \param defaultPriority layer's prioriry (0 is the best, 1 the worst) + * \param active is the layer is active (currently displayed) + * \param toLabel the layer will be labeled whether toLablel is true + * \param pal pointer to the pal object + * \param displayAll if true, all features will be labelled even though overlaps occur * */ Layer( QgsAbstractLabelProvider *provider, const QString &name, QgsPalLayerSettings::Placement arrangement, double defaultPriority, bool active, bool toLabel, Pal *pal, bool displayAll = false ); diff --git a/src/core/pal/pal.h b/src/core/pal/pal.h index e6374d8ac70e..df875463946b 100644 --- a/src/core/pal/pal.h +++ b/src/core/pal/pal.h @@ -105,15 +105,15 @@ namespace pal /** * \brief add a new layer * - * @param provider Provider associated with the layer - * @param layerName layer's name - * @param arrangement Howto place candidates - * @param defaultPriority layer's prioriry (0 is the best, 1 the worst) - * @param active is the layer is active (currently displayed) - * @param toLabel the layer will be labeled only if toLablel is true - * @param displayAll if true, all features will be labelled even though overlaps occur + * \param provider Provider associated with the layer + * \param layerName layer's name + * \param arrangement Howto place candidates + * \param defaultPriority layer's prioriry (0 is the best, 1 the worst) + * \param active is the layer is active (currently displayed) + * \param toLabel the layer will be labeled only if toLablel is true + * \param displayAll if true, all features will be labelled even though overlaps occur * - * @throws PalException::LayerExists + * \throws PalException::LayerExists * * @todo add symbolUnit */ @@ -122,7 +122,7 @@ namespace pal /** * \brief remove a layer * - * @param layer layer to remove + * \param layer layer to remove */ void removeLayer( Layer *layer ); @@ -130,11 +130,11 @@ namespace pal * \brief the labeling machine * Will extract all active layers * - * @param bbox map extent - * @param stats A PalStat object (can be NULL) - * @param displayAll if true, all feature will be labelled even though overlaps occur + * \param bbox map extent + * \param stats A PalStat object (can be NULL) + * \param displayAll if true, all feature will be labelled even though overlaps occur * - * @return A list of label to display on map + * \returns A list of label to display on map */ QList *labeller( double bbox[4], PalStat **stats, bool displayAll ); @@ -153,14 +153,14 @@ namespace pal /** *\brief Set flag show partial label * - * @param show flag value + * \param show flag value */ void setShowPartial( bool show ); /** * \brief Get flag show partial label * - * @return value of flag + * \returns value of flag */ bool getShowPartial(); @@ -168,7 +168,7 @@ namespace pal * \brief set # candidates to generate for points features * Higher the value is, longer Pal::labeller will spend time * - * @param point_p # candidates for a point + * \param point_p # candidates for a point */ void setPointP( int point_p ); @@ -176,7 +176,7 @@ namespace pal * \brief set maximum # candidates to generate for lines features * Higher the value is, longer Pal::labeller will spend time * - * @param line_p maximum # candidates for a line + * \param line_p maximum # candidates for a line */ void setLineP( int line_p ); @@ -184,7 +184,7 @@ namespace pal * \brief set maximum # candidates to generate for polygon features * Higher the value is, longer Pal::labeller will spend time * - * @param poly_p maximum # candidate for a polygon + * \param poly_p maximum # candidate for a polygon */ void setPolyP( int poly_p ); @@ -209,14 +209,14 @@ namespace pal * For interactive mapping using CHAIN is a good * idea because it is the fastest. Other methods, ordered by speedness, are POPMUSIC_TABU, * POPMUSIC_CHAIN and POPMUSIC_TABU_CHAIN, defined in pal::_searchMethod enumeration - * @param method the method to use + * \param method the method to use */ void setSearch( SearchMethod method ); /** * \brief get the search method in use * - * @return the search method + * \returns the search method */ SearchMethod getSearch(); @@ -269,10 +269,10 @@ namespace pal * \brief Problem factory * Extract features to label and generates candidates for them, * respects to a bounding box - * @param lambda_min xMin bounding-box - * @param phi_min yMin bounding-box - * @param lambda_max xMax bounding-box - * @param phi_max yMax bounding-box + * \param lambda_min xMin bounding-box + * \param phi_min yMin bounding-box + * \param lambda_max xMax bounding-box + * \param phi_max yMax bounding-box */ Problem *extract( double lambda_min, double phi_min, double lambda_max, double phi_max ); @@ -280,50 +280,50 @@ namespace pal /** * \brief Choose the size of popmusic subpart's - * @param r subpart size + * \param r subpart size */ void setPopmusicR( int r ); /** * \brief minimum # of iteration for search method POPMUSIC_TABU, POPMUSIC_CHAIN and POPMUSIC_TABU_CHAIN - * @param min_it Sub part optimization min # of iteration + * \param min_it Sub part optimization min # of iteration */ void setMinIt( int min_it ); /** * \brief maximum \# of iteration for search method POPMUSIC_TABU, POPMUSIC_CHAIN and POPMUSIC_TABU_CHAIN - * @param max_it Sub part optimization max # of iteration + * \param max_it Sub part optimization max # of iteration */ void setMaxIt( int max_it ); /** * \brief For tabu search : how many iteration a feature will be tabu - * @param tenure consiser a feature as tabu for tenure iteration after updating feature in solution + * \param tenure consiser a feature as tabu for tenure iteration after updating feature in solution */ void setTenure( int tenure ); /** * \brief For *CHAIN, select the max size of a transformation chain - * @param degree maximum soze of a transformation chain + * \param degree maximum soze of a transformation chain */ void setEjChainDeg( int degree ); /** * \brief How many candidates will be tested by a tabu iteration - * @param fact the ration (0..1) of candidates to test + * \param fact the ration (0..1) of candidates to test */ void setCandListSize( double fact ); /** * \brief Get the minimum # of iteration doing in POPMUSIC_TABU, POPMUSIC_CHAIN and POPMUSIC_TABU_CHAIN - * @return minimum # of iteration + * \returns minimum # of iteration */ int getMinIt(); /** * \brief Get the maximum # of iteration doing in POPMUSIC_TABU, POPMUSIC_CHAIN and POPMUSIC_TABU_CHAIN - * @return maximum # of iteration + * \returns maximum # of iteration */ int getMaxIt(); diff --git a/src/core/pal/pointset.h b/src/core/pal/pointset.h index 1f410f4d9b35..14e9a0191f0b 100644 --- a/src/core/pal/pointset.h +++ b/src/core/pal/pointset.h @@ -78,19 +78,19 @@ namespace pal PointSet *extractShape( int nbPtSh, int imin, int imax, int fps, int fpe, double fptx, double fpty ); /** Tests whether point set contains a specified point. - * @param x x-coordinate of point - * @param y y-coordinate of point - * @returns true if point set contains a specified point + * \param x x-coordinate of point + * \param y y-coordinate of point + * \returns true if point set contains a specified point */ bool containsPoint( double x, double y ) const; /** Tests whether a possible label candidate will fit completely within the shape. - * @param x x-coordinate of label candidate - * @param y y-coordinate of label candidate - * @param width label width - * @param height label height - * @param alpha label angle - * @returns true if point set completely contains candidate label + * \param x x-coordinate of label candidate + * \param y y-coordinate of label candidate + * \param width label width + * \param height label height + * \param alpha label angle + * \returns true if point set completely contains candidate label */ bool containsLabelCandidate( double x, double y, double width, double height, double alpha = 0 ) const; @@ -104,11 +104,11 @@ namespace pal /** Returns the squared minimum distance between the point set geometry and the point (px,py) * Optionally, the nearest point is stored in (rx,ry). - * @param px x coordinate of the point - * @param py y coordinate of the points - * @param rx pointer to x coorinates of the nearest point (can be NULL) - * @param ry pointer to y coorinates of the nearest point (can be NULL) - * @returns minimum distance + * \param px x coordinate of the point + * \param py y coordinate of the points + * \param rx pointer to x coorinates of the nearest point (can be NULL) + * \param ry pointer to y coorinates of the nearest point (can be NULL) + * \returns minimum distance */ double minDistanceToPoint( double px, double py, double *rx = nullptr, double *ry = nullptr ) const; @@ -130,11 +130,11 @@ namespace pal int getNumPoints() const { return nbPoints; } /** Get a point a set distance along a line geometry. - * @param d array of distances between points - * @param ad cumulative total distance from pt0 to each point (ad0 = pt0->pt0) - * @param dl distance to traverse along line - * @param px final x coord on line - * @param py final y coord on line + * \param d array of distances between points + * \param ad cumulative total distance from pt0 to each point (ad0 = pt0->pt0) + * \param dl distance to traverse along line + * \param px final x coord on line + * \param py final y coord on line */ void getPointByDistance( double *d, double *ad, double dl, double *px, double *py ); diff --git a/src/core/pal/priorityqueue.h b/src/core/pal/priorityqueue.h index b62cee3e5649..163462bdede7 100644 --- a/src/core/pal/priorityqueue.h +++ b/src/core/pal/priorityqueue.h @@ -51,9 +51,9 @@ namespace pal public: /** \brief Create a priority queue of max size n - * \@param n max size of the queuet - * \@param p external vector representing the priority - * \@param min best element has the smalest p when min is True ans has the biggest when min is false + * \\param n max size of the queuet + * \\param p external vector representing the priority + * \\param min best element has the smalest p when min is True ans has the biggest when min is false */ PriorityQueue( int n, int maxId, bool min ); ~PriorityQueue(); diff --git a/src/core/pal/problem.h b/src/core/pal/problem.h index 90d859ebccda..4c36a1403ea6 100644 --- a/src/core/pal/problem.h +++ b/src/core/pal/problem.h @@ -119,7 +119,7 @@ namespace pal Problem &operator=( const Problem &other ) = delete; /** Adds a candidate label position to the problem. - * @param position label candidate position. Ownership is transferred to Problem. + * \param position label candidate position. Ownership is transferred to Problem. * \since QGIS 2.12 */ void addCandidatePosition( LabelPosition *position ) { mLabelPositions.append( position ); } diff --git a/src/core/processing/qgsprocessingfeedback.h b/src/core/processing/qgsprocessingfeedback.h index e825abd31f23..4ffbf135c34e 100644 --- a/src/core/processing/qgsprocessingfeedback.h +++ b/src/core/processing/qgsprocessingfeedback.h @@ -41,7 +41,7 @@ class CORE_EXPORT QgsProcessingFeedback : public QgsFeedback * Sets a progress report text string. This can be used in conjunction with * setProgress() to provide detailed progress reports, such as "Transformed * 4 of 5 layers". - * @see setProgress() + * \see setProgress() */ virtual void setProgressText( const QString &text ) { Q_UNUSED( text ); } @@ -55,9 +55,9 @@ class CORE_EXPORT QgsProcessingFeedback : public QgsFeedback * Pushes a general informational message from the algorithm. This can * be used to report feedback which is neither a status report or an * error, such as "Found 47 matching features". - * @see pushCommandInfo() - * @see pushDebugInfo() - * @see pushConsoleInfo() + * \see pushCommandInfo() + * \see pushDebugInfo() + * \see pushConsoleInfo() */ virtual void pushInfo( const QString &info ) { Q_UNUSED( info ); } @@ -65,27 +65,27 @@ class CORE_EXPORT QgsProcessingFeedback : public QgsFeedback * Pushes an informational message containing a command from the algorithm. * This is usually used to report commands which are executed in an external * application or as subprocesses. - * @see pushInfo() - * @see pushDebugInfo() - * @see pushConsoleInfo() + * \see pushInfo() + * \see pushDebugInfo() + * \see pushConsoleInfo() */ virtual void pushCommandInfo( const QString &info ) { Q_UNUSED( info ); } /** * Pushes an informational message containing debugging helpers from * the algorithm. - * @see pushInfo() - * @see pushCommandInfo() - * @see pushConsoleInfo() + * \see pushInfo() + * \see pushCommandInfo() + * \see pushConsoleInfo() */ virtual void pushDebugInfo( const QString &info ) { Q_UNUSED( info ); } /** * Pushes a console feedback message from the algorithm. This is used to * report the output from executing an external command or subprocess. - * @see pushInfo() - * @see pushDebugInfo() - * @see pushCommandInfo() + * \see pushInfo() + * \see pushDebugInfo() + * \see pushCommandInfo() */ virtual void pushConsoleInfo( const QString &info ) { Q_UNUSED( info ); } diff --git a/src/core/processing/qgsprocessingprovider.h b/src/core/processing/qgsprocessingprovider.h index e9710b12413f..30dbecd2044d 100644 --- a/src/core/processing/qgsprocessingprovider.h +++ b/src/core/processing/qgsprocessingprovider.h @@ -48,13 +48,13 @@ class CORE_EXPORT QgsProcessingProvider /** * Returns an icon for the provider. - * @see svgIconPath() + * \see svgIconPath() */ virtual QIcon icon() const; /** * Returns a path to an SVG version of the provider's icon. - * @see icon() + * \see icon() */ virtual QString svgIconPath() const; @@ -62,14 +62,14 @@ class CORE_EXPORT QgsProcessingProvider * Returns the unique provider id, used for identifying the provider. This string * should be a unique, short, character only string, eg "qgis" or "gdal". This * string should not be localised. - * @see name() + * \see name() */ virtual QString id() const = 0; /** * Returns the full provider name, which is used to describe the provider within the GUI. * This string should be localised. - * @see id() + * \see id() */ virtual QString name() const = 0; diff --git a/src/core/processing/qgsprocessingregistry.h b/src/core/processing/qgsprocessingregistry.h index 1db85b93477e..e1fb2d78bf2e 100644 --- a/src/core/processing/qgsprocessingregistry.h +++ b/src/core/processing/qgsprocessingregistry.h @@ -60,21 +60,21 @@ class CORE_EXPORT QgsProcessingRegistry : public QObject * Add a processing provider to the registry. Ownership of the provider is transferred to the registry. * Returns false if the provider could not be added (eg if a provider with a duplicate ID already exists * in the registry). - * @see removeProvider() + * \see removeProvider() */ bool addProvider( QgsProcessingProvider *provider SIP_TRANSFER ); /** * Removes a provider implementation from the registry (the provider object is deleted). * Returns false if the provider could not be removed (eg provider does not exist in the registry). - * @see addProvider() + * \see addProvider() */ bool removeProvider( QgsProcessingProvider *provider ); /** * Removes a provider implementation from the registry (the provider object is deleted). * Returns false if the provider could not be removed (eg provider does not exist in the registry). - * @see addProvider() + * \see addProvider() */ bool removeProvider( const QString &providerId ); diff --git a/src/core/qgis.cpp b/src/core/qgis.cpp index c2366b537e08..19de280574bb 100644 --- a/src/core/qgis.cpp +++ b/src/core/qgis.cpp @@ -72,7 +72,6 @@ const QString GEO_NONE = QStringLiteral( "NONE" ); const double Qgis::DEFAULT_SEARCH_RADIUS_MM = 2.; -//! Default threshold between map coordinates and device coordinates for map2pixel simplification const float Qgis::DEFAULT_MAPTOPIXEL_THRESHOLD = 1.0f; const QColor Qgis::DEFAULT_HIGHLIGHT_COLOR = QColor( 255, 0, 0, 128 ); diff --git a/src/core/qgis.h b/src/core/qgis.h index 7934265c8672..9c983457d892 100644 --- a/src/core/qgis.h +++ b/src/core/qgis.h @@ -130,9 +130,9 @@ class CORE_EXPORT Qgis /** \ingroup core * RAII signal blocking class. Used for temporarily blocking signals from a QObject * for the lifetime of QgsSignalBlocker object. - * @see whileBlocking() + * \see whileBlocking() * \since QGIS 2.16 - * @note not available in Python bindings + * \note not available in Python bindings */ // based on Boojum's code from http://stackoverflow.com/questions/3556687/prevent-firing-signals-in-qt template class QgsSignalBlocker // clazy:exclude=rule-of-three @@ -140,7 +140,7 @@ template class QgsSignalBlocker // clazy:exclude=rule-of-three public: /** Constructor for QgsSignalBlocker - * @param object QObject to block signals from + * \param object QObject to block signals from */ explicit QgsSignalBlocker( Object *object ) : mObject( object ) @@ -171,8 +171,8 @@ template class QgsSignalBlocker // clazy:exclude=rule-of-three * No signals will be emitted when calling these methods. * * \since QGIS 2.16 - * @see QgsSignalBlocker - * @note not available in Python bindings + * \see QgsSignalBlocker + * \note not available in Python bindings */ // based on Boojum's code from http://stackoverflow.com/questions/3556687/prevent-firing-signals-in-qt template inline QgsSignalBlocker whileBlocking( Object *object ) @@ -181,8 +181,8 @@ template inline QgsSignalBlocker whileBlocking( Object *ob } //! Returns a string representation of a double -//! @param a double value -//! @param precision number of decimal places to retain +//! \param a double value +//! \param precision number of decimal places to retain inline QString qgsDoubleToString( double a, int precision = 17 ) { if ( precision ) @@ -192,9 +192,9 @@ inline QString qgsDoubleToString( double a, int precision = 17 ) } //! Compare two doubles (but allow some difference) -//! @param a first double -//! @param b second double -//! @param epsilon maximum difference allowable between doubles +//! \param a first double +//! \param b second double +//! \param epsilon maximum difference allowable between doubles inline bool qgsDoubleNear( double a, double b, double epsilon = 4 * DBL_EPSILON ) { const double diff = a - b; @@ -202,9 +202,9 @@ inline bool qgsDoubleNear( double a, double b, double epsilon = 4 * DBL_EPSILON } //! Compare two floats (but allow some difference) -//! @param a first float -//! @param b second float -//! @param epsilon maximum difference allowable between floats +//! \param a first float +//! \param b second float +//! \param epsilon maximum difference allowable between floats inline bool qgsFloatNear( float a, float b, float epsilon = 4 * FLT_EPSILON ) { const float diff = a - b; @@ -246,54 +246,54 @@ inline double qgsRound( double number, double places ) /** Converts a string to a double in a permissive way, e.g., allowing for incorrect * numbers of digits between thousand separators - * @param string string to convert - * @param ok will be set to true if conversion was successful - * @returns string converted to double if possible + * \param string string to convert + * \param ok will be set to true if conversion was successful + * \returns string converted to double if possible * \since QGIS 2.9 - * @see permissiveToInt + * \see permissiveToInt */ CORE_EXPORT double qgsPermissiveToDouble( QString string, bool &ok ); /** Converts a string to an integer in a permissive way, e.g., allowing for incorrect * numbers of digits between thousand separators - * @param string string to convert - * @param ok will be set to true if conversion was successful - * @returns string converted to int if possible + * \param string string to convert + * \param ok will be set to true if conversion was successful + * \returns string converted to int if possible * \since QGIS 2.9 - * @see permissiveToDouble + * \see permissiveToDouble */ CORE_EXPORT int qgsPermissiveToInt( QString string, bool &ok ); //! Compares two QVariant values and returns whether the first is less than the second. //! Useful for sorting lists of variants, correctly handling sorting of the various //! QVariant data types (such as strings, numeric values, dates and times) -//! @see qgsVariantGreaterThan() +//! \see qgsVariantGreaterThan() CORE_EXPORT bool qgsVariantLessThan( const QVariant &lhs, const QVariant &rhs ); //! Compares two QVariant values and returns whether the first is greater than the second. //! Useful for sorting lists of variants, correctly handling sorting of the various //! QVariant data types (such as strings, numeric values, dates and times) -//! @see qgsVariantLessThan() +//! \see qgsVariantLessThan() CORE_EXPORT bool qgsVariantGreaterThan( const QVariant &lhs, const QVariant &rhs ); CORE_EXPORT QString qgsVsiPrefix( const QString &path ); /** Allocates size bytes and returns a pointer to the allocated memory. Works like C malloc() but prints debug message by QgsLogger if allocation fails. - @param size size in bytes + \param size size in bytes */ void CORE_EXPORT *qgsMalloc( size_t size ); /** Allocates memory for an array of nmemb elements of size bytes each and returns a pointer to the allocated memory. Works like C calloc() but prints debug message by QgsLogger if allocation fails. - @param nmemb number of elements - @param size size of element in bytes + \param nmemb number of elements + \param size size of element in bytes */ void CORE_EXPORT *qgsCalloc( size_t nmemb, size_t size ); /** Frees the memory space pointed to by ptr. Works like C free(). - @param ptr pointer to memory space + \param ptr pointer to memory space */ void CORE_EXPORT qgsFree( void *ptr ); diff --git a/src/core/qgsaction.h b/src/core/qgsaction.h index 9f6de35c0c44..7f4be7fe6605 100644 --- a/src/core/qgsaction.h +++ b/src/core/qgsaction.h @@ -54,10 +54,10 @@ class CORE_EXPORT QgsAction /** * Create a new QgsAction * - * @param type The type of this action - * @param description A human readable description string - * @param command The action text. Its interpretation depends on the type - * @param capture If this is set to true, the output will be captured when an action is run + * \param type The type of this action + * \param description A human readable description string + * \param command The action text. Its interpretation depends on the type + * \param capture If this is set to true, the output will be captured when an action is run */ QgsAction( ActionType type, const QString &description, const QString &command, bool capture = false ) : mType( type ) @@ -70,13 +70,13 @@ class CORE_EXPORT QgsAction /** * Create a new QgsAction * - * @param type The type of this action - * @param description A human readable description string - * @param action The action text. Its interpretation depends on the type - * @param icon Path to an icon for this action - * @param capture If this is set to true, the output will be captured when an action is run - * @param shortTitle A short string used to label user interface elements like buttons - * @param actionScopes A set of scopes in which this action will be available + * \param type The type of this action + * \param description A human readable description string + * \param action The action text. Its interpretation depends on the type + * \param icon Path to an icon for this action + * \param capture If this is set to true, the output will be captured when an action is run + * \param shortTitle A short string used to label user interface elements like buttons + * \param actionScopes A set of scopes in which this action will be available */ QgsAction( ActionType type, const QString &description, const QString &action, const QString &icon, bool capture, const QString &shortTitle = QString(), const QSet &actionScopes = QSet() ) : mType( type ) @@ -152,7 +152,7 @@ class CORE_EXPORT QgsAction * Action scopes may offer additional variables like the clicked * coordinate. * - * @see QgsActionScope + * \see QgsActionScope * \since QGIS 3.0 */ QSet actionScopes() const; diff --git a/src/core/qgsactionmanager.h b/src/core/qgsactionmanager.h index c247b827946c..2dfbe2638395 100644 --- a/src/core/qgsactionmanager.h +++ b/src/core/qgsactionmanager.h @@ -84,15 +84,15 @@ class CORE_EXPORT QgsActionManager /** Does the given action. defaultValueIndex is the index of the * field to be used if the action has a $currfield placeholder. - * @note available in Python bindings as doActionFeature + * \note available in Python bindings as doActionFeature */ void doAction( const QUuid &actionId, const QgsFeature &feature, int defaultValueIndex = 0 ) SIP_PYNAME( doActionFeature ); /** Does the action using the expression engine to replace any embedded expressions * in the action definition. - * @param actionId action id - * @param feature feature to run action for - * @param context expression context to evaluate expressions under + * \param actionId action id + * \param feature feature to run action for + * \param context expression context to evaluate expressions under */ void doAction( const QUuid &actionId, const QgsFeature &feature, const QgsExpressionContext &context ); diff --git a/src/core/qgsaggregatecalculator.h b/src/core/qgsaggregatecalculator.h index 5f1417fbf38e..528d7d878500 100644 --- a/src/core/qgsaggregatecalculator.h +++ b/src/core/qgsaggregatecalculator.h @@ -74,20 +74,20 @@ class CORE_EXPORT QgsAggregateCalculator /** Optional filter for calculating aggregate over a subset of features, or an * empty string to use all features. - * @see QgsAggregateCalculator::setFilter() - * @see QgsAggregateCalculator::filter() + * \see QgsAggregateCalculator::setFilter() + * \see QgsAggregateCalculator::filter() */ QString filter; /** Delimiter to use for joining values with the StringConcatenate aggregate. - * @see QgsAggregateCalculator::setDelimiter() - * @see QgsAggregateCalculator::delimiter() + * \see QgsAggregateCalculator::setDelimiter() + * \see QgsAggregateCalculator::delimiter() */ QString delimiter; }; /** Constructor for QgsAggregateCalculator. - * @param layer vector layer to calculate aggregate from + * \param layer vector layer to calculate aggregate from */ QgsAggregateCalculator( const QgsVectorLayer *layer ); @@ -96,47 +96,47 @@ class CORE_EXPORT QgsAggregateCalculator const QgsVectorLayer *layer() const; /** Sets all aggregate parameters from a parameter bundle. - * @param parameters aggregate parameters + * \param parameters aggregate parameters */ void setParameters( const AggregateParameters ¶meters ); /** Sets a filter to limit the features used during the aggregate calculation. - * @param filterExpression expression for filtering features, or empty string to remove filter - * @see filter() + * \param filterExpression expression for filtering features, or empty string to remove filter + * \see filter() */ void setFilter( const QString &filterExpression ) { mFilterExpression = filterExpression; } /** Returns the filter which limits the features used during the aggregate calculation. - * @see setFilter() + * \see setFilter() */ QString filter() const { return mFilterExpression; } /** Sets the delimiter to use for joining values with the StringConcatenate aggregate. - * @param delimiter string delimiter - * @see delimiter() + * \param delimiter string delimiter + * \see delimiter() */ void setDelimiter( const QString &delimiter ) { mDelimiter = delimiter; } /** Returns the delimiter used for joining values with the StringConcatenate aggregate. - * @see setDelimiter() + * \see setDelimiter() */ QString delimiter() const { return mDelimiter; } /** Calculates the value of an aggregate. - * @param aggregate aggregate to calculate - * @param fieldOrExpression source field or expression to use as basis for aggregated values. + * \param aggregate aggregate to calculate + * \param fieldOrExpression source field or expression to use as basis for aggregated values. * If an expression is used, then the context parameter must be set. - * @param context expression context for evaluating expressions - * @param ok if specified, will be set to true if aggregate calculation was successful - * @returns calculated aggregate value + * \param context expression context for evaluating expressions + * \param ok if specified, will be set to true if aggregate calculation was successful + * \returns calculated aggregate value */ QVariant calculate( Aggregate aggregate, const QString &fieldOrExpression, QgsExpressionContext *context = nullptr, bool *ok = nullptr ) const; /** Converts a string to a aggregate type. - * @param string string to convert - * @param ok if specified, will be set to true if conversion was successful - * @returns aggregate type + * \param string string to convert + * \param ok if specified, will be set to true if conversion was successful + * \returns aggregate type */ static Aggregate stringToAggregate( const QString &string, bool *ok = nullptr ); diff --git a/src/core/qgsanimatedicon.h b/src/core/qgsanimatedicon.h index bd34d531f638..dc283ed2e831 100644 --- a/src/core/qgsanimatedicon.h +++ b/src/core/qgsanimatedicon.h @@ -63,7 +63,7 @@ class CORE_EXPORT QgsAnimatedIcon : public QObject * makes sure the annimation is started. * * \since QGIS 3.0 - * @note Available in Python bindings as + * \note Available in Python bindings as * bool connectFrameChanged( const QObject *receiver, const char *method );. */ template @@ -82,7 +82,7 @@ class CORE_EXPORT QgsAnimatedIcon : public QObject * Convenience function to disconnect the same style that the frame change connection was established. * * \since QGIS 3.0 - * @note Available in Python bindings as + * \note Available in Python bindings as * bool disconnectFrameChanged( const QObject *receiver, const char *method );. */ template @@ -133,7 +133,7 @@ class CORE_EXPORT QgsAnimatedIcon : public QObject * to this signal directly. * Connecting to this signal directly will cause the animation not to be started. * - * @see connectFrameChanged + * \see connectFrameChanged */ void frameChanged(); diff --git a/src/core/qgsapplication.cpp b/src/core/qgsapplication.cpp index b622ae283850..2297a07877ae 100644 --- a/src/core/qgsapplication.cpp +++ b/src/core/qgsapplication.cpp @@ -104,19 +104,6 @@ const char *QgsApplication::QGIS_APPLICATION_NAME = "QGIS3"; QgsApplication::ApplicationMembers *QgsApplication::sApplicationMembers = nullptr; -/*! - \class QgsApplication - \brief The QgsApplication class manages application-wide information. - - This is a subclass of QApplication and should be instantiated in place of - QApplication. Most methods are static in keeping with the design of QApplication. - - This class hides platform-specific path information and provides - a portable way of referencing specific files and directories. - Ideally, hard-coded paths should appear only here and not in other modules - so that platform-conditional code is minimized and paths are easier - to change due to centralization. -*/ QgsApplication::QgsApplication( int &argc, char **argv, bool GUIenabled, const QString &customConfigPath, const QString &platformName ) : QApplication( argc, argv, GUIenabled ) { @@ -489,16 +476,11 @@ QPixmap QgsApplication::getThemePixmap( const QString &name ) } } -/*! - Set the theme path to the specified theme. -*/ void QgsApplication::setThemeName( const QString &themeName ) { ABISYM( mThemeName ) = themeName; } -/*! - * Get the active theme name - */ + QString QgsApplication::themeName() { return ABISYM( mThemeName ); @@ -583,16 +565,11 @@ QHash QgsApplication::uiThemes() return mapping; } -/*! - Returns the path to the authors file. -*/ QString QgsApplication::authorsFilePath() { return ABISYM( mPkgDataPath ) + QStringLiteral( "/doc/AUTHORS" ); } -/*! - Returns the path to the contributors file. -*/ + QString QgsApplication::contributorsFilePath() { return ABISYM( mPkgDataPath ) + QStringLiteral( "/doc/CONTRIBUTORS" ); @@ -602,37 +579,26 @@ QString QgsApplication::developersMapFilePath() return ABISYM( mPkgDataPath ) + QStringLiteral( "/doc/developersmap.html" ); } -/*! - Returns the path to the sponsors file. -*/ QString QgsApplication::sponsorsFilePath() { return ABISYM( mPkgDataPath ) + QStringLiteral( "/doc/SPONSORS" ); } -/*! - Returns the path to the donors file. -*/ QString QgsApplication::donorsFilePath() { return ABISYM( mPkgDataPath ) + QStringLiteral( "/doc/DONORS" ); } -//! Returns the path to the sponsors file. QString QgsApplication::translatorsFilePath() { return ABISYM( mPkgDataPath ) + QStringLiteral( "/doc/TRANSLATORS" ); } -//! Returns the path to the licence file. QString QgsApplication::licenceFilePath() { return ABISYM( mPkgDataPath ) + QStringLiteral( "/doc/LICENSE" ); } -/*! - Returns the path to the help application. -*/ QString QgsApplication::helpAppPath() { QString helpAppPath; @@ -647,9 +613,7 @@ QString QgsApplication::helpAppPath() #endif return helpAppPath; } -/*! - Returns the path to the translation directory. -*/ + QString QgsApplication::i18nPath() { if ( ABISYM( mRunningFromBuildDir ) ) @@ -658,56 +622,36 @@ QString QgsApplication::i18nPath() return ABISYM( mPkgDataPath ) + QStringLiteral( "/i18n/" ); } -/*! - Returns the path to the master qgis.db file. -*/ QString QgsApplication::qgisMasterDatabaseFilePath() { return ABISYM( mPkgDataPath ) + QStringLiteral( "/resources/qgis.db" ); } -/*! - Returns the path to the settings directory in user's home dir - */ QString QgsApplication::qgisSettingsDirPath() { return ABISYM( mConfigPath ); } -/*! - Returns the path to the user qgis.db file. -*/ QString QgsApplication::qgisUserDatabaseFilePath() { return qgisSettingsDirPath() + QStringLiteral( "qgis.db" ); } -/*! - Returns the path to the user authentication database file: qgis-auth.db. -*/ QString QgsApplication::qgisAuthDatabaseFilePath() { return ABISYM( mAuthDbDirPath ) + QStringLiteral( "qgis-auth.db" ); } -/*! - Returns the path to the splash screen image directory. -*/ QString QgsApplication::splashPath() { return QStringLiteral( ":/images/splash/" ); } -/*! - Returns the path to the icons image directory. -*/ QString QgsApplication::iconsPath() { return ABISYM( mPkgDataPath ) + QStringLiteral( "/images/icons/" ); } -/*! - Returns the path to the srs.db file. -*/ + QString QgsApplication::srsDatabaseFilePath() { if ( ABISYM( mRunningFromBuildDir ) ) @@ -731,9 +675,6 @@ QString QgsApplication::srsDatabaseFilePath() } } -/*! - Returns the paths to the svg directories. -*/ QStringList QgsApplication::svgPaths() { //local directories to search when looking for an SVG with a given basename @@ -757,9 +698,6 @@ QStringList QgsApplication::svgPaths() return paths; } -/*! - Returns the paths to the composer template directories. -*/ QStringList QgsApplication::composerTemplatePaths() { //local directories to search when looking for an SVG with a given basename diff --git a/src/core/qgsapplication.h b/src/core/qgsapplication.h index dea551056044..9d4ca58c2343 100644 --- a/src/core/qgsapplication.h +++ b/src/core/qgsapplication.h @@ -43,6 +43,15 @@ class QgsAnnotationRegistry; /** \ingroup core * Extends QApplication to provide access to QGIS specific resources such * as theme paths, database paths etc. + * + * This is a subclass of QApplication and should be instantiated in place of + QApplication. Most methods are static in keeping with the design of QApplication. + + This class hides platform-specific path information and provides + a portable way of referencing specific files and directories. + Ideally, hard-coded paths should appear only here and not in other modules + so that platform-conditional code is minimized and paths are easier + to change due to centralization. */ class CORE_EXPORT QgsApplication : public QApplication @@ -66,9 +75,9 @@ class CORE_EXPORT QgsApplication : public QApplication /** This method initializes paths etc for QGIS. Called by the ctor or call it manually when your app does not extend the QApplication class. - @note you will probably want to call initQgis too to load the providers in + \note you will probably want to call initQgis too to load the providers in the above case. - @note not available in Python bindings + \note not available in Python bindings */ static void init( QString customConfigPath = QString() ); @@ -86,7 +95,7 @@ class CORE_EXPORT QgsApplication : public QApplication * The theme search path usually will be pkgDataPath + "/themes/" + themName + "/" * but plugin writers etc can use themeName() as a basis for searching * for resources in their own datastores e.g. a Qt4 resource bundle. - * @note A basic test will be carried out to ensure the theme search path + * \note A basic test will be carried out to ensure the theme search path * based on the supplied theme name exists. If it does not the theme name will * be reverted to 'default'. */ @@ -101,19 +110,19 @@ class CORE_EXPORT QgsApplication : public QApplication static QString themeName(); /** - * @brief Set the current UI theme used to style the interface. Use uiThemes() to + * \brief Set the current UI theme used to style the interface. Use uiThemes() to * find valid themes to use. Variables found in variables.qss will be added to the stylesheet * on load. - * @param themeName The name of the theme. - * @note using an invalid theme name will reset to default + * \param themeName The name of the theme. + * \note using an invalid theme name will reset to default */ static void setUITheme( const QString &themeName ); /** - * @brief All themes found in ~/.qgis3/themes folder. + * \brief All themes found in ~/.qgis3/themes folder. * The path is to the root folder for the theme - * @note Valid theme folders must contain a style.qss file. - * @return A hash of theme name and theme path. Valid theme folders contain style.qss + * \note Valid theme folders must contain a style.qss file. + * \returns A hash of theme name and theme path. Valid theme folders contain style.qss */ static QHash uiThemes(); @@ -142,7 +151,7 @@ class CORE_EXPORT QgsApplication : public QApplication */ static QString translatorsFilePath(); - /*! + /** Returns the path to the licence file. */ static QString licenceFilePath(); @@ -218,25 +227,25 @@ class CORE_EXPORT QgsApplication : public QApplication /** Returns the user's operating system login account name. * \since QGIS 2.14 - * @see userFullName() + * \see userFullName() */ static QString userLoginName(); /** Returns the user's operating system login account full display name. * \since QGIS 2.14 - * @see userLoginName() + * \see userLoginName() */ static QString userFullName(); /** Returns a string name of the operating system QGIS is running on. * \since QGIS 2.14 - * @see platform() + * \see platform() */ static QString osName(); /** Returns the QGIS platform name, e.g., "desktop" or "server". * \since QGIS 2.14 - * @see osName() + * \see osName() */ static QString platform(); @@ -301,7 +310,7 @@ class CORE_EXPORT QgsApplication : public QApplication static endian_t endian(); /** Swap the endianness of the specified value. - * @note not available in Python bindings + * \note not available in Python bindings */ template static void endian_swap( T &value ) @@ -318,8 +327,8 @@ class CORE_EXPORT QgsApplication : public QApplication * Typically you will use this method by doing: * QString myStyle = QgsApplication::reportStyleSheet(); * textBrowserReport->document()->setDefaultStyleSheet(myStyle); - * @return QString containing the CSS 2.1 compliant stylesheet. - * @note you can use the special Qt extensions too, for example + * \returns QString containing the CSS 2.1 compliant stylesheet. + * \note you can use the special Qt extensions too, for example * the gradient fills for backgrounds. */ static QString reportStyleSheet(); @@ -369,9 +378,9 @@ class CORE_EXPORT QgsApplication : public QApplication static QStringList skippedGdalDrivers() { return ABISYM( mGdalSkipList ); } /** Apply the skipped drivers list to gdal - * @see skipGdalDriver - * @see restoreGdalDriver - * @see skippedGdalDrivers */ + * \see skipGdalDriver + * \see restoreGdalDriver + * \see skippedGdalDrivers */ static void applyGdalSkippedDrivers(); /** Get maximum concurrent thread count @@ -379,7 +388,7 @@ class CORE_EXPORT QgsApplication : public QApplication static int maxThreads() { return ABISYM( mMaxThreads ); } /** Set maximum concurrent thread count - * @note must be between 1 and \#cores, -1 means use all available cores + * \note must be between 1 and \#cores, -1 means use all available cores * \since QGIS 2.4 */ static void setMaxThreads( int maxThreads ); @@ -411,7 +420,7 @@ class CORE_EXPORT QgsApplication : public QApplication /** * Returns the application's raster renderer registry, used for managing raster layer renderers. * \since QGIS 3.0 - * @note not available in Python bindings + * \note not available in Python bindings */ static QgsRasterRendererRegistry *rasterRendererRegistry(); @@ -463,7 +472,7 @@ class CORE_EXPORT QgsApplication : public QApplication /** * Returns the application's annotation registry, used for managing annotation types. * \since QGIS 3.0 - * @note not available in Python bindings + * \note not available in Python bindings */ static QgsAnnotationRegistry *annotationRegistry(); @@ -527,7 +536,7 @@ class CORE_EXPORT QgsApplication : public QApplication static void setCustomVariable( const QString &name, const QVariant &value ); signals: - //! @note not available in Python bindings + //! \note not available in Python bindings void preNotify( QObject *receiver, QEvent *event, bool *done ); /** @@ -572,7 +581,7 @@ class CORE_EXPORT QgsApplication : public QApplication static QString ABISYM( mBuildOutputPath ); /** List of gdal drivers to be skipped. Uses GDAL_SKIP to exclude them. - * @see skipGdalDriver, restoreGdalDriver */ + * \see skipGdalDriver, restoreGdalDriver */ static QStringList ABISYM( mGdalSkipList ); /** diff --git a/src/core/qgsattributeeditorelement.h b/src/core/qgsattributeeditorelement.h index 7cedb300eec2..5d54ac74b0d5 100644 --- a/src/core/qgsattributeeditorelement.h +++ b/src/core/qgsattributeeditorelement.h @@ -46,9 +46,9 @@ class CORE_EXPORT QgsAttributeEditorElement /** * Constructor * - * @param type The type of the new element. Should never - * @param name - * @param parent + * \param type The type of the new element. Should never + * \param name + * \param parent */ QgsAttributeEditorElement( AttributeEditorType type, const QString &name, QgsAttributeEditorElement *parent = nullptr ) : mType( type ) @@ -63,14 +63,14 @@ class CORE_EXPORT QgsAttributeEditorElement /** * Return the name of this element * - * @return The name for this element + * \returns The name for this element */ QString name() const { return mName; } /** * The type of this element * - * @return The type + * \returns The type */ AttributeEditorType type() const { return mType; } @@ -84,9 +84,9 @@ class CORE_EXPORT QgsAttributeEditorElement /** * Get the XML Dom element to save this element. * - * @param doc The QDomDocument which is used to create new XML elements + * \param doc The QDomDocument which is used to create new XML elements * - * @return A DOM element to serialize this element + * \returns A DOM element to serialize this element */ QDomElement toDomElement( QDomDocument &doc ) const; @@ -147,8 +147,8 @@ class CORE_EXPORT QgsAttributeEditorContainer : public QgsAttributeEditorElement /** * Creates a new attribute editor container * - * @param name The name to show as title - * @param parent The parent. May be another container. + * \param name The name to show as title + * \param parent The parent. May be another container. */ QgsAttributeEditorContainer( const QString &name, QgsAttributeEditorElement *parent ) : QgsAttributeEditorElement( AeTypeContainer, name, parent ) @@ -162,37 +162,37 @@ class CORE_EXPORT QgsAttributeEditorContainer : public QgsAttributeEditorElement /** * Add a child element to this container. This may be another container, a field or a relation. * - * @param element The element to add as child + * \param element The element to add as child */ virtual void addChildElement( QgsAttributeEditorElement *element ); /** * Determines if this container is rendered as collapsible group box or tab in a tabwidget * - * @param isGroupBox If true, this will be a group box + * \param isGroupBox If true, this will be a group box */ virtual void setIsGroupBox( bool isGroupBox ) { mIsGroupBox = isGroupBox; } /** * Returns if this container is going to be rendered as a group box * - * @return True if it will be a group box, false if it will be a tab + * \returns True if it will be a group box, false if it will be a tab */ virtual bool isGroupBox() const { return mIsGroupBox; } /** * Get a list of the children elements of this container * - * @return A list of elements + * \returns A list of elements */ QList children() const { return mChildren; } /** * Traverses the element tree to find any element of the specified type * - * @param type The type which should be searched + * \param type The type which should be searched * - * @return A list of elements of the type which has been searched for + * \returns A list of elements of the type which has been searched for */ virtual QList findElements( AttributeEditorType type ) const; @@ -261,9 +261,9 @@ class CORE_EXPORT QgsAttributeEditorField : public QgsAttributeEditorElement /** * Creates a new attribute editor element which represents a field * - * @param name The name of the element - * @param idx The index of the field which should be embedded - * @param parent The parent of this widget (used as container) + * \param name The name of the element + * \param idx The index of the field which should be embedded + * \param parent The parent of this widget (used as container) */ QgsAttributeEditorField( const QString &name, int idx, QgsAttributeEditorElement *parent ) : QgsAttributeEditorElement( AeTypeField, name, parent ) @@ -272,7 +272,7 @@ class CORE_EXPORT QgsAttributeEditorField : public QgsAttributeEditorElement /** * Return the index of the field - * @return + * \returns */ int idx() const { return mIdx; } @@ -294,9 +294,9 @@ class CORE_EXPORT QgsAttributeEditorRelation : public QgsAttributeEditorElement /** * Creates a new element which embeds a relation. * - * @param name The name of this element - * @param relationId The id of the relation to embed - * @param parent The parent (used as container) + * \param name The name of this element + * \param relationId The id of the relation to embed + * \param parent The parent (used as container) */ QgsAttributeEditorRelation( const QString &name, const QString &relationId, QgsAttributeEditorElement *parent ) : QgsAttributeEditorElement( AeTypeRelation, name, parent ) @@ -308,9 +308,9 @@ class CORE_EXPORT QgsAttributeEditorRelation : public QgsAttributeEditorElement /** * Creates a new element which embeds a relation. * - * @param name The name of this element - * @param relation The relation to embed - * @param parent The parent (used as container) + * \param name The name of this element + * \param relation The relation to embed + * \param parent The parent (used as container) */ QgsAttributeEditorRelation( const QString &name, const QgsRelation &relation, QgsAttributeEditorElement *parent ) : QgsAttributeEditorElement( AeTypeRelation, name, parent ) @@ -323,15 +323,15 @@ class CORE_EXPORT QgsAttributeEditorRelation : public QgsAttributeEditorElement /** * Get the id of the relation which shall be embedded * - * @return the id + * \returns the id */ const QgsRelation &relation() const { return mRelation; } /** * Initializes the relation from the id * - * @param relManager The relation manager to use for the initialization - * @return true if the relation was found in the relationmanager + * \param relManager The relation manager to use for the initialization + * \returns true if the relation was found in the relationmanager */ bool init( QgsRelationManager *relManager ); diff --git a/src/core/qgsattributes.h b/src/core/qgsattributes.h index d8826e272af6..af02f146639b 100644 --- a/src/core/qgsattributes.h +++ b/src/core/qgsattributes.h @@ -51,7 +51,7 @@ typedef QMap QgsFieldMap; /** \ingroup core * A vector of attributes. Mostly equal to QVector. - @note QgsAttributes is implemented as a Python list of Python objects. + \note QgsAttributes is implemented as a Python list of Python objects. */ #ifndef SIP_RUN class CORE_EXPORT QgsAttributes : public QVector @@ -64,7 +64,7 @@ class CORE_EXPORT QgsAttributes : public QVector /** * Create a new vector of attributes with the given size * - * @param size Number of attributes + * \param size Number of attributes */ QgsAttributes( int size ) : QVector( size ) @@ -72,8 +72,8 @@ class CORE_EXPORT QgsAttributes : public QVector /** * Constructs a vector with an initial size of size elements. Each element is initialized with value. - * @param size Number of elements - * @param v Initial value + * \param size Number of elements + * \param v Initial value */ QgsAttributes( int size, const QVariant &v ) : QVector( size, v ) @@ -81,20 +81,20 @@ class CORE_EXPORT QgsAttributes : public QVector /** * Copies another vector of attributes - * @param v Attributes to copy + * \param v Attributes to copy */ QgsAttributes( const QVector &v ) : QVector( v ) {} /** - * @brief Compares two vectors of attributes. + * \brief Compares two vectors of attributes. * They are considered equal if all their members contain the same value and NULL flag. * This was introduced because the default Qt implementation of QVariant comparison does not * handle NULL values for certain types (like int). * - * @param v The attributes to compare - * @return True if v is equal + * \param v The attributes to compare + * \returns True if v is equal */ bool operator==( const QgsAttributes &v ) const { @@ -113,7 +113,7 @@ class CORE_EXPORT QgsAttributes : public QVector * Returns a QgsAttributeMap of the attribute values. Null values are * excluded from the map. * \since QGIS 3.0 - * @note not available in Python bindings + * \note not available in Python bindings */ QgsAttributeMap toMap() const SIP_SKIP; diff --git a/src/core/qgsattributetableconfig.h b/src/core/qgsattributetableconfig.h index bcf00fe4da90..34fb80a6bc11 100644 --- a/src/core/qgsattributetableconfig.h +++ b/src/core/qgsattributetableconfig.h @@ -86,8 +86,8 @@ class CORE_EXPORT QgsAttributeTableConfig bool isEmpty() const; /** Maps a visible column index to its original column index. - * @param visibleColumn index of visible column - * @returns corresponding index when hidden columns are considered + * \param visibleColumn index of visible column + * \returns corresponding index when hidden columns are considered */ int mapVisibleColumnToIndex( int visibleColumn ) const; @@ -146,28 +146,28 @@ class CORE_EXPORT QgsAttributeTableConfig void setSortExpression( const QString &sortExpression ); /** Returns the width of a column, or -1 if column should use default width. - * @param column column index - * @see setColumnWidth() + * \param column column index + * \see setColumnWidth() */ int columnWidth( int column ) const; /** Sets the width of a column. - * @param column column index - * @param width column width in pixels, or -1 if column should use default width - * @see columnWidth() + * \param column column index + * \param width column width in pixels, or -1 if column should use default width + * \see columnWidth() */ void setColumnWidth( int column, int width ); /** Returns true if the specified column is hidden. - * @param column column index - * @see setColumnHidden() + * \param column column index + * \see setColumnHidden() */ bool columnHidden( int column ) const; /** Sets whether the specified column should be hidden. - * @param column column index - * @param hidden set to true to hide column - * @see columnHidden() + * \param column column index + * \param hidden set to true to hide column + * \see columnHidden() */ void setColumnHidden( int column, bool hidden ); diff --git a/src/core/qgsbrowsermodel.h b/src/core/qgsbrowsermodel.h index c6eb1ee97d36..29d4bb158ef4 100644 --- a/src/core/qgsbrowsermodel.h +++ b/src/core/qgsbrowsermodel.h @@ -115,13 +115,13 @@ class CORE_EXPORT QgsBrowserModel : public QAbstractItemModel /** Return index of item with given path. It only searches in currently fetched * items, i.e. it does not fetch children. - * @param path item path - * @param matchFlag supported is Qt::MatchExactly and Qt::MatchStartsWith which has reverse meaning, i.e. find + * \param path item path + * \param matchFlag supported is Qt::MatchExactly and Qt::MatchStartsWith which has reverse meaning, i.e. find * item with the longest match from start with path (to get as close/deep as possible to deleted item). - * @return model index, invalid if item not found */ + * \returns model index, invalid if item not found */ QModelIndex findPath( const QString &path, Qt::MatchFlag matchFlag = Qt::MatchExactly ); - //! @note not available in Python bindings + //! \note not available in Python bindings static QModelIndex findPath( QAbstractItemModel *model, const QString &path, Qt::MatchFlag matchFlag = Qt::MatchExactly ); void connectItem( QgsDataItem *item ); @@ -146,14 +146,14 @@ class CORE_EXPORT QgsBrowserModel : public QAbstractItemModel /** * Adds a directory to the favorites group. * \since QGIS 3.0 - * @see removeFavorite() + * \see removeFavorite() */ void addFavoriteDirectory( const QString &directory ); /** * Removes a favorite directory from its corresponding model index. * \since QGIS 3.0 - * @see addFavoriteDirectory() + * \see addFavoriteDirectory() */ void removeFavorite( const QModelIndex &index ); diff --git a/src/core/qgscachedfeatureiterator.h b/src/core/qgscachedfeatureiterator.h index e1388b1d5e03..f7e83624af4f 100644 --- a/src/core/qgscachedfeatureiterator.h +++ b/src/core/qgscachedfeatureiterator.h @@ -23,7 +23,7 @@ class QgsVectorLayerCache; /** \ingroup core - * @brief + * \brief * Delivers features from the cache * */ @@ -34,22 +34,22 @@ class CORE_EXPORT QgsCachedFeatureIterator : public QgsAbstractFeatureIterator /** * This constructor creates a feature iterator, that delivers all cached features. No request is made to the backend. * - * @param vlCache The vector layer cache to use - * @param featureRequest The feature request to answer + * \param vlCache The vector layer cache to use + * \param featureRequest The feature request to answer */ QgsCachedFeatureIterator( QgsVectorLayerCache *vlCache, const QgsFeatureRequest &featureRequest ); /** * Rewind to the beginning of the iterator * - * @return bool true if the operation was ok + * \returns bool true if the operation was ok */ virtual bool rewind() override; /** * Close this iterator. No further features will be available. * - * @return true if successful + * \returns true if successful */ virtual bool close() override; @@ -59,18 +59,18 @@ class CORE_EXPORT QgsCachedFeatureIterator : public QgsAbstractFeatureIterator /** * Implementation for fetching a feature. * - * @param f Will write to this feature - * @return bool true if the operation was ok + * \param f Will write to this feature + * \returns bool true if the operation was ok * - * @see bool getFeature( QgsFeature& f ) + * \see bool getFeature( QgsFeature& f ) */ virtual bool fetchFeature( QgsFeature &f ) override; /** * We have a local special iterator for FilterFids, no need to run the generic. * - * @param f Will write to this feature - * @return bool true if the operation was ok + * \param f Will write to this feature + * \returns bool true if the operation was ok */ virtual bool nextFeatureFilterFids( QgsFeature &f ) override { return fetchFeature( f ); } @@ -81,7 +81,7 @@ class CORE_EXPORT QgsCachedFeatureIterator : public QgsAbstractFeatureIterator }; /** \ingroup core - * @brief + * \brief * Uses another iterator as backend and writes features to the cache * */ @@ -92,22 +92,22 @@ class CORE_EXPORT QgsCachedFeatureWriterIterator : public QgsAbstractFeatureIter /** * This constructor creates a feature iterator, which queries the backend and caches retrieved features. * - * @param vlCache The vector layer cache to use - * @param featureRequest The feature request to answer + * \param vlCache The vector layer cache to use + * \param featureRequest The feature request to answer */ QgsCachedFeatureWriterIterator( QgsVectorLayerCache *vlCache, const QgsFeatureRequest &featureRequest ); /** * Rewind to the beginning of the iterator * - * @return bool true if the operation was ok + * \returns bool true if the operation was ok */ virtual bool rewind() override; /** * Close this iterator. No further features will be available. * - * @return true if successful + * \returns true if successful */ virtual bool close() override; @@ -116,10 +116,10 @@ class CORE_EXPORT QgsCachedFeatureWriterIterator : public QgsAbstractFeatureIter /** * Implementation for fetching a feature. * - * @param f Will write to this feature - * @return bool true if the operation was ok + * \param f Will write to this feature + * \returns bool true if the operation was ok * - * @see bool getFeature( QgsFeature& f ) + * \see bool getFeature( QgsFeature& f ) */ virtual bool fetchFeature( QgsFeature &f ) override; diff --git a/src/core/qgscacheindex.h b/src/core/qgscacheindex.h index 4830d45f8e86..cc933ca7bf05 100644 --- a/src/core/qgscacheindex.h +++ b/src/core/qgscacheindex.h @@ -23,7 +23,7 @@ class QgsFeatureRequest; class QgsFeatureIterator; /** \ingroup core - * @brief + * \brief * Abstract base class for cache indices */ @@ -50,13 +50,13 @@ class CORE_EXPORT QgsAbstractCacheIndex virtual void flush() = 0; /** - * @brief + * \brief * Implement this method to update the the indices, in case you need information contained by the request * to properly index. (E.g. spatial index) * Does nothing by default * - * @param featureRequest The feature request that was answered - * @param fids The feature ids that have been returned + * \param featureRequest The feature request that was answered + * \param fids The feature ids that have been returned */ virtual void requestCompleted( const QgsFeatureRequest &featureRequest, const QgsFeatureIds &fids ); @@ -66,12 +66,12 @@ class CORE_EXPORT QgsAbstractCacheIndex * and set the iterator to a valid iterator over the cached features. If it is not able * it will return false. * - * @param featureIterator A reference to a {@link QgsFeatureIterator}. A valid featureIterator will + * \param featureIterator A reference to a QgsFeatureIterator. A valid featureIterator will * be assigned in case this index is able to answer the request and the return * value is true. - * @param featureRequest The feature request, for which this index is queried. + * \param featureRequest The feature request, for which this index is queried. * - * @return True, if this index holds the information to answer the request. + * \returns True, if this index holds the information to answer the request. * */ virtual bool getCacheIterator( QgsFeatureIterator &featureIterator, const QgsFeatureRequest &featureRequest ) = 0; diff --git a/src/core/qgsclipper.h b/src/core/qgsclipper.h index b6d8e7ebb337..8c3cdf433e08 100644 --- a/src/core/qgsclipper.h +++ b/src/core/qgsclipper.h @@ -87,7 +87,7 @@ class CORE_EXPORT QgsClipper * the function treats the points as a closed shape (polygon), or as * an open shape (linestring). * - * @note not available in Python bindings on android + * \note not available in Python bindings on android */ static void trimFeature( QVector &x, QVector &y, @@ -98,9 +98,9 @@ class CORE_EXPORT QgsClipper static void trimPolygon( QPolygonF &pts, const QgsRectangle &clipRect ); /** Takes a linestring and clips it to clipExtent - * @param curve the linestring - * @param clipExtent clipping bounds - * @return clipped line coordinates + * \param curve the linestring + * \param clipExtent clipping bounds + * \returns clipped line coordinates */ static QPolygonF clippedLine( const QgsCurve &curve, const QgsRectangle &clipExtent ); @@ -139,12 +139,12 @@ class CORE_EXPORT QgsClipper static bool clipLineSegment( double xLeft, double xRight, double yBottom, double yTop, double &x0, double &y0, double &x1, double &y1 ); /** Connects two lines split by the clip (by inserting points on the clip border) - @param x0 x-coordinate of the first line end - @param y0 y-coordinate of the first line end - @param x1 x-coordinate of the second line start - @param y1 y-coordinate of the second line start - @param clipRect clip rectangle - @param pts: in/out array of clipped points + \param x0 x-coordinate of the first line end + \param y0 y-coordinate of the first line end + \param x1 x-coordinate of the second line start + \param y1 y-coordinate of the second line start + \param clipRect clip rectangle + \param pts: in/out array of clipped points */ static void connectSeparatedLines( double x0, double y0, double x1, double y1, const QgsRectangle &clipRect, QPolygonF &pts ); diff --git a/src/core/qgscolorramp.h b/src/core/qgscolorramp.h index 000c5e8af0b4..c81e90069b2c 100644 --- a/src/core/qgscolorramp.h +++ b/src/core/qgscolorramp.h @@ -42,8 +42,8 @@ class CORE_EXPORT QgsColorRamp virtual double value( int index ) const = 0; /** Returns the color corresponding to a specified value. - * @param value value between [0, 1] inclusive - * @returns color for value + * \param value value between [0, 1] inclusive + * \returns color for value */ virtual QColor color( double value ) const = 0; @@ -75,8 +75,8 @@ class CORE_EXPORT QgsGradientStop public: /** Constructor for QgsGradientStop - * @param offset positional offset for stop, between 0 and 1.0 - * @param color color for stop + * \param offset positional offset for stop, between 0 and 1.0 + * \param color color for stop */ QgsGradientStop( double offset, const QColor &color ) : offset( offset ) @@ -111,11 +111,11 @@ class CORE_EXPORT QgsGradientColorRamp : public QgsColorRamp public: /** Constructor for QgsGradientColorRamp - * @param color1 start color, corresponding to a position of 0.0 - * @param color2 end color, corresponding to a position of 1.0 - * @param discrete set to true for discrete interpolation instead of smoothly + * \param color1 start color, corresponding to a position of 0.0 + * \param color2 end color, corresponding to a position of 1.0 + * \param discrete set to true for discrete interpolation instead of smoothly * interpolating between colors - * @param stops optional list of additional color stops + * \param stops optional list of additional color stops */ QgsGradientColorRamp( const QColor &color1 = DEFAULT_GRADIENT_COLOR1, const QColor &color2 = DEFAULT_GRADIENT_COLOR2, @@ -134,80 +134,80 @@ class CORE_EXPORT QgsGradientColorRamp : public QgsColorRamp virtual QgsStringMap properties() const override; /** Returns the gradient start color. - * @see setColor1() - * @see color2() + * \see setColor1() + * \see color2() */ QColor color1() const { return mColor1; } /** Returns the gradient end color. - * @see setColor2() - * @see color1() + * \see setColor2() + * \see color1() */ QColor color2() const { return mColor2; } /** Sets the gradient start color. - * @param color start color - * @see color1() - * @see setColor2() + * \param color start color + * \see color1() + * \see setColor2() */ void setColor1( const QColor &color ) { mColor1 = color; } /** Sets the gradient end color. - * @param color end color - * @see color2() - * @see setColor1() + * \param color end color + * \see color2() + * \see setColor1() */ void setColor2( const QColor &color ) { mColor2 = color; } /** Returns true if the gradient is using discrete interpolation, rather than * smoothly interpolating between colors. - * @see setDiscrete() + * \see setDiscrete() */ bool isDiscrete() const { return mDiscrete; } /** Sets whether the gradient should use discrete interpolation, rather than * smoothly interpolating between colors. - * @param discrete set to true to use discrete interpolation - * @see convertToDiscrete() - * @see isDiscrete() + * \param discrete set to true to use discrete interpolation + * \see convertToDiscrete() + * \see isDiscrete() */ void setDiscrete( bool discrete ) { mDiscrete = discrete; } /** Converts a gradient with existing color stops to or from discrete * interpolation. - * @param discrete set to true to convert the gradient stops to discrete, + * \param discrete set to true to convert the gradient stops to discrete, * or false to convert them to smooth interpolation - * @see isDiscrete() + * \see isDiscrete() */ void convertToDiscrete( bool discrete ); /** Sets the list of intermediate gradient stops for the ramp. - * @param stops list of stops. Any existing color stops will be replaced. The stop + * \param stops list of stops. Any existing color stops will be replaced. The stop * list will be automatically reordered so that stops are listed in ascending offset * order. - * @see stops() + * \see stops() */ void setStops( const QgsGradientStopsList &stops ); /** Returns the list of intermediate gradient stops for the ramp. - * @see setStops() + * \see setStops() */ QgsGradientStopsList stops() const { return mStops; } /** Returns any additional info attached to the gradient ramp (e.g., authorship notes) - * @see setInfo() + * \see setInfo() */ QgsStringMap info() const { return mInfo; } /** Sets additional info to attach to the gradient ramp (e.g., authorship notes) - * @param info map of string info to attach - * @see info() + * \param info map of string info to attach + * \see info() */ void setInfo( const QgsStringMap &info ) { mInfo = info; } /** Copy color ramp stops to a QGradient - * @param gradient gradient to copy stops into - * @param alpha alpha multiplier. Opacity of colors will be multiplied + * \param gradient gradient to copy stops into + * \param alpha alpha multiplier. Opacity of colors will be multiplied * by this factor before adding to the gradient. * \since QGIS 2.1 */ @@ -239,13 +239,13 @@ class CORE_EXPORT QgsLimitedRandomColorRamp : public QgsColorRamp public: /** Constructor for QgsLimitedRandomColorRamp - * @param count number of colors in ramp - * @param hueMin minimum hue - * @param hueMax maximum hue - * @param satMin minimum saturation - * @param satMax maximum saturation - * @param valMin minimum color value - * @param valMax maximum color value + * \param count number of colors in ramp + * \param hueMin minimum hue + * \param hueMax maximum hue + * \param satMin minimum saturation + * \param satMax maximum saturation + * \param valMin minimum color value + * \param valMax maximum color value */ QgsLimitedRandomColorRamp( int count = DEFAULT_RANDOM_COUNT, int hueMin = DEFAULT_RANDOM_HUE_MIN, int hueMax = DEFAULT_RANDOM_HUE_MAX, @@ -254,8 +254,8 @@ class CORE_EXPORT QgsLimitedRandomColorRamp : public QgsColorRamp /** Returns a new QgsLimitedRandomColorRamp color ramp created using the properties encoded in a string * map. - * @param properties color ramp properties - * @see properties() + * \param properties color ramp properties + * \see properties() */ static QgsColorRamp *create( const QgsStringMap &properties = QgsStringMap() ); @@ -280,32 +280,32 @@ class CORE_EXPORT QgsLimitedRandomColorRamp : public QgsColorRamp void updateColors(); /** Returns the minimum hue for generated colors - * @see setHueMin() + * \see setHueMin() */ int hueMin() const { return mHueMin; } /** Returns the maximum hue for generated colors - * @see setHueMax() + * \see setHueMax() */ int hueMax() const { return mHueMax; } /** Returns the minimum saturation for generated colors - * @see setSatMin() + * \see setSatMin() */ int satMin() const { return mSatMin; } /** Returns the maximum saturation for generated colors - * @see setSatMax() + * \see setSatMax() */ int satMax() const { return mSatMax; } /** Returns the minimum value for generated colors - * @see setValMin() + * \see setValMin() */ int valMin() const { return mValMin; } /** Returns the maximum value for generated colors - * @see setValMax() + * \see setValMax() */ int valMax() const { return mValMax; } @@ -314,32 +314,32 @@ class CORE_EXPORT QgsLimitedRandomColorRamp : public QgsColorRamp void setCount( int val ) { mCount = val; } /** Sets the minimum hue for generated colors - * @see hueMin() + * \see hueMin() */ void setHueMin( int val ) { mHueMin = val; } /** Sets the maximum hue for generated colors - * @see hueMax() + * \see hueMax() */ void setHueMax( int val ) { mHueMax = val; } /** Sets the minimum saturation for generated colors - * @see satMin() + * \see satMin() */ void setSatMin( int val ) { mSatMin = val; } /** Sets the maximum saturation for generated colors - * @see satMax() + * \see satMax() */ void setSatMax( int val ) { mSatMax = val; } /** Sets the minimum value for generated colors - * @see valMin() + * \see valMin() */ void setValMin( int val ) { mValMin = val; } /** Sets the maximum value for generated colors - * @see valMax() + * \see valMax() */ void setValMax( int val ) { mValMax = val; } @@ -369,7 +369,7 @@ class CORE_EXPORT QgsRandomColorRamp: public QgsColorRamp /** Sets the desired total number of unique colors for the resultant ramp. Calling * this method pregenerates a set of visually distinct colors which are returned * by subsequent calls to color(). - * @param colorCount number of unique colors + * \param colorCount number of unique colors * \since QGIS 2.5 */ virtual void setTotalColorCount( const int colorCount ); @@ -398,31 +398,31 @@ class CORE_EXPORT QgsPresetSchemeColorRamp : public QgsColorRamp, public QgsColo public: /** Constructor for QgsPresetSchemeColorRamp. - * @param colors list of colors in ramp + * \param colors list of colors in ramp */ QgsPresetSchemeColorRamp( const QList< QColor > &colors = QList< QColor >() ); /** Constructor for QgsPresetColorRamp. - * @param colors list of named colors in ramp - * @note not available in Python bindings - use setColors instead + * \param colors list of named colors in ramp + * \note not available in Python bindings - use setColors instead */ QgsPresetSchemeColorRamp( const QgsNamedColorList &colors ); /** Returns a new QgsPresetSchemeColorRamp color ramp created using the properties encoded in a string * map. - * @param properties color ramp properties - * @see properties() + * \param properties color ramp properties + * \see properties() */ static QgsColorRamp *create( const QgsStringMap &properties = QgsStringMap() ); /** Sets the list of colors used by the ramp. - * @param colors list of colors - * @see colors() + * \param colors list of colors + * \see colors() */ bool setColors( const QgsNamedColorList &colors, const QString & = QString(), const QColor & = QColor() ) override { mColors = colors; return true; } /** Returns the list of colors used by the ramp. - * @see setColors() + * \see setColors() */ QList< QColor > colors() const; @@ -460,9 +460,9 @@ class CORE_EXPORT QgsColorBrewerColorRamp : public QgsColorRamp public: /** Constructor for QgsColorBrewerColorRamp - * @param schemeName color brewer scheme name - * @param colors number of colors in ramp - * @param inverted invert ramp ordering + * \param schemeName color brewer scheme name + * \param colors number of colors in ramp + * \param inverted invert ramp ordering */ QgsColorBrewerColorRamp( const QString &schemeName = DEFAULT_COLORBREWER_SCHEMENAME, int colors = DEFAULT_COLORBREWER_COLORS, @@ -470,8 +470,8 @@ class CORE_EXPORT QgsColorBrewerColorRamp : public QgsColorRamp /** Returns a new QgsColorBrewerColorRamp color ramp created using the properties encoded in a string * map. - * @param properties color ramp properties - * @see properties() + * \param properties color ramp properties + * \see properties() */ static QgsColorRamp *create( const QgsStringMap &properties = QgsStringMap() ); @@ -484,38 +484,38 @@ class CORE_EXPORT QgsColorBrewerColorRamp : public QgsColorRamp virtual int count() const override { return mColors; } /** Returns the name of the color brewer color scheme. - * @see setSchemeName() + * \see setSchemeName() */ QString schemeName() const { return mSchemeName; } /** Returns the number of colors in the ramp. - * @see setColors() + * \see setColors() */ int colors() const { return mColors; } /** Sets the name of the color brewer color scheme. - * @param schemeName scheme name, must match a valid color brewer scheme name - * @see schemeName() - * @see listSchemeNames() + * \param schemeName scheme name, must match a valid color brewer scheme name + * \see schemeName() + * \see listSchemeNames() */ void setSchemeName( const QString &schemeName ) { mSchemeName = schemeName; loadPalette(); } /** Sets the number of colors in the ramp. - * @param colors number of colors. Must match a valid value for the scheme, + * \param colors number of colors. Must match a valid value for the scheme, * which can be retrieved using listSchemeVariants() - * @see colors() + * \see colors() */ void setColors( int colors ) { mColors = colors; loadPalette(); } /** Returns a list of all valid color brewer scheme names. - * @see listSchemeVariants() + * \see listSchemeVariants() */ static QStringList listSchemeNames(); /** Returns a list of the valid variants (numbers of colors) for a specified * color brewer scheme name - * @param schemeName color brewer scheme name - * @see listSchemeNames() + * \param schemeName color brewer scheme name + * \see listSchemeNames() */ static QList listSchemeVariants( const QString &schemeName ); @@ -542,10 +542,10 @@ class CORE_EXPORT QgsCptCityColorRamp : public QgsGradientColorRamp public: /** Constructor for QgsCptCityColorRamp - * @param schemeName cpt-city scheme name - * @param variantName cpt-city variant name - * @param inverted invert ramp ordering - * @param doLoadFile load cpt-city ramp from file + * \param schemeName cpt-city scheme name + * \param variantName cpt-city variant name + * \param inverted invert ramp ordering + * \param doLoadFile load cpt-city ramp from file */ QgsCptCityColorRamp( const QString &schemeName = DEFAULT_CPTCITY_SCHEMENAME, const QString &variantName = DEFAULT_CPTCITY_VARIANTNAME, @@ -553,11 +553,11 @@ class CORE_EXPORT QgsCptCityColorRamp : public QgsGradientColorRamp bool doLoadFile = true ); /** Constructor for QgsCptCityColorRamp - * @param schemeName cpt-city scheme name - * @param variantList cpt-city variant list - * @param variantName cpt-city variant name - * @param inverted invert ramp ordering - * @param doLoadFile load cpt-city ramp from file + * \param schemeName cpt-city scheme name + * \param variantList cpt-city variant list + * \param variantName cpt-city variant name + * \param inverted invert ramp ordering + * \param doLoadFile load cpt-city ramp from file */ QgsCptCityColorRamp( const QString &schemeName, const QStringList &variantList, const QString &variantName = QString(), bool inverted = false, diff --git a/src/core/qgscolorscheme.h b/src/core/qgscolorscheme.h index b74e55d58bd6..f96d2e1612b2 100644 --- a/src/core/qgscolorscheme.h +++ b/src/core/qgscolorscheme.h @@ -62,45 +62,45 @@ class CORE_EXPORT QgsColorScheme virtual ~QgsColorScheme() = default; /** Gets the name for the color scheme - * @returns color scheme name + * \returns color scheme name */ virtual QString schemeName() const = 0; /** Returns the current flags for the color scheme. - * @returns current flags + * \returns current flags */ virtual SchemeFlags flags() const { return ShowInColorDialog; } /** Gets a list of colors from the scheme. The colors can optionally * be generated using the supplied context and base color. - * @param context string specifying an optional context for the returned + * \param context string specifying an optional context for the returned * colors. For instance, a "recent colors" scheme may filter returned colors * by context so that colors used only in a "composer" context are returned. - * @param baseColor base color for the scheme's colors. Some color schemes + * \param baseColor base color for the scheme's colors. Some color schemes * may take advantage of this to filter or modify their returned colors * to colors related to the base color. - * @returns a list of QPairs of color and color name + * \returns a list of QPairs of color and color name */ virtual QgsNamedColorList fetchColors( const QString &context = QString(), const QColor &baseColor = QColor() ) = 0; /** Returns whether the color scheme is editable - * @returns true if scheme is editable - * @see setColors + * \returns true if scheme is editable + * \see setColors */ virtual bool isEditable() const { return false; } /** Sets the colors for the scheme. This method is only valid for editable color schemes. - * @param colors list of colors for the scheme - * @param context to set colors for - * @param baseColor base color to set colors for - * @returns true if colors were set successfully - * @see isEditable + * \param colors list of colors for the scheme + * \param context to set colors for + * \param baseColor base color to set colors for + * \returns true if colors were set successfully + * \see isEditable */ virtual bool setColors( const QgsNamedColorList &colors, const QString &context = QString(), const QColor &baseColor = QColor() ); /** Clones a color scheme - * @returns copy of color scheme + * \returns copy of color scheme */ virtual QgsColorScheme *clone() const = 0; }; @@ -126,7 +126,7 @@ class CORE_EXPORT QgsGplColorScheme : public QgsColorScheme protected: /** Returns the file path for the associated gpl palette file - * @returns gpl file path + * \returns gpl file path */ virtual QString gplFilePath() = 0; @@ -143,7 +143,7 @@ class CORE_EXPORT QgsUserColorScheme : public QgsGplColorScheme public: /** Constructs a new user color scheme, using a specified gpl palette file - * @param filename filename of gpl palette file stored in the users "palettes" folder + * \param filename filename of gpl palette file stored in the users "palettes" folder */ QgsUserColorScheme( const QString &filename ); @@ -156,17 +156,17 @@ class CORE_EXPORT QgsUserColorScheme : public QgsGplColorScheme virtual QgsColorScheme::SchemeFlags flags() const override; /** Sets the name for the scheme - * @param name new name + * \param name new name */ void setName( const QString &name ) { mName = name; } /** Erases the associated gpl palette file from the users "palettes" folder - * @returns true if erase was successful + * \returns true if erase was successful */ bool erase(); /** Sets whether a this scheme should be shown in color button menus. - * @param show set to true to show in color button menus, or false to hide from menus + * \param show set to true to show in color button menus, or false to hide from menus * \since QGIS 3.0 */ void setShowSchemeInMenu( bool show ); @@ -202,15 +202,15 @@ class CORE_EXPORT QgsRecentColorScheme : public QgsColorScheme QgsRecentColorScheme *clone() const override; /** Adds a color to the list of recent colors. - * @param color color to add + * \param color color to add * \since QGIS 2.14 - * @see lastUsedColor() + * \see lastUsedColor() */ static void addRecentColor( const QColor &color ); /** Returns the most recently used color. * \since QGIS 3.0 - * @see addRecentColor() + * \see addRecentColor() */ static QColor lastUsedColor(); }; diff --git a/src/core/qgscolorschemeregistry.h b/src/core/qgscolorschemeregistry.h index 5685acc0f6f3..f81b3080461e 100644 --- a/src/core/qgscolorschemeregistry.h +++ b/src/core/qgscolorschemeregistry.h @@ -42,54 +42,54 @@ class CORE_EXPORT QgsColorSchemeRegistry virtual ~QgsColorSchemeRegistry(); /** Adds all color schemes from the global instance to this color scheme. - * @see addDefaultSchemes - * @see addColorScheme + * \see addDefaultSchemes + * \see addColorScheme */ void populateFromInstance(); /** Adds all default color schemes to this color scheme. - * @see populateFromInstance - * @see addColorScheme - * @see addUserSchemes + * \see populateFromInstance + * \see addColorScheme + * \see addUserSchemes */ void addDefaultSchemes(); /** Creates schemes for all gpl palettes in the user's palettes folder. - * @see populateFromInstance - * @see addDefaultSchemes - * @see addColorScheme + * \see populateFromInstance + * \see addDefaultSchemes + * \see addColorScheme */ void addUserSchemes(); /** Adds a color scheme to the registry. Ownership of the scheme is transferred * to the registry. - * @param scheme color scheme to add - * @see populateFromInstance - * @see removeColorScheme + * \param scheme color scheme to add + * \see populateFromInstance + * \see removeColorScheme */ void addColorScheme( QgsColorScheme *scheme ); /** Removes all matching color schemes from the registry - * @param scheme color scheme to remove - * @returns true if scheme was found and removed - * @see addColorScheme + * \param scheme color scheme to remove + * \returns true if scheme was found and removed + * \see addColorScheme */ bool removeColorScheme( QgsColorScheme *scheme ); /** Returns all color schemes in the registry - * @returns list of color schemes + * \returns list of color schemes */ QList schemes() const; /** Returns all color schemes in the registry which have a specified flag set - * @param flag flag to match - * @returns list of color schemes with flag set + * \param flag flag to match + * \returns list of color schemes with flag set */ QList schemes( const QgsColorScheme::SchemeFlag flag ) const; /** Return color schemes of a specific type - * @param schemeList destination list for matching schemes - * @note not available in Python bindings + * \param schemeList destination list for matching schemes + * \note not available in Python bindings */ template void schemes( QList &schemeList ); diff --git a/src/core/qgsconditionalstyle.h b/src/core/qgsconditionalstyle.h index e5621f81c883..073a2481477f 100644 --- a/src/core/qgsconditionalstyle.h +++ b/src/core/qgsconditionalstyle.h @@ -16,7 +16,7 @@ typedef QList QgsConditionalStyles; /** \ingroup core - * @brief The QgsConditionalLayerStyles class holds conditional style information + * \brief The QgsConditionalLayerStyles class holds conditional style information * for a layer. This includes field styles and full row styles. */ class CORE_EXPORT QgsConditionalLayerStyles @@ -27,23 +27,23 @@ class CORE_EXPORT QgsConditionalLayerStyles QList rowStyles(); /** - * @brief Set the conditional styles that apply to full rows of data in the attribute table. + * \brief Set the conditional styles that apply to full rows of data in the attribute table. * Each row will check be checked against each rule. - * @param styles The styles to assign to all the rows + * \param styles The styles to assign to all the rows * \since QGIS 2.12 */ void setRowStyles( const QList &styles ); /** - * @brief Set the conditional styles for the field UI properties. - * @param fieldName name of field - * @param styles + * \brief Set the conditional styles for the field UI properties. + * \param fieldName name of field + * \param styles */ void setFieldStyles( const QString &fieldName, const QList &styles ); /** - * @brief Returns the conditional styles set for the field UI properties - * @return A list of conditional styles that have been set. + * \brief Returns the conditional styles set for the field UI properties + * \returns A list of conditional styles that have been set. */ QList fieldStyles( const QString &fieldName ); @@ -74,149 +74,149 @@ class CORE_EXPORT QgsConditionalStyle QgsConditionalStyle &operator=( const QgsConditionalStyle &other ); /** - * @brief Check if the rule matches using the given value and feature - * @param value The current value being checked. The "value" variable from the context is replaced with this value. - * @param context Expression context for evaluating rule expression - * @return True of the rule matches against the given feature + * \brief Check if the rule matches using the given value and feature + * \param value The current value being checked. The "value" variable from the context is replaced with this value. + * \param context Expression context for evaluating rule expression + * \returns True of the rule matches against the given feature */ bool matches( const QVariant &value, QgsExpressionContext &context ) const; /** - * @brief Render a preview icon of the rule. - * @return QPixmap preview of the style + * \brief Render a preview icon of the rule. + * \returns QPixmap preview of the style */ QPixmap renderPreview() const; /** - * @brief Set the name of the style. Names are optional but handy for display - * @param value The name given to the style + * \brief Set the name of the style. Names are optional but handy for display + * \param value The name given to the style */ void setName( const QString &value ) { mName = value; mValid = true; } /** - * @brief Set the rule for the style. Rules should be of QgsExpression syntax. + * \brief Set the rule for the style. Rules should be of QgsExpression syntax. * Special value of \@value is replaced at run time with the check value - * @param value The QgsExpression style rule to use for this style + * \param value The QgsExpression style rule to use for this style */ void setRule( const QString &value ) { mRule = value; mValid = true; } /** - * @brief Set the background color for the style - * @param value QColor for background color + * \brief Set the background color for the style + * \param value QColor for background color */ void setBackgroundColor( const QColor &value ) { mBackColor = value; mValid = true; } /** - * @brief Set the text color for the style - * @param value QColor for text color + * \brief Set the text color for the style + * \param value QColor for text color */ void setTextColor( const QColor &value ) { mTextColor = value; mValid = true; } /** - * @brief Set the font for the the style - * @param value QFont to be used for text + * \brief Set the font for the the style + * \param value QFont to be used for text */ void setFont( const QFont &value ) { mFont = value; mValid = true; } /** - * @brief Set the icon for the style. Icons are generated from symbols - * @param value QgsSymbol to be used when generating the icon + * \brief Set the icon for the style. Icons are generated from symbols + * \param value QgsSymbol to be used when generating the icon */ void setSymbol( QgsSymbol *value ); /** - * @brief The name of the style. - * @return The name of the style. Names are optional so might be empty. + * \brief The name of the style. + * \returns The name of the style. Names are optional so might be empty. */ QString displayText() const; /** - * @brief The name of the style. - * @return The name of the style. Names are optional so might be empty. + * \brief The name of the style. + * \returns The name of the style. Names are optional so might be empty. */ QString name() const { return mName; } /** - * @brief The icon set for style generated from the set symbol - * @return A QPixmap that was set for the icon using the symbol + * \brief The icon set for style generated from the set symbol + * \returns A QPixmap that was set for the icon using the symbol */ QPixmap icon() const { return mIcon; } /** - * @brief The symbol used to generate the icon for the style - * @return The QgsSymbol used for the icon + * \brief The symbol used to generate the icon for the style + * \returns The QgsSymbol used for the icon */ QgsSymbol *symbol() const { return mSymbol.get(); } /** - * @brief The text color set for style - * @return QColor for text color + * \brief The text color set for style + * \returns QColor for text color */ QColor textColor() const { return mTextColor; } /** - * @brief Check if the text color is valid for render. + * \brief Check if the text color is valid for render. * Valid colors are non invalid QColors and a color with a > 0 alpha - * @return True of the color set for text is valid. + * \returns True of the color set for text is valid. */ bool validTextColor() const; /** - * @brief The background color for style - * @return QColor for background color + * \brief The background color for style + * \returns QColor for background color */ QColor backgroundColor() const { return mBackColor; } /** - * @brief Check if the background color is valid for render. + * \brief Check if the background color is valid for render. * Valid colors are non invalid QColors and a color with a > 0 alpha - * @return True of the color set for background is valid. + * \returns True of the color set for background is valid. */ bool validBackgroundColor() const; /** - * @brief The font for the style - * @return QFont for the style + * \brief The font for the style + * \returns QFont for the style */ QFont font() const { return mFont; } /** - * @brief The condition rule set for the style. Rule may contain variable \@value + * \brief The condition rule set for the style. Rule may contain variable \@value * to represent the current value - * @return QString of the current set rule + * \returns QString of the current set rule */ QString rule() const { return mRule; } /** - * @brief isValid Check if this rule is valid. A valid rule has one or more properties + * \brief isValid Check if this rule is valid. A valid rule has one or more properties * set. - * @return True if the rule is valid. + * \returns True if the rule is valid. */ bool isValid() const { return mValid; } /** - * @brief Find and return the matching styles for the value and feature. + * \brief Find and return the matching styles for the value and feature. * If no match is found a invalid QgsConditionalStyle is return. * - * @return A condtional style that matches the value and feature. + * \returns A condtional style that matches the value and feature. * Check with QgsConditionalStyle::isValid() */ static QList matchingConditionalStyles( const QList &styles, const QVariant &value, QgsExpressionContext &context ); /** - * @brief Find and return the matching style for the value and feature. + * \brief Find and return the matching style for the value and feature. * If no match is found a invalid QgsConditionalStyle is return. * - * @return A condtional style that matches the value and feature. + * \returns A condtional style that matches the value and feature. * Check with QgsConditionalStyle::isValid() */ static QgsConditionalStyle matchingConditionalStyle( const QList &styles, const QVariant &value, QgsExpressionContext &context ); /** - * @brief Compress a list of styles into a single style. This can be used to stack the elements of the + * \brief Compress a list of styles into a single style. This can be used to stack the elements of the * styles. The font of the last style is used in the output. - * @param styles The list of styles to compress down - * @return A single style generated from joining each style property. + * \param styles The list of styles to compress down + * \returns A single style generated from joining each style property. */ static QgsConditionalStyle compressStyles( const QList &styles ); diff --git a/src/core/qgsconnectionpool.h b/src/core/qgsconnectionpool.h index fa603764943b..26a9a21e41d9 100644 --- a/src/core/qgsconnectionpool.h +++ b/src/core/qgsconnectionpool.h @@ -256,7 +256,7 @@ class QgsConnectionPool } //! Try to acquire a connection: if no connections are available, the thread will get blocked. - //! @return initialized connection or null on error + //! \returns initialized connection or null on error T acquireConnection( const QString &connInfo ) { mMutex.lock(); diff --git a/src/core/qgscoordinatereferencesystem.h b/src/core/qgscoordinatereferencesystem.h index 704fb7dce6e9..2721aeffdf2e 100644 --- a/src/core/qgscoordinatereferencesystem.h +++ b/src/core/qgscoordinatereferencesystem.h @@ -204,7 +204,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem ~QgsCoordinateReferenceSystem(); - /*! + /** * Constructs a CRS object from a string definition using createFromString() * * It supports the following formats: @@ -215,17 +215,17 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * - "WKT:" - handled with createFromWkt() * * If no prefix is specified, WKT definition is assumed. - * @param definition A String containing a coordinate reference system definition. - * @see createFromString() + * \param definition A String containing a coordinate reference system definition. + * \see createFromString() */ // TODO QGIS 3: remove "POSTGIS" and "INTERNAL", allow PROJ4 without the prefix explicit QgsCoordinateReferenceSystem( const QString &definition ); /** Constructor a CRS object using a postgis SRID, an EPSG code or an internal QGIS CRS ID. - * @note We encourage you to use EPSG code, WKT or Proj4 to describe CRS's in your code + * \note We encourage you to use EPSG code, WKT or Proj4 to describe CRS's in your code * wherever possible. Internal QGIS CRS IDs are not guaranteed to be permanent / involatile. - * @param id The ID valid for the chosen CRS ID type - * @param type One of the types described in CrsType + * \param id The ID valid for the chosen CRS ID type + * \param type One of the types described in CrsType */ // TODO QGIS 3: remove type and always use EPSG code QgsCoordinateReferenceSystem( const long id, CrsType type = PostgisCrsId ); @@ -240,7 +240,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * Returns a list of all valid SRS IDs present in the CRS database. Any of the * returned values can be safely passed to fromSrsId() to create a new, valid * QgsCoordinateReferenceSystem object. - * @see fromSrsId() + * \see fromSrsId() * \since QGIS 3.0 */ static QList< long > validSrsIds(); @@ -248,42 +248,42 @@ class CORE_EXPORT QgsCoordinateReferenceSystem // static creators /** Creates a CRS from a given OGC WMS-format Coordinate Reference System string. - * @param ogcCrs OGR compliant CRS definition, e.g., "EPSG:4326" - * @returns matching CRS, or an invalid CRS if string could not be matched + * \param ogcCrs OGR compliant CRS definition, e.g., "EPSG:4326" + * \returns matching CRS, or an invalid CRS if string could not be matched * \since QGIS 3.0 - * @see createFromOgcWmsCrs() + * \see createFromOgcWmsCrs() */ static QgsCoordinateReferenceSystem fromOgcWmsCrs( const QString &ogcCrs ); /** Creates a CRS from a given EPSG ID. - * @param epsg epsg CRS ID - * @returns matching CRS, or an invalid CRS if string could not be matched + * \param epsg epsg CRS ID + * \returns matching CRS, or an invalid CRS if string could not be matched * \since QGIS 3.0 */ Q_INVOKABLE static QgsCoordinateReferenceSystem fromEpsgId( long epsg ); /** Creates a CRS from a proj4 style formatted string. - * @param proj4 proj4 format string - * @returns matching CRS, or an invalid CRS if string could not be matched + * \param proj4 proj4 format string + * \returns matching CRS, or an invalid CRS if string could not be matched * \since QGIS 3.0 - * @see createFromProj4() + * \see createFromProj4() */ static QgsCoordinateReferenceSystem fromProj4( const QString &proj4 ); /** Creates a CRS from a WKT spatial ref sys definition string. - * @param wkt WKT for the desired spatial reference system. - * @returns matching CRS, or an invalid CRS if string could not be matched + * \param wkt WKT for the desired spatial reference system. + * \returns matching CRS, or an invalid CRS if string could not be matched * \since QGIS 3.0 - * @see createFromWkt() + * \see createFromWkt() */ static QgsCoordinateReferenceSystem fromWkt( const QString &wkt ); /** Creates a CRS from a specified QGIS SRS ID. - * @param srsId internal QGIS SRS ID - * @returns matching CRS, or an invalid CRS if ID could not be found + * \param srsId internal QGIS SRS ID + * \returns matching CRS, or an invalid CRS if ID could not be found * \since QGIS 3.0 - * @see createFromSrsId() - * @see validSrsIds() + * \see createFromSrsId() + * \see validSrsIds() */ static QgsCoordinateReferenceSystem fromSrsId( long srsId ); @@ -291,9 +291,9 @@ class CORE_EXPORT QgsCoordinateReferenceSystem /** * Sets this CRS by lookup of the given ID in the CRS database. - * @note We encourage you to use EPSG code, WKT or Proj4 to describe CRS's in your code + * \note We encourage you to use EPSG code, WKT or Proj4 to describe CRS's in your code * wherever possible. Internal QGIS CRS IDs are not guaranteed to be permanent / involatile. - * @return True on success else false + * \returns True on success else false */ // TODO QGIS 3: remove type and always use EPSG code, rename to createFromEpsg bool createFromId( const long id, CrsType type = PostgisCrsId ); @@ -304,16 +304,16 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * Accepts both ":" format and OGC URN "urn:ogc:def:crs::[]:". * It also recognizes "QGIS", "USER", "CUSTOM" authorities, which all have the same meaning * and refer to QGIS internal CRS IDs. - * @note this method uses an internal cache. Call invalidateCache() to clear the cache. - * @return True on success else false - * @see fromOgcWmsCrs() + * \note this method uses an internal cache. Call invalidateCache() to clear the cache. + * \returns True on success else false + * \see fromOgcWmsCrs() */ // TODO QGIS 3: remove "QGIS" and "CUSTOM", only support "USER" (also returned by authid()) bool createFromOgcWmsCrs( const QString &crs ); /** Sets this CRS by lookup of the given PostGIS SRID in the CRS database. - * @param srid The postgis SRID for the desired spatial reference system. - * @return True on success else false + * \param srid The postgis SRID for the desired spatial reference system. + * \returns True on success else false */ // TODO QGIS 3: remove unless really necessary - let's use EPSG codes instead bool createFromSrid( const long srid ); @@ -324,11 +324,11 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * and createFromOgcWmsCrs() is used to initialize the object. * Otherwise the WKT will be converted to a proj4 string and createFromProj4() * set up the object. - * @note Some members may be left blank if no match can be found in CRS database. - * @note this method uses an internal cache. Call invalidateCache() to clear the cache. - * @param wkt The WKT for the desired spatial reference system. - * @return True on success else false - * @see fromWkt() + * \note Some members may be left blank if no match can be found in CRS database. + * \note this method uses an internal cache. Call invalidateCache() to clear the cache. + * \param wkt The WKT for the desired spatial reference system. + * \returns True on success else false + * \see fromWkt() */ bool createFromWkt( const QString &wkt ); @@ -336,10 +336,10 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * * If the srsid is < USER_CRS_START_ID, system CRS database is used, otherwise * user's local CRS database from home directory is used. - * @note this method uses an internal cache. Call invalidateCache() to clear the cache. - * @param srsId The internal QGIS CRS ID for the desired spatial reference system. - * @return True on success else false - * @see fromSrsId() + * \note this method uses an internal cache. Call invalidateCache() to clear the cache. + * \param srsId The internal QGIS CRS ID for the desired spatial reference system. + * \returns True on success else false + * \see fromSrsId() */ bool createFromSrsId( const long srsId ); @@ -359,11 +359,11 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * a match where the parameters are in a different order * - if none of the above match, use findMatchingProj() * - * @note Some members may be left blank if no match can be found in CRS database. - * @note this method uses an internal cache. Call invalidateCache() to clear the cache. - * @param projString A proj4 format string - * @return True on success else false - * @see fromProj4() + * \note Some members may be left blank if no match can be found in CRS database. + * \note this method uses an internal cache. Call invalidateCache() to clear the cache. + * \param projString A proj4 format string + * \returns True on success else false + * \see fromProj4() */ bool createFromProj4( const QString &projString ); @@ -377,8 +377,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * - "WKT:" - handled with createFromWkt() * * If no prefix is specified, WKT definition is assumed. - * @param definition A String containing a coordinate reference system definition. - * @return True on success else false + * \param definition A String containing a coordinate reference system definition. + * \returns True on success else false */ bool createFromString( const QString &definition ); @@ -391,19 +391,19 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * * For more details on supported formats see OGRSpatialReference::SetFromUserInput() * ( http://www.gdal.org/ogr/classOGRSpatialReference.html#aec3c6a49533fe457ddc763d699ff8796 ) - * @note this function generates a WKT string using OSRSetFromUserInput() and + * \note this function generates a WKT string using OSRSetFromUserInput() and * passes it to createFromWkt() function. - * @param definition A String containing a coordinate reference system definition. - * @return True on success else false + * \param definition A String containing a coordinate reference system definition. + * \returns True on success else false */ // TODO QGIS3: rename to createFromStringOGR so it is clear it's similar to createFromString, just different backend bool createFromUserInput( const QString &definition ); /** Make sure that ESRI WKT import is done properly. * This is required for proper shapefile CRS import when using gdal>= 1.9. - * @note This function is called by createFromUserInput() and QgsOgrProvider::crs(), there is usually + * \note This function is called by createFromUserInput() and QgsOgrProvider::crs(), there is usually * no need to call it from elsewhere. - * @note This function sets CPL config option GDAL_FIX_ESRI_WKT to a proper value, + * \note This function sets CPL config option GDAL_FIX_ESRI_WKT to a proper value, * unless it has been set by the user through the commandline or an environment variable. * For more details refer to OGRSpatialReference::morphFromESRI() . */ @@ -418,17 +418,17 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * method will do its best to make sure that this CRS is valid - even * if that involves resorting to a hard coded default of geocs:wgs84. * - * @note It is not usually necessary to use this function, unless you + * \note It is not usually necessary to use this function, unless you * are trying to force this CRS to be valid. - * @see setCustomCrsValidation(), customCrsValidation() + * \see setCustomCrsValidation(), customCrsValidation() */ void validate(); /** Walks the CRS databases (both system and user database) trying to match * stored PROJ.4 string to a database entry in order to fill in further * pieces of information about CRS. - * @note The ellipsoid and projection acronyms must be set as well as the proj4string! - * @return long the SrsId of the matched CRS, zero if no match was found + * \note The ellipsoid and projection acronyms must be set as well as the proj4string! + * \returns long the SrsId of the matched CRS, zero if no match was found */ // TODO QGIS 3: seems completely obsolete now (only compares proj4 - already done in createFromProj4) long findMatchingProj(); @@ -446,39 +446,39 @@ class CORE_EXPORT QgsCoordinateReferenceSystem bool operator!=( const QgsCoordinateReferenceSystem &srs ) const; /** Restores state from the given DOM node. - * @param node The node from which state will be restored - * @return bool True on success, False on failure + * \param node The node from which state will be restored + * \returns bool True on success, False on failure */ bool readXml( const QDomNode &node ); /** Stores state to the given Dom node in the given document. - * @param node The node in which state will be restored - * @param doc The document in which state will be stored - * @return bool True on success, False on failure + * \param node The node in which state will be restored + * \param doc The document in which state will be stored + * \returns bool True on success, False on failure */ bool writeXml( QDomNode &node, QDomDocument &doc ) const; /** Sets custom function to force valid CRS * QGIS uses implementation in QgisGui::customSrsValidation - * @note not available in Python bindings + * \note not available in Python bindings */ static void setCustomCrsValidation( CUSTOM_CRS_VALIDATION f ); /** Gets custom function - * @note not available in Python bindings + * \note not available in Python bindings */ static CUSTOM_CRS_VALIDATION customCrsValidation(); // Accessors ----------------------------------- /** Returns the internal CRS ID, if available. - * @return the internal sqlite3 srs.db primary key for this CRS + * \returns the internal sqlite3 srs.db primary key for this CRS */ long srsid() const; /** Returns PostGIS SRID for the CRS. - * @return the PostGIS spatial_ref_sys identifier for this CRS (defaults to 0) + * \returns the PostGIS spatial_ref_sys identifier for this CRS (defaults to 0) */ // TODO QGIS 3: remove unless really necessary - let's use EPSG codes instead long postgisSrid() const; @@ -491,37 +491,37 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * * If CRS object is a custom CRS (not found in database), the method will return * internal QGIS CRS ID with "QGIS" authority, for example "QGIS:100005" - * @returns the authority identifier for this CRS - * @see description() + * \returns the authority identifier for this CRS + * \see description() */ QString authid() const; /** Returns the descriptive name of the CRS, e.g., "WGS 84" or "GDA 94 / Vicgrid94". In most * cases this is the best method to use when showing a friendly identifier for the CRS to a * user. - * @returns descriptive name of the CRS - * @note an empty string will be returned if the description is not available for the CRS - * @see authid() + * \returns descriptive name of the CRS + * \note an empty string will be returned if the description is not available for the CRS + * \see authid() */ QString description() const; /** Returns the projection acronym for the projection used by the CRS. - * @returns the official proj4 acronym for the projection family - * @note an empty string will be returned if the projectionAcronym is not available for the CRS - * @see ellipsoidAcronym() + * \returns the official proj4 acronym for the projection family + * \note an empty string will be returned if the projectionAcronym is not available for the CRS + * \see ellipsoidAcronym() */ QString projectionAcronym() const; /** Returns the ellipsoid acronym for the ellipsoid used by the CRS. - * @returns the official proj4 acronym for the ellipoid - * @note an empty string will be returned if the ellipsoidAcronym is not available for the CRS - * @see projectionAcronym() + * \returns the official proj4 acronym for the ellipoid + * \note an empty string will be returned if the ellipsoidAcronym is not available for the CRS + * \see projectionAcronym() */ QString ellipsoidAcronym() const; /** Returns a WKT representation of this CRS. - * @return string containing WKT of the CRS - * @see toProj4() + * \returns string containing WKT of the CRS + * \see toProj4() */ QString toWkt() const; @@ -530,19 +530,19 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * If proj and ellps keys are found in the parameters, * they will be stripped out and the projection and ellipsoid acronyms will be * overridden with these. - * @return Proj4 format string that defines this CRS. - * @note an empty string will be returned if the CRS could not be represented by a Proj4 string - * @see toWkt() + * \returns Proj4 format string that defines this CRS. + * \note an empty string will be returned if the CRS could not be represented by a Proj4 string + * \see toWkt() */ QString toProj4() const; /** Returns whether the CRS is a geographic CRS (using lat/lon coordinates) - * @returns true if CRS is geographic, or false if it is a projected CRS + * \returns true if CRS is geographic, or false if it is a projected CRS */ bool isGeographic() const; /** Returns whether axis is inverted (e.g., for WMS 1.3) for the CRS. - * @returns true if CRS axis is inverted + * \returns true if CRS axis is inverted */ bool hasAxisInverted() const; @@ -561,15 +561,15 @@ class CORE_EXPORT QgsCoordinateReferenceSystem QString validationHint(); /** Update proj.4 parameters in our database from proj.4 - * @returns number of updated CRS on success and + * \returns number of updated CRS on success and * negative number of failed updates in case of errors. - * @note This is used internally and should not be necessary to call in client code + * \note This is used internally and should not be necessary to call in client code */ static int syncDatabase(); /** Save the proj4-string as a custom CRS - * @returns bool true if success else false + * \returns bool true if success else false */ bool saveAsUserCrs( const QString &name ); @@ -577,7 +577,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem QString geographicCrsAuthId() const; /** Returns a list of recently used projections - * @returns list of srsid for recently used projections + * \returns list of srsid for recently used projections * \since QGIS 2.7 */ static QStringList recentProjections(); @@ -595,30 +595,30 @@ class CORE_EXPORT QgsCoordinateReferenceSystem private: /** A static helper function to find out the proj4 string for a srsid - * @param srsId The srsid used for the lookup - * @return QString The proj4 string + * \param srsId The srsid used for the lookup + * \returns QString The proj4 string */ static QString proj4FromSrsId( const int srsId ); /** Set the QGIS SrsId - * @param srsId The internal sqlite3 srs.db primary key for this CRS + * \param srsId The internal sqlite3 srs.db primary key for this CRS */ void setInternalId( long srsId ); /** Set the postgis srid - * @param srid The postgis spatial_ref_sys key for this CRS + * \param srid The postgis spatial_ref_sys key for this CRS */ void setSrid( long srid ); /** Set the Description - * @param description A textual description of the CRS. + * \param description A textual description of the CRS. */ void setDescription( const QString &description ); /** Set the Proj Proj4String. - * @param proj4String Proj4 format specifies + * \param proj4String Proj4 format specifies * (excluding proj and ellips) that define this CRS. - * @note some content of the PROJ4 string may be stripped off by this + * \note some content of the PROJ4 string may be stripped off by this * method due to the parsing of the string by OSRNewSpatialReference . * For example input: * +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs @@ -628,27 +628,27 @@ class CORE_EXPORT QgsCoordinateReferenceSystem void setProj4String( const QString &proj4String ); /** Set this Geographic? flag - * @param geoFlag Whether this is a geographic or projected coordinate system + * \param geoFlag Whether this is a geographic or projected coordinate system */ void setGeographicFlag( bool geoFlag ); /** Set the EpsgCrsId identifier for this CRS - * @param epsg the ESPG identifier for this CRS (defaults to 0) + * \param epsg the ESPG identifier for this CRS (defaults to 0) */ void setEpsg( long epsg ); /** Set the authority identifier for this CRS - * @param theID the authority identifier for this CRS (defaults to 0) + * \param theID the authority identifier for this CRS (defaults to 0) */ void setAuthId( const QString &theID ); /** Set the projection acronym - * @param projectionAcronym the acronym (must be a valid proj4 projection acronym) + * \param projectionAcronym the acronym (must be a valid proj4 projection acronym) */ void setProjectionAcronym( const QString &projectionAcronym ); /** Set the ellipsoid acronym - * @param ellipsoidAcronym the acronym (must be a valid proj4 ellipsoid acronym) + * \param ellipsoidAcronym the acronym (must be a valid proj4 ellipsoid acronym) */ void setEllipsoidAcronym( const QString &ellipsoidAcronym ); @@ -660,15 +660,15 @@ class CORE_EXPORT QgsCoordinateReferenceSystem typedef QMap RecordMap; /** Get a record from the srs.db or qgis.db backends, given an sql statement. - * @note only handles queries that return a single record. - * @note it will first try the system srs.db then the users qgis.db! - * @param sql The sql query to execute - * @return An associative array of field name <-> value pairs + * \note only handles queries that return a single record. + * \note it will first try the system srs.db then the users qgis.db! + * \param sql The sql query to execute + * \returns An associative array of field name <-> value pairs */ RecordMap getRecord( const QString &sql ); //! Open SQLite db and show message if cannot be opened - //! @return the same code as sqlite3_open + //! \returns the same code as sqlite3_open static int openDatabase( const QString &path, sqlite3 **db, bool readonly = true ); //! Work out the projection units and set the appropriate local variable diff --git a/src/core/qgscoordinatetransform.h b/src/core/qgscoordinatetransform.h index 5d26d3901f32..9295a4ea1bb9 100644 --- a/src/core/qgscoordinatetransform.h +++ b/src/core/qgscoordinatetransform.h @@ -56,8 +56,8 @@ class CORE_EXPORT QgsCoordinateTransform QgsCoordinateTransform(); /** Constructs a QgsCoordinateTransform using QgsCoordinateReferenceSystem objects. - * @param source source CRS, typically of the layer's coordinate system - * @param destination CRS, typically of the map canvas coordinate system + * \param source source CRS, typically of the layer's coordinate system + * \param destination CRS, typically of the map canvas coordinate system */ QgsCoordinateTransform( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination ); @@ -74,59 +74,59 @@ class CORE_EXPORT QgsCoordinateTransform ~QgsCoordinateTransform(); - /*! + /** * Returns true if the coordinate transform is valid, ie both the source and destination * CRS have been set and are valid. * \since QGIS 3.0 */ bool isValid() const; - /*! + /** * Sets the source coordinate reference system. - * @param crs CRS to transform coordinates from - * @see sourceCrs() - * @see setDestinationCrs() + * \param crs CRS to transform coordinates from + * \see sourceCrs() + * \see setDestinationCrs() */ void setSourceCrs( const QgsCoordinateReferenceSystem &crs ); - /*! + /** * Sets the destination coordinate reference system. - * @param crs CRS to transform coordinates to - * @see destinationCrs() - * @see setSourceCrs() + * \param crs CRS to transform coordinates to + * \see destinationCrs() + * \see setSourceCrs() */ void setDestinationCrs( const QgsCoordinateReferenceSystem &crs ); /** Returns the source coordinate reference system, which the transform will * transform coordinates from. - * @see setSourceCrs() - * @see destinationCrs() + * \see setSourceCrs() + * \see destinationCrs() */ QgsCoordinateReferenceSystem sourceCrs() const; /** Returns the destination coordinate reference system, which the transform will * transform coordinates to. - * @see setDestinationCrs() - * @see sourceCrs() + * \see setDestinationCrs() + * \see sourceCrs() */ QgsCoordinateReferenceSystem destinationCrs() const; /** Transform the point from the source CRS to the destination CRS. * If the direction is ForwardTransform then coordinates are transformed from source to destination, * otherwise points are transformed from destination to source CRS. - * @param point point to transform - * @param direction transform direction (defaults to ForwardTransform) - * @return transformed point + * \param point point to transform + * \param direction transform direction (defaults to ForwardTransform) + * \returns transformed point */ QgsPoint transform( const QgsPoint &point, TransformDirection direction = ForwardTransform ) const; /** Transform the point specified by x,y from the source CRS to the destination CRS. * If the direction is ForwardTransform then coordinates are transformed from source to destination, * otherwise points are transformed from destination to source CRS. - * @param x x coordinate of point to transform - * @param y y coordinate of point to transform - * @param direction transform direction (defaults to ForwardTransform) - * @return transformed point + * \param x x coordinate of point to transform + * \param y y coordinate of point to transform + * \param direction transform direction (defaults to ForwardTransform) + * \returns transformed point */ QgsPoint transform( const double x, const double y, TransformDirection direction = ForwardTransform ) const; @@ -136,62 +136,62 @@ class CORE_EXPORT QgsCoordinateTransform * This method assumes that the rectangle is a bounding box, and creates a bounding box * in the projected CRS, such that all points from the source rectangle are within * the returned rectangle. - * @param rectangle rectangle to transform - * @param direction transform direction (defaults to ForwardTransform) - * @param handle180Crossover set to true if destination CRS is geographic and handling of extents + * \param rectangle rectangle to transform + * \param direction transform direction (defaults to ForwardTransform) + * \param handle180Crossover set to true if destination CRS is geographic and handling of extents * crossing the 180 degree longitude line is required - * @return rectangle in destination CRS + * \returns rectangle in destination CRS */ QgsRectangle transformBoundingBox( const QgsRectangle &rectangle, TransformDirection direction = ForwardTransform, const bool handle180Crossover = false ) const; /** Transforms an array of x, y and z double coordinates in place, from the source CRS to the destination CRS. * If the direction is ForwardTransform then coordinates are transformed from source to destination, * otherwise points are transformed from destination to source CRS. - * @param x array of x coordinates of points to transform - * @param y array of y coordinates of points to transform - * @param z array of z coordinates of points to transform. The z coordinates of the points + * \param x array of x coordinates of points to transform + * \param y array of y coordinates of points to transform + * \param z array of z coordinates of points to transform. The z coordinates of the points * must represent height relative to the vertical datum of the source CRS (generally ellipsoidal * heights) and must be expressed in its vertical units (generally meters) - * @param direction transform direction (defaults to ForwardTransform) + * \param direction transform direction (defaults to ForwardTransform) */ void transformInPlace( double &x, double &y, double &z, TransformDirection direction = ForwardTransform ) const; /** Transforms an array of x, y and z float coordinates in place, from the source CRS to the destination CRS. * If the direction is ForwardTransform then coordinates are transformed from source to destination, * otherwise points are transformed from destination to source CRS. - * @param x array of x coordinates of points to transform - * @param y array of y coordinates of points to transform - * @param z array of z coordinates of points to transform. The z coordinates of the points + * \param x array of x coordinates of points to transform + * \param y array of y coordinates of points to transform + * \param z array of z coordinates of points to transform. The z coordinates of the points * must represent height relative to the vertical datum of the source CRS (generally ellipsoidal * heights) and must be expressed in its vertical units (generally meters) - * @param direction transform direction (defaults to ForwardTransform) - * @note not available in Python bindings + * \param direction transform direction (defaults to ForwardTransform) + * \note not available in Python bindings */ void transformInPlace( float &x, float &y, double &z, TransformDirection direction = ForwardTransform ) const; /** Transforms an array of x, y and z float coordinates in place, from the source CRS to the destination CRS. * If the direction is ForwardTransform then coordinates are transformed from source to destination, * otherwise points are transformed from destination to source CRS. - * @param x array of x coordinates of points to transform - * @param y array of y coordinates of points to transform - * @param z array of z coordinates of points to transform. The z coordinates of the points + * \param x array of x coordinates of points to transform + * \param y array of y coordinates of points to transform + * \param z array of z coordinates of points to transform. The z coordinates of the points * must represent height relative to the vertical datum of the source CRS (generally ellipsoidal * heights) and must be expressed in its vertical units (generally meters) - * @param direction transform direction (defaults to ForwardTransform) - * @note not available in Python bindings + * \param direction transform direction (defaults to ForwardTransform) + * \note not available in Python bindings */ void transformInPlace( float &x, float &y, float &z, TransformDirection direction = ForwardTransform ) const; /** Transforms a vector of x, y and z float coordinates in place, from the source CRS to the destination CRS. * If the direction is ForwardTransform then coordinates are transformed from source to destination, * otherwise points are transformed from destination to source CRS. - * @param x vector of x coordinates of points to transform - * @param y vector of y coordinates of points to transform - * @param z vector of z coordinates of points to transform. The z coordinates of the points + * \param x vector of x coordinates of points to transform + * \param y vector of y coordinates of points to transform + * \param z vector of z coordinates of points to transform. The z coordinates of the points * must represent height relative to the vertical datum of the source CRS (generally ellipsoidal * heights) and must be expressed in its vertical units (generally meters) - * @param direction transform direction (defaults to ForwardTransform) - * @note not available in Python bindings + * \param direction transform direction (defaults to ForwardTransform) + * \note not available in Python bindings */ void transformInPlace( QVector &x, QVector &y, QVector &z, TransformDirection direction = ForwardTransform ) const; @@ -199,40 +199,40 @@ class CORE_EXPORT QgsCoordinateTransform /** Transforms a vector of x, y and z double coordinates in place, from the source CRS to the destination CRS. * If the direction is ForwardTransform then coordinates are transformed from source to destination, * otherwise points are transformed from destination to source CRS. - * @param x vector of x coordinates of points to transform - * @param y vector of y coordinates of points to transform - * @param z vector of z coordinates of points to transform. The z coordinates of the points + * \param x vector of x coordinates of points to transform + * \param y vector of y coordinates of points to transform + * \param z vector of z coordinates of points to transform. The z coordinates of the points * must represent height relative to the vertical datum of the source CRS (generally ellipsoidal * heights) and must be expressed in its vertical units (generally meters) - * @param direction transform direction (defaults to ForwardTransform) - * @note not available in Python bindings + * \param direction transform direction (defaults to ForwardTransform) + * \note not available in Python bindings */ void transformInPlace( QVector &x, QVector &y, QVector &z, TransformDirection direction = ForwardTransform ) const; /** Transforms a polygon to the destination coordinate system. - * @param polygon polygon to transform (occurs in place) - * @param direction transform direction (defaults to forward transformation) + * \param polygon polygon to transform (occurs in place) + * \param direction transform direction (defaults to forward transformation) */ void transformPolygon( QPolygonF &polygon, TransformDirection direction = ForwardTransform ) const; /** Transforms a rectangle to the destination CRS. * If the direction is ForwardTransform then coordinates are transformed from source to destination, * otherwise points are transformed from destination to source CRS. - * @param rectangle rectangle to transform - * @param direction transform direction (defaults to ForwardTransform) - * @return transformed rectangle + * \param rectangle rectangle to transform + * \param direction transform direction (defaults to ForwardTransform) + * \returns transformed rectangle */ QgsRectangle transform( const QgsRectangle &rectangle, TransformDirection direction = ForwardTransform ) const; /** Transform an array of coordinates to the destination CRS. * If the direction is ForwardTransform then coordinates are transformed from source to destination, * otherwise points are transformed from destination to source CRS. - * @param numPoint number of coordinates in arrays - * @param x array of x coordinates to transform - * @param y array of y coordinates to transform - * @param z array of z coordinates to transform - * @param direction transform direction (defaults to ForwardTransform) + * \param numPoint number of coordinates in arrays + * \param x array of x coordinates to transform + * \param y array of y coordinates to transform + * \param z array of z coordinates to transform + * \param direction transform direction (defaults to ForwardTransform) */ void transformCoords( int numPoint, double *x, double *y, double *z, TransformDirection direction = ForwardTransform ) const; @@ -241,13 +241,13 @@ class CORE_EXPORT QgsCoordinateTransform bool isShortCircuited() const; /** Returns list of datum transformations for the given src and dest CRS - * @note not available in Python bindings + * \note not available in Python bindings */ static QList< QList< int > > datumTransformations( const QgsCoordinateReferenceSystem &srcCRS, const QgsCoordinateReferenceSystem &destinationCrs ); static QString datumTransformString( int datumTransform ); /** Gets name of source and dest geographical CRS (to show in a tooltip) - @return epsgNr epsg code of the transformation (or 0 if not in epsg db)*/ + \returns epsgNr epsg code of the transformation (or 0 if not in epsg db)*/ static bool datumTransformCrsInfo( int datumTransform, int &epsgNr, QString &srcProjection, QString &dstProjection, QString &remarks, QString &scope, bool &preferred, bool &deprecated ); int sourceDatumTransform() const; @@ -259,17 +259,17 @@ class CORE_EXPORT QgsCoordinateTransform void initialize(); /** Restores state from the given Dom node. - * @param node The node from which state will be restored - * @return bool True on success, False on failure - * @see writeXml() + * \param node The node from which state will be restored + * \returns bool True on success, False on failure + * \see writeXml() */ bool readXml( const QDomNode &node ); /** Stores state to the given Dom node in the given document - * @param node The node in which state will be restored - * @param document The document in which state will be stored - * @return bool True on success, False on failure - * @see readXml() + * \param node The node in which state will be restored + * \param document The document in which state will be stored + * \returns bool True on success, False on failure + * \see readXml() */ bool writeXml( QDomNode &node, QDomDocument &document ) const; diff --git a/src/core/qgscoordinateutils.h b/src/core/qgscoordinateutils.h index adc1395b3572..7835aa435f49 100644 --- a/src/core/qgscoordinateutils.h +++ b/src/core/qgscoordinateutils.h @@ -43,9 +43,9 @@ class CORE_EXPORT QgsCoordinateUtils * map units per pixel by calculating the number of decimal places for the coordinates * with the aim of always having enough decimal places to show the difference in position * between adjacent pixels. - * @param mapUnitsPerPixel number of map units per pixel - * @param mapCrs CRS of map - * @returns optimal number of decimal places for coordinates + * \param mapUnitsPerPixel number of map units per pixel + * \param mapCrs CRS of map + * \returns optimal number of decimal places for coordinates */ static int calculateCoordinatePrecision( double mapUnitsPerPixel, const QgsCoordinateReferenceSystem &mapCrs ); diff --git a/src/core/qgscrscache.h b/src/core/qgscrscache.h index 88413f2ee079..b3b39f3751d9 100644 --- a/src/core/qgscrscache.h +++ b/src/core/qgscrscache.h @@ -39,11 +39,11 @@ class CORE_EXPORT QgsCoordinateTransformCache QgsCoordinateTransformCache &operator=( const QgsCoordinateTransformCache &rh ) = delete; /** Returns coordinate transformation. Cache keeps ownership - @param srcAuthId auth id string of source crs - @param destAuthId auth id string of dest crs - @param srcDatumTransform id of source's datum transform - @param destDatumTransform id of destinations's datum transform - @returns matching transform, or an invalid transform if none could be created + \param srcAuthId auth id string of source crs + \param destAuthId auth id string of dest crs + \param srcDatumTransform id of source's datum transform + \param destDatumTransform id of destinations's datum transform + \returns matching transform, or an invalid transform if none could be created */ QgsCoordinateTransform transform( const QString &srcAuthId, const QString &destAuthId, int srcDatumTransform = -1, int destDatumTransform = -1 ); diff --git a/src/core/qgsdataitem.h b/src/core/qgsdataitem.h index cb19a2eb1e33..3b248003ed93 100644 --- a/src/core/qgsdataitem.h +++ b/src/core/qgsdataitem.h @@ -82,27 +82,27 @@ class CORE_EXPORT QgsDataItem : public QObject State state() const; /** Set item state. It also take care about starting/stopping loading icon animation. - * @param state + * \param state * \since QGIS 2.8 */ virtual void setState( State state ); /** Inserts a new child item. The child will be inserted at a position using an alphabetical order based on mName. - * @param child child item to insert. Ownership is transferred, and item parent will be set and relevant connections made. - * @param refresh - set to true to refresh populated item, emitting relevant signals to the model - * @see deleteChildItem() + * \param child child item to insert. Ownership is transferred, and item parent will be set and relevant connections made. + * \param refresh - set to true to refresh populated item, emitting relevant signals to the model + * \see deleteChildItem() */ virtual void addChildItem( QgsDataItem *child, bool refresh = false ); /** Removes and deletes a child item, emitting relevant signals to the model. - * @param child child to remove. Item must exist as a current child. - * @see addChildItem() + * \param child child to remove. Item must exist as a current child. + * \see addChildItem() */ virtual void deleteChildItem( QgsDataItem *child ); /** Removes a child item and returns it without deleting it. Emits relevant signals to model as required. - * @param child child to remove - * @returns pointer to the removed item or null if no such item was found + * \param child child to remove + * \returns pointer to the removed item or null if no such item was found */ virtual QgsDataItem *removeChildItem( QgsDataItem *child ); @@ -119,27 +119,27 @@ class CORE_EXPORT QgsDataItem : public QObject /** Returns whether the item accepts drag and dropped layers - e.g. for importing a dataset to a provider. * Subclasses should override this and handleDrop() to accept dropped layers. - * @see handleDrop() + * \see handleDrop() */ virtual bool acceptDrop() { return false; } /** Attempts to process the mime data dropped on this item. Subclasses must override this and acceptDrop() if they * accept dropped layers. - * @see acceptDrop() + * \see acceptDrop() */ virtual bool handleDrop( const QMimeData * /*data*/, Qt::DropAction /*action*/ ) { return false; } /** Returns true if the item may be dragged. * Default implementation returns false. * A draggable item has to implement mimeUri() that will be used to pass data. - * @see mimeUri() + * \see mimeUri() * \since QGIS 3.0 */ virtual bool hasDragEnabled() const { return false; } /** Return mime URI for the data item. * Items that return valid URI will be returned in mime data when dragging a selection from browser model. - * @see hasDragEnabled() + * \see hasDragEnabled() * \since QGIS 3.0 */ virtual QgsMimeDataUtils::Uri mimeUri() const { return QgsMimeDataUtils::Uri(); } @@ -251,7 +251,7 @@ class CORE_EXPORT QgsDataItem : public QObject virtual void deleteLater(); // Populate children using children vector created by createChildren() - // @param foreground run createChildren in foreground + // \param foreground run createChildren in foreground virtual void populate( bool foreground = false ); //! Remove children recursively and set as not populated. This is used when refreshing collapsed items. @@ -368,7 +368,7 @@ class CORE_EXPORT QgsLayerItem : public QgsDataItem static QIcon iconRaster(); static QIcon iconDefault(); - //! @return the layer name + //! \returns the layer name virtual QString layerName() const { return name(); } }; @@ -410,10 +410,10 @@ class CORE_EXPORT QgsDirectoryItem : public QgsDataCollectionItem QgsDirectoryItem( QgsDataItem *parent, const QString &name, const QString &path ); /** Constructor. - * @param parent - * @param name directory name - * @param dirPath path to directory in file system - * @param path item path in the tree, it may be dirPath or dirPath with some prefix, e.g. favorites: */ + * \param parent + * \param name directory name + * \param dirPath path to directory in file system + * \param path item path in the tree, it may be dirPath or dirPath with some prefix, e.g. favorites: */ QgsDirectoryItem( QgsDataItem *parent, const QString &name, const QString &dirPath, const QString &path ); virtual void setState( State state ) override; @@ -450,10 +450,10 @@ class CORE_EXPORT QgsProjectItem : public QgsDataItem public: /** - * @brief A data item holding a reference to a QGIS project file. - * @param parent The parent data item. - * @param name The name of the of the project. Displayed to the user. - * @param path The full path to the project. + * \brief A data item holding a reference to a QGIS project file. + * \param parent The parent data item. + * \param name The name of the of the project. Displayed to the user. + * \param path The full path to the project. */ QgsProjectItem( QgsDataItem *parent, const QString &name, const QString &path ); @@ -512,13 +512,13 @@ class CORE_EXPORT QgsFavoritesItem : public QgsDataCollectionItem /** * Adds a new directory to the favorites group. - * @see removeDirectory() + * \see removeDirectory() */ void addDirectory( const QString &directory ); /** * Removes an existing directory from the favorites group. - * @see addDirectory() + * \see addDirectory() */ void removeDirectory( QgsDirectoryItem *item ); @@ -548,7 +548,7 @@ class CORE_EXPORT QgsZipItem : public QgsDataCollectionItem QVector createChildren() override; QStringList getZipFileList(); - //! @note not available via Python bindings + //! \note not available via Python bindings static QVector sDataItemPtr; static QStringList sProviderNames; @@ -561,7 +561,7 @@ class CORE_EXPORT QgsZipItem : public QgsDataCollectionItem /** * Creates a new data item from the specified path. - * @note available in Python as itemFromFilePath + * \note available in Python as itemFromFilePath */ static QgsDataItem *itemFromPath( QgsDataItem *parent, const QString &filePath, const QString &name, const QString &path ); diff --git a/src/core/qgsdataprovider.h b/src/core/qgsdataprovider.h index 492ca31b6d73..4d21f07898d7 100644 --- a/src/core/qgsdataprovider.h +++ b/src/core/qgsdataprovider.h @@ -34,7 +34,6 @@ class QgsCoordinateReferenceSystem; /** \ingroup core * Abstract base class for spatial data provider implementations. - * @author Gary E.Sherman * * This object needs to inherit from QObject to enable event * processing in the Postgres/PostGIS provider (QgsPostgresProvider). @@ -89,7 +88,7 @@ class CORE_EXPORT QgsDataProvider : public QObject /** * Set the data source specification. This may be a path or database * connection string - * @param uri source specification + * \param uri source specification */ virtual void setDataSourceUri( const QString &uri ) { @@ -99,9 +98,9 @@ class CORE_EXPORT QgsDataProvider : public QObject /** * Get the data source specification. This may be a path or database * connection string - * @param expandAuthConfig Whether to expand any assigned authentication configuration - * @return data source specification - * @note The default authentication configuration expansion is FALSE. This keeps credentials + * \param expandAuthConfig Whether to expand any assigned authentication configuration + * \returns data source specification + * \note The default authentication configuration expansion is FALSE. This keeps credentials * out of layer data source URIs and project files. Expansion should be specifically done * only when needed within a provider */ @@ -121,7 +120,7 @@ class CORE_EXPORT QgsDataProvider : public QObject /** * Returns the extent of the layer - * @return QgsRectangle containing the extent of the layer + * \returns QgsRectangle containing the extent of the layer */ virtual QgsRectangle extent() const = 0; @@ -244,7 +243,7 @@ class CORE_EXPORT QgsDataProvider : public QObject * if more than one provider supports a given format, the user is able to * select a specific provider to open that file. * - * @note + * \note * * Instead of being pure virtual, might be better to generalize this * behavior and presume that none of the sub-classes are going to do @@ -258,7 +257,7 @@ class CORE_EXPORT QgsDataProvider : public QObject * * Return a terse string describing what the provider is. * - * @note + * \note * * Instead of being pure virtual, might be better to generalize this * behavior and presume that none of the sub-classes are going to do @@ -275,7 +274,7 @@ class CORE_EXPORT QgsDataProvider : public QObject * for those data providers that do not deal with plain files, such as * databases and servers. * - * @note It'd be nice to eventually be raster/vector neutral. + * \note It'd be nice to eventually be raster/vector neutral. */ virtual QString fileVectorFilters() const { @@ -290,7 +289,7 @@ class CORE_EXPORT QgsDataProvider : public QObject * for those data providers that do not deal with plain files, such as * databases and servers. * - * @note It'd be nice to eventually be raster/vector neutral. + * \note It'd be nice to eventually be raster/vector neutral. */ virtual QString fileRasterFilters() const { @@ -336,7 +335,7 @@ class CORE_EXPORT QgsDataProvider : public QObject * a concept of stack of calls that must be handled by the provider. Only the first * call to enterUpdateMode() will really turn update mode on. * - * @return true in case of success (or no-op implementation), false in case of failure. + * \returns true in case of success (or no-op implementation), false in case of failure. * * \since QGIS 2.16 */ @@ -354,7 +353,7 @@ class CORE_EXPORT QgsDataProvider : public QObject * a concept of stack of calls that must be handled by the provider. Only the last * call to leaveUpdateMode() will really turn update mode off. * - * @return true in case of success (or no-op implementation), false in case of failure. + * \returns true in case of success (or no-op implementation), false in case of failure. * * \since QGIS 2.16 */ diff --git a/src/core/qgsdatasourceuri.h b/src/core/qgsdatasourceuri.h index f08364872282..289c333148bc 100644 --- a/src/core/qgsdatasourceuri.h +++ b/src/core/qgsdatasourceuri.h @@ -69,7 +69,7 @@ class CORE_EXPORT QgsDataSourceUri //! Set generic param (generic mode) // \note if key exists, another is inserted void setParam( const QString &key, const QString &value ); - //! @note available in Python as setParamList + //! \note available in Python as setParamList void setParam( const QString &key, const QStringList &value ); //! Remove generic param (generic mode) diff --git a/src/core/qgsdatetimestatisticalsummary.h b/src/core/qgsdatetimestatisticalsummary.h index 9f3f139d42d0..83867053a0dc 100644 --- a/src/core/qgsdatetimestatisticalsummary.h +++ b/src/core/qgsdatetimestatisticalsummary.h @@ -33,10 +33,10 @@ * \class QgsDateTimeStatisticalSummary * \brief Calculator for summary statistics and aggregates for a list of datetimes. * - * Statistics are calculated by calling @link calculate @endlink and passing a list of datetimes. The + * Statistics are calculated by calling calculate() and passing a list of datetimes. The * individual statistics can then be retrieved using the associated methods. Note that not all statistics * are calculated by default. Statistics which require slower computations are only calculated by - * specifying the statistic in the constructor or via @link setStatistics @endlink. + * specifying the statistic in the constructor or via setStatistics(). * * \since QGIS 2.16 */ @@ -59,20 +59,20 @@ class CORE_EXPORT QgsDateTimeStatisticalSummary Q_DECLARE_FLAGS( Statistics, Statistic ) /** Constructor for QgsDateTimeStatisticalSummary - * @param stats flags for statistics to calculate + * \param stats flags for statistics to calculate */ QgsDateTimeStatisticalSummary( QgsDateTimeStatisticalSummary::Statistics stats = All ); /** Returns flags which specify which statistics will be calculated. Some statistics * are always calculated (e.g., count). - * @see setStatistics + * \see setStatistics */ Statistics statistics() const { return mStatistics; } /** Sets flags which specify which statistics will be calculated. Some statistics * are always calculated (e.g., count). - * @param stats flags for statistics to calculate - * @see statistics + * \param stats flags for statistics to calculate + * \see statistics */ void setStatistics( Statistics stats ) { mStatistics = stats; } @@ -82,8 +82,8 @@ class CORE_EXPORT QgsDateTimeStatisticalSummary /** Calculates summary statistics for a list of variants. Any non-datetime variants will be * ignored. - * @param values list of variants - * @see addValue() + * \param values list of variants + * \see addValue() */ void calculate( const QVariantList &values ); @@ -91,25 +91,25 @@ class CORE_EXPORT QgsDateTimeStatisticalSummary * allows datetimes to be added to the calculation one at a time. For large * quantities of dates this may be more efficient then first adding all the * variants to a list and calling calculate(). - * @param value datetime to add. Any non-datetime variants will be ignored. - * @note call reset() before adding the first datetime using this method + * \param value datetime to add. Any non-datetime variants will be ignored. + * \note call reset() before adding the first datetime using this method * to clear the results from any previous calculations - * @note finalize() must be called after adding the final value and before + * \note finalize() must be called after adding the final value and before * retrieving calculated statistics. - * @see calculate() - * @see finalize() + * \see calculate() + * \see finalize() */ void addValue( const QVariant &value ); /** Must be called after adding all datetimes with addValue() and before retrieving * any calculated datetime statistics. - * @see addValue() + * \see addValue() */ void finalize(); /** Returns the value of a specified statistic - * @param stat statistic to return - * @returns calculated value of statistic + * \param stat statistic to return + * \returns calculated value of statistic */ QVariant statistic( Statistic stat ) const; @@ -142,7 +142,7 @@ class CORE_EXPORT QgsDateTimeStatisticalSummary QgsInterval range() const { return mMax - mMin; } /** Returns the friendly display name for a statistic - * @param statistic statistic to return name for + * \param statistic statistic to return name for */ static QString displayName( Statistic statistic ); diff --git a/src/core/qgsdatumtransformstore.h b/src/core/qgsdatumtransformstore.h index 11e076a75fff..ac7d29c819e3 100644 --- a/src/core/qgsdatumtransformstore.h +++ b/src/core/qgsdatumtransformstore.h @@ -25,7 +25,7 @@ class QDomElement; /** \ingroup core - * @brief The QgsDatumTransformStore class keeps track of datum transformations + * \brief The QgsDatumTransformStore class keeps track of datum transformations * as chosen by the user. * * \since QGIS 2.4 @@ -45,7 +45,7 @@ class CORE_EXPORT QgsDatumTransformStore /** Will return transform from layer's CRS to current destination CRS. * Will emit datumTransformInfoRequested signal if the layer has no entry. - * @returns transformation associated with layer, or an invalid QgsCoordinateTransform + * \returns transformation associated with layer, or an invalid QgsCoordinateTransform * if no transform is associated with the layer */ QgsCoordinateTransform transformation( const QgsMapLayer *layer ) const; diff --git a/src/core/qgsdiagramrenderer.h b/src/core/qgsdiagramrenderer.h index d6846a19bcc7..0b96208c4d2f 100644 --- a/src/core/qgsdiagramrenderer.h +++ b/src/core/qgsdiagramrenderer.h @@ -115,147 +115,147 @@ class CORE_EXPORT QgsDiagramLayerSettings /** * Returns the diagram placement. - * @see setPlacement() + * \see setPlacement() * \since QGIS 2.16 */ Placement placement() const { return mPlacement; } /** Sets the diagram placement. - * @param value placement value - * @see placement() + * \param value placement value + * \see placement() * \since QGIS 2.16 */ void setPlacement( Placement value ) { mPlacement = value; } /** Returns the diagram placement flags. These are only used if the diagram placement * is set to a line type. - * @see setLinePlacementFlags() + * \see setLinePlacementFlags() * \since QGIS 2.16 */ LinePlacementFlags linePlacementFlags() const { return mPlacementFlags; } /** Sets the the diagram placement flags. These are only used if the diagram placement * is set to a line type. - * @param flags placement value - * @see getPlacement() + * \param flags placement value + * \see getPlacement() * \since QGIS 2.16 */ void setLinePlacementFlags( LinePlacementFlags flags ) { mPlacementFlags = flags; } /** Returns the diagram priority. - * @returns diagram priority, where 0 = low and 10 = high - * @note placement priority is shared with labeling, so diagrams with a high priority may displace labels + * \returns diagram priority, where 0 = low and 10 = high + * \note placement priority is shared with labeling, so diagrams with a high priority may displace labels * and vice-versa - * @see setPriority() + * \see setPriority() * \since QGIS 2.16 */ int priority() const { return mPriority; } /** Sets the diagram priority. - * @param value priority, where 0 = low and 10 = high - * @see priority() + * \param value priority, where 0 = low and 10 = high + * \see priority() * \since QGIS 2.16 */ void setPriority( int value ) { mPriority = value; } /** Returns the diagram z-index. Diagrams (or labels) with a higher z-index are drawn over diagrams * with a lower z-index. - * @note z-index ordering is shared with labeling, so diagrams with a high z-index may be drawn over labels + * \note z-index ordering is shared with labeling, so diagrams with a high z-index may be drawn over labels * with a low z-index and vice-versa - * @see setZIndex() + * \see setZIndex() * \since QGIS 2.16 */ double zIndex() const { return mZIndex; } /** Sets the diagram z-index. Diagrams (or labels) with a higher z-index are drawn over diagrams * with a lower z-index. - * @param index diagram z-index - * @see zIndex() + * \param index diagram z-index + * \see zIndex() * \since QGIS 2.16 */ void setZIndex( double index ) { mZIndex = index; } /** Returns whether the feature associated with a diagram acts as an obstacle for other labels or diagrams. - * @see setIsObstacle() + * \see setIsObstacle() * \since QGIS 2.16 */ bool isObstacle() const { return mObstacle; } /** Sets whether the feature associated with a diagram acts as an obstacle for other labels or diagrams. - * @param isObstacle set to true for feature to act as obstacle - * @see isObstacle() + * \param isObstacle set to true for feature to act as obstacle + * \see isObstacle() * \since QGIS 2.16 */ void setIsObstacle( bool isObstacle ) { mObstacle = isObstacle; } /** Returns the distance between the diagram and the feature (in mm). - * @see setDistance() + * \see setDistance() * \since QGIS 2.16 */ double distance() const { return mDistance; } /** Sets the distance between the diagram and the feature. - * @param distance distance in mm - * @see distance() + * \param distance distance in mm + * \see distance() * \since QGIS 2.16 */ void setDistance( double distance ) { mDistance = distance; } /** Returns the diagram renderer associated with the layer. - * @see setRenderer() + * \see setRenderer() * \since QGIS 2.16 */ QgsDiagramRenderer *renderer() { return mRenderer; } /** Returns the diagram renderer associated with the layer. - * @see setRenderer() + * \see setRenderer() * \since QGIS 2.16 */ const QgsDiagramRenderer *renderer() const { return mRenderer; } /** Sets the diagram renderer associated with the layer. - * @param diagramRenderer diagram renderer. Ownership is transferred to the object. - * @see renderer() + * \param diagramRenderer diagram renderer. Ownership is transferred to the object. + * \see renderer() * \since QGIS 2.16 */ void setRenderer( QgsDiagramRenderer *diagramRenderer ); /** Returns the coordinate transform associated with the layer, or an * invalid transform if no transformation is required. - * @see setCoordinateTransform() + * \see setCoordinateTransform() * \since QGIS 2.16 */ QgsCoordinateTransform coordinateTransform() const { return mCt; } /** Sets the coordinate transform associated with the layer. - * @param transform coordinate transform. Ownership is transferred to the object. - * @see coordinateTransform() + * \param transform coordinate transform. Ownership is transferred to the object. + * \see coordinateTransform() * \since QGIS 2.16 */ void setCoordinateTransform( const QgsCoordinateTransform &transform ); /** Returns whether the layer should show all diagrams, including overlapping diagrams - * @see setShowAllDiagrams() + * \see setShowAllDiagrams() * \since QGIS 2.16 */ bool showAllDiagrams() const { return mShowAll; } /** Sets whether the layer should show all diagrams, including overlapping diagrams - * @param showAllDiagrams set to true to show all diagrams - * @see showAllDiagrams() + * \param showAllDiagrams set to true to show all diagrams + * \see showAllDiagrams() * \since QGIS 2.16 */ void setShowAllDiagrams( bool showAllDiagrams ) { mShowAll = showAllDiagrams; } /** * Reads the diagram settings from a DOM element. - * @see writeXml() + * \see writeXml() */ void readXml( const QDomElement &elem, const QgsVectorLayer *layer ); /** * Writes the diagram settings to a DOM element. - * @see readXml() + * \see readXml() */ void writeXml( QDomElement &layerElem, QDomDocument &doc, const QgsVectorLayer *layer ) const; @@ -268,27 +268,27 @@ class CORE_EXPORT QgsDiagramLayerSettings bool prepare( const QgsExpressionContext &context = QgsExpressionContext() ) const; /** Returns the set of any fields referenced by the layer's diagrams. - * @param context expression context the diagrams will be drawn using + * \param context expression context the diagrams will be drawn using * \since QGIS 2.16 */ QSet< QString > referencedFields( const QgsExpressionContext &context = QgsExpressionContext() ) const; /** Returns a reference to the diagram's property collection, used for data defined overrides. * \since QGIS 3.0 - * @see setDataDefinedProperties() + * \see setDataDefinedProperties() */ QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; } /** Returns a reference to the diagram's property collection, used for data defined overrides. * \since QGIS 3.0 - * @see setProperties() + * \see setProperties() */ const QgsPropertyCollection &dataDefinedProperties() const { return mDataDefinedProperties; } /** Sets the diagram's property collection, used for data defined overrides. - * @param collection property collection. Existing properties will be replaced. + * \param collection property collection. Existing properties will be replaced. * \since QGIS 3.0 - * @see dataDefinedProperties() + * \see dataDefinedProperties() */ void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; } @@ -304,7 +304,7 @@ class CORE_EXPORT QgsDiagramLayerSettings LinePlacementFlags mPlacementFlags = OnLine; //! Placement priority, where 0 = low and 10 = high - //! @note placement priority is shared with labeling, so diagrams with a high priority may displace labels + //! \note placement priority is shared with labeling, so diagrams with a high priority may displace labels //! and vice-versa int mPriority = 5; @@ -425,7 +425,7 @@ class CORE_EXPORT QgsDiagramSettings void writeXml( QDomElement &rendererElem, QDomDocument &doc, const QgsVectorLayer *layer ) const; /** Returns list of legend nodes for the diagram - * @note caller is responsible for deletion of QgsLayerTreeModelLegendNodes + * \note caller is responsible for deletion of QgsLayerTreeModelLegendNodes * \since QGIS 2.10 */ QList< QgsLayerTreeModelLegendNode * > legendItems( QgsLayerTreeLayer *nodeLayer ) const; @@ -477,7 +477,7 @@ class CORE_EXPORT QgsDiagramRenderer virtual QList diagramAttributes() const = 0; /** Returns the set of any fields required for diagram rendering - * @param context expression context the diagrams will be drawn using + * \param context expression context the diagrams will be drawn using * \since QGIS 2.16 */ virtual QSet< QString > referencedFields( const QgsExpressionContext &context = QgsExpressionContext() ) const; @@ -496,67 +496,67 @@ class CORE_EXPORT QgsDiagramRenderer /** * Reads diagram state from a DOM element. Subclasses should ensure that _readXml() is called * by their readXml implementation to restore the general QgsDiagramRenderer settings. - * @see writeXml() + * \see writeXml() */ virtual void readXml( const QDomElement &elem, const QgsVectorLayer *layer ) = 0; /** * Writes diagram state to a DOM element. Subclasses should ensure that _writeXml() is called * by their writeXml implementation to save the general QgsDiagramRenderer settings. - * @see readXml() + * \see readXml() */ virtual void writeXml( QDomElement &layerElem, QDomDocument &doc, const QgsVectorLayer *layer ) const = 0; /** Returns list of legend nodes for the diagram - * @note caller is responsible for deletion of QgsLayerTreeModelLegendNodes + * \note caller is responsible for deletion of QgsLayerTreeModelLegendNodes * \since QGIS 2.10 */ virtual QList< QgsLayerTreeModelLegendNode * > legendItems( QgsLayerTreeLayer *nodeLayer ) const; /** Returns true if renderer will show legend items for diagram attributes. * \since QGIS 2.16 - * @see setAttributeLegend() - * @see sizeLegend() + * \see setAttributeLegend() + * \see sizeLegend() */ bool attributeLegend() const { return mShowAttributeLegend; } /** Sets whether the renderer will show legend items for diagram attributes. - * @param enabled set to true to show diagram attribute legend + * \param enabled set to true to show diagram attribute legend * \since QGIS 2.16 - * @see attributeLegend() - * @see setSizeLegend() + * \see attributeLegend() + * \see setSizeLegend() */ void setAttributeLegend( bool enabled ) { mShowAttributeLegend = enabled; } /** Returns true if renderer will show legend items for diagram sizes. * \since QGIS 2.16 - * @see setSizeLegend() - * @see attributeLegend() - * @see sizeLegendSymbol() + * \see setSizeLegend() + * \see attributeLegend() + * \see sizeLegendSymbol() */ bool sizeLegend() const { return mShowSizeLegend; } /** Sets whether the renderer will show legend items for diagram sizes. - * @param enabled set to true to show diagram size legend + * \param enabled set to true to show diagram size legend * \since QGIS 2.16 - * @see sizeLegend() - * @see setAttributeLegend() - * @see setSizeLegendSymbol() + * \see sizeLegend() + * \see setAttributeLegend() + * \see setSizeLegendSymbol() */ void setSizeLegend( bool enabled ) { mShowSizeLegend = enabled; } /** Returns the marker symbol used for rendering the diagram size legend. * \since QGIS 2.16 - * @see setSizeLegendSymbol() - * @see sizeLegend() + * \see setSizeLegendSymbol() + * \see sizeLegend() */ QgsMarkerSymbol *sizeLegendSymbol() const { return mSizeLegendSymbol.get(); } /** Sets the marker symbol used for rendering the diagram size legend. - * @param symbol marker symbol, ownership is transferred to the renderer. + * \param symbol marker symbol, ownership is transferred to the renderer. * \since QGIS 2.16 - * @see sizeLegendSymbol() - * @see setSizeLegend() + * \see sizeLegendSymbol() + * \see setSizeLegend() */ void setSizeLegendSymbol( QgsMarkerSymbol *symbol ) { mSizeLegendSymbol.reset( symbol ); } @@ -565,9 +565,9 @@ class CORE_EXPORT QgsDiagramRenderer QgsDiagramRenderer &operator=( const QgsDiagramRenderer &other ); /** Returns diagram settings for a feature (or false if the diagram for the feature is not to be rendered). Used internally within renderDiagram() - * @param feature the feature - * @param c render context - * @param s out: diagram settings for the feature + * \param feature the feature + * \param c render context + * \param s out: diagram settings for the feature */ virtual bool diagramSettings( const QgsFeature &feature, const QgsRenderContext &c, QgsDiagramSettings &s ) const = 0; @@ -584,13 +584,13 @@ class CORE_EXPORT QgsDiagramRenderer /** * Reads internal QgsDiagramRenderer state from a DOM element. - * @see _writeXml() + * \see _writeXml() */ void _readXml( const QDomElement &elem, const QgsVectorLayer *layer ); /** * Writes internal QgsDiagramRenderer diagram state to a DOM element. - * @see _readXml() + * \see _readXml() */ void _writeXml( QDomElement &rendererElem, QDomDocument &doc, const QgsVectorLayer *layer ) const; @@ -674,14 +674,14 @@ class CORE_EXPORT QgsLinearlyInterpolatedDiagramRenderer : public QgsDiagramRend /** * Returns the field name used for interpolating the diagram size. - * @see setClassificationField() + * \see setClassificationField() * \since QGIS 3.0 */ QString classificationField() const { return mInterpolationSettings.classificationField; } /** * Sets the field name used for interpolating the diagram size. - * @see classificationField() + * \see classificationField() * \since QGIS 3.0 */ void setClassificationField( const QString &field ) { mInterpolationSettings.classificationField = field; } diff --git a/src/core/qgsdistancearea.cpp b/src/core/qgsdistancearea.cpp index d09350e9ffd6..dc5b7208622f 100644 --- a/src/core/qgsdistancearea.cpp +++ b/src/core/qgsdistancearea.cpp @@ -54,13 +54,11 @@ QgsDistanceArea::QgsDistanceArea() } -//! Copy constructor QgsDistanceArea::QgsDistanceArea( const QgsDistanceArea &origDA ) { _copy( origDA ); } -//! Assignment operator QgsDistanceArea &QgsDistanceArea::operator=( const QgsDistanceArea &origDA ) { if ( this == & origDA ) @@ -243,7 +241,6 @@ bool QgsDistanceArea::setEllipsoid( const QString &ellipsoid ) return true; } -//! Sets ellipsoid by supplied radii // Inverse flattening is calculated with invf = a/(a-b) // Also, b = a-(a/invf) bool QgsDistanceArea::setEllipsoid( double semiMajor, double semiMinor ) diff --git a/src/core/qgsdistancearea.h b/src/core/qgsdistancearea.h index dbbf8e73ace8..3fade5715f01 100644 --- a/src/core/qgsdistancearea.h +++ b/src/core/qgsdistancearea.h @@ -50,24 +50,24 @@ class CORE_EXPORT QgsDistanceArea QgsDistanceArea &operator=( const QgsDistanceArea &origDA ); /** Sets whether coordinates must be projected to ellipsoid before measuring - * @note for calculations to use the ellipsoid, both the ellipsoid mode must be true + * \note for calculations to use the ellipsoid, both the ellipsoid mode must be true * and an ellipse must be set - * @see setEllipsoid() - * @see willUseEllipsoid() + * \see setEllipsoid() + * \see willUseEllipsoid() */ void setEllipsoidalMode( bool flag ); /** Returns whether ellipsoidal calculations are enabled - * @see willUseEllipsoid() - * @see setEllipsoidalMode() + * \see willUseEllipsoid() + * \see setEllipsoidalMode() */ bool ellipsoidalEnabled() const { return mEllipsoidalMode; } /** Returns whether calculations will use the ellipsoid. Calculations will only use the * ellipsoid if ellipsoidalEnabled() is true and an ellipsoid has been set. * \since QGIS 2.14 - * @see ellipsoidalEnabled() - * @see ellipsoid() + * \see ellipsoidalEnabled() + * \see ellipsoid() */ bool willUseEllipsoid() const; @@ -76,8 +76,8 @@ class CORE_EXPORT QgsDistanceArea /** * Sets source spatial reference system (by QGIS CRS) - * @note: missing in Python bindings in QGIS < 2.2 - * @see sourceCrs() + * \note: missing in Python bindings in QGIS < 2.2 + * \see sourceCrs() */ void setSourceCrs( const QgsCoordinateReferenceSystem &srcCRS ); @@ -85,12 +85,12 @@ class CORE_EXPORT QgsDistanceArea void setSourceAuthId( const QString &authid ); /** Returns the source spatial reference system. - * @see setSourceCrs() + * \see setSourceCrs() */ QgsCoordinateReferenceSystem sourceCrs() const { return mCoordTransform.sourceCrs(); } /** Returns the QgsCoordinateReferenceSystem::srsid() for the CRS used during calculations. - * @see setSourceCrs() + * \see setSourceCrs() * \since QGIS 2.14 */ long sourceCrsId() const { return mCoordTransform.sourceCrs().srsid(); } @@ -100,28 +100,28 @@ class CORE_EXPORT QgsDistanceArea /** Sets ellipsoid by its acronym. Calculations will only use the ellipsoid if * both the ellipsoid has been set and ellipsoidalEnabled() is true. - * @returns true if ellipsoid was successfully set - * @see ellipsoid() - * @see setEllipsoidalMode() - * @see willUseEllipsoid() + * \returns true if ellipsoid was successfully set + * \see ellipsoid() + * \see setEllipsoidalMode() + * \see willUseEllipsoid() */ bool setEllipsoid( const QString &ellipsoid ); /** Sets ellipsoid by supplied radii. Calculations will only use the ellipsoid if * both the ellipsoid has been set and ellipsoidalEnabled() is true. - * @returns true if ellipsoid was successfully set - * @see ellipsoid() - * @see setEllipsoidalMode() - * @see willUseEllipsoid() + * \returns true if ellipsoid was successfully set + * \see ellipsoid() + * \see setEllipsoidalMode() + * \see willUseEllipsoid() */ // Inverse flattening is calculated with invf = a/(a-b) bool setEllipsoid( double semiMajor, double semiMinor ); /** Returns ellipsoid's acronym. Calculations will only use the * ellipsoid if ellipsoidalEnabled() is true and an ellipsoid has been set. - * @see setEllipsoid() - * @see ellipsoidalEnabled() - * @see willUseEllipsoid() + * \see setEllipsoid() + * \see ellipsoidalEnabled() + * \see willUseEllipsoid() */ QString ellipsoid() const { return mEllipsoid; } @@ -133,104 +133,104 @@ class CORE_EXPORT QgsDistanceArea double ellipsoidInverseFlattening() const { return mInvFlattening; } /** Measures the area of a geometry. - * @param geometry geometry to measure - * @returns area of geometry. For geometry collections, non surface geometries will be ignored. The units for the + * \param geometry geometry to measure + * \returns area of geometry. For geometry collections, non surface geometries will be ignored. The units for the * returned area can be retrieved by calling areaUnits(). * \since QGIS 2.12 - * @see measureLength() - * @see measurePerimeter() - * @see areaUnits() + * \see measureLength() + * \see measurePerimeter() + * \see areaUnits() */ double measureArea( const QgsGeometry *geometry ) const; /** Measures the area of a geometry. - * @param geometry geometry to measure - * @returns area of geometry. For geometry collections, non surface geometries will be ignored. The units for the + * \param geometry geometry to measure + * \returns area of geometry. For geometry collections, non surface geometries will be ignored. The units for the * returned area can be retrieved by calling areaUnits(). * \since QGIS 2.12 - * @see measureLength() - * @see measurePerimeter() - * @see areaUnits() + * \see measureLength() + * \see measurePerimeter() + * \see areaUnits() */ double measureArea( const QgsGeometry &geometry ) const; /** Measures the length of a geometry. - * @param geometry geometry to measure - * @returns length of geometry. For geometry collections, non curve geometries will be ignored. The units for the + * \param geometry geometry to measure + * \returns length of geometry. For geometry collections, non curve geometries will be ignored. The units for the * returned distance can be retrieved by calling lengthUnits(). * \since QGIS 2.12 - * @see lengthUnits() - * @see measureArea() - * @see measurePerimeter() + * \see lengthUnits() + * \see measureArea() + * \see measurePerimeter() */ double measureLength( const QgsGeometry *geometry ) const; /** Measures the length of a geometry. - * @param geometry geometry to measure - * @returns length of geometry. For geometry collections, non curve geometries will be ignored. The units for the + * \param geometry geometry to measure + * \returns length of geometry. For geometry collections, non curve geometries will be ignored. The units for the * returned distance can be retrieved by calling lengthUnits(). * \since QGIS 2.12 - * @see lengthUnits() - * @see measureArea() - * @see measurePerimeter() + * \see lengthUnits() + * \see measureArea() + * \see measurePerimeter() */ double measureLength( const QgsGeometry &geometry ) const; /** Measures the perimeter of a polygon geometry. - * @param geometry geometry to measure - * @returns perimeter of geometry. For geometry collections, any non-polygon geometries will be ignored. The units for the + * \param geometry geometry to measure + * \returns perimeter of geometry. For geometry collections, any non-polygon geometries will be ignored. The units for the * returned perimeter can be retrieved by calling lengthUnits(). * \since QGIS 2.12 - * @see lengthUnits() - * @see measureArea() - * @see measurePerimeter() + * \see lengthUnits() + * \see measureArea() + * \see measurePerimeter() */ double measurePerimeter( const QgsGeometry *geometry ) const; /** Measures the perimeter of a polygon geometry. - * @param geometry geometry to measure - * @returns perimeter of geometry. For geometry collections, any non-polygon geometries will be ignored. The units for the + * \param geometry geometry to measure + * \returns perimeter of geometry. For geometry collections, any non-polygon geometries will be ignored. The units for the * returned perimeter can be retrieved by calling lengthUnits(). * \since QGIS 2.12 - * @see lengthUnits() - * @see measureArea() - * @see measurePerimeter() + * \see lengthUnits() + * \see measureArea() + * \see measurePerimeter() */ double measurePerimeter( const QgsGeometry &geometry ) const; /** Measures the length of a line with multiple segments. - * @param points list of points in line - * @returns length of line. The units for the returned length can be retrieved by calling lengthUnits(). - * @see lengthUnits() + * \param points list of points in line + * \returns length of line. The units for the returned length can be retrieved by calling lengthUnits(). + * \see lengthUnits() */ double measureLine( const QList &points ) const; /** Measures length of a line with one segment. - * @param p1 start of line - * @param p2 end of line - * @returns distance between points. The units for the returned distance can be retrieved by calling lengthUnits(). - * @see lengthUnits() + * \param p1 start of line + * \param p2 end of line + * \returns distance between points. The units for the returned distance can be retrieved by calling lengthUnits(). + * \see lengthUnits() */ double measureLine( const QgsPoint &p1, const QgsPoint &p2 ) const; /** Measures length of line with one segment and returns units of distance. - * @param p1 start of line - * @param p2 end of line - * @param units will be set to units of measure - * @returns calculated distance between points. Distance units are stored in units parameter. + * \param p1 start of line + * \param p2 end of line + * \param units will be set to units of measure + * \returns calculated distance between points. Distance units are stored in units parameter. * \since QGIS 2.12 */ double measureLine( const QgsPoint &p1, const QgsPoint &p2, QgsUnitTypes::DistanceUnit &units ) const; /** Returns the units of distance for length calculations made by this object. * \since QGIS 2.14 - * @see areaUnits() + * \see areaUnits() */ QgsUnitTypes::DistanceUnit lengthUnits() const; /** Returns the units of area for areal calculations made by this object. * \since QGIS 2.14 - * @see lengthUnits() + * \see lengthUnits() */ QgsUnitTypes::AreaUnit areaUnits() const; @@ -241,54 +241,54 @@ class CORE_EXPORT QgsDistanceArea double bearing( const QgsPoint &p1, const QgsPoint &p2 ) const; /** Returns an distance formatted as a friendly string. - * @param distance distance to format - * @param decimals number of decimal places to show - * @param unit unit of distance - * @param keepBaseUnit set to false to allow conversion of large distances to more suitable units, e.g., meters to + * \param distance distance to format + * \param decimals number of decimal places to show + * \param unit unit of distance + * \param keepBaseUnit set to false to allow conversion of large distances to more suitable units, e.g., meters to * kilometers - * @returns formatted distance string + * \returns formatted distance string * \since QGIS 2.16 - * @see formatArea() + * \see formatArea() */ static QString formatDistance( double distance, int decimals, QgsUnitTypes::DistanceUnit unit, bool keepBaseUnit = false ); /** Returns an area formatted as a friendly string. - * @param area area to format - * @param decimals number of decimal places to show - * @param unit unit of area - * @param keepBaseUnit set to false to allow conversion of large areas to more suitable units, e.g., square meters to + * \param area area to format + * \param decimals number of decimal places to show + * \param unit unit of area + * \param keepBaseUnit set to false to allow conversion of large areas to more suitable units, e.g., square meters to * square kilometers - * @returns formatted area string + * \returns formatted area string * \since QGIS 2.14 - * @see formatDistance() + * \see formatDistance() */ static QString formatArea( double area, int decimals, QgsUnitTypes::AreaUnit unit, bool keepBaseUnit = false ); /** Takes a length measurement calculated by this QgsDistanceArea object and converts it to a * different distance unit. - * @param length length value calculated by this class to convert. It is assumed that the length + * \param length length value calculated by this class to convert. It is assumed that the length * was calculated by this class, ie that its unit of length is equal to lengthUnits(). - * @param toUnits distance unit to convert measurement to - * @returns converted distance - * @see convertAreaMeasurement() + * \param toUnits distance unit to convert measurement to + * \returns converted distance + * \see convertAreaMeasurement() * \since QGIS 2.14 */ double convertLengthMeasurement( double length, QgsUnitTypes::DistanceUnit toUnits ) const; /** Takes an area measurement calculated by this QgsDistanceArea object and converts it to a * different areal unit. - * @param area area value calculated by this class to convert. It is assumed that the area + * \param area area value calculated by this class to convert. It is assumed that the area * was calculated by this class, ie that its unit of area is equal to areaUnits(). - * @param toUnits area unit to convert measurement to - * @returns converted area - * @see convertLengthMeasurement() + * \param toUnits area unit to convert measurement to + * \returns converted area + * \see convertLengthMeasurement() * \since QGIS 2.14 */ double convertAreaMeasurement( double area, QgsUnitTypes::AreaUnit toUnits ) const; protected: //! measures polygon area and perimeter, vertices are extracted from WKB - // @note not available in Python bindings + // \note not available in Python bindings QgsConstWkbPtr measurePolygon( QgsConstWkbPtr feature, double *area, double *perimeter, bool hasZptr = false ) const; /** @@ -297,9 +297,9 @@ class CORE_EXPORT QgsDistanceArea * * Points p1 and p2 are expected to be in degrees and in currently used ellipsoid * - * @note if course1 is not NULL, bearing (in radians) from first point is calculated + * \note if course1 is not NULL, bearing (in radians) from first point is calculated * (the same for course2) - * @return distance in meters + * \returns distance in meters */ double computeDistanceBearing( const QgsPoint &p1, const QgsPoint &p2, double *course1 = nullptr, double *course2 = nullptr ) const; diff --git a/src/core/qgseditformconfig.h b/src/core/qgseditformconfig.h index afa8ded0ea07..8414d3535514 100644 --- a/src/core/qgseditformconfig.h +++ b/src/core/qgseditformconfig.h @@ -151,30 +151,30 @@ class CORE_EXPORT QgsEditFormConfig * layer.setEditFormConfig(editFormConfig) * \endcode * - * @param widgetName The name of the widget to configure - * @param config The config to set for this widget - * @returns false if a field exists with the provided widgetName. In this case + * \param widgetName The name of the widget to configure + * \param config The config to set for this widget + * \returns false if a field exists with the provided widgetName. In this case * QgsVectorLayer::setEditorWidgetSetup should be used. * - * @see QgsVectorLayer::setEditorWidgetSetup() for field configurations. + * \see QgsVectorLayer::setEditorWidgetSetup() for field configurations. */ bool setWidgetConfig( const QString &widgetName, const QVariantMap &config ); /** * Get the configuration for the editor widget with the given name. * - * @param widgetName The name of the widget. + * \param widgetName The name of the widget. * - * @return The configuration for the editor widget or an empty config if the field does not exist + * \returns The configuration for the editor widget or an empty config if the field does not exist */ QVariantMap widgetConfig( const QString &widgetName ) const; /** * Remove the configuration for the editor widget with the given name * - * @param widgetName The name of the widget. + * \param widgetName The name of the widget. * - * @return true if a configuration has been removed + * \returns true if a configuration has been removed */ bool removeWidgetConfig( const QString &widgetName ); @@ -211,7 +211,7 @@ class CORE_EXPORT QgsEditFormConfig * Get Python function for edit form initialization. * Will be looked up in a Python file relative to the project folder if it * includes a module name or if it's a pure function name it will searched - * in the Python code set with @link setInitCode @endlink. + * in the Python code set with setInitCode(). */ QString initFunction() const; @@ -219,7 +219,7 @@ class CORE_EXPORT QgsEditFormConfig * Set Python function for edit form initialization. * Will be looked up in a Python file relative to the project folder if it * includes a module name or if it's a pure function name it will searched - * in the Python code set with @link setInitCode @endlink. + * in the Python code set with setInitCode(). */ void setInitFunction( const QString &function ); @@ -231,7 +231,7 @@ class CORE_EXPORT QgsEditFormConfig /** * Set Python code for edit form initialization. * Make sure that you also set the appropriate function name in - * @link setInitFunction @endlink + * setInitFunction(). */ void setInitCode( const QString &code ); @@ -243,7 +243,7 @@ class CORE_EXPORT QgsEditFormConfig /** * Set Python external file path for edit form initialization. * Make sure that you also set the appropriate function name in - * @link setInitFunction @endlink + * setInitFunction(). */ void setInitFilePath( const QString &filePath ); diff --git a/src/core/qgseditorwidgetsetup.h b/src/core/qgseditorwidgetsetup.h index ef7aa791cf81..4c00be808e10 100644 --- a/src/core/qgseditorwidgetsetup.h +++ b/src/core/qgseditorwidgetsetup.h @@ -39,17 +39,17 @@ class CORE_EXPORT QgsEditorWidgetSetup QgsEditorWidgetSetup() {} /** - * @return the widget type to use + * \returns the widget type to use */ QString type() const { return mType; } /** - * @return the widget configuration to used + * \returns the widget configuration to used */ QVariantMap config() const { return mConfig; } /** - * @return true if there is no widget configured. + * \returns true if there is no widget configured. */ bool isNull() const { return mType.isEmpty(); } diff --git a/src/core/qgserror.h b/src/core/qgserror.h index 4f2611f8bafb..99945575e604 100644 --- a/src/core/qgserror.h +++ b/src/core/qgserror.h @@ -44,11 +44,11 @@ class CORE_EXPORT QgsErrorMessage {} /** Constructor. - * @param message error message string - * @param tag error label, for example GDAL, GDAL Provider, Raster layer - * @param file the file where error was created - * @param function the function where error was created - * @param line the line where error was created + * \param message error message string + * \param tag error label, for example GDAL, GDAL Provider, Raster layer + * \param file the file where error was created + * \param function the function where error was created + * \param line the line where error was created */ QgsErrorMessage( const QString &message, const QString &tag = QString::null, const QString &file = QString::null, const QString &function = QString::null, int line = 0 ); @@ -86,35 +86,35 @@ class CORE_EXPORT QgsError QgsError() {} /** Constructor with single message. - * @param message error message - * @param tag short description, e.g. GDAL, Provider, Layer + * \param message error message + * \param tag short description, e.g. GDAL, Provider, Layer */ QgsError( const QString &message, const QString &tag ); /** Append new error message. - * @param message error message string - * @param tag error label, for example GDAL, GDAL Provider, Raster layer + * \param message error message string + * \param tag error label, for example GDAL, GDAL Provider, Raster layer */ void append( const QString &message, const QString &tag ); /** Append new error message. - * @param message error message + * \param message error message */ void append( const QgsErrorMessage &message ); /** Test if any error is set. - * @return true if contains error + * \returns true if contains error */ bool isEmpty() const { return mMessageList.isEmpty(); } /** Full error messages description - * @param format output format - * @return error report + * \param format output format + * \returns error report */ QString message( QgsErrorMessage::Format format = QgsErrorMessage::Html ) const; /** Short error description, usually the first error in chain, the real error. - * @return error description + * \returns error description */ QString summary() const; diff --git a/src/core/qgsexception.h b/src/core/qgsexception.h index 1514bed14c72..5e85e4a62f7f 100644 --- a/src/core/qgsexception.h +++ b/src/core/qgsexception.h @@ -34,7 +34,7 @@ class CORE_EXPORT QgsException virtual ~QgsException() throw() {} - //! @note not available in Python bindings + //! \note not available in Python bindings QString what() const throw() { return what_; diff --git a/src/core/qgsexpression.h b/src/core/qgsexpression.h index a9378bc12b23..263a1900dda6 100644 --- a/src/core/qgsexpression.h +++ b/src/core/qgsexpression.h @@ -98,7 +98,7 @@ Implicit sharing This class is implicitly shared, copying has a very low overhead. It is normally preferable to call `QgsExpression( otherExpression )` instead of `QgsExpression( otherExpression.expression() )`. A deep copy will only be made -when {@link prepare()} is called. For usage this means mainly, that you should +when prepare() is called. For usage this means mainly, that you should normally keep an unprepared master copy of a QgsExpression and whenever using it with a particular QgsFeatureIterator copy it just before and prepare it using the same context as the iterator. @@ -115,7 +115,7 @@ class CORE_EXPORT QgsExpression /** * Creates a new expression based on the provided string. * The string will immediately be parsed. For optimization - * {@link prepare()} should always be called before every + * prepare() should always be called before every * loop in which this expression is used. */ QgsExpression( const QString &expr ); @@ -170,7 +170,7 @@ class CORE_EXPORT QgsExpression const Node *rootNode() const; /** Get the expression ready for evaluation - find out column indexes. - * @param context context for preparing expression + * \param context context for preparing expression * \since QGIS 2.12 */ bool prepare( const QgsExpressionContext *context ); @@ -178,11 +178,11 @@ class CORE_EXPORT QgsExpression /** * Get list of columns referenced by the expression. * - * @note If the returned list contains the QgsFeatureRequest::AllAttributes constant then + * \note If the returned list contains the QgsFeatureRequest::AllAttributes constant then * all attributes from the layer are required for evaluation of the expression. * QgsFeatureRequest::setSubsetOfAttributes automatically handles this case. * - * @see referencedAttributeIndexes() + * \see referencedAttributeIndexes() */ QSet referencedColumns() const; @@ -208,14 +208,14 @@ class CORE_EXPORT QgsExpression // evaluation /** Evaluate the feature and return the result. - * @note this method does not expect that prepare() has been called on this instance + * \note this method does not expect that prepare() has been called on this instance * \since QGIS 2.12 */ QVariant evaluate(); /** Evaluate the expression against the specified context and return the result. - * @param context context for evaluating expression - * @note prepare() should be called before calling this method. + * \param context context for evaluating expression + * \note prepare() should be called before calling this method. * \since QGIS 2.12 */ QVariant evaluate( const QgsExpressionContext *context ); @@ -233,10 +233,10 @@ class CORE_EXPORT QgsExpression bool isField() const { return rootNode() && dynamic_cast( rootNode() ) ;} /** Tests whether a string is a valid expression. - * @param text string to test - * @param context optional expression context - * @param errorMessage will be filled with any error message from the validation - * @returns true if string is a valid expression + * \param text string to test + * \param context optional expression context + * \param errorMessage will be filled with any error message from the validation + * \returns true if string is a valid expression * \since QGIS 2.12 */ static bool checkExpression( const QString &text, const QgsExpressionContext *context, QString &errorMessage ); @@ -261,9 +261,9 @@ class CORE_EXPORT QgsExpression /** Return calculator used for distance and area calculations * (used by $length, $area and $perimeter functions only) - * @see setGeomCalculator() - * @see distanceUnits() - * @see areaUnits() + * \see setGeomCalculator() + * \see distanceUnits() + * \see areaUnits() */ QgsDistanceArea *geomCalculator(); @@ -271,41 +271,41 @@ class CORE_EXPORT QgsExpression * (used by $length, $area and $perimeter functions only). By default, no geometry * calculator is set and all distance and area calculations are performed using simple * cartesian methods (ie no ellipsoidal calculations). - * @param calc geometry calculator. Ownership is not transferred. Set to a nullptr to force + * \param calc geometry calculator. Ownership is not transferred. Set to a nullptr to force * cartesian calculations. - * @see geomCalculator() + * \see geomCalculator() */ void setGeomCalculator( const QgsDistanceArea *calc ); /** Returns the desired distance units for calculations involving geomCalculator(), e.g., "$length" and "$perimeter". - * @note distances are only converted when a geomCalculator() has been set + * \note distances are only converted when a geomCalculator() has been set * \since QGIS 2.14 - * @see setDistanceUnits() - * @see areaUnits() + * \see setDistanceUnits() + * \see areaUnits() */ QgsUnitTypes::DistanceUnit distanceUnits() const; /** Sets the desired distance units for calculations involving geomCalculator(), e.g., "$length" and "$perimeter". - * @note distances are only converted when a geomCalculator() has been set + * \note distances are only converted when a geomCalculator() has been set * \since QGIS 2.14 - * @see distanceUnits() - * @see setAreaUnits() + * \see distanceUnits() + * \see setAreaUnits() */ void setDistanceUnits( QgsUnitTypes::DistanceUnit unit ); /** Returns the desired areal units for calculations involving geomCalculator(), e.g., "$area". - * @note areas are only converted when a geomCalculator() has been set + * \note areas are only converted when a geomCalculator() has been set * \since QGIS 2.14 - * @see setAreaUnits() - * @see distanceUnits() + * \see setAreaUnits() + * \see distanceUnits() */ QgsUnitTypes::AreaUnit areaUnits() const; /** Sets the desired areal units for calculations involving geomCalculator(), e.g., "$area". - * @note areas are only converted when a geomCalculator() has been set + * \note areas are only converted when a geomCalculator() has been set * \since QGIS 2.14 - * @see areaUnits() - * @see setDistanceUnits() + * \see areaUnits() + * \see setDistanceUnits() */ void setAreaUnits( QgsUnitTypes::AreaUnit unit ); @@ -313,9 +313,9 @@ class CORE_EXPORT QgsExpression * in the string with the result of its evaluation with the specified context * * Additional substitutions can be passed through the substitutionMap parameter - * @param action The source string in which placeholders should be replaced. - * @param context Expression context - * @param distanceArea Optional QgsDistanceArea. If specified, the QgsDistanceArea is used for distance + * \param action The source string in which placeholders should be replaced. + * \param context Expression context + * \param distanceArea Optional QgsDistanceArea. If specified, the QgsDistanceArea is used for distance * and area conversion * \since QGIS 2.12 */ @@ -324,18 +324,18 @@ class CORE_EXPORT QgsExpression /** Attempts to evaluate a text string as an expression to a resultant double * value. - * @param text text to evaluate as expression - * @param fallbackValue value to return if text can not be evaluated as a double - * @returns evaluated double value, or fallback value + * \param text text to evaluate as expression + * \param fallbackValue value to return if text can not be evaluated as a double + * \returns evaluated double value, or fallback value * \since QGIS 2.7 - * @note this method is inefficient for bulk evaluation of expressions, it is intended + * \note this method is inefficient for bulk evaluation of expressions, it is intended * for one-off evaluations only. */ static double evaluateToDouble( const QString &text, const double fallbackValue ); /** - * @brief list of unary operators - * @note if any change is made here, the definition of QgsExpression::UnaryOperatorText[] must be adapted. + * \brief list of unary operators + * \note if any change is made here, the definition of QgsExpression::UnaryOperatorText[] must be adapted. */ enum UnaryOperator { @@ -344,8 +344,8 @@ class CORE_EXPORT QgsExpression }; /** - * @brief list of binary operators - * @note if any change is made here, the definition of QgsExpression::BinaryOperatorText[] must be adapted. + * \brief list of binary operators + * \note if any change is made here, the definition of QgsExpression::BinaryOperatorText[] must be adapted. */ enum BinaryOperator { @@ -394,10 +394,10 @@ class CORE_EXPORT QgsExpression soWithin, }; - //! @note not available in Python bindings + //! \note not available in Python bindings static const char *BINARY_OPERATOR_TEXT[]; - //! @note not available in Python bindings + //! \note not available in Python bindings static const char *UNARY_OPERATOR_TEXT[]; /** \ingroup core @@ -409,9 +409,9 @@ class CORE_EXPORT QgsExpression public: /** Constructor for Parameter. - * @param name parameter name, used when named parameter are specified in an expression - * @param optional set to true if parameter should be optional - * @param defaultValue default value to use for optional parameters + * \param name parameter name, used when named parameter are specified in an expression + * \param optional set to true if parameter should be optional + * \param defaultValue default value to use for optional parameters */ Parameter( const QString &name, bool optional = false, @@ -568,7 +568,7 @@ class CORE_EXPORT QgsExpression /** Returns a list of possible aliases for the function. These include * other permissible names for the function, e.g., deprecated names. - * @return list of known aliases + * \returns list of known aliases * \since QGIS 2.9 */ virtual QStringList aliases() const { return QStringList(); } @@ -600,13 +600,13 @@ class CORE_EXPORT QgsExpression virtual bool isDeprecated() const { return mGroups.isEmpty() ? false : mGroups.contains( QStringLiteral( "deprecated" ) ); } /** Returns the first group which the function belongs to. - * @note consider using groups() instead, as some functions naturally belong in multiple groups + * \note consider using groups() instead, as some functions naturally belong in multiple groups */ QString group() const { return mGroups.isEmpty() ? QString() : mGroups.at( 0 ); } /** Returns a list of the groups the function belongs to. * \since QGIS 3.0 - * @see group() + * \see group() */ QStringList groups() const { return mGroups; } @@ -614,10 +614,10 @@ class CORE_EXPORT QgsExpression const QString helpText() const { return mHelpText.isEmpty() ? QgsExpression::helpText( mName ) : mHelpText; } /** Returns result of evaluating the function. - * @param values list of values passed to the function - * @param context context expression is being evaluated against - * @param parent parent expression - * @returns result of function + * \param values list of values passed to the function + * \param context context expression is being evaluated against + * \param parent parent expression + * \returns result of function */ virtual QVariant func( const QVariantList &values, const QgsExpressionContext *context, QgsExpression *parent ) = 0; @@ -725,10 +725,10 @@ class CORE_EXPORT QgsExpression {} /** Returns result of evaluating the function. - * @param values list of values passed to the function - * @param context context expression is being evaluated against - * @param parent parent expression - * @returns result of function + * \param values list of values passed to the function + * \param context context expression is being evaluated against + * \param parent parent expression + * \returns result of function */ virtual QVariant func( const QVariantList &values, const QgsExpressionContext *context, QgsExpression *parent ) override { @@ -750,30 +750,30 @@ class CORE_EXPORT QgsExpression QSet mReferencedColumns; }; - //! @note not available in Python bindings + //! \note not available in Python bindings static QList sFunctions; static const QList &Functions(); - //! @note not available in Python bindings + //! \note not available in Python bindings static QStringList sBuiltinFunctions; static const QStringList &BuiltinFunctions(); /** Registers a function to the expression engine. This is required to allow expressions to utilize the function. - * @param function function to register - * @param transferOwnership set to true to transfer ownership of function to expression engine - * @returns true on successful registration - * @see unregisterFunction + * \param function function to register + * \param transferOwnership set to true to transfer ownership of function to expression engine + * \returns true on successful registration + * \see unregisterFunction */ static bool registerFunction( Function *function, bool transferOwnership = false ); /** Unregisters a function from the expression engine. The function will no longer be usable in expressions. - * @param name function name - * @see registerFunction + * \param name function name + * \see registerFunction */ static bool unregisterFunction( const QString &name ); //! List of functions owned by the expression engine - //! @note not available in Python bindings + //! \note not available in Python bindings static QList sOwnedFunctions; /** Deletes all registered functions whose ownership have been transferred to the expression engine. @@ -788,38 +788,38 @@ class CORE_EXPORT QgsExpression static int functionIndex( const QString &name ); /** Returns the number of functions defined in the parser - * @return The number of function defined in the parser. + * \returns The number of function defined in the parser. */ static int functionCount(); /** Returns a quoted column reference (in double quotes) - * @see quotedString() - * @see quotedValue() + * \see quotedString() + * \see quotedValue() */ static QString quotedColumnRef( QString name ); /** Returns a quoted version of a string (in single quotes) - * @see quotedValue() - * @see quotedColumnRef() + * \see quotedValue() + * \see quotedColumnRef() */ static QString quotedString( QString text ); /** Returns a string representation of a literal value, including appropriate * quotations where required. - * @param value value to convert to a string representation + * \param value value to convert to a string representation * \since QGIS 2.14 - * @see quotedString() - * @see quotedColumnRef() + * \see quotedString() + * \see quotedColumnRef() */ static QString quotedValue( const QVariant &value ); /** Returns a string representation of a literal value, including appropriate * quotations where required. - * @param value value to convert to a string representation - * @param type value type + * \param value value to convert to a string representation + * \param type value type * \since QGIS 2.14 - * @see quotedString() - * @see quotedColumnRef() + * \see quotedString() + * \see quotedColumnRef() */ static QString quotedValue( const QVariant &value, QVariant::Type type ); @@ -846,7 +846,7 @@ class CORE_EXPORT QgsExpression /** * Abstract virtual that returns the type of this node. * - * @return The type of this node + * \returns The type of this node */ virtual NodeType nodeType() const = 0; @@ -867,7 +867,7 @@ class CORE_EXPORT QgsExpression /** * Abstract virtual dump method * - * @return An expression which represents this node as string + * \returns An expression which represents this node as string */ virtual QString dump() const = 0; @@ -877,7 +877,7 @@ class CORE_EXPORT QgsExpression * generated in prepare and context related. * Ownership is transferred to the caller. * - * @return a deep copy of this node. + * \returns a deep copy of this node. */ virtual Node *clone() const = 0; @@ -889,7 +889,7 @@ class CORE_EXPORT QgsExpression * evaluate this node and in addition recursively collect all the columns required * to evaluate child nodes. * - * @return A list of columns required to evaluate this expression + * \returns A list of columns required to evaluate this expression */ virtual QSet referencedColumns() const = 0; @@ -904,7 +904,7 @@ class CORE_EXPORT QgsExpression * * This needs to call `needsGeometry()` recursively on any child nodes. * - * @return true if a geometry is required to evaluate this expression + * \returns true if a geometry is required to evaluate this expression */ virtual bool needsGeometry() const = 0; }; @@ -917,8 +917,8 @@ class CORE_EXPORT QgsExpression public: /** Constructor for NamedNode - * @param name node name - * @param node node + * \param name node name + * \param node node */ NamedNode( const QString &name, Node *node ) : name( name ) @@ -1049,8 +1049,8 @@ class CORE_EXPORT QgsExpression double computeDouble( double x, double y ); /** Computes the result date time calculation from a start datetime and an interval - * @param d start datetime - * @param i interval to add or subtract (depending on mOp) + * \param d start datetime + * \param i interval to add or subtract (depending on mOp) */ QDateTime computeDateTimeFromInterval( const QDateTime &d, QgsInterval *i ); @@ -1231,29 +1231,29 @@ class CORE_EXPORT QgsExpression }; /** Returns the help text for a specified function. - * @param name function name - * @see variableHelpText() + * \param name function name + * \see variableHelpText() */ static QString helpText( QString name ); /** Returns the help text for a specified variable. - * @param variableName name of variable - * @param showValue set to true to include current value of variable in help text - * @param value current value of variable to show in help text - * @see helpText() + * \param variableName name of variable + * \param showValue set to true to include current value of variable in help text + * \param value current value of variable to show in help text + * \see helpText() * \since QGIS 2.12 */ static QString variableHelpText( const QString &variableName, bool showValue = true, const QVariant &value = QVariant() ); /** Returns the translated name for a function group. - * @param group untranslated group name + * \param group untranslated group name */ static QString group( const QString &group ); /** Formats an expression result for friendly display to the user. Truncates the result to a sensible * length, and presents text representations of non numeric/text types (e.g., geometries and features). - * @param value expression result to format - * @returns formatted string, may contain HTML formatting characters + * \param value expression result to format + * \returns formatted string, may contain HTML formatting characters * \since QGIS 2.14 */ static QString formatPreviewString( const QVariant &value ); @@ -1338,7 +1338,7 @@ class CORE_EXPORT QgsExpression * Helper for implicit sharing. When called will create * a new deep copy of this expression. * - * @note not available in Python bindings + * \note not available in Python bindings */ void detach(); @@ -1348,9 +1348,9 @@ class CORE_EXPORT QgsExpression static QHash sVariableHelpTexts; static QHash sGroups; - //! @note not available in Python bindings + //! \note not available in Python bindings static void initFunctionHelp(); - //! @note not available in Python bindings + //! \note not available in Python bindings static void initVariableHelp(); friend class QgsOgcUtils; diff --git a/src/core/qgsexpressioncontext.h b/src/core/qgsexpressioncontext.h index be8439022be6..8c5920610d34 100644 --- a/src/core/qgsexpressioncontext.h +++ b/src/core/qgsexpressioncontext.h @@ -121,9 +121,9 @@ class CORE_EXPORT QgsExpressionContextScope { /** Constructor for StaticVariable. - * @param name variable name (should be unique within the QgsExpressionContextScope) - * @param value initial variable value - * @param readOnly true if variable should not be editable by users + * \param name variable name (should be unique within the QgsExpressionContextScope) + * \param value initial variable value + * \param readOnly true if variable should not be editable by users */ StaticVariable( const QString &name = QString(), const QVariant &value = QVariant(), bool readOnly = false ) : name( name ) @@ -142,7 +142,7 @@ class CORE_EXPORT QgsExpressionContextScope }; /** Constructor for QgsExpressionContextScope - * @param name friendly display name for the context scope + * \param name friendly display name for the context scope */ QgsExpressionContextScope( const QString &name = QString() ); @@ -160,60 +160,60 @@ class CORE_EXPORT QgsExpressionContextScope /** Convenience method for setting a variable in the context scope by name and value. If a variable * with the same name is already set then its value is overwritten, otherwise a new variable is added to the scope. - * @param name variable name - * @param value variable value - * @see addVariable() + * \param name variable name + * \param value variable value + * \see addVariable() */ void setVariable( const QString &name, const QVariant &value ); /** Adds a variable into the context scope. If a variable with the same name is already set then its * value is overwritten, otherwise a new variable is added to the scope. - * @param variable definition of variable to insert - * @see setVariable() - * @see addFunction() + * \param variable definition of variable to insert + * \see setVariable() + * \see addFunction() */ void addVariable( const QgsExpressionContextScope::StaticVariable &variable ); /** Removes a variable from the context scope, if found. - * @param name name of variable to remove - * @returns true if variable was removed from the scope, false if matching variable was not + * \param name name of variable to remove + * \returns true if variable was removed from the scope, false if matching variable was not * found within the scope */ bool removeVariable( const QString &name ); /** Tests whether a variable with the specified name exists in the scope. - * @param name variable name - * @returns true if matching variable was found in the scope - * @see variable() - * @see hasFunction() + * \param name variable name + * \returns true if matching variable was found in the scope + * \see variable() + * \see hasFunction() */ bool hasVariable( const QString &name ) const; /** Retrieves a variable's value from the scope. - * @param name variable name - * @returns variable value, or invalid QVariant if matching variable could not be found - * @see hasVariable() - * @see function() + * \param name variable name + * \returns variable value, or invalid QVariant if matching variable could not be found + * \see hasVariable() + * \see function() */ QVariant variable( const QString &name ) const; /** Returns a list of variable names contained within the scope. - * @see functionNames() - * @see filteredVariableNames() + * \see functionNames() + * \see filteredVariableNames() */ QStringList variableNames() const; /** Returns a filtered and sorted list of variable names contained within the scope. * Hidden variable names will be excluded, and the list will be sorted so that * read only variables are listed first. - * @see variableNames() + * \see variableNames() */ QStringList filteredVariableNames() const; /** Tests whether the specified variable is read only and should not be editable * by users. - * @param name variable name - * @returns true if variable is read only + * \param name variable name + * \returns true if variable is read only */ bool isReadOnly( const QString &name ) const; @@ -222,69 +222,69 @@ class CORE_EXPORT QgsExpressionContextScope int variableCount() const { return mVariables.count(); } /** Tests whether a function with the specified name exists in the scope. - * @param name function name - * @returns true if matching function was found in the scope - * @see function() - * @see hasFunction() + * \param name function name + * \returns true if matching function was found in the scope + * \see function() + * \see hasFunction() */ bool hasFunction( const QString &name ) const; /** Retrieves a function from the scope. - * @param name function name - * @returns function, or null if matching function could not be found - * @see hasFunction() - * @see functionNames() - * @see variable() + * \param name function name + * \returns function, or null if matching function could not be found + * \see hasFunction() + * \see functionNames() + * \see variable() */ QgsExpression::Function *function( const QString &name ) const; /** Retrieves a list of names of functions contained in the scope. - * @see function() - * @see variableNames() + * \see function() + * \see variableNames() */ QStringList functionNames() const; /** Adds a function to the scope. - * @param name function name - * @param function function to insert. Ownership is transferred to the scope. - * @see addVariable() + * \param name function name + * \param function function to insert. Ownership is transferred to the scope. + * \see addVariable() */ void addFunction( const QString &name, QgsScopedExpressionFunction *function ); /** * Returns true if the scope has a feature associated with it. * \since QGIS 3.0 - * @see feature() + * \see feature() */ bool hasFeature() const { return mHasFeature; } /** * Sets the feature associated with the scope. - * @see setFeature() - * @see hasFeature() + * \see setFeature() + * \see hasFeature() * \since QGIS 3.0 */ QgsFeature feature() const { return mFeature; } /** Convenience function for setting a feature for the scope. Any existing * feature set by the scope will be overwritten. - * @param feature feature for scope - * @see removeFeature() - * @see feature() + * \param feature feature for scope + * \see removeFeature() + * \see feature() */ void setFeature( const QgsFeature &feature ) { mHasFeature = true; mFeature = feature; } /** * Removes any feature associated with the scope. * \since QGIS 3.0 - * @see setFeature() - * @see hasFeature() + * \see setFeature() + * \see hasFeature() */ void removeFeature() { mHasFeature = false; mFeature = QgsFeature(); } /** Convenience function for setting a fields for the scope. Any existing * fields set by the scope will be overwritten. - * @param fields fields for scope + * \param fields fields for scope */ void setFields( const QgsFields &fields ); @@ -333,20 +333,20 @@ class CORE_EXPORT QgsExpressionContext ~QgsExpressionContext(); /** Check whether a variable is specified by any scope within the context. - * @param name variable name - * @returns true if variable is set - * @see variable() - * @see variableNames() + * \param name variable name + * \returns true if variable is set + * \see variable() + * \see variableNames() */ bool hasVariable( const QString &name ) const; /** Fetches a matching variable from the context. The variable will be fetched * from the last scope contained within the context which has a matching * variable set. - * @param name variable name - * @returns variable value if matching variable exists in the context, otherwise an invalid QVariant - * @see hasVariable() - * @see variableNames() + * \param name variable name + * \returns variable value if matching variable exists in the context, otherwise an invalid QVariant + * \see hasVariable() + * \see variableNames() */ QVariant variable( const QString &name ) const; @@ -360,107 +360,107 @@ class CORE_EXPORT QgsExpressionContext /** Returns true if the specified variable name is intended to be highlighted to the * user. This is used by the expression builder to more prominently display the * variable. - * @param name variable name - * @see setHighlightedVariables() + * \param name variable name + * \see setHighlightedVariables() */ bool isHighlightedVariable( const QString &name ) const; /** Sets the list of variable names within the context intended to be highlighted to the user. This * is used by the expression builder to more prominently display these variables. - * @param variableNames variable names to highlight - * @see isHighlightedVariable() + * \param variableNames variable names to highlight + * \see isHighlightedVariable() */ void setHighlightedVariables( const QStringList &variableNames ); /** Returns the currently active scope from the context for a specified variable name. * As scopes later in the stack override earlier contexts, this will be the last matching * scope which contains a matching variable. - * @param name variable name - * @returns matching scope containing variable, or null if none found + * \param name variable name + * \returns matching scope containing variable, or null if none found */ QgsExpressionContextScope *activeScopeForVariable( const QString &name ); /** Returns the currently active scope from the context for a specified variable name. * As scopes later in the stack override earlier contexts, this will be the last matching * scope which contains a matching variable. - * @param name variable name - * @returns matching scope containing variable, or null if none found - * @note not available in Python bindings + * \param name variable name + * \returns matching scope containing variable, or null if none found + * \note not available in Python bindings */ const QgsExpressionContextScope *activeScopeForVariable( const QString &name ) const; /** Returns the scope at the specified index within the context. - * @param index index of scope - * @returns matching scope, or null if none found - * @see lastScope() + * \param index index of scope + * \returns matching scope, or null if none found + * \see lastScope() */ QgsExpressionContextScope *scope( int index ); /** Returns the last scope added to the context. - * @see scope() + * \see scope() */ QgsExpressionContextScope *lastScope(); /** Returns a list of scopes contained within the stack. - * @returns list of pointers to scopes + * \returns list of pointers to scopes */ QList< QgsExpressionContextScope * > scopes() { return mStack; } /** Returns the index of the specified scope if it exists within the context. - * @param scope scope to find - * @returns index of scope, or -1 if scope was not found within the context. + * \param scope scope to find + * \returns index of scope, or -1 if scope was not found within the context. */ int indexOfScope( QgsExpressionContextScope *scope ) const; /** Returns the index of the first scope with a matching name within the context. - * @param scopeName name of scope to find - * @returns index of scope, or -1 if scope was not found within the context. + * \param scopeName name of scope to find + * \returns index of scope, or -1 if scope was not found within the context. * \since QGIS 3.0 */ int indexOfScope( const QString &scopeName ) const; /** Returns a list of variables names set by all scopes in the context. - * @returns list of unique variable names - * @see filteredVariableNames - * @see functionNames - * @see hasVariable - * @see variable + * \returns list of unique variable names + * \see filteredVariableNames + * \see functionNames + * \see hasVariable + * \see variable */ QStringList variableNames() const; /** Returns a filtered list of variables names set by all scopes in the context. The included * variables are those which should be seen by users. - * @returns filtered list of unique variable names - * @see variableNames + * \returns filtered list of unique variable names + * \see variableNames */ QStringList filteredVariableNames() const; /** Returns whether a variable is read only, and should not be modifiable by users. - * @param name variable name - * @returns true if variable is read only. Read only status will be taken from last + * \param name variable name + * \returns true if variable is read only. Read only status will be taken from last * matching scope which contains a matching variable. */ bool isReadOnly( const QString &name ) const; /** Checks whether a specified function is contained in the context. - * @param name function name - * @returns true if context provides a matching function - * @see function + * \param name function name + * \returns true if context provides a matching function + * \see function */ bool hasFunction( const QString &name ) const; /** Retrieves a list of function names contained in the context. - * @see function() - * @see variableNames() + * \see function() + * \see variableNames() */ QStringList functionNames() const; /** Fetches a matching function from the context. The function will be fetched * from the last scope contained within the context which has a matching * function set. - * @param name function name - * @returns function if contained by the context, otherwise null. - * @see hasFunction + * \param name function name + * \returns function if contained by the context, otherwise null. + * \see hasFunction */ QgsExpression::Function *function( const QString &name ) const; @@ -471,14 +471,14 @@ class CORE_EXPORT QgsExpressionContext /** Appends a scope to the end of the context. This scope will override * any matching variables or functions provided by existing scopes within the * context. Ownership of the scope is transferred to the stack. - * @param scope expression context to append to context + * \param scope expression context to append to context */ void appendScope( QgsExpressionContextScope *scope ); /** Appends a list of scopes to the end of the context. This scopes will override * any matching variables or functions provided by existing scopes within the * context. Ownership of the scopes is transferred to the stack. - * @param scopes scopes to append to context + * \param scopes scopes to append to context * \since QGIS 3.0 */ void appendScopes( const QList &scopes ); @@ -497,38 +497,38 @@ class CORE_EXPORT QgsExpressionContext /** Convenience function for setting a feature for the context. The feature * will be set within the last scope of the context, so will override any * existing features within the context. - * @param feature feature for context - * @see feature() + * \param feature feature for context + * \see feature() */ void setFeature( const QgsFeature &feature ); /** * Returns true if the context has a feature associated with it. * \since QGIS 3.0 - * @see feature() + * \see feature() */ bool hasFeature() const; /** Convenience function for retrieving the feature for the context, if set. - * @see setFeature + * \see setFeature */ QgsFeature feature() const; /** Convenience function for setting a fields for the context. The fields * will be set within the last scope of the context, so will override any * existing fields within the context. - * @param fields fields for context - * @see fields() + * \param fields fields for context + * \see fields() */ void setFields( const QgsFields &fields ); /** Convenience function for retrieving the fields for the context, if set. - * @see setFields + * \see setFields */ QgsFields fields() const; /** Sets the original value variable value for the context. - * @param value value for original value variable. This usually represents the an original widget + * \param value value for original value variable. This usually represents the an original widget * value before any data defined overrides have been applied. * \since QGIS 2.12 */ @@ -537,39 +537,39 @@ class CORE_EXPORT QgsExpressionContext /** Sets a value to cache within the expression context. This can be used to cache the results * of expensive expression sub-calculations, to speed up future evaluations using the same * expression context. - * @param key unique key for retrieving cached value - * @param value value to cache - * @see hasCachedValue() - * @see cachedValue() - * @see clearCachedValues() + * \param key unique key for retrieving cached value + * \param value value to cache + * \see hasCachedValue() + * \see cachedValue() + * \see clearCachedValues() * \since QGIS 2.16 */ void setCachedValue( const QString &key, const QVariant &value ) const; /** Returns true if the expression context contains a cached value with a matching key. - * @param key unique key used to store cached value - * @see setCachedValue() - * @see cachedValue() - * @see clearCachedValues() + * \param key unique key used to store cached value + * \see setCachedValue() + * \see cachedValue() + * \see clearCachedValues() * \since QGIS 2.16 */ bool hasCachedValue( const QString &key ) const; /** Returns the matching cached value, if set. This can be used to retrieve the previously stored results * of an expensive expression sub-calculation. - * @param key unique key used to store cached value - * @returns matching cached value, or invalid QVariant if not set - * @see setCachedValue() - * @see hasCachedValue() - * @see clearCachedValues() + * \param key unique key used to store cached value + * \returns matching cached value, or invalid QVariant if not set + * \see setCachedValue() + * \see hasCachedValue() + * \see clearCachedValues() * \since QGIS 2.16 */ QVariant cachedValue( const QString &key ) const; /** Clears all cached values from the context. - * @see setCachedValue() - * @see hasCachedValue() - * @see cachedValue() + * \see setCachedValue() + * \see hasCachedValue() + * \see cachedValue() * \since QGIS 2.16 */ void clearCachedValues() const; @@ -618,50 +618,50 @@ class CORE_EXPORT QgsExpressionContextUtils /** Creates a new scope which contains variables and functions relating to the global QGIS context. * For instance, QGIS version numbers and variables specified through QGIS options. - * @see setGlobalVariable() + * \see setGlobalVariable() */ static QgsExpressionContextScope *globalScope(); /** Sets a global context variable. This variable will be contained within scopes retrieved via * globalScope(). - * @param name variable name - * @param value variable value - * @see setGlobalVariable() - * @see globalScope() + * \param name variable name + * \param value variable value + * \see setGlobalVariable() + * \see globalScope() */ static void setGlobalVariable( const QString &name, const QVariant &value ); /** Sets all global context variables. Existing global variables will be removed and replaced * with the variables specified. - * @param variables new set of global variables - * @see setGlobalVariable() - * @see globalScope() + * \param variables new set of global variables + * \see setGlobalVariable() + * \see globalScope() */ static void setGlobalVariables( const QVariantMap &variables ); /** Creates a new scope which contains variables and functions relating to a QGIS project. * For instance, project path and title, and variables specified through the project properties. - * @param project What project to use - * @see setProjectVariable() + * \param project What project to use + * \see setProjectVariable() */ static QgsExpressionContextScope *projectScope( const QgsProject *project ); /** Sets a project context variable. This variable will be contained within scopes retrieved via * projectScope(). - * @param project Project to apply changes to - * @param name variable name - * @param value variable value - * @see setProjectVariables() - * @see projectScope() + * \param project Project to apply changes to + * \param name variable name + * \param value variable value + * \see setProjectVariables() + * \see projectScope() */ static void setProjectVariable( QgsProject *project, const QString &name, const QVariant &value ); /** Sets all project context variables. Existing project variables will be removed and replaced * with the variables specified. - * @param project Project to apply changes to - * @param variables new set of project variables - * @see setProjectVariable() - * @see projectScope() + * \param project Project to apply changes to + * \param variables new set of project variables + * \see setProjectVariable() + * \see projectScope() */ static void setProjectVariables( QgsProject *project, const QVariantMap &variables ); @@ -677,20 +677,20 @@ class CORE_EXPORT QgsExpressionContextUtils /** Sets a layer context variable. This variable will be contained within scopes retrieved via * layerScope(). - * @param layer map layer - * @param name variable name - * @param value variable value - * @see setLayerVariables() - * @see layerScope() + * \param layer map layer + * \param name variable name + * \param value variable value + * \see setLayerVariables() + * \see layerScope() */ static void setLayerVariable( QgsMapLayer *layer, const QString &name, const QVariant &value ); /** Sets all layer context variables. Existing layer variables will be removed and replaced * with the variables specified. - * @param layer map layer - * @param variables new set of layer variables - * @see setLayerVariable() - * @see layerScope() + * \param layer map layer + * \param variables new set of layer variables + * \see setLayerVariable() + * \see layerScope() */ static void setLayerVariables( QgsMapLayer *layer, const QVariantMap &variables ); @@ -701,65 +701,65 @@ class CORE_EXPORT QgsExpressionContextUtils /** * Updates a symbol scope related to a QgsSymbol to an expression context. - * @param symbol symbol to extract properties from - * @param symbolScope pointer to an existing scope to update + * \param symbol symbol to extract properties from + * \param symbolScope pointer to an existing scope to update * \since QGIS 2.14 */ static QgsExpressionContextScope *updateSymbolScope( const QgsSymbol *symbol, QgsExpressionContextScope *symbolScope = nullptr ); /** Creates a new scope which contains variables and functions relating to a QgsComposition. * For instance, number of pages and page sizes. - * @param composition source composition + * \param composition source composition */ static QgsExpressionContextScope *compositionScope( const QgsComposition *composition ); /** Sets a composition context variable. This variable will be contained within scopes retrieved via * compositionScope(). - * @param composition target composition - * @param name variable name - * @param value variable value - * @see setCompositionVariables() - * @see compositionScope() + * \param composition target composition + * \param name variable name + * \param value variable value + * \see setCompositionVariables() + * \see compositionScope() */ static void setCompositionVariable( QgsComposition *composition, const QString &name, const QVariant &value ); /** Sets all composition context variables. Existing composition variables will be removed and replaced * with the variables specified. - * @param composition target composition - * @param variables new set of layer variables - * @see setCompositionVariable() - * @see compositionScope() + * \param composition target composition + * \param variables new set of layer variables + * \see setCompositionVariable() + * \see compositionScope() */ static void setCompositionVariables( QgsComposition *composition, const QVariantMap &variables ); /** Creates a new scope which contains variables and functions relating to a QgsAtlasComposition. * For instance, current page name and number. - * @param atlas source atlas. If null, a set of default atlas variables will be added to the scope. + * \param atlas source atlas. If null, a set of default atlas variables will be added to the scope. */ static QgsExpressionContextScope *atlasScope( const QgsAtlasComposition *atlas ); /** Creates a new scope which contains variables and functions relating to a QgsComposerItem. * For instance, item size and position. - * @param composerItem source composer item + * \param composerItem source composer item */ static QgsExpressionContextScope *composerItemScope( const QgsComposerItem *composerItem ); /** Sets a composer item context variable. This variable will be contained within scopes retrieved via * composerItemScope(). - * @param composerItem target composer item - * @param name variable name - * @param value variable value - * @see setComposerItemVariables() - * @see composerItemScope() + * \param composerItem target composer item + * \param name variable name + * \param value variable value + * \see setComposerItemVariables() + * \see composerItemScope() */ static void setComposerItemVariable( QgsComposerItem *composerItem, const QString &name, const QVariant &value ); /** Sets all composition context variables. Existing compositoin variables will be removed and replaced * with the variables specified. - * @param composerItem target composer item - * @param variables new set of layer variables - * @see setComposerItemVariable() - * @see composerItemScope() + * \param composerItem target composer item + * \param variables new set of layer variables + * \see setComposerItemVariable() + * \see composerItemScope() */ static void setComposerItemVariables( QgsComposerItem *composerItem, const QVariantMap &variables ); diff --git a/src/core/qgsexpressionfieldbuffer.h b/src/core/qgsexpressionfieldbuffer.h index 843650be7b83..31bfd88aabb9 100644 --- a/src/core/qgsexpressionfieldbuffer.h +++ b/src/core/qgsexpressionfieldbuffer.h @@ -50,23 +50,23 @@ class CORE_EXPORT QgsExpressionFieldBuffer /** * Add an expression to the buffer * - * @param exp expression to add - * @param fld field to add + * \param exp expression to add + * \param fld field to add */ void addExpression( const QString &exp, const QgsField &fld ); /** * Remove an expression from the buffer * - * @param index index of expression to remove + * \param index index of expression to remove */ void removeExpression( int index ); /** * Renames an expression field at a given index * - * @param index The index of the expression to change - * @param name New name for field + * \param index The index of the expression to change + * \param name New name for field * * \since QGIS 3.0 */ @@ -75,8 +75,8 @@ class CORE_EXPORT QgsExpressionFieldBuffer /** * Changes the expression at a given index * - * @param index The index of the expression to change - * @param exp The new expression to set + * \param index The index of the expression to change + * \param exp The new expression to set * * \since QGIS 2.9 */ @@ -95,7 +95,7 @@ class CORE_EXPORT QgsExpressionFieldBuffer /** * Adds fields with the expressions buffered in this object to a QgsFields object * - * @param flds The fields to be updated + * \param flds The fields to be updated */ void updateFields( QgsFields &flds ); diff --git a/src/core/qgsfeature.h b/src/core/qgsfeature.h index 1a70911e2464..f7706906bd38 100644 --- a/src/core/qgsfeature.h +++ b/src/core/qgsfeature.h @@ -57,7 +57,6 @@ typedef qint64 QgsFeatureId; * The feature class encapsulates a single feature including its id, * geometry and a list of field/values attributes. * \note QgsFeature objects are implicitly shared. - * @author Gary E.Sherman */ class CORE_EXPORT QgsFeature { @@ -178,7 +177,7 @@ class CORE_EXPORT QgsFeature #endif /** Constructor for QgsFeature - * @param id feature id + * \param id feature id */ #ifndef SIP_RUN QgsFeature( QgsFeatureId id = QgsFeatureId() ); @@ -187,8 +186,8 @@ class CORE_EXPORT QgsFeature #endif /** Constructor for QgsFeature - * @param fields feature's fields - * @param id feature id + * \param fields feature's fields + * \param id feature id */ #ifndef SIP_RUN QgsFeature( const QgsFields &fields, QgsFeatureId id = QgsFeatureId() ); @@ -217,42 +216,41 @@ class CORE_EXPORT QgsFeature virtual ~QgsFeature(); /** Get the feature ID for this feature. - * @returns feature ID - * @see setId() + * \returns feature ID + * \see setId() */ QgsFeatureId id() const; /** Sets the feature ID for this feature. - * @param id feature id - * @see id + * \param id feature id + * \see id */ void setId( QgsFeatureId id ); /** Returns the feature's attributes. - * @link attributes @endlink method. - * @returns list of feature's attributes - * @see setAttributes + * \returns list of feature's attributes + * \see setAttributes * \since QGIS 2.9 - * @note Alternatively in Python: iterate feature, eg. @code [attr for attr in feature] @endcode + * \note Alternatively in Python: iterate feature, eg. @code [attr for attr in feature] @endcode */ QgsAttributes attributes() const; /** Sets the feature's attributes. * The feature will be valid after. - * @param attrs attribute list - * @see setAttribute - * @see attributes + * \param attrs attribute list + * \see setAttribute + * \see attributes */ void setAttributes( const QgsAttributes &attrs ); /** Set an attribute's value by field index. * The feature will be valid if it was successful. - * @param field the index of the field to set - * @param attr the value of the attribute - * @return false, if the field index does not exist - * @note For Python: raises a KeyError exception instead of returning false - * @note Alternatively in Python: @code feature[field] = attr @endcode - * @see setAttributes + * \param field the index of the field to set + * \param attr the value of the attribute + * \returns false, if the field index does not exist + * \note For Python: raises a KeyError exception instead of returning false + * \note Alternatively in Python: @code feature[field] = attr @endcode + * \see setAttributes */ #ifndef SIP_RUN bool setAttribute( int field, const QVariant &attr ); @@ -281,15 +279,15 @@ class CORE_EXPORT QgsFeature #endif /** Initialize this feature with the given number of fields. Discard any previously set attribute data. - * @param fieldCount Number of fields to initialize + * \param fieldCount Number of fields to initialize */ void initAttributes( int fieldCount ); /** Deletes an attribute and its value. - * @param field the index of the field - * @see setAttribute - * @note For Python: raises a KeyError exception if the field is not found - * @note Alternatively in Python: @code del feature[field] @endcode + * \param field the index of the field + * \see setAttribute + * \note For Python: raises a KeyError exception if the field is not found + * \note Alternatively in Python: @code del feature[field] @endcode */ void deleteAttribute( int field ); #ifdef SIP_RUN @@ -307,67 +305,67 @@ class CORE_EXPORT QgsFeature /** Returns the validity of this feature. This is normally set by * the provider to indicate some problem that makes the feature * invalid or to indicate a null feature. - * @see setValid + * \see setValid */ bool isValid() const; /** Sets the validity of the feature. - * @param validity set to true if feature is valid - * @see isValid + * \param validity set to true if feature is valid + * \see isValid */ void setValid( bool validity ); /** Returns true if the feature has an associated geometry. - * @see geometry() + * \see geometry() * \since QGIS 3.0. */ bool hasGeometry() const; /** Returns the geometry associated with this feature. If the feature has no geometry, * an empty QgsGeometry object will be returned. - * @see hasGeometry() - * @see setGeometry() + * \see hasGeometry() + * \see setGeometry() */ QgsGeometry geometry() const; /** Set the feature's geometry. The feature will be valid after. - * @param geometry new feature geometry - * @see geometry() - * @see clearGeometry() + * \param geometry new feature geometry + * \see geometry() + * \see clearGeometry() */ void setGeometry( const QgsGeometry &geometry ); /** Removes any geometry associated with the feature. - * @see setGeometry() - * @see hasGeometry() + * \see setGeometry() + * \see hasGeometry() * \since QGIS 3.0 */ void clearGeometry(); /** Assign a field map with the feature to allow attribute access by attribute name. - * @param fields The attribute fields which this feature holds - * @param initAttributes If true, attributes are initialized. Clears any data previously assigned. + * \param fields The attribute fields which this feature holds + * \param initAttributes If true, attributes are initialized. Clears any data previously assigned. * C++: Defaults to false * Python: Defaults to true * \since QGIS 2.9 - * @see fields + * \see fields */ void setFields( const QgsFields &fields, bool initAttributes = false SIP_PYDEFAULTVALUE( true ) ); /** Returns the field map associated with the feature. - * @see setFields + * \see setFields */ QgsFields fields() const; /** Insert a value into attribute. Returns false if attribute name could not be converted to index. - * Field map must be associated using @link setFields @endlink before this method can be used. + * Field map must be associated using setFields() before this method can be used. * The feature will be valid if it was successful - * @param name The name of the field to set - * @param value The value to set - * @return false if attribute name could not be converted to index (C++ only) - * @note For Python: raises a KeyError exception instead of returning false - * @note Alternatively in Python: @code feature[name] = attr @endcode - * @see setFields + * \param name The name of the field to set + * \param value The value to set + * \returns false if attribute name could not be converted to index (C++ only) + * \note For Python: raises a KeyError exception instead of returning false + * \note Alternatively in Python: @code feature[name] = attr @endcode + * \see setFields */ #ifndef SIP_RUN bool setAttribute( const QString &name, const QVariant &value ); @@ -394,13 +392,13 @@ class CORE_EXPORT QgsFeature % End #endif - /** Removes an attribute value by field name. Field map must be associated using @link setFields @endlink + /** Removes an attribute value by field name. Field map must be associated using setFields() * before this method can be used. - * @param name The name of the field to delete - * @return false if attribute name could not be converted to index (C++ only) - * @note For Python: raises a KeyError exception instead of returning false - * @note Alternatively in Python: @code del feature[name] @endcode - * @see setFields + * \param name The name of the field to delete + * \returns false if attribute name could not be converted to index (C++ only) + * \note For Python: raises a KeyError exception instead of returning false + * \note Alternatively in Python: @code del feature[name] @endcode + * \see setFields */ bool deleteAttribute( const QString &name ); #ifdef SIP_RUN @@ -420,13 +418,13 @@ class CORE_EXPORT QgsFeature % End #endif - /** Lookup attribute value from attribute name. Field map must be associated using @link setFields @endlink + /** Lookup attribute value from attribute name. Field map must be associated using setFields() * before this method can be used. - * @param name The name of the attribute to get - * @return The value of the attribute (C++: Invalid variant if no such name exists ) - * @note For Python: raises a KeyError exception if the field is not found - * @note Alternatively in Python: @code feature[name] @endcode - * @see setFields + * \param name The name of the attribute to get + * \returns The value of the attribute (C++: Invalid variant if no such name exists ) + * \note For Python: raises a KeyError exception if the field is not found + * \note Alternatively in Python: @code feature[name] @endcode + * \see setFields */ #ifndef SIP_RUN QVariant attribute( const QString &name ) const; @@ -447,13 +445,13 @@ class CORE_EXPORT QgsFeature % End #endif - /** Lookup attribute value from its index. Field map must be associated using @link setFields @endlink + /** Lookup attribute value from its index. Field map must be associated using setFields() * before this method can be used. - * @param fieldIdx The index of the attribute to get - * @return The value of the attribute (C++: Invalid variant if no such index exists ) - * @note For Python: raises a KeyError exception if the field is not found - * @note Alternatively in Python: @code feature[fieldIdx] @endcode - * @see setFields + * \param fieldIdx The index of the attribute to get + * \returns The value of the attribute (C++: Invalid variant if no such index exists ) + * \note For Python: raises a KeyError exception if the field is not found + * \note Alternatively in Python: @code feature[fieldIdx] @endcode + * \see setFields */ #ifndef SIP_RUN QVariant attribute( int fieldIdx ) const; @@ -475,11 +473,11 @@ class CORE_EXPORT QgsFeature % End #endif - /** Utility method to get attribute index from name. Field map must be associated using @link setFields @endlink + /** Utility method to get attribute index from name. Field map must be associated using setFields() * before this method can be used. - * @param fieldName name of field to get attribute index of - * @returns -1 if field does not exist or field map is not associated. - * @see setFields + * \param fieldName name of field to get attribute index of + * \returns -1 if field does not exist or field map is not associated. + * \see setFields */ int fieldNameIndex( const QString &fieldName ) const; diff --git a/src/core/qgsfeaturefilterprovider.h b/src/core/qgsfeaturefilterprovider.h index 9c82112886dc..23c98977b5c0 100644 --- a/src/core/qgsfeaturefilterprovider.h +++ b/src/core/qgsfeaturefilterprovider.h @@ -46,13 +46,13 @@ class CORE_EXPORT QgsFeatureFilterProvider /** Add additional filters to the feature request to further restrict the features returned by the request. * Derived classes must implement this method. - * @param layer the layer to filter - * @param featureRequest the feature request to update + * \param layer the layer to filter + * \param featureRequest the feature request to update */ virtual void filterFeatures( const QgsVectorLayer *layer, QgsFeatureRequest &featureRequest ) const = 0; /** Create a clone of the feature filter provider - * @return a new clone + * \returns a new clone */ virtual QgsFeatureFilterProvider *clone() const = 0; }; diff --git a/src/core/qgsfeatureiterator.h b/src/core/qgsfeatureiterator.h index 5e97ec73b2c3..429abe4d3b2a 100644 --- a/src/core/qgsfeatureiterator.h +++ b/src/core/qgsfeatureiterator.h @@ -24,7 +24,7 @@ * Interface that can be optionally attached to an iterator so its * nextFeature() implementaton can check if it must stop as soon as possible. * \since QGIS 2.16 - * @note not available in Python bindings + * \note not available in Python bindings */ class CORE_EXPORT QgsInterruptionChecker { @@ -68,7 +68,7 @@ class CORE_EXPORT QgsAbstractFeatureIterator * WFS provider. When nextFeature()/fetchFeature() is reasonably fast, it is not necessary * to implement this method. The default implementation does nothing. * \since QGIS 2.16 - * @note not available in Python bindings + * \note not available in Python bindings */ virtual void setInterruptionChecker( QgsInterruptionChecker *interruptionChecker ); @@ -83,8 +83,8 @@ class CORE_EXPORT QgsAbstractFeatureIterator * If you write a feature iterator for your provider, this is the method you * need to implement!! * - * @param f The feature to write to - * @return true if a feature was written to f + * \param f The feature to write to + * \returns true if a feature was written to f */ virtual bool fetchFeature( QgsFeature &f ) = 0; @@ -95,8 +95,8 @@ class CORE_EXPORT QgsAbstractFeatureIterator * and you check for the expression in your fetchFeature method, you can just * redirect this call to fetchFeature so the default check will be omitted. * - * @param f The feature to write to - * @return true if a feature was written to f + * \param f The feature to write to + * \returns true if a feature was written to f */ virtual bool nextFeatureFilterExpression( QgsFeature &f ); @@ -108,8 +108,8 @@ class CORE_EXPORT QgsAbstractFeatureIterator * if the request was FilterFids you can just redirect this call to fetchFeature * so the default check will be omitted. * - * @param f The feature to write to - * @return true if a feature was written to f + * \param f The feature to write to + * \returns true if a feature was written to f */ virtual bool nextFeatureFilterFids( QgsFeature &f ); @@ -233,7 +233,7 @@ class CORE_EXPORT QgsFeatureIterator * nextFeature()/fetchFeature() iteration might be very long. A typical use case is the * WFS provider. * \since QGIS 2.16 - * @note not available in Python bindings + * \note not available in Python bindings */ void setInterruptionChecker( QgsInterruptionChecker *interruptionChecker ); diff --git a/src/core/qgsfeaturerequest.h b/src/core/qgsfeaturerequest.h index bf9d46aced2b..664ba65e70b1 100644 --- a/src/core/qgsfeaturerequest.h +++ b/src/core/qgsfeaturerequest.h @@ -114,8 +114,8 @@ class CORE_EXPORT QgsFeatureRequest /** * Creates a new OrderByClause for a QgsFeatureRequest * - * @param expression The expression to use for ordering - * @param ascending If the order should be ascending (1,2,3) or descending (3,2,1) + * \param expression The expression to use for ordering + * \param ascending If the order should be ascending (1,2,3) or descending (3,2,1) * If the order is ascending, by default nulls are last * If the order is descending, by default nulls are first */ @@ -124,21 +124,21 @@ class CORE_EXPORT QgsFeatureRequest /** * Creates a new OrderByClause for a QgsFeatureRequest * - * @param expression The expression to use for ordering - * @param ascending If the order should be ascending (1,2,3) or descending (3,2,1) - * @param nullsfirst If true, NULLS are at the beginning, if false, NULLS are at the end + * \param expression The expression to use for ordering + * \param ascending If the order should be ascending (1,2,3) or descending (3,2,1) + * \param nullsfirst If true, NULLS are at the beginning, if false, NULLS are at the end */ OrderByClause( const QString &expression, bool ascending, bool nullsfirst ); /** * The expression - * @return the expression + * \returns the expression */ QgsExpression expression() const; /** * Order ascending - * @return If ascending order is requested + * \returns If ascending order is requested */ bool ascending() const; @@ -149,7 +149,7 @@ class CORE_EXPORT QgsFeatureRequest /** * Set if NULLS should be returned first - * @return if NULLS should be returned first + * \returns if NULLS should be returned first */ bool nullsFirst() const; @@ -245,7 +245,7 @@ class CORE_EXPORT QgsFeatureRequest /** * Return the filter type which is currently set on this request * - * @return Filter type + * \returns Filter type */ FilterType filterType() const { return mFilter; } @@ -270,16 +270,16 @@ class CORE_EXPORT QgsFeatureRequest //! Get feature IDs that should be fetched. const QgsFeatureIds &filterFids() const { return mFilterFids; } - /** Set the filter expression. {@see QgsExpression} - * @param expression expression string - * @see filterExpression - * @see setExpressionContext + /** Set the filter expression. {\see QgsExpression} + * \param expression expression string + * \see filterExpression + * \see setExpressionContext */ QgsFeatureRequest &setFilterExpression( const QString &expression ); /** Returns the filter expression if set. - * @see setFilterExpression - * @see expressionContext + * \see setFilterExpression + * \see expressionContext */ QgsExpression *filterExpression() const { return mFilterExpression.get(); } @@ -292,15 +292,15 @@ class CORE_EXPORT QgsFeatureRequest /** Returns the expression context used to evaluate filter expressions. * \since QGIS 2.12 - * @see setExpressionContext - * @see filterExpression + * \see setExpressionContext + * \see filterExpression */ QgsExpressionContext *expressionContext() { return &mExpressionContext; } /** Sets the expression context used to evaluate filter expressions. * \since QGIS 2.12 - * @see expressionContext - * @see setFilterExpression + * \see expressionContext + * \see setFilterExpression */ QgsFeatureRequest &setExpressionContext( const QgsExpressionContext &context ); @@ -308,7 +308,7 @@ class CORE_EXPORT QgsFeatureRequest * Disables filter conditions. * The spatial filter (filterRect) will be kept in place. * - * @return The object the method is called on for chaining + * \returns The object the method is called on for chaining * * \since QGIS 2.12 */ @@ -317,8 +317,8 @@ class CORE_EXPORT QgsFeatureRequest /** * Adds a new OrderByClause, appending it as the least important one. * - * @param expression The expression to use for ordering - * @param ascending If the order should be ascending (1,2,3) or descending (3,2,1) + * \param expression The expression to use for ordering + * \param ascending If the order should be ascending (1,2,3) or descending (3,2,1) * If the order is ascending, by default nulls are last * If the order is descending, by default nulls are first * @@ -330,9 +330,9 @@ class CORE_EXPORT QgsFeatureRequest /** * Adds a new OrderByClause, appending it as the least important one. * - * @param expression The expression to use for ordering - * @param ascending If the order should be ascending (1,2,3) or descending (3,2,1) - * @param nullsfirst If true, NULLS are at the beginning, if false, NULLS are at the end + * \param expression The expression to use for ordering + * \param ascending If the order should be ascending (1,2,3) or descending (3,2,1) + * \param nullsfirst If true, NULLS are at the beginning, if false, NULLS are at the end * * \since QGIS 2.14 */ @@ -353,14 +353,14 @@ class CORE_EXPORT QgsFeatureRequest QgsFeatureRequest &setOrderBy( const OrderBy &orderBy ); /** Set the maximum number of features to request. - * @param limit maximum number of features, or -1 to request all features. - * @see limit() + * \param limit maximum number of features, or -1 to request all features. + * \see limit() * \since QGIS 2.14 */ QgsFeatureRequest &setLimit( long limit ); /** Returns the maximum number of features to request, or -1 if no limit set. - * @see setLimit + * \see setLimit * \since QGIS 2.14 */ long limit() const { return mLimit; } @@ -375,7 +375,7 @@ class CORE_EXPORT QgsFeatureRequest /** * Return the subset of attributes which at least need to be fetched - * @return A list of attributes to be fetched + * \returns A list of attributes to be fetched */ QgsAttributeList subsetOfAttributes() const { return mAttrs; } @@ -395,9 +395,9 @@ class CORE_EXPORT QgsFeatureRequest /** * Check if a feature is accepted by this requests filter * - * @param feature The feature which will be tested + * \param feature The feature which will be tested * - * @return true, if the filter accepts the feature + * \returns true, if the filter accepts the feature * * \since QGIS 2.1 */ @@ -434,8 +434,8 @@ class CORE_EXPORT QgsAbstractFeatureSource /** * Get an iterator for features matching the specified request - * @param request The request - * @return A feature iterator + * \param request The request + * \returns A feature iterator */ virtual QgsFeatureIterator getFeatures( const QgsFeatureRequest &request ) = 0; diff --git a/src/core/qgsfeaturestore.h b/src/core/qgsfeaturestore.h index c897644c1775..81c8677dd037 100644 --- a/src/core/qgsfeaturestore.h +++ b/src/core/qgsfeaturestore.h @@ -49,7 +49,7 @@ class CORE_EXPORT QgsFeatureStore void setCrs( const QgsCoordinateReferenceSystem &crs ) { mCrs = crs; } /** Add feature. Feature's fields will be set to pointer to the store fields. - * @param feature + * \param feature * \since QGIS 2.1 */ void addFeature( const QgsFeature &feature ); diff --git a/src/core/qgsfeedback.h b/src/core/qgsfeedback.h index 5fa1503cde97..0382526a8160 100644 --- a/src/core/qgsfeedback.h +++ b/src/core/qgsfeedback.h @@ -64,8 +64,8 @@ class CORE_EXPORT QgsFeedback : public QObject /** * Sets the current progress for the feedback object. The \a progress * argument is in percentage and valid values range from 0-100. - * @see progress() - * @see progressChanged() + * \see progress() + * \see progressChanged() * \since QGIS 3.0 */ void setProgress( double progress ) { mProgress = progress; emit progressChanged( mProgress ); } @@ -74,8 +74,8 @@ class CORE_EXPORT QgsFeedback : public QObject * Returns the current progress reported by the feedback object. Depending on how the * feedback object is used progress reporting may not be supported. The returned value * is in percentage and ranges from 0-100. - * @see setProgress() - * @see progressChanged() + * \see setProgress() + * \see progressChanged() * \since QGIS 3.0 */ double progress() const { return mProgress; } @@ -89,8 +89,8 @@ class CORE_EXPORT QgsFeedback : public QObject * feedback object is used progress reporting may not be supported. The \a progress * argument is in percentage and ranges from 0-100. * \since QGIS 3.0 - * @see setProgress() - * @see progress() + * \see setProgress() + * \see progress() */ void progressChanged( double progress ); diff --git a/src/core/qgsfield.h b/src/core/qgsfield.h index 018468040a81..87d1f1cd10eb 100644 --- a/src/core/qgsfield.h +++ b/src/core/qgsfield.h @@ -58,16 +58,16 @@ class CORE_EXPORT QgsField public: /** Constructor. Constructs a new QgsField object. - * @param name Field name - * @param type Field variant type, currently supported: String / Int / Double - * @param typeName Field type (e.g., char, varchar, text, int, serial, double). + * \param name Field name + * \param type Field variant type, currently supported: String / Int / Double + * \param typeName Field type (e.g., char, varchar, text, int, serial, double). * Field types are usually unique to the source and are stored exactly * as returned from the data store. - * @param len Field length - * @param prec Field precision. Usually decimal places but may also be + * \param len Field length + * \param prec Field precision. Usually decimal places but may also be * used in conjunction with other fields types (e.g., variable character fields) - * @param comment Comment for the field - * @param subType If the field is a collection, its element's type. When + * \param comment Comment for the field + * \param subType If the field is a collection, its element's type. When * all the elements don't need to have the same type, leave * this to QVariant::Invalid. */ @@ -93,15 +93,15 @@ class CORE_EXPORT QgsField bool operator!=( const QgsField &other ) const; /** Returns the name of the field. - * @see setName() - * @see displayName() + * \see setName() + * \see displayName() */ QString name() const; /** Returns the name to use when displaying this field. This will be the * field alias if set, otherwise the field name. - * @see name() - * @see alias() + * \see name() + * \see alias() * \since QGIS 3.0 */ QString displayName() const; @@ -121,19 +121,19 @@ class CORE_EXPORT QgsField * Gets the field type. Field types vary depending on the data source. Examples * are char, int, double, blob, geometry, etc. The type is stored exactly as * the data store reports it, with no attempt to standardize the value. - * @return QString containing the field type + * \returns QString containing the field type */ QString typeName() const; /** * Gets the length of the field. - * @return int containing the length of the field + * \returns int containing the length of the field */ int length() const; /** * Gets the precision of the field. Not all field types have a related precision. - * @return int containing the precision or zero if not applicable to the field type. + * \returns int containing the precision or zero if not applicable to the field type. */ int precision() const; @@ -152,7 +152,7 @@ class CORE_EXPORT QgsField /** * Set the field name. - * @param name Name of the field + * \param name Name of the field */ void setName( const QString &name ); @@ -171,19 +171,19 @@ class CORE_EXPORT QgsField /** * Set the field type. - * @param typeName Field type + * \param typeName Field type */ void setTypeName( const QString &typeName ); /** * Set the field length. - * @param len Length of the field + * \param len Length of the field */ void setLength( int len ); /** * Set the field precision. - * @param precision Precision of the field + * \param precision Precision of the field */ void setPrecision( int precision ); @@ -193,45 +193,45 @@ class CORE_EXPORT QgsField void setComment( const QString &comment ); /** Returns the expression used when calculating the default value for the field. - * @returns expression evaluated when calculating default values for field, or an + * \returns expression evaluated when calculating default values for field, or an * empty string if no default is set * \since QGIS 3.0 - * @see setDefaultValueExpression() + * \see setDefaultValueExpression() */ QString defaultValueExpression() const; /** Sets an expression to use when calculating the default value for the field. - * @param expression expression to evaluate when calculating default values for field. Pass + * \param expression expression to evaluate when calculating default values for field. Pass * an empty expression to clear the default. * \since QGIS 3.0 - * @see defaultValueExpression() + * \see defaultValueExpression() */ void setDefaultValueExpression( const QString &expression ); /** * Returns constraints which are present for the field. * \since QGIS 3.0 - * @see setConstraints() + * \see setConstraints() */ const QgsFieldConstraints &constraints() const; /** * Sets constraints which are present for the field. * \since QGIS 3.0 - * @see constraints() + * \see constraints() */ void setConstraints( const QgsFieldConstraints &constraints ); /** Returns the alias for the field (the friendly displayed name of the field ), * or an empty string if there is no alias. - * @see setAlias() + * \see setAlias() * \since QGIS 3.0 */ QString alias() const; /** Sets the alias for the field (the friendly displayed name of the field ). - * @param alias field alias, or empty string to remove an existing alias - * @see alias() + * \param alias field alias, or empty string to remove an existing alias + * \see alias() * \since QGIS 3.0 */ void setAlias( const QString &alias ); @@ -242,9 +242,9 @@ class CORE_EXPORT QgsField /** * Converts the provided variant to a compatible format * - * @param v The value to convert + * \param v The value to convert * - * @return True if the conversion was successful + * \returns True if the conversion was successful */ bool convertCompatible( QVariant &v ) const; @@ -257,7 +257,7 @@ class CORE_EXPORT QgsField /** * Set the editor widget setup for the field. * - * @param v The value to set + * \param v The value to set */ void setEditorWidgetSetup( const QgsEditorWidgetSetup &v ); @@ -267,7 +267,7 @@ class CORE_EXPORT QgsField * Defaults may be set by the provider and can be overridden * by manual field configuration. * - * @return the value + * \returns the value */ QgsEditorWidgetSetup editorWidgetSetup() const; diff --git a/src/core/qgsfieldconstraints.h b/src/core/qgsfieldconstraints.h index ecc81508ae6a..3f438784dd78 100644 --- a/src/core/qgsfieldconstraints.h +++ b/src/core/qgsfieldconstraints.h @@ -75,23 +75,23 @@ class CORE_EXPORT QgsFieldConstraints /** * Returns any constraints which are present for the field. - * @see setConstraints() - * @see constraintOrigin() + * \see setConstraints() + * \see constraintOrigin() */ Constraints constraints() const { return mConstraints; } /** * Returns the origin of a field constraint, or ConstraintOriginNotSet if the constraint * is not present on this field. - * @see constraints() + * \see constraints() */ ConstraintOrigin constraintOrigin( Constraint constraint ) const; /** * Returns the strength of a field constraint, or ConstraintStrengthNotSet if the constraint * is not present on this field. - * @see constraints() - * @see setConstraintStrength() + * \see constraints() + * \see setConstraintStrength() */ ConstraintStrength constraintStrength( Constraint constraint ) const; @@ -99,46 +99,46 @@ class CORE_EXPORT QgsFieldConstraints * Sets the strength of a constraint. Note that the strength of constraints which originate * from a provider cannot be changed. Constraints default to ConstraintStrengthHard unless * explicitly changed. - * @see constraintStrength() + * \see constraintStrength() */ void setConstraintStrength( Constraint constraint, ConstraintStrength strength ); /** * Sets a constraint on the field. - * @see constraints() - * @see removeConstraint() + * \see constraints() + * \see removeConstraint() */ void setConstraint( Constraint constraint, ConstraintOrigin origin = ConstraintOriginLayer ); /** * Removes a constraint from the field. - * @see setConstraint() - * @see constraints() + * \see setConstraint() + * \see constraints() */ void removeConstraint( Constraint constraint ) { mConstraints &= ~constraint; } /** * Returns the constraint expression for the field, if set. - * @see constraints() - * @see constraintDescription() - * @see setConstraintExpression() + * \see constraints() + * \see constraintDescription() + * \see setConstraintExpression() */ QString constraintExpression() const; /** * Returns the descriptive name for the constraint expression. - * @see constraints() - * @see constraintExpression() - * @see setConstraintExpression() + * \see constraints() + * \see constraintExpression() + * \see setConstraintExpression() */ QString constraintDescription() const { return mExpressionConstraintDescription; } /** * Set the constraint expression for the field. An optional descriptive name for the constraint * can also be set. Setting an empty expression will clear any existing expression constraint. - * @see constraintExpression() - * @see constraintDescription() - * @see constraints() + * \see constraintExpression() + * \see constraintDescription() + * \see constraints() */ void setConstraintExpression( const QString &expression, const QString &description = QString() ); diff --git a/src/core/qgsfieldformatter.h b/src/core/qgsfieldformatter.h index f78324e94d84..50a3e817acf3 100644 --- a/src/core/qgsfieldformatter.h +++ b/src/core/qgsfieldformatter.h @@ -55,7 +55,7 @@ class CORE_EXPORT QgsFieldFormatter /** * Create a pretty String representation of the value. * - * @return By default the string representation of the provided value as implied by the field definition is returned. + * \returns By default the string representation of the provided value as implied by the field definition is returned. * * \since QGIS 3.0 */ @@ -64,7 +64,7 @@ class CORE_EXPORT QgsFieldFormatter /** * If the default sort order should be overwritten for this widget, you can transform the value in here. * - * @returns an unmodified value by default. + * \returns an unmodified value by default. * * \since QGIS 3.0 */ diff --git a/src/core/qgsfields.h b/src/core/qgsfields.h index dc24fa8b9ce2..196bd9277fdd 100644 --- a/src/core/qgsfields.h +++ b/src/core/qgsfields.h @@ -103,8 +103,8 @@ class CORE_EXPORT QgsFields //! Return number of items int size() const; //! Return if a field index is valid - //! @param i Index of the field which needs to be checked - //! @return True if the field exists + //! \param i Index of the field which needs to be checked + //! \returns True if the field exists bool exists( int i ) const; //! Get field at particular index (must be in range 0..N-1) @@ -129,10 +129,10 @@ class CORE_EXPORT QgsFields * name of the field. * Alias for indexOf * - * @param fieldName The name of the field. + * \param fieldName The name of the field. * - * @return The field index if found or -1 in case it cannot be found. - * @see lookupField For a more tolerant alternative. + * \returns The field index if found or -1 in case it cannot be found. + * \see lookupField For a more tolerant alternative. */ int indexFromName( const QString &fieldName ) const; @@ -141,10 +141,10 @@ class CORE_EXPORT QgsFields * This method takes is case sensitive and only matches the data source * name of the field. * - * @param fieldName The name of the field. + * \param fieldName The name of the field. * - * @return The field index if found or -1 in case it cannot be found. - * @see lookupField For a more tolerant alternative. + * \returns The field index if found or -1 in case it cannot be found. + * \see lookupField For a more tolerant alternative. * \since QGIS 3.0 */ int indexOf( const QString &fieldName ) const; @@ -157,10 +157,10 @@ class CORE_EXPORT QgsFields * 2. Looks for the field name by case insensitive comparison * 3. The field alias (case insensitive) * - * @param fieldName The name to look for. + * \param fieldName The name to look for. * - * @return The field index if found or -1 in case it cannot be found. - * @see indexFromName For a more performant and precise but less tolerant alternative. + * \returns The field index if found or -1 in case it cannot be found. + * \see indexFromName For a more performant and precise but less tolerant alternative. * \since QGIS 2.4 */ int lookupField( const QString &fieldName ) const; @@ -271,7 +271,7 @@ class CORE_EXPORT QgsFields * Returns a const STL-style iterator pointing to the first item in the list. * * \since QGIS 2.16 - * @note not available in Python bindings + * \note not available in Python bindings */ const_iterator constBegin() const noexcept; @@ -279,7 +279,7 @@ class CORE_EXPORT QgsFields * Returns a const STL-style iterator pointing to the imaginary item after the last item in the list. * * \since QGIS 2.16 - * @note not available in Python bindings + * \note not available in Python bindings */ const_iterator constEnd() const noexcept; @@ -287,7 +287,7 @@ class CORE_EXPORT QgsFields * Returns a const STL-style iterator pointing to the first item in the list. * * \since QGIS 2.16 - * @note not available in Python bindings + * \note not available in Python bindings */ const_iterator begin() const noexcept; @@ -295,7 +295,7 @@ class CORE_EXPORT QgsFields * Returns a const STL-style iterator pointing to the imaginary item after the last item in the list. * * \since QGIS 2.16 - * @note not available in Python bindings + * \note not available in Python bindings */ const_iterator end() const noexcept; @@ -303,7 +303,7 @@ class CORE_EXPORT QgsFields * Returns an STL-style iterator pointing to the first item in the list. * * \since QGIS 2.16 - * @note not available in Python bindings + * \note not available in Python bindings */ iterator begin(); @@ -312,7 +312,7 @@ class CORE_EXPORT QgsFields * Returns an STL-style iterator pointing to the imaginary item after the last item in the list. * * \since QGIS 2.16 - * @note not available in Python bindings + * \note not available in Python bindings */ iterator end(); diff --git a/src/core/qgsfontutils.h b/src/core/qgsfontutils.h index d26cfefab5e9..a627d31662fa 100644 --- a/src/core/qgsfontutils.h +++ b/src/core/qgsfontutils.h @@ -30,39 +30,39 @@ class CORE_EXPORT QgsFontUtils public: /** Check whether exact font is on system - * @param f The font to test for match + * \param f The font to test for match */ static bool fontMatchOnSystem( const QFont &f ); /** Check whether font family is on system in a quick manner, which does not compare [foundry] - * @param family The family to test - * @returns Whether family was found on system - * @note This is good for use in loops of large lists, e.g. registering many features for labeling + * \param family The family to test + * \returns Whether family was found on system + * \note This is good for use in loops of large lists, e.g. registering many features for labeling */ static bool fontFamilyOnSystem( const QString &family ); /** Check whether font family on system has specific style - * @param family The family to test - * @param style The style to test for - * @returns Whether family has style + * \param family The family to test + * \param style The style to test for + * \returns Whether family has style * \since QGIS 2.1 */ static bool fontFamilyHasStyle( const QString &family, const QString &style ); /** Check whether font family is on system - * @param family The family to test - * @param chosen The actual family (possibly from different foundry) returned by system - * @param match Whether the family [foundry] returned by system is a match - * @returns Whether family was found on system + * \param family The family to test + * \param chosen The actual family (possibly from different foundry) returned by system + * \param match Whether the family [foundry] returned by system is a match + * \returns Whether family was found on system */ static bool fontFamilyMatchOnSystem( const QString &family, QString *chosen = nullptr, bool *match = nullptr ); /** Updates font with named style and retain all font properties - * @param f The font to update - * @param fontstyle The style to try and switch the font to - * @param fallback If no matching fontstyle found for font, assign most similar or first style found to font - * @returns Whether the font was updated (also returns true if the requested style matches font's current style) - * @note This is a more featured replacement for a Qt 4.8+ function: void QFont::setStyleName ( const QString & styleName ) + * \param f The font to update + * \param fontstyle The style to try and switch the font to + * \param fallback If no matching fontstyle found for font, assign most similar or first style found to font + * \returns Whether the font was updated (also returns true if the requested style matches font's current style) + * \note This is a more featured replacement for a Qt 4.8+ function: void QFont::setStyleName ( const QString & styleName ) */ static bool updateFontViaStyle( QFont &f, const QString &fontstyle, bool fallback = false ); @@ -72,77 +72,77 @@ class CORE_EXPORT QgsFontUtils static QString standardTestFontFamily(); /** Loads standard test fonts from filesystem or qrc resource - * @param loadstyles List of styles to load, e.g. All, Roman, Oblique, Bold, Bold Oblique - * @returns Whether any font was loaded - * @note Done by default on debug app/server startup to ensure fonts available for unit tests (Roman and Bold) + * \param loadstyles List of styles to load, e.g. All, Roman, Oblique, Bold, Bold Oblique + * \returns Whether any font was loaded + * \note Done by default on debug app/server startup to ensure fonts available for unit tests (Roman and Bold) * \since QGIS 2.1 */ static bool loadStandardTestFonts( const QStringList &loadstyles ); /** Get standard test font with specific style - * @param style Style to load, e.g. Roman, Oblique, Bold, Bold Oblique - * @param pointsize Font point size to set - * @returns QFont + * \param style Style to load, e.g. Roman, Oblique, Bold, Bold Oblique + * \param pointsize Font point size to set + * \returns QFont * \since QGIS 2.1 */ static QFont getStandardTestFont( const QString &style = "Roman", int pointsize = 12 ); /** Returns a DOM element containing the properties of the font. - * @param font font - * @param document DOM document - * @param elementName name for DOM element - * @returns DOM element containing font settings + * \param font font + * \param document DOM document + * \param elementName name for DOM element + * \returns DOM element containing font settings * \since QGIS 2.10 - * @see setFromXmlElement + * \see setFromXmlElement */ static QDomElement toXmlElement( const QFont &font, QDomDocument &document, const QString &elementName ); /** Sets the properties of a font to match the properties stored in an XML element. Calling * this will overwrite the current properties of the font. - * @param font font to update - * @param element DOM element - * @returns true if properties were successfully read from element + * \param font font to update + * \param element DOM element + * \returns true if properties were successfully read from element * \since QGIS 2.10 - * @see toXmlElement - * @see setFromXmlChildNode + * \see toXmlElement + * \see setFromXmlChildNode */ static bool setFromXmlElement( QFont &font, const QDomElement &element ); /** Sets the properties of a font to match the properties stored in an XML child node. Calling * this will overwrite the current properties of the font. - * @param font font to update - * @param element DOM element - * @param childNode name of child node - * @returns true if child node exists and properties were successfully read from node + * \param font font to update + * \param element DOM element + * \param childNode name of child node + * \returns true if child node exists and properties were successfully read from node * \since QGIS 2.10 - * @see setFromXmlElement - * @see toXmlElement + * \see setFromXmlElement + * \see toXmlElement */ static bool setFromXmlChildNode( QFont &font, const QDomElement &element, const QString &childNode ); /** Returns the localized named style of a font, if such a translation is available. - * @param namedStyle a named style, i.e. "Bold", "Italic", etc - * @returns The localized named style + * \param namedStyle a named style, i.e. "Bold", "Italic", etc + * \returns The localized named style * \since QGIS 2.12 - * @see untranslateNamedStyle + * \see untranslateNamedStyle */ static QString translateNamedStyle( const QString &namedStyle ); /** Returns the english named style of a font, if possible. - * @param namedStyle a localized named style, i.e. "Fett", "Kursiv", etc - * @returns The english named style + * \param namedStyle a localized named style, i.e. "Fett", "Kursiv", etc + * \returns The english named style * \since QGIS 2.12 - * @see translateNamedStyle + * \see translateNamedStyle */ static QString untranslateNamedStyle( const QString &namedStyle ); /** Returns a CSS string representing the specified font as closely as possible. - * @param font QFont to convert - * @param pointToPixelMultiplier scaling factor to apply to convert point sizes to pixel font sizes. + * \param font QFont to convert + * \param pointToPixelMultiplier scaling factor to apply to convert point sizes to pixel font sizes. * The CSS returned by this function will always use pixels for font sizes, so this parameter * should be set to a suitable value to convert point sizes to pixels (e.g., taking into account * destination DPI) - * @returns partial CSS string, e.g., "font-family: Comic Sans; font-size: 12px;" + * \returns partial CSS string, e.g., "font-family: Comic Sans; font-size: 12px;" * \since QGIS 2.16 */ static QString asCSS( const QFont &font, double pointToPixelMultiplier = 1.0 ); diff --git a/src/core/qgsgml.h b/src/core/qgsgml.h index 5db99cd2e5fe..73d44ae3dea1 100644 --- a/src/core/qgsgml.h +++ b/src/core/qgsgml.h @@ -39,7 +39,7 @@ class QgsCoordinateReferenceSystem; * as soon it has new content from the source. At any point, it can call * getAndStealReadyFeatures() to collect the features that have been completely * parsed. - * @note not available in Python bindings + * \note not available in Python bindings * \since QGIS 2.16 */ class CORE_EXPORT QgsGmlStreamingParser @@ -183,33 +183,33 @@ class CORE_EXPORT QgsGmlStreamingParser //helper routines /** Reads attribute srsName="EpsgCrsId:..." - @param epsgNr result - @param attr attribute strings - @return 0 in case of success + \param epsgNr result + \param attr attribute strings + \returns 0 in case of success */ int readEpsgFromAttribute( int &epsgNr, const XML_Char **attr ); /** Reads attribute as string - @param attributeName - @param attr - @return attribute value or an empty string if no such attribute + \param attributeName + \param attr + \returns attribute value or an empty string if no such attribute */ QString readAttribute( const QString &attributeName, const XML_Char **attr ) const; //! Creates a rectangle from a coordinate string. bool createBBoxFromCoordinateString( QgsRectangle &bb, const QString &coordString ) const; /** Creates a set of points from a coordinate string. - @param points list that will contain the created points - @param coordString the text containing the coordinates - @return 0 in case of success + \param points list that will contain the created points + \param coordString the text containing the coordinates + \returns 0 in case of success */ int pointsFromCoordinateString( QList &points, const QString &coordString ) const; /** Creates a set of points from a gml:posList or gml:pos coordinate string. - @param points list that will contain the created points - @param coordString the text containing the coordinates - @param dimension number of dimensions - @return 0 in case of success + \param points list that will contain the created points + \param coordString the text containing the coordinates + \param dimension number of dimensions + \returns 0 in case of success */ int pointsFromPosListString( QList &points, const QString &coordString, int dimension ) const; @@ -342,14 +342,14 @@ class CORE_EXPORT QgsGml : public QObject /** Does the Http GET request to the wfs server * Supports only UTF-8, UTF-16, ISO-8859-1, ISO-8859-1 XML encodings. - * @param uri GML URL - * @param wkbType wkbType to retrieve - * @param extent retrieved extents - * @param userName username for authentication - * @param password password for authentication - * @param authcfg authentication configuration id - * @return 0 in case of success - * @note available in Python as getFeaturesUri + * \param uri GML URL + * \param wkbType wkbType to retrieve + * \param extent retrieved extents + * \param userName username for authentication + * \param password password for authentication + * \param authcfg authentication configuration id + * \returns 0 in case of success + * \note available in Python as getFeaturesUri */ int getFeatures( const QString &uri, QgsWkbTypes::Type *wkbType, diff --git a/src/core/qgsgmlschema.h b/src/core/qgsgmlschema.h index b872f825348d..7b81f2cb53f8 100644 --- a/src/core/qgsgmlschema.h +++ b/src/core/qgsgmlschema.h @@ -85,8 +85,8 @@ class CORE_EXPORT QgsGmlSchema : public QObject /** Guess GML schema from data if XSD does not exist. * Currently only recognizes UMN Mapserver GetFeatureInfo GML response. * Supports only UTF-8, UTF-16, ISO-8859-1, US-ASCII XML encodings. - * @param data GML data - * @return true in case of success */ + * \param data GML data + * \returns true in case of success */ bool guessSchema( const QByteArray &data ); //! Get list of dot separated paths to feature classes parsed from GML or XSD @@ -136,7 +136,7 @@ class CORE_EXPORT QgsGmlSchema : public QObject //helper routines /** Reads attribute as string - @return attribute value or an empty string if no such attribute*/ + \returns attribute value or an empty string if no such attribute*/ QString readAttribute( const QString &attributeName, const XML_Char **attr ) const; //! Returns pointer to main window or 0 if it does not exist @@ -158,9 +158,9 @@ class CORE_EXPORT QgsGmlSchema : public QObject QString stripNS( const QString &name ); /** Find GML base type for complex type of given name - * @param element input element - * @param name complex type name - * @return name of GML base type without NS, e.g. AbstractFeatureType or empty string if not passed on GML type + * \param element input element + * \param name complex type name + * \returns name of GML base type without NS, e.g. AbstractFeatureType or empty string if not passed on GML type */ QString xsdComplexTypeGmlBaseType( const QDomElement &element, const QString &name ); diff --git a/src/core/qgshistogram.h b/src/core/qgshistogram.h index 12fa72c0b5d2..28a1d25e3340 100644 --- a/src/core/qgshistogram.h +++ b/src/core/qgshistogram.h @@ -42,48 +42,48 @@ class CORE_EXPORT QgsHistogram virtual ~QgsHistogram() = default; /** Assigns numeric source values for the histogram. - * @param values list of doubles + * \param values list of doubles */ void setValues( const QList &values ); /** Assigns numeric source values for the histogram from a vector layer's field or as the * result of an expression. - * @param layer vector layer - * @param fieldOrExpression field name or expression to be evaluated - * @param feedback optional feedback object to allow cancelation of calculation - * @returns true if values were successfully set + * \param layer vector layer + * \param fieldOrExpression field name or expression to be evaluated + * \param feedback optional feedback object to allow cancelation of calculation + * \returns true if values were successfully set */ bool setValues( const QgsVectorLayer *layer, const QString &fieldOrExpression, QgsFeedback *feedback = nullptr ); /** Calculates the optimal bin width using the Freedman-Diaconis rule. Bins widths are * determined by the inter-quartile range of values and the number of values. - * @returns optimal width for bins - * @see optimalNumberBins - * @note values must first be specified using @link setValues @endlink + * \returns optimal width for bins + * \see optimalNumberBins + * \note values must first be specified using setValues() */ double optimalBinWidth() const; /** Returns the optimal number of bins for the source values, calculated using the * Freedman-Diaconis rule. The number of bins are determined by the inter-quartile range * of values and the number of values. - * @returns optimal number of bins - * @see optimalBinWidth - * @note values must first be specified using @link setValues @endlink + * \returns optimal number of bins + * \see optimalBinWidth + * \note values must first be specified using setValues() */ int optimalNumberBins() const; /** Returns a list of edges for the histogram for a specified number of bins. This list * will be length bins + 1, as both the first and last value are also included. - * @param bins number of bins - * @return list of bin edges - * @note values must first be specified using @link setValues @endlink + * \param bins number of bins + * \returns list of bin edges + * \note values must first be specified using setValues() */ QList binEdges( int bins ) const; /** Returns the calculated list of the counts for the histogram bins. - * @param bins number of histogram bins - * @return list of histogram counts - * @note values must first be specified using @link setValues @endlink + * \param bins number of histogram bins + * \returns list of histogram counts + * \note values must first be specified using setValues() */ QList counts( int bins ) const; diff --git a/src/core/qgsinterval.h b/src/core/qgsinterval.h index d21cb297234c..e4ed5dce68c0 100644 --- a/src/core/qgsinterval.h +++ b/src/core/qgsinterval.h @@ -58,103 +58,103 @@ class CORE_EXPORT QgsInterval QgsInterval(); /** Constructor for QgsInterval. - * @param seconds duration of interval in seconds + * \param seconds duration of interval in seconds */ QgsInterval( double seconds ); /** Returns the interval duration in years (based on an average year length) - * @see setYears() + * \see setYears() */ double years() const { return mSeconds / YEARS; } /** Sets the interval duration in years. - * @param years duration in years (based on average year length) - * @see years() + * \param years duration in years (based on average year length) + * \see years() */ void setYears( double years ) { mSeconds = years * YEARS; mValid = true; } /** Returns the interval duration in months (based on a 30 day month). - * @see setMonths() + * \see setMonths() */ double months() const { return mSeconds / MONTHS; } /** Sets the interval duration in months. - * @param months duration in months (based on a 30 day month) - * @see months() + * \param months duration in months (based on a 30 day month) + * \see months() */ void setMonths( double months ) { mSeconds = months * MONTHS; mValid = true; } /** Returns the interval duration in weeks. - * @see setWeeks() + * \see setWeeks() */ double weeks() const { return mSeconds / WEEKS; } /** Sets the interval duration in weeks. - * @param weeks duration in weeks - * @see weeks() + * \param weeks duration in weeks + * \see weeks() */ void setWeeks( double weeks ) { mSeconds = weeks * WEEKS; mValid = true; } /** Returns the interval duration in days. - * @see setDays() + * \see setDays() */ double days() const { return mSeconds / DAY; } /** Sets the interval duration in days. - * @param days duration in days - * @see days() + * \param days duration in days + * \see days() */ void setDays( double days ) { mSeconds = days * DAY; mValid = true; } /** Returns the interval duration in hours. - * @see setHours() + * \see setHours() */ double hours() const { return mSeconds / HOUR; } /** Sets the interval duration in hours. - * @param hours duration in hours - * @see hours() + * \param hours duration in hours + * \see hours() */ void setHours( double hours ) { mSeconds = hours * HOUR; mValid = true; } /** Returns the interval duration in minutes. - * @see setMinutes() + * \see setMinutes() */ double minutes() const { return mSeconds / MINUTE; } /** Sets the interval duration in minutes. - * @param minutes duration in minutes - * @see minutes() + * \param minutes duration in minutes + * \see minutes() */ void setMinutes( double minutes ) { mSeconds = minutes * MINUTE; mValid = true; } /** Returns the interval duration in seconds. - * @see setSeconds() + * \see setSeconds() */ double seconds() const { return mSeconds; } /** Sets the interval duration in seconds. - * @param seconds duration in seconds - * @see seconds() + * \param seconds duration in seconds + * \see seconds() */ void setSeconds( double seconds ) { mSeconds = seconds; mValid = true; } /** Returns true if the interval is valid. - * @see setValid() + * \see setValid() */ bool isValid() const { return mValid; } /** Sets whether the interval is valid. - * @param valid set to true to set the interval as valid. - * @see isValid() + * \param valid set to true to set the interval as valid. + * \see isValid() */ void setValid( bool valid ) { mValid = valid; } bool operator==( QgsInterval other ) const; /** Converts a string to an interval - * @param string string to parse - * @returns interval, or invalid interval if string could not be parsed + * \param string string to parse + * \returns interval, or invalid interval if string could not be parsed */ static QgsInterval fromString( const QString &string ); @@ -176,34 +176,34 @@ class CORE_EXPORT QgsInterval Q_DECLARE_METATYPE( QgsInterval ) /** Returns the interval between two datetimes. - * @param datetime1 start datetime - * @param datetime2 datetime to subtract, ie subtract datetime2 from datetime1 + * \param datetime1 start datetime + * \param datetime2 datetime to subtract, ie subtract datetime2 from datetime1 * \since QGIS 2.16 - * @note not available in Python bindings + * \note not available in Python bindings */ QgsInterval CORE_EXPORT operator-( const QDateTime &datetime1, const QDateTime &datetime2 ); /** Returns the interval between two dates. - * @param date1 start date - * @param date2 date to subtract, ie subtract date2 from date1 + * \param date1 start date + * \param date2 date to subtract, ie subtract date2 from date1 * \since QGIS 2.16 - * @note not available in Python bindings + * \note not available in Python bindings */ QgsInterval CORE_EXPORT operator-( QDate date1, QDate date2 ); /** Returns the interval between two times. - * @param time1 start time - * @param time2 time to subtract, ie subtract time2 from time1 + * \param time1 start time + * \param time2 time to subtract, ie subtract time2 from time1 * \since QGIS 2.16 - * @note not available in Python bindings + * \note not available in Python bindings */ QgsInterval CORE_EXPORT operator-( QTime time1, QTime time2 ); /** Adds an interval to a datetime - * @param start initial datetime - * @param interval interval to add + * \param start initial datetime + * \param interval interval to add * \since QGIS 2.16 - * @note not available in Python bindings + * \note not available in Python bindings */ QDateTime CORE_EXPORT operator+( const QDateTime &start, const QgsInterval &interval ); diff --git a/src/core/qgsjsonutils.h b/src/core/qgsjsonutils.h index 936dea83bc50..8c9ff8b1af10 100644 --- a/src/core/qgsjsonutils.h +++ b/src/core/qgsjsonutils.h @@ -39,126 +39,126 @@ class CORE_EXPORT QgsJSONExporter public: /** Constructor for QgsJSONExporter. - * @param vectorLayer associated vector layer (required for related attribute export) - * @param precision maximum number of decimal places to use for geometry coordinates, + * \param vectorLayer associated vector layer (required for related attribute export) + * \param precision maximum number of decimal places to use for geometry coordinates, * the RFC 7946 GeoJSON specification recommends limiting coordinate precision to 6 */ QgsJSONExporter( const QgsVectorLayer *vectorLayer = nullptr, int precision = 6 ); /** Sets the maximum number of decimal places to use in geometry coordinates. * The RFC 7946 GeoJSON specification recommends limiting coordinate precision to 6 - * @param precision number of decimal places - * @see precision() + * \param precision number of decimal places + * \see precision() */ void setPrecision( int precision ) { mPrecision = precision; } /** Returns the maximum number of decimal places to use in geometry coordinates. - * @see setPrecision() + * \see setPrecision() */ int precision() const { return mPrecision; } /** Sets whether to include geometry in the JSON exports. - * @param includeGeometry set to false to prevent geometry inclusion - * @see includeGeometry() + * \param includeGeometry set to false to prevent geometry inclusion + * \see includeGeometry() */ void setIncludeGeometry( bool includeGeometry ) { mIncludeGeometry = includeGeometry; } /** Returns whether geometry will be included in the JSON exports. - * @see setIncludeGeometry() + * \see setIncludeGeometry() */ bool includeGeometry() const { return mIncludeGeometry; } /** Sets whether to include attributes in the JSON exports. - * @param includeAttributes set to false to prevent attribute inclusion - * @see includeAttributes() + * \param includeAttributes set to false to prevent attribute inclusion + * \see includeAttributes() */ void setIncludeAttributes( bool includeAttributes ) { mIncludeAttributes = includeAttributes; } /** Returns whether attributes will be included in the JSON exports. - * @see setIncludeAttributes() + * \see setIncludeAttributes() */ bool includeAttributes() const { return mIncludeAttributes; } /** Sets whether to include attributes of features linked via references in the JSON exports. - * @param includeRelated set to true to include attributes for any related child features + * \param includeRelated set to true to include attributes for any related child features * within the exported properties element. - * @note associated vector layer must be set with setVectorLayer() - * @see includeRelated() + * \note associated vector layer must be set with setVectorLayer() + * \see includeRelated() */ void setIncludeRelated( bool includeRelated ) { mIncludeRelatedAttributes = includeRelated; } /** Returns whether attributes of related (child) features will be included in the JSON exports. - * @see setIncludeRelated() + * \see setIncludeRelated() */ bool includeRelated() const { return mIncludeRelatedAttributes; } /** Sets the associated vector layer (required for related attribute export). This will automatically * update the sourceCrs() to match. - * @param vectorLayer vector layer - * @see vectorLayer() + * \param vectorLayer vector layer + * \see vectorLayer() */ void setVectorLayer( const QgsVectorLayer *vectorLayer ); /** Returns the associated vector layer, if set. - * @see setVectorLayer() + * \see setVectorLayer() */ QgsVectorLayer *vectorLayer() const; /** Sets the source CRS for feature geometries. The source CRS must be set if geometries are to be * correctly automatically reprojected to WGS 84, to match GeoJSON specifications. - * @param crs source CRS for input feature geometries - * @note the source CRS will be overwritten when a vector layer is specified via setVectorLayer() - * @see sourceCrs() + * \param crs source CRS for input feature geometries + * \note the source CRS will be overwritten when a vector layer is specified via setVectorLayer() + * \see sourceCrs() */ void setSourceCrs( const QgsCoordinateReferenceSystem &crs ); /** Returns the source CRS for feature geometries. The source CRS must be set if geometries are to be * correctly automatically reprojected to WGS 84, to match GeoJSON specifications. - * @see setSourceCrs() + * \see setSourceCrs() */ QgsCoordinateReferenceSystem sourceCrs() const; /** Sets the list of attributes to include in the JSON exports. - * @param attributes list of attribute indexes, or an empty list to include all + * \param attributes list of attribute indexes, or an empty list to include all * attributes - * @see attributes() - * @see setExcludedAttributes() - * @note Attributes excluded via setExcludedAttributes() take precedence over + * \see attributes() + * \see setExcludedAttributes() + * \note Attributes excluded via setExcludedAttributes() take precedence over * attributes specified by this method. */ void setAttributes( const QgsAttributeList &attributes ) { mAttributeIndexes = attributes; } /** Returns the list of attributes which will be included in the JSON exports, or * an empty list if all attributes will be included. - * @see setAttributes() - * @see excludedAttributes() - * @note Attributes excluded via excludedAttributes() take precedence over + * \see setAttributes() + * \see excludedAttributes() + * \note Attributes excluded via excludedAttributes() take precedence over * attributes returned by this method. */ QgsAttributeList attributes() const { return mAttributeIndexes; } /** Sets a list of attributes to specifically exclude from the JSON exports. Excluded attributes * take precedence over attributes included via setAttributes(). - * @param attributes list of attribute indexes to exclude - * @see excludedAttributes() - * @see setAttributes() + * \param attributes list of attribute indexes to exclude + * \see excludedAttributes() + * \see setAttributes() */ void setExcludedAttributes( const QgsAttributeList &attributes ) { mExcludedAttributeIndexes = attributes; } /** Returns a list of attributes which will be specifically excluded from the JSON exports. Excluded attributes * take precedence over attributes included via attributes(). - * @see setExcludedAttributes() - * @see attributes() + * \see setExcludedAttributes() + * \see attributes() */ QgsAttributeList excludedAttributes() const { return mExcludedAttributeIndexes; } /** Returns a GeoJSON string representation of a feature. - * @param feature feature to convert - * @param extraProperties map of extra attributes to include in feature's properties - * @param id optional ID to use as GeoJSON feature's ID instead of input feature's ID. If omitted, feature's + * \param feature feature to convert + * \param extraProperties map of extra attributes to include in feature's properties + * \param id optional ID to use as GeoJSON feature's ID instead of input feature's ID. If omitted, feature's * ID is used. - * @returns GeoJSON string - * @see exportFeatures() + * \returns GeoJSON string + * \see exportFeatures() */ QString exportFeature( const QgsFeature &feature, const QVariantMap &extraProperties = QVariantMap(), @@ -166,9 +166,9 @@ class CORE_EXPORT QgsJSONExporter /** Returns a GeoJSON string representation of a list of features (feature collection). - * @param features features to convert - * @returns GeoJSON string - * @see exportFeature() + * \param features features to convert + * \returns GeoJSON string + * \see exportFeature() */ QString exportFeatures( const QgsFeatureList &features ) const; @@ -178,7 +178,7 @@ class CORE_EXPORT QgsJSONExporter int mPrecision; //! List of attribute indexes to include in export, or empty list to include all attributes - //! @see mExcludedAttributeIndexes + //! \see mExcludedAttributeIndexes QgsAttributeList mAttributeIndexes; //! List of attribute indexes to exclude from export @@ -213,39 +213,39 @@ class CORE_EXPORT QgsJSONUtils public: /** Attempts to parse a GeoJSON string to a collection of features. - * @param string GeoJSON string to parse - * @param fields fields collection to use for parsed features - * @param encoding text encoding - * @returns list of parsed features, or an empty list if no features could be parsed - * @see stringToFields() - * @note this function is a wrapper around QgsOgrUtils::stringToFeatureList() + * \param string GeoJSON string to parse + * \param fields fields collection to use for parsed features + * \param encoding text encoding + * \returns list of parsed features, or an empty list if no features could be parsed + * \see stringToFields() + * \note this function is a wrapper around QgsOgrUtils::stringToFeatureList() */ static QgsFeatureList stringToFeatureList( const QString &string, const QgsFields &fields, QTextCodec *encoding ); /** Attempts to retrieve the fields from a GeoJSON string representing a collection of features. - * @param string GeoJSON string to parse - * @param encoding text encoding - * @returns retrieved fields collection, or an empty list if no fields could be determined from the string - * @see stringToFeatureList() - * @note this function is a wrapper around QgsOgrUtils::stringToFields() + * \param string GeoJSON string to parse + * \param encoding text encoding + * \returns retrieved fields collection, or an empty list if no fields could be determined from the string + * \see stringToFeatureList() + * \note this function is a wrapper around QgsOgrUtils::stringToFields() */ static QgsFields stringToFields( const QString &string, QTextCodec *encoding ); /** Encodes a value to a JSON string representation, adding appropriate quotations and escaping * where required. - * @param value value to encode - * @returns encoded value + * \param value value to encode + * \returns encoded value */ static QString encodeValue( const QVariant &value ); /** Exports all attributes from a QgsFeature as a JSON map type. - * @param feature feature to export + * \param feature feature to export */ static QString exportAttributes( const QgsFeature &feature ); /** Parse a simple array (depth=1). - * @param json the JSON to parse - * @param type the type of the elements + * \param json the JSON to parse + * \param type the type of the elements * \since QGIS 3.0 */ static QVariantList parseArray( const QString &json, QVariant::Type type ); diff --git a/src/core/qgslabelfeature.h b/src/core/qgslabelfeature.h index 498814779867..0eb832a42973 100644 --- a/src/core/qgslabelfeature.h +++ b/src/core/qgslabelfeature.h @@ -17,7 +17,7 @@ class QgsGeometry; /** \ingroup core - * @brief The QgsLabelFeature class describes a feature that + * \brief The QgsLabelFeature class describes a feature that * should be used within the labeling engine. Those may be the usual textual labels, * diagrams, or any other custom type of map annotations (generated by custom * label providers). @@ -28,9 +28,9 @@ class QgsGeometry; * Individual label providers may create subclasses of QgsLabelFeature in order to add * more data to the instances that will be later used for drawing of labels. * - * @note this class is not a part of public API yet. See notes in QgsLabelingEngine + * \note this class is not a part of public API yet. See notes in QgsLabelingEngine * \since QGIS 2.12 - * @note not available in Python bindings + * \note not available in Python bindings */ class CORE_EXPORT QgsLabelFeature { @@ -53,23 +53,23 @@ class CORE_EXPORT QgsLabelFeature * point itself. It not set, the feature's geometry is used for obstacle detection. * Ownership of obstacle geometry is transferred. * \since QGIS 2.14 - * @see obstacleGeometry() + * \see obstacleGeometry() */ void setObstacleGeometry( GEOSGeometry *obstacleGeom ); /** Returns the label's obstacle geometry, if different to the feature geometry. * \since QGIS 2.14 - * @see setObstacleGeometry() + * \see setObstacleGeometry() */ GEOSGeometry *obstacleGeometry() const { return mObstacleGeometry; } /** Sets the label's permissible zone geometry. If set, the feature's label MUST be fully contained * within this zone, and the feature will not be labeled if no candidates can be generated which * are not contained within the zone. - * @param geometry permissible zone geometry. If an invalid QgsGeometry is passed then no zone limit + * \param geometry permissible zone geometry. If an invalid QgsGeometry is passed then no zone limit * will be applied to the label candidates (this is the default behavior). * \since QGIS 3.0 - * @see permissibleZone() + * \see permissibleZone() */ void setPermissibleZone( const QgsGeometry &geometry ); @@ -77,13 +77,13 @@ class CORE_EXPORT QgsLabelFeature * MUST be fully contained within this zone, and the feature will not be labeled if no candidates can be * generated which are not contained within the zone. * \since QGIS 3.0 - * @see setPermissibleZone() - * @see permissibleZonePrepared() + * \see setPermissibleZone() + * \see permissibleZonePrepared() */ QgsGeometry permissibleZone() const { return mPermissibleZone; } /** Returns a GEOS prepared geometry representing the label's permissibleZone(). - * @see permissibleZone() + * \see permissibleZone() * \since QGIS 3.0 */ //TODO - remove when QgsGeometry caches GEOS preparedness @@ -98,20 +98,20 @@ class CORE_EXPORT QgsLabelFeature * of candidates so that they all appear to be at visually equal distances from a point feature. * For instance, this can be used to place labels which sit above a point so that their baseline * rather then the descender of the label is at a preset distance from the point. - * @param margin visual margins for label - * @see visualMargin() + * \param margin visual margins for label + * \see visualMargin() */ void setVisualMargin( const QgsMargins &margin ) { mVisualMargin = margin; } /** Returns the visual margin for the label feature. - * @see setVisualMargin() for details + * \see setVisualMargin() for details */ const QgsMargins &visualMargin() const { return mVisualMargin; } /** Sets the size of the rendered symbol associated with this feature. This size is taken into * account in certain label placement modes to avoid placing labels over the rendered * symbol for this feature. - * @see symbolSize() + * \see symbolSize() */ void setSymbolSize( QSizeF size ) { mSymbolSize = size; } @@ -119,36 +119,36 @@ class CORE_EXPORT QgsLabelFeature * This size is taken into account in certain label placement modes to avoid placing labels over * the rendered symbol for this feature. The size will only be set for labels associated * with a point feature. - * @see symbolSize() + * \see symbolSize() */ const QSizeF &symbolSize() const { return mSymbolSize; } /** Returns the feature's labeling priority. - * @returns feature's priority, as a value between 0 (highest priority) + * \returns feature's priority, as a value between 0 (highest priority) * and 1 (lowest priority). Returns -1.0 if feature will use the layer's default priority. - * @see setPriority + * \see setPriority */ double priority() const { return mPriority; } /** Sets the priority for labeling the feature. - * @param priority feature's priority, as a value between 0 (highest priority) + * \param priority feature's priority, as a value between 0 (highest priority) * and 1 (lowest priority). Set to -1.0 to use the layer's default priority * for this feature. - * @see priority + * \see priority */ void setPriority( double priority ) { mPriority = priority; } /** Returns the label's z-index. Higher z-index labels are rendered on top of lower * z-index labels. - * @see setZIndex() + * \see setZIndex() * \since QGIS 2.14 */ double zIndex() const { return mZIndex; } /** Sets the label's z-index. Higher z-index labels are rendered on top of lower * z-index labels. - * @param zIndex z-index for label - * @see zIndex() + * \param zIndex z-index for label + * \see zIndex() * \since QGIS 2.14 */ void setZIndex( double zIndex ) { mZIndex = zIndex; } @@ -173,15 +173,15 @@ class CORE_EXPORT QgsLabelFeature /** Returns whether the quadrant for the label is fixed. * Applies to "around point" placement strategy. - * @see setFixedQuadrant - * @see quadOffset + * \see setFixedQuadrant + * \see quadOffset */ bool hasFixedQuadrant() const { return mHasFixedQuadrant; } /** Sets whether the quadrant for the label must be respected. This can be used * to fix the quadrant for specific features when using an "around point" placement. - * @see fixedQuadrant - * @see quadOffset + * \see fixedQuadrant + * \see quadOffset */ void setHasFixedQuadrant( bool enabled ) { mHasFixedQuadrant = enabled; } //! Applies to "offset from point" placement strategy and "around point" (in case hasFixedQuadrant() returns true). @@ -190,7 +190,7 @@ class CORE_EXPORT QgsLabelFeature //! For Y coordinate, values -1, 0, 1 mean above, center, below. QPointF quadOffset() const { return mQuadOffset; } //! Set which side of the point to use - //! @see quadOffset + //! \see quadOffset void setQuadOffset( QPointF quadOffset ) { mQuadOffset = quadOffset; } //! Applies only to "offset from point" placement strategy. //! What offset (in map units) to use from the point @@ -202,14 +202,14 @@ class CORE_EXPORT QgsLabelFeature /** Returns the offset type, which determines how offsets and distance to label * behaves. Support depends on which placement mode is used for generating * label candidates. - * @see setOffsetType() + * \see setOffsetType() */ QgsPalLayerSettings::OffsetType offsetType() const { return mOffsetType; } /** Sets the offset type, which determines how offsets and distance to label * behaves. Support depends on which placement mode is used for generating * label candidates. - * @see offsetType() + * \see offsetType() */ void setOffsetType( QgsPalLayerSettings::OffsetType type ) { mOffsetType = type; } @@ -222,13 +222,13 @@ class CORE_EXPORT QgsLabelFeature /** Returns the priority ordered list of predefined positions for label candidates. This property * is only used for OrderedPositionsAroundPoint placements. - * @see setPredefinedPositionOrder() + * \see setPredefinedPositionOrder() */ QVector< QgsPalLayerSettings::PredefinedPointPosition > predefinedPositionOrder() const { return mPredefinedPositionOrder; } /** Sets the priority ordered list of predefined positions for label candidates. This property * is only used for OrderedPositionsAroundPoint placements. - * @see predefinedPositionOrder() + * \see predefinedPositionOrder() */ void setPredefinedPositionOrder( const QVector< QgsPalLayerSettings::PredefinedPointPosition > &order ) { mPredefinedPositionOrder = order; } @@ -245,29 +245,29 @@ class CORE_EXPORT QgsLabelFeature void setAlwaysShow( bool enabled ) { mAlwaysShow = enabled; } /** Returns whether the feature will act as an obstacle for labels. - * @returns true if feature is an obstacle - * @see setIsObstacle + * \returns true if feature is an obstacle + * \see setIsObstacle */ bool isObstacle() const { return mIsObstacle; } /** Sets whether the feature will act as an obstacle for labels. - * @param enabled whether feature will act as an obstacle - * @see isObstacle + * \param enabled whether feature will act as an obstacle + * \see isObstacle */ void setIsObstacle( bool enabled ) { mIsObstacle = enabled; } /** Returns the obstacle factor for the feature. The factor controls the penalty * for labels overlapping this feature. - * @see setObstacleFactor + * \see setObstacleFactor */ double obstacleFactor() const { return mObstacleFactor; } /** Sets the obstacle factor for the feature. The factor controls the penalty * for labels overlapping this feature. - * @param factor larger factors ( > 1.0 ) will result in labels + * \param factor larger factors ( > 1.0 ) will result in labels * which are less likely to cover this feature, smaller factors ( < 1.0 ) mean labels * are more likely to cover this feature (where required) - * @see obstacleFactor + * \see obstacleFactor */ void setObstacleFactor( double factor ) { mObstacleFactor = factor; } diff --git a/src/core/qgslabelingengine.h b/src/core/qgslabelingengine.h index fc7d60ae0353..227a72164b56 100644 --- a/src/core/qgslabelingengine.h +++ b/src/core/qgslabelingengine.h @@ -28,14 +28,14 @@ class QgsLabelingEngine; /** \ingroup core - * @brief The QgsAbstractLabelProvider class is an interface class. Implementations + * \brief The QgsAbstractLabelProvider class is an interface class. Implementations * return list of labels and their associated geometries - these are used by * QgsLabelingEngine to compute the final layout of labels. * * Implementations also take care of drawing the returned final label positions. * - * @note this class is not a part of public API yet. See notes in QgsLabelingEngine - * @note not available in Python bindings + * \note this class is not a part of public API yet. See notes in QgsLabelingEngine + * \note not available in Python bindings * \since QGIS 2.12 */ class CORE_EXPORT QgsAbstractLabelProvider @@ -132,7 +132,7 @@ Q_DECLARE_OPERATORS_FOR_FLAGS( QgsAbstractLabelProvider::Flags ) /** \ingroup core - * @brief The QgsLabelingEngine class provides map labeling functionality. + * \brief The QgsLabelingEngine class provides map labeling functionality. * The input for the engine is a list of label provider objects and map settings. * Based on the input, the engine computes layout of labels for the given map view * with no collisions between the labels. Drawing of resulting labels is done @@ -153,7 +153,7 @@ Q_DECLARE_OPERATORS_FOR_FLAGS( QgsAbstractLabelProvider::Flags ) * engine.run( context ); * \endcode * - * @note this class is not a part of public API yet. The provider's interface still + * \note this class is not a part of public API yet. The provider's interface still * uses pal::LabelPosition as an argument in drawLabels() method - this should be * sorted out first (a class common to API and pal?). Also, the API may need more * polishing to be easy to use - e.g. use concept of labeling layers in API @@ -161,7 +161,7 @@ Q_DECLARE_OPERATORS_FOR_FLAGS( QgsAbstractLabelProvider::Flags ) * into feature loop vs providers with independent feature loop), split labeling * computation from drawing of labels, improved results class with label iterator). * \since QGIS 2.12 - * @note not available in Python bindings + * \note not available in Python bindings */ class CORE_EXPORT QgsLabelingEngine { @@ -263,11 +263,11 @@ Q_DECLARE_OPERATORS_FOR_FLAGS( QgsLabelingEngine::Flags ) /** \ingroup core - * @class QgsLabelingUtils - * @brief Contains helper utilities for working with QGIS' labeling engine. - * @note this class is not a part of public API yet. See notes in QgsLabelingEngine + * \class QgsLabelingUtils + * \brief Contains helper utilities for working with QGIS' labeling engine. + * \note this class is not a part of public API yet. See notes in QgsLabelingEngine * \since QGIS 2.14 - * @note not available in Python bindings + * \note not available in Python bindings */ class CORE_EXPORT QgsLabelingUtils @@ -275,16 +275,16 @@ class CORE_EXPORT QgsLabelingUtils public: /** Encodes an ordered list of predefined point label positions to a string. - * @param positions order list of positions - * @returns list encoded to string - * @see decodePredefinedPositionOrder() + * \param positions order list of positions + * \returns list encoded to string + * \see decodePredefinedPositionOrder() */ static QString encodePredefinedPositionOrder( const QVector< QgsPalLayerSettings::PredefinedPointPosition > &positions ); /** Decodes a string to an ordered list of predefined point label positions. - * @param positionString encoded string of positions - * @returns decoded list - * @see encodePredefinedPositionOrder() + * \param positionString encoded string of positions + * \returns decoded list + * \see encodePredefinedPositionOrder() */ static QVector< QgsPalLayerSettings::PredefinedPointPosition > decodePredefinedPositionOrder( const QString &positionString ); diff --git a/src/core/qgslabelsearchtree.h b/src/core/qgslabelsearchtree.h index 5d209cde0f6e..ddebe8a7c6d4 100644 --- a/src/core/qgslabelsearchtree.h +++ b/src/core/qgslabelsearchtree.h @@ -46,20 +46,20 @@ class CORE_EXPORT QgsLabelSearchTree void clear(); /** Returns label position(s) at a given point. QgsLabelSearchTree keeps ownership, don't delete the LabelPositions - * @note not available in Python bindings + * \note not available in Python bindings * TODO: why does this break bindings with QList? */ void label( const QgsPoint &p, QList &posList ) const; /** Returns label position(s) in given rectangle. QgsLabelSearchTree keeps ownership, don't delete the LabelPositions - * @note not available in Python bindings + * \note not available in Python bindings * TODO: why does this break bindings with QList? */ void labelsInRect( const QgsRectangle &r, QList &posList ) const; /** Inserts label position. Does not take ownership of labelPos - * @return true in case of success - * @note not available in Python bindings + * \returns true in case of success + * \note not available in Python bindings */ bool insertLabel( pal::LabelPosition *labelPos, int featureId, const QString &layerName, const QString &labeltext, const QFont &labelfont, bool diagram = false, bool pinned = false, const QString &providerId = QString() ); diff --git a/src/core/qgslayerdefinition.h b/src/core/qgslayerdefinition.h index 4d25b230a464..dc6fed2a7bb3 100644 --- a/src/core/qgslayerdefinition.h +++ b/src/core/qgslayerdefinition.h @@ -31,7 +31,7 @@ class QgsPathResolver; class QgsProject; /** \ingroup core - * @brief The QgsLayerDefinition class holds generic methods for loading/exporting QLR files. + * \brief The QgsLayerDefinition class holds generic methods for loading/exporting QLR files. * * QLR files are an export of the layer xml including the style and datasource location. There is no link * to the QLR file once loaded. Consider the QLR file a mini project file for layers and styles. QLR @@ -55,17 +55,17 @@ class CORE_EXPORT QgsLayerDefinition * Layer definitions can be used to load a layer and styling all from a single file. * * This is a low-level routine that does not write layer tree. - * @see exportLayerDefinition() + * \see exportLayerDefinition() */ static QDomDocument exportLayerDefinitionLayers( const QList &layers, const QgsPathResolver &pathResolver ); //! Creates new layers from a layer definition document. //! This is a low-level routine that does not resolve layer ID conflicts, dependencies and joins - //! @see loadLayerDefinition() + //! \see loadLayerDefinition() static QList loadLayerDefinitionLayers( QDomDocument &document, const QgsPathResolver &pathResolver ); //! Creates new layers from a layer definition file (.QLR) //! This is a low-level routine that does not resolve layer ID conflicts, dependencies and joins - //! @see loadLayerDefinition() + //! \see loadLayerDefinition() static QList loadLayerDefinitionLayers( const QString &qlrfile ); /** @@ -77,12 +77,12 @@ class CORE_EXPORT QgsLayerDefinition public: /** Constructor - * @param doc The XML document containing maplayer elements + * \param doc The XML document containing maplayer elements */ DependencySorter( const QDomDocument &doc ); /** Constructor - * @param fileName The filename where the XML document is stored + * \param fileName The filename where the XML document is stored */ DependencySorter( const QString &fileName ); diff --git a/src/core/qgslegendrenderer.h b/src/core/qgslegendrenderer.h index fd1952b74026..8eb20e7cb72a 100644 --- a/src/core/qgslegendrenderer.h +++ b/src/core/qgslegendrenderer.h @@ -32,7 +32,7 @@ class QgsSymbol; #include "qgslegendsettings.h" /** \ingroup core - * @brief The QgsLegendRenderer class handles automatic layout and rendering of legend. + * \brief The QgsLegendRenderer class handles automatic layout and rendering of legend. * The content is given by QgsLayerTreeModel instance. Various layout properties can be configured * within QgsLegendRenderer. * diff --git a/src/core/qgslegendsettings.h b/src/core/qgslegendsettings.h index a3a4aeaebd6b..9744eb711068 100644 --- a/src/core/qgslegendsettings.h +++ b/src/core/qgslegendsettings.h @@ -26,7 +26,7 @@ class QRectF; /** \ingroup core - * @brief The QgsLegendSettings class stores the appearance and layout settings + * \brief The QgsLegendSettings class stores the appearance and layout settings * for legend drawing with QgsLegendRenderer. The content of the legend is given * in QgsLegendModel class. * @@ -41,14 +41,14 @@ class CORE_EXPORT QgsLegendSettings QString title() const { return mTitle; } /** Returns the alignment of the legend title - * @returns Qt::AlignmentFlag for the legend title - * @see setTitleAlignment + * \returns Qt::AlignmentFlag for the legend title + * \see setTitleAlignment */ Qt::AlignmentFlag titleAlignment() const { return mTitleAlignment; } /** Sets the alignment of the legend title - * @param alignment Text alignment for drawing the legend title - * @see titleAlignment + * \param alignment Text alignment for drawing the legend title + * \see titleAlignment */ void setTitleAlignment( Qt::AlignmentFlag alignment ) { mTitleAlignment = alignment; } @@ -83,56 +83,56 @@ class CORE_EXPORT QgsLegendSettings void setSymbolSize( QSizeF s ) {mSymbolSize = s;} /** Returns whether a stroke will be drawn around raster symbol items. - * @see setDrawRasterStroke() - * @see rasterStrokeColor() - * @see rasterStrokeWidth() + * \see setDrawRasterStroke() + * \see rasterStrokeColor() + * \see rasterStrokeWidth() * \since QGIS 2.12 */ bool drawRasterStroke() const { return mRasterSymbolStroke; } /** Sets whether a stroke will be drawn around raster symbol items. - * @param enabled set to true to draw borders - * @see drawRasterStroke() - * @see setRasterStrokeColor() - * @see setRasterStrokeWidth() + * \param enabled set to true to draw borders + * \see drawRasterStroke() + * \see setRasterStrokeColor() + * \see setRasterStrokeWidth() * \since QGIS 2.12 */ void setDrawRasterStroke( bool enabled ) { mRasterSymbolStroke = enabled; } /** Returns the stroke color for the stroke drawn around raster symbol items. The stroke is * only drawn if drawRasterStroke() is true. - * @see setRasterStrokeColor() - * @see drawRasterStroke() - * @see rasterStrokeWidth() + * \see setRasterStrokeColor() + * \see drawRasterStroke() + * \see rasterStrokeWidth() * \since QGIS 2.12 */ QColor rasterStrokeColor() const { return mRasterStrokeColor; } /** Sets the stroke color for the stroke drawn around raster symbol items. The stroke is * only drawn if drawRasterStroke() is true. - * @param color stroke color - * @see rasterStrokeColor() - * @see setDrawRasterStroke() - * @see setRasterStrokeWidth() + * \param color stroke color + * \see rasterStrokeColor() + * \see setDrawRasterStroke() + * \see setRasterStrokeWidth() * \since QGIS 2.12 */ void setRasterStrokeColor( const QColor &color ) { mRasterStrokeColor = color; } /** Returns the stroke width (in millimeters) for the stroke drawn around raster symbol items. The stroke is * only drawn if drawRasterStroke() is true. - * @see setRasterStrokeWidth() - * @see drawRasterStroke() - * @see rasterStrokeColor() + * \see setRasterStrokeWidth() + * \see drawRasterStroke() + * \see rasterStrokeColor() * \since QGIS 2.12 */ double rasterStrokeWidth() const { return mRasterStrokeWidth; } /** Sets the stroke width for the stroke drawn around raster symbol items. The stroke is * only drawn if drawRasterStroke() is true. - * @param width stroke width in millimeters - * @see rasterStrokeWidth() - * @see setDrawRasterStroke() - * @see setRasterStrokeColor() + * \param width stroke width in millimeters + * \see rasterStrokeWidth() + * \see setDrawRasterStroke() + * \see setRasterStrokeColor() * \since QGIS 2.12 */ void setRasterStrokeWidth( double width ) { mRasterStrokeWidth = width; } @@ -168,13 +168,13 @@ class CORE_EXPORT QgsLegendSettings void drawText( QPainter *p, double x, double y, const QString &text, const QFont &font ) const; /** Like the above, but with a rectangle for multiline text - * @param p painter to use - * @param rect rectangle to draw into - * @param text text to draw - * @param font font to use - * @param halignment optional horizontal alignment - * @param valignment optional vertical alignment - * @param flags allows for passing Qt::TextFlags to control appearance of rendered text + * \param p painter to use + * \param rect rectangle to draw into + * \param text text to draw + * \param font font to use + * \param halignment optional horizontal alignment + * \param valignment optional vertical alignment + * \param flags allows for passing Qt::TextFlags to control appearance of rendered text */ void drawText( QPainter *p, const QRectF &rect, const QString &text, const QFont &font, Qt::AlignmentFlag halignment = Qt::AlignLeft, Qt::AlignmentFlag valignment = Qt::AlignTop, int flags = Qt::TextWordWrap ) const; diff --git a/src/core/qgslogger.h b/src/core/qgslogger.h index 5503505233e1..1202bbfe94e3 100644 --- a/src/core/qgslogger.h +++ b/src/core/qgslogger.h @@ -58,22 +58,22 @@ class CORE_EXPORT QgsLogger public: /** Goes to qDebug. - @param msg the message to be printed - @param debuglevel - @param file file name where the message comes from - @param function function where the message comes from - @param line place in file where the message comes from*/ + \param msg the message to be printed + \param debuglevel + \param file file name where the message comes from + \param function function where the message comes from + \param line place in file where the message comes from*/ static void debug( const QString &msg, int debuglevel = 1, const char *file = nullptr, const char *function = nullptr, int line = -1 ); //! Similar to the previous method, but prints a variable int-value pair static void debug( const QString &var, int val, int debuglevel = 1, const char *file = nullptr, const char *function = nullptr, int line = -1 ); //! Similar to the previous method, but prints a variable double-value pair - // @note not available in Python bindings + // \note not available in Python bindings static void debug( const QString &var, double val, int debuglevel = 1, const char *file = nullptr, const char *function = nullptr, int line = -1 ); //! Prints out a variable/value pair for types with overloaded operator<< - // @note not available in Python bindings + // \note not available in Python bindings template static void debug( const QString &var, T val, const char *file = nullptr, const char *function = nullptr, int line = -1, int debuglevel = 1 ) { diff --git a/src/core/qgsmaphittest.h b/src/core/qgsmaphittest.h index 825e3221d140..9f983c5e1878 100644 --- a/src/core/qgsmaphittest.h +++ b/src/core/qgsmaphittest.h @@ -38,9 +38,9 @@ class CORE_EXPORT QgsMapHitTest //! Maps an expression string to a layer id typedef QMap LayerFilterExpression; - //! @param settings Map settings used to evaluate symbols - //! @param polygon Polygon geometry to refine the hit test - //! @param layerFilterExpression Expression string for each layer id to evaluate in order to refine the symbol selection + //! \param settings Map settings used to evaluate symbols + //! \param polygon Polygon geometry to refine the hit test + //! \param layerFilterExpression Expression string for each layer id to evaluate in order to refine the symbol selection QgsMapHitTest( const QgsMapSettings &settings, const QgsGeometry &polygon = QgsGeometry(), const LayerFilterExpression &layerFilterExpression = LayerFilterExpression() ); //! Constructor version used with only expressions to filter symbols (no extent or polygon intersection) @@ -50,36 +50,36 @@ class CORE_EXPORT QgsMapHitTest void run(); /** Tests whether a symbol is visible for a specified layer. - * @param symbol symbol to find - * @param layer vector layer + * \param symbol symbol to find + * \param layer vector layer * \since QGIS 2.12 - * @see legendKeyVisible() + * \see legendKeyVisible() */ bool symbolVisible( QgsSymbol *symbol, QgsVectorLayer *layer ) const; /** Tests whether a given legend key is visible for a specified layer. - * @param ruleKey legend rule key - * @param layer vector layer + * \param ruleKey legend rule key + * \param layer vector layer * \since QGIS 2.14 - * @see symbolVisible() + * \see symbolVisible() */ bool legendKeyVisible( const QString &ruleKey, QgsVectorLayer *layer ) const; protected: - //! @note not available in Python bindings + //! \note not available in Python bindings typedef QSet SymbolSet; - //! @note not available in Python bindings + //! \note not available in Python bindings typedef QMap HitTest; /** Runs test for visible symbols within a layer - * @param vl vector layer - * @param usedSymbols set for storage of visible symbols - * @param usedSymbolsRuleKey set of storage of visible legend rule keys - * @param context render context + * \param vl vector layer + * \param usedSymbols set for storage of visible symbols + * \param usedSymbolsRuleKey set of storage of visible legend rule keys + * \param context render context * \since QGIS 2.12 - * @note not available in Python bindings + * \note not available in Python bindings */ void runHitTestLayer( QgsVectorLayer *vl, SymbolSet &usedSymbols, SymbolSet &usedSymbolsRuleKey, QgsRenderContext &context ); diff --git a/src/core/qgsmaplayer.cpp b/src/core/qgsmaplayer.cpp index 688c83a61644..e2f7a738ad42 100644 --- a/src/core/qgsmaplayer.cpp +++ b/src/core/qgsmaplayer.cpp @@ -98,7 +98,6 @@ QgsMapLayer::LayerType QgsMapLayer::type() const return mLayerType; } -//! Get this layer's unique ID QString QgsMapLayer::id() const { return mID; @@ -116,7 +115,6 @@ void QgsMapLayer::setName( const QString &name ) emit nameChanged(); } -//! Read property of QString layerName. QString QgsMapLayer::name() const { QgsDebugMsgLevel( "returning name '" + mLayerName + '\'', 4 ); @@ -141,7 +139,6 @@ QgsRectangle QgsMapLayer::extent() const return mExtent; } -//! Write blend mode for layer void QgsMapLayer::setBlendMode( QPainter::CompositionMode blendMode ) { mBlendMode = blendMode; @@ -149,7 +146,6 @@ void QgsMapLayer::setBlendMode( QPainter::CompositionMode blendMode ) emit styleChanged(); } -//! Read blend mode for layer QPainter::CompositionMode QgsMapLayer::blendMode() const { return mBlendMode; diff --git a/src/core/qgsmaplayer.h b/src/core/qgsmaplayer.h index a84d20a1cb78..3860fb1c69b9 100644 --- a/src/core/qgsmaplayer.h +++ b/src/core/qgsmaplayer.h @@ -67,9 +67,9 @@ class CORE_EXPORT QgsMapLayer : public QObject }; /** Constructor for QgsMapLayer - * @param type layer type - * @param name display name for the layer - * @param source datasource of layer + * \param type layer type + * \param name display name for the layer + * \param source datasource of layer */ QgsMapLayer( QgsMapLayer::LayerType type = VectorLayer, const QString &name = QString::null, const QString &source = QString::null ); @@ -89,76 +89,76 @@ class CORE_EXPORT QgsMapLayer : public QObject /** * Set the display name of the layer - * @param name new name for the layer + * \param name new name for the layer * \since QGIS 2.16 - * @see name() + * \see name() */ void setName( const QString &name ); /** Returns the display name of the layer. - * @return the layer name - * @see setName() + * \returns the layer name + * \see setName() */ QString name() const; /** Returns the original name of the layer. - * @return the original layer name + * \returns the original layer name */ QString originalName() const { return mLayerOrigName; } /** Sets the short name of the layer * used by QGIS Server to identify the layer. - * @return the layer short name - * @see shortName() + * \returns the layer short name + * \see shortName() */ void setShortName( const QString &shortName ) { mShortName = shortName; } /** Returns the short name of the layer * used by QGIS Server to identify the layer. - * @return the layer short name - * @see setShortName() + * \returns the layer short name + * \see setShortName() */ QString shortName() const { return mShortName; } /** Sets the title of the layer * used by QGIS Server in GetCapabilities request. - * @return the layer title - * @see title() + * \returns the layer title + * \see title() */ void setTitle( const QString &title ) { mTitle = title; } /** Returns the title of the layer * used by QGIS Server in GetCapabilities request. - * @return the layer title - * @see setTitle() + * \returns the layer title + * \see setTitle() */ QString title() const { return mTitle; } /** Sets the abstract of the layer * used by QGIS Server in GetCapabilities request. - * @return the layer abstract - * @see abstract() + * \returns the layer abstract + * \see abstract() */ void setAbstract( const QString &abstract ) { mAbstract = abstract; } /** Returns the abstract of the layer * used by QGIS Server in GetCapabilities request. - * @return the layer abstract - * @see setAbstract() + * \returns the layer abstract + * \see setAbstract() */ QString abstract() const { return mAbstract; } /** Sets the keyword list of the layer * used by QGIS Server in GetCapabilities request. - * @return the layer keyword list - * @see keywordList() + * \returns the layer keyword list + * \see keywordList() */ void setKeywordList( const QString &keywords ) { mKeywordList = keywords; } /** Returns the keyword list of the layer * used by QGIS Server in GetCapabilities request. - * @return the layer keyword list - * @see setKeywordList() + * \returns the layer keyword list + * \see setKeywordList() */ QString keywordList() const { return mKeywordList; } @@ -167,32 +167,32 @@ class CORE_EXPORT QgsMapLayer : public QObject /** Sets the DataUrl of the layer * used by QGIS Server in GetCapabilities request. * DataUrl is a a link to the underlying data represented by a particular layer. - * @return the layer DataUrl - * @see dataUrl() + * \returns the layer DataUrl + * \see dataUrl() */ void setDataUrl( const QString &dataUrl ) { mDataUrl = dataUrl; } /** Returns the DataUrl of the layer * used by QGIS Server in GetCapabilities request. * DataUrl is a a link to the underlying data represented by a particular layer. - * @return the layer DataUrl - * @see setDataUrl() + * \returns the layer DataUrl + * \see setDataUrl() */ QString dataUrl() const { return mDataUrl; } /** Sets the DataUrl format of the layer * used by QGIS Server in GetCapabilities request. * DataUrl is a a link to the underlying data represented by a particular layer. - * @return the layer DataUrl format - * @see dataUrlFormat() + * \returns the layer DataUrl format + * \see dataUrlFormat() */ void setDataUrlFormat( const QString &dataUrlFormat ) { mDataUrlFormat = dataUrlFormat; } /** Returns the DataUrl format of the layer * used by QGIS Server in GetCapabilities request. * DataUrl is a a link to the underlying data represented by a particular layer. - * @return the layer DataUrl format - * @see setDataUrlFormat() + * \returns the layer DataUrl format + * \see setDataUrlFormat() */ QString dataUrlFormat() const { return mDataUrlFormat; } @@ -201,32 +201,32 @@ class CORE_EXPORT QgsMapLayer : public QObject /** Sets the attribution of the layer * used by QGIS Server in GetCapabilities request. * Attribution indicates the provider of a layer or collection of layers. - * @return the layer attribution - * @see attribution() + * \returns the layer attribution + * \see attribution() */ void setAttribution( const QString &attrib ) { mAttribution = attrib; } /** Returns the attribution of the layer * used by QGIS Server in GetCapabilities request. * Attribution indicates the provider of a layer or collection of layers. - * @return the layer attribution - * @see setAttribution() + * \returns the layer attribution + * \see setAttribution() */ QString attribution() const { return mAttribution; } /** Sets the attribution URL of the layer * used by QGIS Server in GetCapabilities request. * Attribution indicates the provider of a layer or collection of layers. - * @return the layer attribution URL - * @see attributionUrl() + * \returns the layer attribution URL + * \see attributionUrl() */ void setAttributionUrl( const QString &attribUrl ) { mAttributionUrl = attribUrl; } /** Returns the attribution URL of the layer * used by QGIS Server in GetCapabilities request. * Attribution indicates the provider of a layer or collection of layers. - * @return the layer attribution URL - * @see setAttributionUrl() + * \returns the layer attribution URL + * \see setAttributionUrl() */ QString attributionUrl() const { return mAttributionUrl; } @@ -235,59 +235,59 @@ class CORE_EXPORT QgsMapLayer : public QObject /** Sets the metadata URL of the layer * used by QGIS Server in GetCapabilities request. * MetadataUrl is a a link to the detailed, standardized metadata about the data. - * @return the layer metadata URL - * @see metadataUrl() + * \returns the layer metadata URL + * \see metadataUrl() */ void setMetadataUrl( const QString &metaUrl ) { mMetadataUrl = metaUrl; } /** Returns the metadata URL of the layer * used by QGIS Server in GetCapabilities request. * MetadataUrl is a a link to the detailed, standardized metadata about the data. - * @return the layer metadata URL - * @see setMetadataUrl() + * \returns the layer metadata URL + * \see setMetadataUrl() */ QString metadataUrl() const { return mMetadataUrl; } /** Set the metadata type of the layer * used by QGIS Server in GetCapabilities request * MetadataUrlType indicates the standard to which the metadata complies. - * @return the layer metadata type - * @see metadataUrlType() + * \returns the layer metadata type + * \see metadataUrlType() */ void setMetadataUrlType( const QString &metaUrlType ) { mMetadataUrlType = metaUrlType; } /** Returns the metadata type of the layer * used by QGIS Server in GetCapabilities request. * MetadataUrlType indicates the standard to which the metadata complies. - * @return the layer metadata type - * @see setMetadataUrlType() + * \returns the layer metadata type + * \see setMetadataUrlType() */ QString metadataUrlType() const { return mMetadataUrlType; } /** Sets the metadata format of the layer * used by QGIS Server in GetCapabilities request. * MetadataUrlType indicates how the metadata is structured. - * @return the layer metadata format - * @see metadataUrlFormat() + * \returns the layer metadata format + * \see metadataUrlFormat() */ void setMetadataUrlFormat( const QString &metaUrlFormat ) { mMetadataUrlFormat = metaUrlFormat; } /** Returns the metadata format of the layer * used by QGIS Server in GetCapabilities request. * MetadataUrlType indicates how the metadata is structured. - * @return the layer metadata format - * @see setMetadataUrlFormat() + * \returns the layer metadata format + * \see setMetadataUrlFormat() */ QString metadataUrlFormat() const { return mMetadataUrlFormat; } /** Set the blending mode used for rendering a layer. - * @param blendMode new blending mode - * @see blendMode() + * \param blendMode new blending mode + * \see blendMode() */ void setBlendMode( QPainter::CompositionMode blendMode ); /** Returns the current blending mode for a layer. - * @see setBlendMode() + * \see setBlendMode() */ QPainter::CompositionMode blendMode() const; @@ -308,20 +308,20 @@ class CORE_EXPORT QgsMapLayer : public QObject /** Return the status of the layer. An invalid layer is one which has a bad datasource * or other problem. Child classes set this flag when initialized. - * @return true if the layer is valid and can be accessed + * \returns true if the layer is valid and can be accessed */ bool isValid() const; /** Gets a version of the internal layer definition that has sensitive * bits removed (for example, the password). This function should * be used when displaying the source name for general viewing. - * @see source() + * \see source() */ QString publicSource() const; /** Returns the source for the layer. This source may contain usernames, passwords * and other sensitive information. - * @see publicSource() + * \see publicSource() */ QString source() const; @@ -338,8 +338,8 @@ class CORE_EXPORT QgsMapLayer : public QObject virtual void setLayerOrder( const QStringList &layers ); /** Set the visibility of the given sublayer name. - * @param name sublayer name - * @param visible sublayer visibility + * \param name sublayer name + * \param visible sublayer visibility */ virtual void setSubLayerVisibility( const QString &name, bool visible ); @@ -352,9 +352,9 @@ class CORE_EXPORT QgsMapLayer : public QObject virtual bool isSpatial() const { return true; } /** Sets state from Dom document - @param layerElement The Dom element corresponding to ``maplayer'' tag - @param pathResolver object for conversion between relative and absolute paths - @note + \param layerElement The Dom element corresponding to ``maplayer'' tag + \param pathResolver object for conversion between relative and absolute paths + \note The Dom node corresponds to a Dom document project file XML element read by QgsProject. @@ -364,15 +364,15 @@ class CORE_EXPORT QgsMapLayer : public QObject Invoked by QgsProject::read(). - @returns true if successful + \returns true if successful */ bool readLayerXml( const QDomElement &layerElement, const QgsPathResolver &pathResolver ); /** Stores state in Dom node - * @param layerElement is a Dom element corresponding to ``maplayer'' tag - * @param document is a the dom document being written - * @param pathResolver object for conversion between relative and absolute paths - * @note + * \param layerElement is a Dom element corresponding to ``maplayer'' tag + * \param document is a the dom document being written + * \param pathResolver object for conversion between relative and absolute paths + * \note * * The Dom node corresponds to a Dom document project file XML element to be * written by QgsProject. @@ -382,23 +382,23 @@ class CORE_EXPORT QgsMapLayer : public QObject * * Invoked by QgsProject::write(). * - * @returns true if successful + * \returns true if successful */ bool writeLayerXml( QDomElement &layerElement, QDomDocument &document, const QgsPathResolver &pathResolver ) const; /** Set a custom property for layer. Properties are stored in a map and saved in project file. - * @see customProperty() - * @see removeCustomProperty() + * \see customProperty() + * \see removeCustomProperty() */ void setCustomProperty( const QString &key, const QVariant &value ); /** Read a custom property from layer. Properties are stored in a map and saved in project file. - * @see setCustomProperty() + * \see setCustomProperty() */ QVariant customProperty( const QString &value, const QVariant &defaultValue = QVariant() ) const; /** Remove a custom property from layer. Properties are stored in a map and saved in project file. - * @see setCustomProperty() + * \see setCustomProperty() */ void removeCustomProperty( const QString &key ); @@ -409,7 +409,7 @@ class CORE_EXPORT QgsMapLayer : public QObject virtual QgsError error() const { return mError; } /** Returns the layer's spatial reference system. - @note This was introduced in QGIS 1.4 + \since QGIS 1.4 */ QgsCoordinateReferenceSystem crs() const; @@ -422,58 +422,58 @@ class CORE_EXPORT QgsMapLayer : public QObject /** Retrieve the style URI for this layer * (either as a .qml file on disk or as a * record in the users style table in their personal qgis.db) - * @return a QString with the style file name - * @see also loadNamedStyle () and saveNamedStyle (); + * \returns a QString with the style file name + * \see also loadNamedStyle () and saveNamedStyle (); */ virtual QString styleURI() const; /** Retrieve the default style for this layer if one * exists (either as a .qml file on disk or as a * record in the users style table in their personal qgis.db) - * @param resultFlag a reference to a flag that will be set to false if + * \param resultFlag a reference to a flag that will be set to false if * we did not manage to load the default style. - * @return a QString with any status messages - * @see also loadNamedStyle (); + * \returns a QString with any status messages + * \see also loadNamedStyle (); */ virtual QString loadDefaultStyle( bool &resultFlag ); /** Retrieve a named style for this layer if one * exists (either as a .qml file on disk or as a * record in the users style table in their personal qgis.db) - * @param uri - the file name or other URI for the + * \param uri - the file name or other URI for the * style file. First an attempt will be made to see if this * is a file and load that, if that fails the qgis.db styles * table will be consulted to see if there is a style who's * key matches the URI. - * @param resultFlag a reference to a flag that will be set to false if + * \param resultFlag a reference to a flag that will be set to false if * we did not manage to load the default style. - * @return a QString with any status messages - * @see also loadDefaultStyle (); + * \returns a QString with any status messages + * \see also loadDefaultStyle (); */ virtual QString loadNamedStyle( const QString &uri, bool &resultFlag ); /** Retrieve a named style for this layer from a sqlite database. - * @param db path to sqlite database - * @param uri uri for table - * @param qml will be set to QML style content from database - * @returns true if style was successfully loaded + * \param db path to sqlite database + * \param uri uri for table + * \param qml will be set to QML style content from database + * \returns true if style was successfully loaded */ virtual bool loadNamedStyleFromDatabase( const QString &db, const QString &uri, QString &qml ); /** * Import the properties of this layer from a QDomDocument - * @param doc source QDomDocument - * @param errorMsg this QString will be initialized on error + * \param doc source QDomDocument + * \param errorMsg this QString will be initialized on error * during the execution of readSymbology - * @return true on success + * \returns true on success * \since QGIS 2.8 */ virtual bool importNamedStyle( QDomDocument &doc, QString &errorMsg ); /** * Export the properties of this layer as named style in a QDomDocument - * @param doc the target QDomDocument - * @param errorMsg this QString will be initialized on error + * \param doc the target QDomDocument + * \param errorMsg this QString will be initialized on error * during the execution of writeSymbology */ virtual void exportNamedStyle( QDomDocument &doc, QString &errorMsg ) const; @@ -481,8 +481,8 @@ class CORE_EXPORT QgsMapLayer : public QObject /** * Export the properties of this layer as SLD style in a QDomDocument - * @param doc the target QDomDocument - * @param errorMsg this QString will be initialized on error + * \param doc the target QDomDocument + * \param errorMsg this QString will be initialized on error * during the execution of writeSymbology */ virtual void exportSldStyle( QDomDocument &doc, QString &errorMsg ) const; @@ -490,43 +490,43 @@ class CORE_EXPORT QgsMapLayer : public QObject /** Save the properties of this layer as the default style * (either as a .qml file on disk or as a * record in the users style table in their personal qgis.db) - * @param resultFlag a reference to a flag that will be set to false if + * \param resultFlag a reference to a flag that will be set to false if * we did not manage to save the default style. - * @return a QString with any status messages - * @sa loadNamedStyle() and @see saveNamedStyle() + * \returns a QString with any status messages + * \see loadNamedStyle() and \see saveNamedStyle() */ virtual QString saveDefaultStyle( bool &resultFlag ); /** Save the properties of this layer as a named style * (either as a .qml file on disk or as a * record in the users style table in their personal qgis.db) - * @param uri the file name or other URI for the + * \param uri the file name or other URI for the * style file. First an attempt will be made to see if this * is a file and save to that, if that fails the qgis.db styles * table will be used to create a style entry who's * key matches the URI. - * @param resultFlag a reference to a flag that will be set to false if + * \param resultFlag a reference to a flag that will be set to false if * we did not manage to save the default style. - * @return a QString with any status messages - * @sa saveDefaultStyle() + * \returns a QString with any status messages + * \see saveDefaultStyle() */ virtual QString saveNamedStyle( const QString &uri, bool &resultFlag ); /** Saves the properties of this layer to an SLD format file. - * @param uri uri of destination for exported SLD file. - * @param resultFlag a reference to a flag that will be set to false if + * \param uri uri of destination for exported SLD file. + * \param resultFlag a reference to a flag that will be set to false if * the SLD file could not be generated - * @returns a string with any status or error messages - * @see loadSldStyle() + * \returns a string with any status or error messages + * \see loadSldStyle() */ virtual QString saveSldStyle( const QString &uri, bool &resultFlag ) const; /** Attempts to style the layer using the formatting from an SLD type file. - * @param uri uri of source SLD file - * @param resultFlag a reference to a flag that will be set to false if + * \param uri uri of source SLD file + * \param resultFlag a reference to a flag that will be set to false if * the SLD file could not be loaded - * @returns a string with any status or error messages - * @see saveSldStyle() + * \returns a string with any status or error messages + * \see saveSldStyle() */ virtual QString loadSldStyle( const QString &uri, bool &resultFlag ); @@ -536,36 +536,36 @@ class CORE_EXPORT QgsMapLayer : public QObject /** Read the symbology for the current layer from the Dom node supplied. - * @param node node that will contain the symbology definition for this layer. - * @param errorMessage reference to string that will be updated with any error messages - * @return true in case of success. + * \param node node that will contain the symbology definition for this layer. + * \param errorMessage reference to string that will be updated with any error messages + * \returns true in case of success. */ virtual bool readSymbology( const QDomNode &node, QString &errorMessage ) = 0; /** Read the style for the current layer from the Dom node supplied. - * @param node node that will contain the style definition for this layer. - * @param errorMessage reference to string that will be updated with any error messages - * @return true in case of success. + * \param node node that will contain the style definition for this layer. + * \param errorMessage reference to string that will be updated with any error messages + * \returns true in case of success. * \since QGIS 2.16 - * @note To be implemented in subclasses. Default implementation does nothing and returns false. + * \note To be implemented in subclasses. Default implementation does nothing and returns false. */ virtual bool readStyle( const QDomNode &node, QString &errorMessage ); /** Write the symbology for the layer into the docment provided. - * @param node the node that will have the style element added to it. - * @param doc the document that will have the QDomNode added. - * @param errorMessage reference to string that will be updated with any error messages - * @return true in case of success. + * \param node the node that will have the style element added to it. + * \param doc the document that will have the QDomNode added. + * \param errorMessage reference to string that will be updated with any error messages + * \returns true in case of success. */ virtual bool writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage ) const = 0; /** Write just the style information for the layer into the document - * @param node the node that will have the style element added to it. - * @param doc the document that will have the QDomNode added. - * @param errorMessage reference to string that will be updated with any error messages - * @return true in case of success. + * \param node the node that will have the style element added to it. + * \param doc the document that will have the QDomNode added. + * \param errorMessage reference to string that will be updated with any error messages + * \returns true in case of success. * \since QGIS 2.16 - * @note To be implemented in subclasses. Default implementation does nothing and returns false. + * \note To be implemented in subclasses. Default implementation does nothing and returns false. */ virtual bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage ) const; @@ -585,7 +585,7 @@ class CORE_EXPORT QgsMapLayer : public QObject /** * Assign a legend controller to the map layer. The object will be responsible for providing legend items. - * @param legend Takes ownership of the object. Can be null pointer + * \param legend Takes ownership of the object. Can be null pointer * \since QGIS 2.6 */ void setLegend( QgsMapLayerLegend *legend ); @@ -603,49 +603,49 @@ class CORE_EXPORT QgsMapLayer : public QObject QgsMapLayerStyleManager *styleManager() const; /** Tests whether the layer should be visible at the specified scale. - * @param scale scale denominator to test - * @returns true if the layer is visible at the given scale. + * \param scale scale denominator to test + * \returns true if the layer is visible at the given scale. * \since QGIS 2.16 - * @see minimumScale() - * @see maximumScale() - * @see hasScaleBasedVisibility() + * \see minimumScale() + * \see maximumScale() + * \see hasScaleBasedVisibility() */ bool isInScaleRange( double scale ) const; /** Returns the minimum scale denominator at which the layer is visible. * Scale based visibility is only used if hasScaleBasedVisibility is true. - * @returns minimum scale denominator at which the layer will render - * @see setMinimumScale() - * @see maximumScale() - * @see hasScaleBasedVisibility() - * @see isInScaleRange() + * \returns minimum scale denominator at which the layer will render + * \see setMinimumScale() + * \see maximumScale() + * \see hasScaleBasedVisibility() + * \see isInScaleRange() */ double minimumScale() const; /** Returns the maximum scale denominator at which the layer is visible. * Scale based visibility is only used if hasScaleBasedVisibility is true. - * @returns minimum scale denominator at which the layer will render - * @see setMaximumScale() - * @see minimumScale() - * @see hasScaleBasedVisibility() - * @see isInScaleRange() + * \returns minimum scale denominator at which the layer will render + * \see setMaximumScale() + * \see minimumScale() + * \see hasScaleBasedVisibility() + * \see isInScaleRange() */ double maximumScale() const; /** Returns whether scale based visibility is enabled for the layer. - * @returns true if scale based visibility is enabled - * @see minimumScale() - * @see maximumScale() - * @see setScaleBasedVisibility() - * @see isInScaleRange() + * \returns true if scale based visibility is enabled + * \see minimumScale() + * \see maximumScale() + * \see setScaleBasedVisibility() + * \see isInScaleRange() */ bool hasScaleBasedVisibility() const; /** * Returns true if auto refresh is enabled for the layer. * \since QGIS 3.0 - * @see autoRefreshInterval() - * @see setAutoRefreshEnabled() + * \see autoRefreshInterval() + * \see setAutoRefreshEnabled() */ bool hasAutoRefreshEnabled() const; @@ -653,8 +653,8 @@ class CORE_EXPORT QgsMapLayer : public QObject * Returns the auto refresh interval (in milliseconds). Note that * auto refresh is only active when hasAutoRefreshEnabled() is true. * \since QGIS 3.0 - * @see autoRefreshEnabled() - * @see setAutoRefreshInterval() + * \see autoRefreshEnabled() + * \see setAutoRefreshInterval() */ int autoRefreshInterval() const; @@ -666,16 +666,16 @@ class CORE_EXPORT QgsMapLayer : public QObject * Note that auto refresh triggers deferred repaints of the layer. Any map * canvas must be refreshed separately in order to view the refreshed layer. * \since QGIS 3.0 - * @see autoRefreshInterval() - * @see setAutoRefreshEnabled() + * \see autoRefreshInterval() + * \see setAutoRefreshEnabled() */ void setAutoRefreshInterval( int interval ); /** * Sets whether auto refresh is enabled for the layer. * \since QGIS 3.0 - * @see hasAutoRefreshEnabled() - * @see setAutoRefreshInterval() + * \see hasAutoRefreshEnabled() + * \see setAutoRefreshInterval() */ void setAutoRefreshEnabled( bool enabled ); @@ -686,27 +686,27 @@ class CORE_EXPORT QgsMapLayer : public QObject /** Sets the minimum scale denominator at which the layer will be visible. * Scale based visibility is only used if setScaleBasedVisibility is set to true. - * @param scale minimum scale denominator at which the layer should render - * @see minimumScale - * @see setMaximumScale - * @see setScaleBasedVisibility + * \param scale minimum scale denominator at which the layer should render + * \see minimumScale + * \see setMaximumScale + * \see setScaleBasedVisibility */ void setMinimumScale( double scale ); /** Sets the maximum scale denominator at which the layer will be visible. * Scale based visibility is only used if setScaleBasedVisibility is set to true. - * @param scale maximum scale denominator at which the layer should render - * @see maximumScale - * @see setMinimumScale - * @see setScaleBasedVisibility + * \param scale maximum scale denominator at which the layer should render + * \see maximumScale + * \see setMinimumScale + * \see setScaleBasedVisibility */ void setMaximumScale( double scale ); /** Sets whether scale based visibility is enabled for the layer. - * @param enabled set to true to enable scale based visibility - * @see setMinimumScale - * @see setMaximumScale - * @see scaleBasedVisibility + * \param enabled set to true to enable scale based visibility + * \see setMinimumScale + * \see setMaximumScale + * \see scaleBasedVisibility */ void setScaleBasedVisibility( const bool enabled ); @@ -716,7 +716,7 @@ class CORE_EXPORT QgsMapLayer : public QObject * If \a deferredUpdate is true then the layer will only be repainted when the canvas is next * re-rendered, and will not trigger any canvas redraws itself. * - * @note in 2.6 function moved from vector/raster subclasses to QgsMapLayer + * \note in 2.6 function moved from vector/raster subclasses to QgsMapLayer */ void triggerRepaint( bool deferredUpdate = false ); @@ -733,19 +733,19 @@ class CORE_EXPORT QgsMapLayer : public QObject /** * Sets the list of dependencies. - * @see dependencies() + * \see dependencies() * - * @param layers set of QgsMapLayerDependency. Only user-defined dependencies will be added - * @returns false if a dependency cycle has been detected + * \param layers set of QgsMapLayerDependency. Only user-defined dependencies will be added + * \returns false if a dependency cycle has been detected * \since QGIS 3.0 */ virtual bool setDependencies( const QSet &layers ); /** - * Gets the list of dependencies. This includes data dependencies set by the user (@see setDataDependencies) + * Gets the list of dependencies. This includes data dependencies set by the user (\see setDataDependencies) * as well as dependencies given by the provider * - * @returns a set of QgsMapLayerDependency + * \returns a set of QgsMapLayerDependency * \since QGIS 3.0 */ virtual QSet dependencies() const; @@ -782,7 +782,7 @@ class CORE_EXPORT QgsMapLayer : public QObject void blendModeChanged( QPainter::CompositionMode blendMode ); /** Signal emitted when renderer is changed. - * @see styleChanged() + * \see styleChanged() */ void rendererChanged(); @@ -790,7 +790,7 @@ class CORE_EXPORT QgsMapLayer : public QObject * by renderer changes, label style changes, or other style changes such as blend * mode or layer opacity changes. * \since QGIS 2.16 - * @see rendererChanged() + * \see rendererChanged() */ void styleChanged(); @@ -821,7 +821,7 @@ class CORE_EXPORT QgsMapLayer : public QObject /** * Emitted when the auto refresh interval changes. - * @see setAutoRefreshInterval() + * \see setAutoRefreshInterval() * \since QGIS 3.0 */ void autoRefreshIntervalChanged( int interval ); @@ -845,8 +845,8 @@ class CORE_EXPORT QgsMapLayer : public QObject /** Read custom properties from project file. - @param layerNode note to read from - @param keyStartsWith reads only properties starting with the specified string (or all if the string is empty)*/ + \param layerNode note to read from + \param keyStartsWith reads only properties starting with the specified string (or all if the string is empty)*/ void readCustomProperties( const QDomNode &layerNode, const QString &keyStartsWith = "" ); //! Write custom properties to project file. @@ -971,14 +971,14 @@ Q_DECLARE_METATYPE( QgsMapLayer * ) /** * Weak pointer for QgsMapLayer * \since QGIS 3.0 - * @note not available in Python bindings + * \note not available in Python bindings */ typedef QPointer< QgsMapLayer > QgsWeakMapLayerPointer; /** * A list of weak pointers to QgsMapLayers. * \since QGIS 3.0 - * @note not available in Python bindings + * \note not available in Python bindings */ typedef QList< QgsWeakMapLayerPointer > QgsWeakMapLayerPointerList; diff --git a/src/core/qgsmaplayermodel.h b/src/core/qgsmaplayermodel.h index da3a85c8a7f1..373d482f37ea 100644 --- a/src/core/qgsmaplayermodel.h +++ b/src/core/qgsmaplayermodel.h @@ -26,9 +26,9 @@ class QgsMapLayer; /** \ingroup core - * @brief The QgsMapLayerModel class is a model to display layers in widgets. - * @see QgsMapLayerProxyModel to sort and/filter the layers - * @see QgsFieldModel to combine in with a field selector. + * \brief The QgsMapLayerModel class is a model to display layers in widgets. + * \see QgsMapLayerProxyModel to sort and/filter the layers + * \see QgsFieldModel to combine in with a field selector. * \since QGIS 2.3 */ class CORE_EXPORT QgsMapLayerModel : public QAbstractItemModel @@ -52,62 +52,62 @@ class CORE_EXPORT QgsMapLayerModel : public QAbstractItemModel }; /** - * @brief QgsMapLayerModel creates a model to display layers in widgets. + * \brief QgsMapLayerModel creates a model to display layers in widgets. */ explicit QgsMapLayerModel( QObject *parent = nullptr ); /** - * @brief QgsMapLayerModel creates a model to display a specific list of layers in a widget. + * \brief QgsMapLayerModel creates a model to display a specific list of layers in a widget. */ explicit QgsMapLayerModel( const QList &layers, QObject *parent = nullptr ); /** - * @brief setItemsCheckable defines if layers should be selectable in the widget + * \brief setItemsCheckable defines if layers should be selectable in the widget */ void setItemsCheckable( bool checkable ); /** - * @brief checkAll changes the checkstate for all the layers + * \brief checkAll changes the checkstate for all the layers */ void checkAll( Qt::CheckState checkState ); /** * Sets whether an optional empty layer ("not set") option is present in the model. - * @see allowEmptyLayer() + * \see allowEmptyLayer() * \since QGIS 3.0 */ void setAllowEmptyLayer( bool allowEmpty ); /** * Returns true if the model allows the empty layer ("not set") choice. - * @see setAllowEmptyLayer() + * \see setAllowEmptyLayer() * \since QGIS 3.0 */ bool allowEmptyLayer() const { return mAllowEmpty; } /** * Sets whether the CRS of layers is also included in the model's display role. - * @see showCrs() + * \see showCrs() * \since QGIS 3.0 */ void setShowCrs( bool showCrs ); /** * Returns true if the model includes layer's CRS in the display role. - * @see setShowCrs() + * \see setShowCrs() * \since QGIS 3.0 */ bool showCrs() const { return mShowCrs; } /** - * @brief layersChecked returns the list of layers which are checked (or unchecked) + * \brief layersChecked returns the list of layers which are checked (or unchecked) */ QList layersChecked( Qt::CheckState checkState = Qt::Checked ); //! returns if the items can be checked or not bool itemsCheckable() const { return mItemCheckable; } /** - * @brief indexFromLayer returns the model index for a given layer + * \brief indexFromLayer returns the model index for a given layer */ QModelIndex indexFromLayer( QgsMapLayer *layer ) const; @@ -115,14 +115,14 @@ class CORE_EXPORT QgsMapLayerModel : public QAbstractItemModel * Sets a list of additional (non map layer) items to include at the end of the model. * These may represent additional layers such as layers which are not included in the map * layer registry, or paths to layers which have not yet been loaded into QGIS. - * @see additionalItems() + * \see additionalItems() * \since QGIS 3.0 */ void setAdditionalItems( const QStringList &items ); /** * Return the list of additional (non map layer) items included at the end of the model. - * @see setAdditionalItems() + * \see setAdditionalItems() * \since QGIS 3.0 */ QStringList additionalItems() const { return mAdditionalItems; } @@ -147,7 +147,7 @@ class CORE_EXPORT QgsMapLayerModel : public QAbstractItemModel /** * Returns strings for all roles supported by this model. * - * @note Available only with Qt5 (Python and c++) + * \note Available only with Qt5 (Python and c++) */ QHash roleNames() const override; diff --git a/src/core/qgsmaplayerproxymodel.h b/src/core/qgsmaplayerproxymodel.h index e462fac7713d..76faf3183f24 100644 --- a/src/core/qgsmaplayerproxymodel.h +++ b/src/core/qgsmaplayerproxymodel.h @@ -25,7 +25,7 @@ class QgsMapLayerModel; class QgsMapLayer; /** \ingroup core - * @brief The QgsMapLayerProxyModel class provides an easy to use model to display the list of layers in widgets. + * \brief The QgsMapLayerProxyModel class provides an easy to use model to display the list of layers in widgets. * \since QGIS 2.3 */ class CORE_EXPORT QgsMapLayerProxyModel : public QSortFilterProxyModel @@ -54,19 +54,19 @@ class CORE_EXPORT QgsMapLayerProxyModel : public QSortFilterProxyModel Q_DECLARE_FLAGS( Filters, Filter ) /** - * @brief QgsMapLayerProxModel creates a proxy model with a QgsMapLayerModel as source model. + * \brief QgsMapLayerProxModel creates a proxy model with a QgsMapLayerModel as source model. * It can be used to filter the layers list in a widget. */ explicit QgsMapLayerProxyModel( QObject *parent = nullptr ); /** - * @brief layerModel returns the QgsMapLayerModel used in this QSortFilterProxyModel + * \brief layerModel returns the QgsMapLayerModel used in this QSortFilterProxyModel */ QgsMapLayerModel *sourceLayerModel() const { return mModel; } /** - * @brief setFilters set flags that affect how layers are filtered - * @param filters are Filter flags + * \brief setFilters set flags that affect how layers are filtered + * \param filters are Filter flags * \since QGIS 2.3 */ QgsMapLayerProxyModel *setFilters( QgsMapLayerProxyModel::Filters filters ); @@ -85,13 +85,13 @@ class CORE_EXPORT QgsMapLayerProxyModel : public QSortFilterProxyModel /** * Sets a list of data providers which should be excluded from the model. * \since QGIS 3.0 - * @see excludedProviders() + * \see excludedProviders() */ void setExcludedProviders( const QStringList &providers ); /** * Returns the list of data providers which are excluded from the model. - * @see setExcludedProviders() + * \see setExcludedProviders() * \since QGIS 3.0 */ QStringList excludedProviders() const { return mExcludedProviders; } diff --git a/src/core/qgsmaplayerref.h b/src/core/qgsmaplayerref.h index b5ccb1894b15..2fa6e4e394c8 100644 --- a/src/core/qgsmaplayerref.h +++ b/src/core/qgsmaplayerref.h @@ -22,7 +22,7 @@ /** Internal structure to keep weak pointer to QgsMapLayer or layerId * if the layer is not available yet. - * @note not available in Python bindings + * \note not available in Python bindings */ template struct _LayerRef diff --git a/src/core/qgsmaplayerstylemanager.h b/src/core/qgsmaplayerstylemanager.h index b422769e2e43..b86babfcd4a4 100644 --- a/src/core/qgsmaplayerstylemanager.h +++ b/src/core/qgsmaplayerstylemanager.h @@ -114,22 +114,22 @@ class CORE_EXPORT QgsMapLayerStyleManager : public QObject QgsMapLayerStyle style( const QString &name ) const; //! Add a style with given name and data - //! @return true on success (name is unique and style is valid) + //! \returns true on success (name is unique and style is valid) bool addStyle( const QString &name, const QgsMapLayerStyle &style ); //! Add style by cloning the current one - //! @return true on success + //! \returns true on success bool addStyleFromLayer( const QString &name ); //! Remove a stored style - //! @return true on success (style exists and it is not the last one) + //! \returns true on success (style exists and it is not the last one) bool removeStyle( const QString &name ); //! Rename a stored style to a different name - //! @return true on success (style exists and new name is unique) + //! \returns true on success (style exists and new name is unique) bool renameStyle( const QString &name, const QString &newName ); //! Return name of the current style QString currentStyle() const; //! Set a different style as the current style - will apply it to the layer - //! @return true on success + //! \returns true on success bool setCurrentStyle( const QString &name ); //! Temporarily apply a different style to the layer. The argument diff --git a/src/core/qgsmaprenderercache.h b/src/core/qgsmaprenderercache.h index 14702261678a..a446b96846d8 100644 --- a/src/core/qgsmaprenderercache.h +++ b/src/core/qgsmaprenderercache.h @@ -47,14 +47,14 @@ class CORE_EXPORT QgsMapRendererCache : public QObject /** * Invalidates the cache contents, clearing all cached images. - * @see clearCacheImage() + * \see clearCacheImage() */ void clear(); /** * Initialize cache: set new parameters and clears the cache if any * parameters have changed since last initialization. - * @return flag whether the parameters are the same as last time + * \returns flag whether the parameters are the same as last time */ bool init( const QgsRectangle &extent, double scale ); @@ -64,14 +64,14 @@ class CORE_EXPORT QgsMapRendererCache : public QObject * A list of \a dependentLayers should be passed containing all layer * on which this cache image is dependent. If any of these layers triggers a * repaint then the cache image will be cleared. - * @see cacheImage() + * \see cacheImage() */ void setCacheImage( const QString &cacheKey, const QImage &image, const QList< QgsMapLayer * > &dependentLayers = QList< QgsMapLayer * >() ); /** * Returns true if the cache contains an image with the specified \a cacheKey. * \since QGIS 3.0 - * @see cacheImage() + * \see cacheImage() */ bool hasCacheImage( const QString &cacheKey ) const; @@ -79,8 +79,8 @@ class CORE_EXPORT QgsMapRendererCache : public QObject * Returns the cached image for the specified \a cacheKey. The \a cacheKey usually * matches the QgsMapLayer::id() which the image is a render of. * Returns a null image if it is not cached. - * @see setCacheImage() - * @see hasCacheImage() + * \see setCacheImage() + * \see hasCacheImage() */ QImage cacheImage( const QString &cacheKey ) const; @@ -92,7 +92,7 @@ class CORE_EXPORT QgsMapRendererCache : public QObject /** * Removes an image from the cache with matching \a cacheKey. - * @see clear() + * \see clear() */ void clearCacheImage( const QString &cacheKey ); diff --git a/src/core/qgsmaprenderercustompainterjob.h b/src/core/qgsmaprenderercustompainterjob.h index c5f9b5fba635..9fd97a8e1c64 100644 --- a/src/core/qgsmaprenderercustompainterjob.h +++ b/src/core/qgsmaprenderercustompainterjob.h @@ -45,7 +45,7 @@ class CORE_EXPORT QgsMapRendererCustomPainterJob : public QgsMapRendererJob virtual bool usedCachedLabels() const override; virtual QgsLabelingResults *takeLabelingResults() override; - //! @note not available in Python bindings + //! \note not available in Python bindings const LayerRenderJobs &jobs() const { return mLayerJobs; } /** diff --git a/src/core/qgsmaprendererjob.h b/src/core/qgsmaprendererjob.h index 53e0722eeefc..611400938509 100644 --- a/src/core/qgsmaprendererjob.h +++ b/src/core/qgsmaprendererjob.h @@ -140,7 +140,7 @@ class CORE_EXPORT QgsMapRendererJob : public QObject * Returns true if the render job was able to use a cached labeling solution. * If so, any previously stored labeling results (see takeLabelingResults()) * should be retained. - * @see takeLabelingResults() + * \see takeLabelingResults() * \since QGIS 3.0 */ virtual bool usedCachedLabels() const = 0; @@ -148,7 +148,7 @@ class CORE_EXPORT QgsMapRendererJob : public QObject /** * Get pointer to internal labeling engine (in order to get access to the results). * This should not be used if cached labeling was redrawn - see usedCachedLabels(). - * @see usedCachedLabels() + * \see usedCachedLabels() */ virtual QgsLabelingResults *takeLabelingResults() = 0; @@ -186,7 +186,7 @@ class CORE_EXPORT QgsMapRendererJob : public QObject void setCache( QgsMapRendererCache *cache ); //! Set which vector layers should be cached while rendering - //! @note The way how geometries are cached is really suboptimal - this method may be removed in future releases + //! \note The way how geometries are cached is really suboptimal - this method may be removed in future releases void setRequestedGeometryCacheForLayers( const QStringList &layerIds ) { mRequestedGeomCacheForLayers = layerIds; } //! Find out how long it took to finish the job (in milliseconds) @@ -194,14 +194,14 @@ class CORE_EXPORT QgsMapRendererJob : public QObject /** * Return map settings with which this job was started. - * @return A QgsMapSettings instance with render settings + * \returns A QgsMapSettings instance with render settings * \since QGIS 2.8 */ const QgsMapSettings &mapSettings() const; /** * QgsMapRendererCache ID string for cached label image. - * @note not available in Python bindings + * \note not available in Python bindings */ static const QString LABEL_CACHE_ID; @@ -232,38 +232,38 @@ class CORE_EXPORT QgsMapRendererJob : public QObject /** * Prepares the cache for storing the result of labeling. Returns false if * the render cannot use cached labels and should not cache the result. - * @note not available in Python bindings + * \note not available in Python bindings */ bool prepareLabelCache() const; - //! @note not available in Python bindings + //! \note not available in Python bindings LayerRenderJobs prepareJobs( QPainter *painter, QgsLabelingEngine *labelingEngine2 ); /** * Prepares a labeling job. - * @note not available in Python bindings + * \note not available in Python bindings * \since QGIS 3.0 */ LabelRenderJob prepareLabelingJob( QPainter *painter, QgsLabelingEngine *labelingEngine2, bool canUseLabelCache = true ); - //! @note not available in Python bindings + //! \note not available in Python bindings static QImage composeImage( const QgsMapSettings &settings, const LayerRenderJobs &jobs, const LabelRenderJob &labelJob ); - //! @note not available in Python bindings + //! \note not available in Python bindings void logRenderingTime( const LayerRenderJobs &jobs, const LabelRenderJob &labelJob ); - //! @note not available in Python bindings + //! \note not available in Python bindings void cleanupJobs( LayerRenderJobs &jobs ); /** * Handles clean up tasks for a label job, including deletion of images and storing cached * label results. * \since QGIS 3.0 - * @note not available in Python bindings + * \note not available in Python bindings */ void cleanupLabelJob( LabelRenderJob &job ); - //! @note not available in Python bindings + //! \note not available in Python bindings static void drawLabeling( const QgsMapSettings &settings, QgsRenderContext &renderContext, QgsLabelingEngine *labelingEngine2, QPainter *painter ); private: diff --git a/src/core/qgsmaprendererparalleljob.h b/src/core/qgsmaprendererparalleljob.h index 0542b4722336..73541eb8b304 100644 --- a/src/core/qgsmaprendererparalleljob.h +++ b/src/core/qgsmaprendererparalleljob.h @@ -54,14 +54,14 @@ class CORE_EXPORT QgsMapRendererParallelJob : public QgsMapRendererQImageJob private: - //! @note not available in Python bindings + //! \note not available in Python bindings static void renderLayerStatic( LayerRenderJob &job ); - //! @note not available in Python bindings + //! \note not available in Python bindings static void renderLabelsStatic( QgsMapRendererParallelJob *self ); QImage mFinalImage; - //! @note not available in Python bindings + //! \note not available in Python bindings enum { Idle, RenderingLayers, RenderingLabels } mStatus; QFuture mFuture; diff --git a/src/core/qgsmapsettings.h b/src/core/qgsmapsettings.h index 3a1547344214..e7ec1b9fd461 100644 --- a/src/core/qgsmapsettings.h +++ b/src/core/qgsmapsettings.h @@ -91,15 +91,15 @@ class CORE_EXPORT QgsMapSettings /** * Set the magnification factor. - * @param factor the factor of magnification + * \param factor the factor of magnification * \since QGIS 2.16 - * @see magnificationFactor() + * \see magnificationFactor() */ void setMagnificationFactor( double factor ); //! Return the magnification factor. //! \since QGIS 2.16 - //! @see setMagnificationFactor() + //! \see setMagnificationFactor() double magnificationFactor() const; //! Get list of layer IDs for map rendering @@ -120,16 +120,16 @@ class CORE_EXPORT QgsMapSettings void setLayerStyleOverrides( const QMap &overrides ); /** Get custom rendering flags. Layers might honour these to alter their rendering. - * @returns custom flags strings, separated by ';' + * \returns custom flags strings, separated by ';' * \since QGIS 2.16 - * @see setCustomRenderFlags() + * \see setCustomRenderFlags() */ QString customRenderFlags() const { return mCustomRenderFlags; } /** Sets the custom rendering flags. Layers might honour these to alter their rendering. - * @param customRenderFlags custom flags strings, separated by ';' + * \param customRenderFlags custom flags strings, separated by ';' * \since QGIS 2.16 - * @see customRenderFlags() + * \see customRenderFlags() */ void setCustomRenderFlags( const QString &customRenderFlags ) { mCustomRenderFlags = customRenderFlags; } @@ -196,77 +196,77 @@ class CORE_EXPORT QgsMapSettings /** Sets the expression context. This context is used for all expression evaluation * associated with this map settings. - * @see expressionContext() + * \see expressionContext() * \since QGIS 2.12 */ void setExpressionContext( const QgsExpressionContext &context ) { mExpressionContext = context; } /** Gets the expression context. This context should be used for all expression evaluation * associated with this map settings. - * @see setExpressionContext() + * \see setExpressionContext() * \since QGIS 2.12 */ const QgsExpressionContext &expressionContext() const { return mExpressionContext; } // -- utility functions -- - //! @note not available in Python bindings + //! \note not available in Python bindings const QgsDatumTransformStore &datumTransformStore() const { return mDatumTransformStore; } QgsDatumTransformStore &datumTransformStore() { return mDatumTransformStore; } const QgsMapToPixel &mapToPixel() const { return mMapToPixel; } /** Computes an *estimated* conversion factor between layer and map units: layerUnits * layerToMapUnits = mapUnits - * @param layer The layer - * @param referenceExtent A reference extent based on which to perform the computation. If not specified, the layer extent is used + * \param layer The layer + * \param referenceExtent A reference extent based on which to perform the computation. If not specified, the layer extent is used * \since QGIS 2.12 */ double layerToMapUnits( const QgsMapLayer *layer, const QgsRectangle &referenceExtent = QgsRectangle() ) const; /** - * @brief transform bounding box from layer's CRS to output CRS - * @see layerToMapCoordinates( QgsMapLayer* layer, QgsRectangle rect ) if you want to transform a rectangle - * @return a bounding box (aligned rectangle) containing the transformed extent + * \brief transform bounding box from layer's CRS to output CRS + * \see layerToMapCoordinates( QgsMapLayer* layer, QgsRectangle rect ) if you want to transform a rectangle + * \returns a bounding box (aligned rectangle) containing the transformed extent */ QgsRectangle layerExtentToOutputExtent( const QgsMapLayer *layer, QgsRectangle extent ) const; /** - * @brief transform bounding box from output CRS to layer's CRS - * @see mapToLayerCoordinates( QgsMapLayer* layer,QgsRectangle rect ) if you want to transform a rectangle - * @return a bounding box (aligned rectangle) containing the transformed extent + * \brief transform bounding box from output CRS to layer's CRS + * \see mapToLayerCoordinates( QgsMapLayer* layer,QgsRectangle rect ) if you want to transform a rectangle + * \returns a bounding box (aligned rectangle) containing the transformed extent */ QgsRectangle outputExtentToLayerExtent( const QgsMapLayer *layer, QgsRectangle extent ) const; /** - * @brief transform point coordinates from layer's CRS to output CRS - * @return the transformed point + * \brief transform point coordinates from layer's CRS to output CRS + * \returns the transformed point */ QgsPoint layerToMapCoordinates( const QgsMapLayer *layer, QgsPoint point ) const; /** - * @brief transform rectangle from layer's CRS to output CRS - * @see layerExtentToOutputExtent() if you want to transform a bounding box - * @return the transformed rectangle + * \brief transform rectangle from layer's CRS to output CRS + * \see layerExtentToOutputExtent() if you want to transform a bounding box + * \returns the transformed rectangle */ QgsRectangle layerToMapCoordinates( const QgsMapLayer *layer, QgsRectangle rect ) const; /** - * @brief transform point coordinates from output CRS to layer's CRS - * @return the transformed point + * \brief transform point coordinates from output CRS to layer's CRS + * \returns the transformed point */ QgsPoint mapToLayerCoordinates( const QgsMapLayer *layer, QgsPoint point ) const; /** - * @brief transform rectangle from output CRS to layer's CRS - * @see outputExtentToLayerExtent() if you want to transform a bounding box - * @return the transformed rectangle + * \brief transform rectangle from output CRS to layer's CRS + * \see outputExtentToLayerExtent() if you want to transform a bounding box + * \returns the transformed rectangle */ QgsRectangle mapToLayerCoordinates( const QgsMapLayer *layer, QgsRectangle rect ) const; /** - * @brief Return coordinate transform from layer's CRS to destination CRS - * @param layer - * @return transform - may be invalid if the transform is not needed + * \brief Return coordinate transform from layer's CRS to destination CRS + * \param layer + * \returns transform - may be invalid if the transform is not needed */ QgsCoordinateTransform layerTransform( const QgsMapLayer *layer ) const; @@ -280,13 +280,13 @@ class CORE_EXPORT QgsMapSettings void writeXml( QDomNode &node, QDomDocument &doc ); /** Sets the segmentation tolerance applied when rendering curved geometries - @param tolerance the segmentation tolerance*/ + \param tolerance the segmentation tolerance*/ void setSegmentationTolerance( double tolerance ) { mSegmentationTolerance = tolerance; } //! Gets the segmentation tolerance applied when rendering curved geometries double segmentationTolerance() const { return mSegmentationTolerance; } /** Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) - @param type the segmentation tolerance typename*/ + \param type the segmentation tolerance typename*/ void setSegmentationToleranceType( QgsAbstractGeometry::SegmentationToleranceType type ) { mSegmentationToleranceType = type; } //! Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) QgsAbstractGeometry::SegmentationToleranceType segmentationToleranceType() const { return mSegmentationToleranceType; } diff --git a/src/core/qgsmapthemecollection.h b/src/core/qgsmapthemecollection.h index 1b58abf420c8..12b14ec4a243 100644 --- a/src/core/qgsmapthemecollection.h +++ b/src/core/qgsmapthemecollection.h @@ -122,7 +122,7 @@ class CORE_EXPORT QgsMapThemeCollection : public QObject void addLayerRecord( const MapThemeLayerRecord &record ); //! Return set with only records for valid layers - //! @note not available in Python bindings + //! \note not available in Python bindings QHash validLayerRecords() const; private: @@ -145,15 +145,15 @@ class CORE_EXPORT QgsMapThemeCollection : public QObject /** * Inserts a new map theme to the collection. - * @see update() + * \see update() */ void insert( const QString &name, const MapThemeRecord &state ); /** * Updates a map theme within the collection. - * @param name name of map theme to update - * @param state map theme record to replace existing map theme - * @see insert() + * \param name name of map theme to update + * \param state map theme record to replace existing map theme + * \see insert() */ void update( const QString &name, const MapThemeRecord &state ); @@ -181,7 +181,7 @@ class CORE_EXPORT QgsMapThemeCollection : public QObject /** * Returns the list of layer IDs that are visible for the specified map theme. * - * @note The order of the returned list is not guaranteed to reflect the order of layers + * \note The order of the returned list is not guaranteed to reflect the order of layers * in the canvas. * \since QGIS 3.0 */ @@ -190,7 +190,7 @@ class CORE_EXPORT QgsMapThemeCollection : public QObject /** * Returns the list of layers that are visible for the specified map theme. * - * @note The order of the returned list is not guaranteed to reflect the order of layers + * \note The order of the returned list is not guaranteed to reflect the order of layers * in the canvas. * \since QGIS 3.0 */ @@ -204,14 +204,14 @@ class CORE_EXPORT QgsMapThemeCollection : public QObject /** * Reads the map theme collection state from XML - * @param doc DOM document - * @see writeXml + * \param doc DOM document + * \see writeXml */ void readXml( const QDomDocument &doc ); /** Writes the map theme collection state to XML. - * @param doc DOM document - * @see readXml + * \param doc DOM document + * \see readXml */ void writeXml( QDomDocument &doc ); @@ -246,7 +246,7 @@ class CORE_EXPORT QgsMapThemeCollection : public QObject * Returns the master layer order (this will always match the project's QgsProject::layerOrder() ). * All map themes will maintain the same layer order as the master layer order. * \since QGIS 3.0 - * @see masterVisibleLayers() + * \see masterVisibleLayers() */ QList< QgsMapLayer * > masterLayerOrder() const; @@ -255,7 +255,7 @@ class CORE_EXPORT QgsMapThemeCollection : public QObject * of masterLayerOrder(), but the returned layers are filtered to only include those visible * in the project's layer tree. * \since QGIS 3.0 - * @see masterLayerOrder() + * \see masterLayerOrder() */ QList< QgsMapLayer * > masterVisibleLayers() const; diff --git a/src/core/qgsmaptopixel.h b/src/core/qgsmaptopixel.h index 1cade03afb64..38e6cdc21497 100644 --- a/src/core/qgsmaptopixel.h +++ b/src/core/qgsmaptopixel.h @@ -37,27 +37,27 @@ class CORE_EXPORT QgsMapToPixel /** * Constructor - * @param mapUnitsPerPixel Map units per pixel - * @param centerX X coordinate of map center, in geographical units - * @param centerY Y coordinate of map center, in geographical units - * @param widthPixels Output width, in pixels - * @param heightPixels Output height, in pixels - * @param rotation clockwise rotation in degrees + * \param mapUnitsPerPixel Map units per pixel + * \param centerX X coordinate of map center, in geographical units + * \param centerY Y coordinate of map center, in geographical units + * \param widthPixels Output width, in pixels + * \param heightPixels Output height, in pixels + * \param rotation clockwise rotation in degrees * \since QGIS 2.8 */ QgsMapToPixel( double mapUnitsPerPixel, double centerX, double centerY, int widthPixels, int heightPixels, double rotation ); /** * Constructor - * @param mapUnitsPerPixel Map units per pixel + * \param mapUnitsPerPixel Map units per pixel */ QgsMapToPixel( double mapUnitsPerPixel ); /** Returns a new QgsMapToPixel created using a specified scale and distance unit. - * @param scale map scale - * @param dpi screen DPI - * @param mapUnits map units - * @returns matching QgsMapToPixel + * \param scale map scale + * \param dpi screen DPI + * \param mapUnits map units + * \returns matching QgsMapToPixel * \since QGIS 3.0 */ static QgsMapToPixel fromScale( double scale, QgsUnitTypes::DistanceUnit mapUnits, double dpi = 96 ); @@ -71,8 +71,8 @@ class CORE_EXPORT QgsMapToPixel /** * Transform the point from map (world) coordinates to device coordinates - * @param p Point to transform - * @return QgsPoint in device coordinates + * \param p Point to transform + * \returns QgsPoint in device coordinates */ QgsPoint transform( const QgsPoint &p ) const; @@ -81,9 +81,9 @@ class CORE_EXPORT QgsMapToPixel /** * Transform the point specified by x,y from map (world) * coordinates to device coordinates - * @param x x cordinate o point to transform - * @param y y coordinate of point to transform - * @return QgsPoint in device coordinates + * \param x x cordinate o point to transform + * \param y y coordinate of point to transform + * \returns QgsPoint in device coordinates */ QgsPoint transform( qreal x, qreal y ) const; @@ -94,14 +94,14 @@ class CORE_EXPORT QgsMapToPixel */ void transformInPlace( double &x, double &y ) const; - // @note not available in Python bindings + // \note not available in Python bindings void transformInPlace( float &x, float &y ) const; /** * Transform device coordinates to map coordinates. Modifies the * given coordinates in place. Intended as a fast way to do the * transform. - * @note not available in Python bindings + * \note not available in Python bindings */ template void transformInPlace( QVector &x, QVector &y ) const @@ -118,8 +118,8 @@ class CORE_EXPORT QgsMapToPixel /** * Transform device coordinates to map (world) coordinates - * @param p Point to be converted to map cooordinates - * @return QgsPoint in map coorndiates + * \param p Point to be converted to map cooordinates + * \returns QgsPoint in map coorndiates */ QgsPoint toMapCoordinates( QPoint p ) const; @@ -127,7 +127,7 @@ class CORE_EXPORT QgsMapToPixel /** * Set map units per pixel - * @param mapUnitsPerPixel Map units per pixel + * \param mapUnitsPerPixel Map units per pixel */ void setMapUnitsPerPixel( double mapUnitsPerPixel ); @@ -149,9 +149,9 @@ class CORE_EXPORT QgsMapToPixel /** * Set map rotation in degrees (clockwise) - * @param degrees clockwise rotation in degrees - * @param cx X ordinate of map center in geographical units - * @param cy Y ordinate of map center in geographical units + * \param degrees clockwise rotation in degrees + * \param cx X ordinate of map center in geographical units + * \param cy Y ordinate of map center in geographical units * \since QGIS 2.8 */ void setMapRotation( double degrees, double cx, double cy ); @@ -164,12 +164,12 @@ class CORE_EXPORT QgsMapToPixel /** * Set parameters for use in transforming coordinates - * @param mapUnitsPerPixel Map units per pixel - * @param centerX X coordinate of map center, in geographical units - * @param centerY Y coordinate of map center, in geographical units - * @param widthPixels Output width, in pixels - * @param heightPixels Output height, in pixels - * @param rotation clockwise rotation in degrees + * \param mapUnitsPerPixel Map units per pixel + * \param centerX X coordinate of map center, in geographical units + * \param centerY Y coordinate of map center, in geographical units + * \param widthPixels Output width, in pixels + * \param heightPixels Output height, in pixels + * \param rotation clockwise rotation in degrees * \since QGIS 2.8 */ void setParameters( double mapUnitsPerPixel, double centerX, double centerY, int widthPixels, int heightPixels, double rotation ); @@ -180,13 +180,13 @@ class CORE_EXPORT QgsMapToPixel QTransform transform() const; /** Returns the center x-coordinate for the transform. - * @see yCenter() + * \see yCenter() * \since QGIS 3.0 */ double xCenter() const { return mXCenter; } /** Returns the center y-coordinate for the transform. - * @see xCenter() + * \see xCenter() * \since QGIS 3.0 */ double yCenter() const { return mYCenter; } diff --git a/src/core/qgsmaptopixelgeometrysimplifier.cpp b/src/core/qgsmaptopixelgeometrysimplifier.cpp index 9a1a00825c9b..d6f001039cf1 100644 --- a/src/core/qgsmaptopixelgeometrysimplifier.cpp +++ b/src/core/qgsmaptopixelgeometrysimplifier.cpp @@ -37,7 +37,6 @@ QgsMapToPixelSimplifier::QgsMapToPixelSimplifier( int simplifyFlags, double tole ////////////////////////////////////////////////////////////////////////////////////////////// // Helper simplification methods -//! Returns the squared 2D-distance of the vector defined by the two points specified float QgsMapToPixelSimplifier::calculateLengthSquared2D( double x1, double y1, double x2, double y2 ) { float vx = static_cast< float >( x2 - x1 ); @@ -46,7 +45,6 @@ float QgsMapToPixelSimplifier::calculateLengthSquared2D( double x1, double y1, d return ( vx * vx ) + ( vy * vy ); } -//! Returns whether the points belong to the same grid bool QgsMapToPixelSimplifier::equalSnapToGrid( double x1, double y1, double x2, double y2, double gridOriginX, double gridOriginY, float gridInverseSizeXY ) { int grid_x1 = qRound( ( x1 - gridOriginX ) * gridInverseSizeXY ); @@ -114,7 +112,6 @@ static T *createEmptySameTypeGeom( const T &geom ) return output; } -//! Simplify the WKB-geometry using the specified tolerance QgsGeometry QgsMapToPixelSimplifier::simplifyGeometry( int simplifyFlags, SimplifyAlgorithm simplifyAlgorithm, @@ -297,14 +294,12 @@ QgsGeometry QgsMapToPixelSimplifier::simplifyGeometry( ////////////////////////////////////////////////////////////////////////////////////////////// -//! Returns whether the envelope can be replaced by its BBOX when is applied the specified map2pixel context bool QgsMapToPixelSimplifier::isGeneralizableByMapBoundingBox( const QgsRectangle &envelope, double map2pixelTol ) { // Can replace the geometry by its BBOX ? return envelope.width() < map2pixelTol && envelope.height() < map2pixelTol; } -//! Returns a simplified version the specified geometry (Removing duplicated points) when is applied the specified map2pixel context QgsGeometry QgsMapToPixelSimplifier::simplify( const QgsGeometry &geometry ) const { if ( geometry.isNull() ) diff --git a/src/core/qgsmapunitscale.h b/src/core/qgsmapunitscale.h index 31c83875efb5..782e7654079b 100644 --- a/src/core/qgsmapunitscale.h +++ b/src/core/qgsmapunitscale.h @@ -38,8 +38,8 @@ class CORE_EXPORT QgsMapUnitScale public: /** Constructor for QgsMapUnitScale - * @param minScale minimum allowed scale, or 0.0 if no minimum scale set - * @param maxScale maximum allowed scale, or 0.0 if no maximum scale set + * \param minScale minimum allowed scale, or 0.0 if no minimum scale set + * \param maxScale maximum allowed scale, or 0.0 if no maximum scale set */ explicit QgsMapUnitScale( double minScale = 0.0, double maxScale = 0.0 ) : minScale( minScale ) @@ -66,8 +66,8 @@ class CORE_EXPORT QgsMapUnitScale /** Computes a map units per pixel scaling factor, respecting the minimum and maximum scales * set for the object. - * @param c render context - * @returns map units per pixel, limited between minimum and maximum scales + * \param c render context + * \returns map units per pixel, limited between minimum and maximum scales */ double computeMapUnitsPerPixel( const QgsRenderContext &c ) const; diff --git a/src/core/qgsmargins.h b/src/core/qgsmargins.h index f8e2fd122fe0..5383f145cc12 100644 --- a/src/core/qgsmargins.h +++ b/src/core/qgsmargins.h @@ -45,10 +45,10 @@ class CORE_EXPORT QgsMargins /** * Constructs margins with the given \a left, \a top, \a right, \a bottom - * @see setLeft() - * @see setRight() - * @see setTop() - * @see setBottom() + * \see setLeft() + * \see setRight() + * \see setTop() + * \see setBottom() */ QgsMargins( double left, double top, double right, double bottom ) : mLeft( left ) @@ -67,49 +67,49 @@ class CORE_EXPORT QgsMargins /** * Returns the left margin. - * @see setLeft() + * \see setLeft() */ double left() const { return mLeft; } /** * Returns the top margin. - * @see setTop() + * \see setTop() */ double top() const { return mTop; } /** * Returns the right margin. - * @see setRight() + * \see setRight() */ double right() const { return mRight; } /** * Returns the bottom margin. - * @see setBottom() + * \see setBottom() */ double bottom() const { return mBottom; } /** * Sets the left margin to \a left. - * @see left() + * \see left() */ void setLeft( double left ) { mLeft = left; } /** * Sets the top margin to \a top. - * @see top() + * \see top() */ void setTop( double top ) { mTop = top; } /** * Sets the right margin to \a right. - * @see right() + * \see right() */ void setRight( double right ) { mRight = right; } /** * Sets the bottom margin to \a bottom. - * @see bottom() + * \see bottom() */ void setBottom( double bottom ) { mBottom = bottom; } @@ -150,14 +150,14 @@ class CORE_EXPORT QgsMargins /** * Returns the margins encoded to a string. - * @see fromString() + * \see fromString() */ QString toString() const; /** * Returns a QgsMargins object decoded from a string, or a null QgsMargins * if the string could not be interpreted as margins. - * @see toString() + * \see toString() */ static QgsMargins fromString( const QString &string ); diff --git a/src/core/qgsmessageoutput.h b/src/core/qgsmessageoutput.h index 3343b41ebfe2..f605a42a51a5 100644 --- a/src/core/qgsmessageoutput.h +++ b/src/core/qgsmessageoutput.h @@ -64,7 +64,7 @@ class CORE_EXPORT QgsMessageOutput static void showMessage( const QString &title, const QString &message, MessageType msgType ); //! sets function that will be used to create message output - //! @note not available in Python bindings + //! \note not available in Python bindings // TODO: implementation where Python class could be passed static void setMessageOutputCreator( MESSAGE_OUTPUT_CREATOR f ); diff --git a/src/core/qgsmultirenderchecker.h b/src/core/qgsmultirenderchecker.h index a57d285f9321..b6ef3e89f8cc 100644 --- a/src/core/qgsmultirenderchecker.h +++ b/src/core/qgsmultirenderchecker.h @@ -69,14 +69,14 @@ class CORE_EXPORT QgsMultiRenderChecker * Set the path to the rendered image. If this is not set or set to QString::Null, an image * will be rendered based on the provided mapsettings * - * @param renderedImagePath A path to the rendered image with which control images will be compared + * \param renderedImagePath A path to the rendered image with which control images will be compared */ void setRenderedImage( const QString &renderedImagePath ) { mRenderedImage = renderedImagePath; } /** * Set the map settings to use to render the image * - * @param mapSettings The map settings + * \param mapSettings The map settings */ void setMapSettings( const QgsMapSettings &mapSettings ); @@ -84,7 +84,7 @@ class CORE_EXPORT QgsMultiRenderChecker * Set tolerance for color components used by runTest() * Default value is 0. * - * @param colorTolerance The maximum difference for each color component + * \param colorTolerance The maximum difference for each color component * including alpha to be considered correct. */ void setColorTolerance( unsigned int colorTolerance ) { mColorTolerance = colorTolerance; } @@ -92,28 +92,28 @@ class CORE_EXPORT QgsMultiRenderChecker /** * Test using renderer to generate the image to be compared. * - * @param testName - to be used as the basis for writing a file to + * \param testName - to be used as the basis for writing a file to * e.g. /tmp/theTestName.png * - * @param mismatchCount - defaults to 0 - the number of pixels that + * \param mismatchCount - defaults to 0 - the number of pixels that * are allowed to be different from the control image. In some cases * rendering may be non-deterministic. This parameter allows you to account * for that by providing a tolerance. * - * @note make sure to call setExpectedImage and setMapSettings first + * \note make sure to call setExpectedImage and setMapSettings first */ bool runTest( const QString &testName, unsigned int mismatchCount = 0 ); /** * Returns a report for this test * - * @return A report + * \returns A report */ QString report() const { return mReport; } /** - * @brief controlImagePath - * @return + * \brief controlImagePath + * \returns */ QString controlImagePath() const; diff --git a/src/core/qgsnetworkcontentfetcher.h b/src/core/qgsnetworkcontentfetcher.h index c3e245368677..b83e90edf9a9 100644 --- a/src/core/qgsnetworkcontentfetcher.h +++ b/src/core/qgsnetworkcontentfetcher.h @@ -45,17 +45,17 @@ class CORE_EXPORT QgsNetworkContentFetcher : public QObject /** Fetches content from a remote URL and handles redirects. The finished() * signal will be emitted when content has been fetched. - * @param url URL to fetch + * \param url URL to fetch */ void fetchContent( const QUrl &url ); /** Returns a reference to the network reply - * @returns QNetworkReply for fetched URL content + * \returns QNetworkReply for fetched URL content */ QNetworkReply *reply(); /** Returns the fetched content as a string - * @returns string containing network content + * \returns string containing network content */ QString contentAsString() const; @@ -72,8 +72,8 @@ class CORE_EXPORT QgsNetworkContentFetcher : public QObject bool mContentLoaded; /** Tries to create a text codec for decoding html content. Works around bugs in Qt's built in method. - * @param array input html byte array - * @returns QTextCodec for html content, if detected + * \param array input html byte array + * \returns QTextCodec for html content, if detected */ QTextCodec *codecForHtml( QByteArray &array ) const; diff --git a/src/core/qgsnetworkdiskcache.h b/src/core/qgsnetworkdiskcache.h index 90d417530109..ad48a059d2f5 100644 --- a/src/core/qgsnetworkdiskcache.h +++ b/src/core/qgsnetworkdiskcache.h @@ -27,7 +27,7 @@ class QNetworkDiskCache; * Wrapper implementation of QNetworkDiskCache with all methods guarded by a * mutex soly for internal use of QgsNetworkAccessManagers * - * @note not available in Python bindings + * \note not available in Python bindings */ class QgsNetworkDiskCache : public QNetworkDiskCache { @@ -35,48 +35,48 @@ class QgsNetworkDiskCache : public QNetworkDiskCache public: - //! @see QNetworkDiskCache::cacheDirectory + //! \see QNetworkDiskCache::cacheDirectory QString cacheDirectory() const; - //! @see QNetworkDiskCache::setCacheDirectory + //! \see QNetworkDiskCache::setCacheDirectory void setCacheDirectory( const QString &cacheDir ); - //! @see QNetworkDiskCache::maximumCacheSize() + //! \see QNetworkDiskCache::maximumCacheSize() qint64 maximumCacheSize() const; - //! @see QNetworkDiskCache::setMaximumCacheSize() + //! \see QNetworkDiskCache::setMaximumCacheSize() void setMaximumCacheSize( qint64 size ); - //! @see QNetworkDiskCache::metaData() + //! \see QNetworkDiskCache::metaData() QNetworkCacheMetaData metaData( const QUrl &url ) override; - //! @see QNetworkDiskCache::updateMetaData() + //! \see QNetworkDiskCache::updateMetaData() void updateMetaData( const QNetworkCacheMetaData &metaData ) override; - //! @see QNetworkDiskCache::data() + //! \see QNetworkDiskCache::data() QIODevice *data( const QUrl &url ) override; - //! @see QNetworkDiskCache::remove() + //! \see QNetworkDiskCache::remove() bool remove( const QUrl &url ) override; - //! @see QNetworkDiskCache::cacheSize() + //! \see QNetworkDiskCache::cacheSize() qint64 cacheSize() const override; - //! @see QNetworkDiskCache::prepare() + //! \see QNetworkDiskCache::prepare() QIODevice *prepare( const QNetworkCacheMetaData &metaData ) override; - //! @see QNetworkDiskCache::insert() + //! \see QNetworkDiskCache::insert() void insert( QIODevice *device ) override; - //! @see QNetworkDiskCache::fileMetaData() + //! \see QNetworkDiskCache::fileMetaData() QNetworkCacheMetaData fileMetaData( const QString &fileName ) const; public slots: - //! @see QNetworkDiskCache::clear() + //! \see QNetworkDiskCache::clear() void clear() override; protected: - //! @see QNetworkDiskCache::expire() + //! \see QNetworkDiskCache::expire() virtual qint64 expire() override; private: diff --git a/src/core/qgsnetworkreplyparser.h b/src/core/qgsnetworkreplyparser.h index 49a3f8a916df..3eefca663f70 100644 --- a/src/core/qgsnetworkreplyparser.h +++ b/src/core/qgsnetworkreplyparser.h @@ -41,29 +41,29 @@ class CORE_EXPORT QgsNetworkReplyParser : public QObject typedef QMap RawHeaderMap; /** Constructor - * @param reply */ + * \param reply */ QgsNetworkReplyParser( QNetworkReply *reply ); /** Indicates if successfully parsed - * @return true if successfully parsed */ + * \returns true if successfully parsed */ bool isValid() const { return mValid; } /** Get number of parts - * @return number of parts */ + * \returns number of parts */ int parts() const { return mHeaders.size(); } /** Get part header - * @param part part index - * @param headerName header name - * @return raw header */ + * \param part part index + * \param headerName header name + * \returns raw header */ QByteArray rawHeader( int part, const QByteArray &headerName ) const { return mHeaders.value( part ).value( headerName ); } //! Get headers QList< RawHeaderMap > headers() const { return mHeaders; } /** Get part part body - * @param part part index - * @return part body */ + * \param part part index + * \returns part body */ QByteArray body( int part ) const { return mBodies.value( part ); } //! Get bodies @@ -73,7 +73,7 @@ class CORE_EXPORT QgsNetworkReplyParser : public QObject QString error() const { return mError; } /** Test if reply is multipart. - * @return true if reply is multipart */ + * \returns true if reply is multipart */ static bool isMultipart( QNetworkReply *reply ); private: diff --git a/src/core/qgsobjectcustomproperties.h b/src/core/qgsobjectcustomproperties.h index 674a981d8a7b..87d031618915 100644 --- a/src/core/qgsobjectcustomproperties.h +++ b/src/core/qgsobjectcustomproperties.h @@ -50,8 +50,8 @@ class CORE_EXPORT QgsObjectCustomProperties /** Read store contents from XML - @param parentNode node to read from - @param keyStartsWith reads only properties starting with the specified string (or all if the string is empty) + \param parentNode node to read from + \param keyStartsWith reads only properties starting with the specified string (or all if the string is empty) */ void readXml( const QDomNode &parentNode, const QString &keyStartsWith = QString() ); diff --git a/src/core/qgsofflineediting.h b/src/core/qgsofflineediting.h index 54b562f1f638..c7f57082469d 100644 --- a/src/core/qgsofflineediting.h +++ b/src/core/qgsofflineediting.h @@ -51,10 +51,10 @@ class CORE_EXPORT QgsOfflineEditing : public QObject QgsOfflineEditing(); /** Convert current project for offline editing - * @param offlineDataPath Path to offline db file - * @param offlineDbFile Offline db file name - * @param layerIds List of layer names to convert - * @param onlySelected Only copy selected features from layers where a selection is present + * \param offlineDataPath Path to offline db file + * \param offlineDbFile Offline db file name + * \param layerIds List of layer names to convert + * \param onlySelected Only copy selected features from layers where a selection is present */ bool convertToOfflineProject( const QString &offlineDataPath, const QString &offlineDbFile, const QStringList &layerIds, bool onlySelected = false ); @@ -69,19 +69,19 @@ class CORE_EXPORT QgsOfflineEditing : public QObject void progressStarted(); /** Emit a signal that the next layer of numLayers has started processing - * @param layer current layer index - * @param numLayers total number of layers + * \param layer current layer index + * \param numLayers total number of layers */ void layerProgressUpdated( int layer, int numLayers ); /** Emit a signal that sets the mode for the progress of the current operation - * @param mode progress mode - * @param maximum total number of entities to process in the current operation + * \param mode progress mode + * \param maximum total number of entities to process in the current operation */ void progressModeSet( QgsOfflineEditing::ProgressMode mode, int maximum ); /** Emit a signal with the progress of the current mode - * @param progress current index of processed entities + * \param progress current index of processed entities */ void progressUpdated( int progress ); @@ -90,8 +90,8 @@ class CORE_EXPORT QgsOfflineEditing : public QObject /** * Emitted when a warning needs to be displayed. - * @param title title string for message - * @param message A descriptive message for the warning + * \param title title string for message + * \param message A descriptive message for the warning */ void warning( const QString &title, const QString &message ); diff --git a/src/core/qgsogcutils.h b/src/core/qgsogcutils.h index a964de6234bc..f9f0758eeef9 100644 --- a/src/core/qgsogcutils.h +++ b/src/core/qgsogcutils.h @@ -35,7 +35,7 @@ class QgsRectangle; #include "qgssqlstatement.h" /** \ingroup core - * @brief The QgsOgcUtils class provides various utility functions for conversion between + * \brief The QgsOgcUtils class provides various utility functions for conversion between * OGC (Open Geospatial Consortium) standards and QGIS internal representations. * * Currently supported standards: @@ -46,7 +46,7 @@ class CORE_EXPORT QgsOgcUtils public: /** GML version - * @note not available in Python bindings + * \note not available in Python bindings */ typedef enum { @@ -56,7 +56,7 @@ class CORE_EXPORT QgsOgcUtils } GMLVersion; /** Static method that creates geometry from GML - @param xmlString xml representation of the geometry. GML elements are expected to be + \param xmlString xml representation of the geometry. GML elements are expected to be in default namespace (\verbatim {... \endverbatim) or in "gml" namespace (\verbatim ... \endverbatim) */ @@ -73,7 +73,7 @@ class CORE_EXPORT QgsOgcUtils static QgsRectangle rectangleFromGMLEnvelope( const QDomNode &envelopeNode ); /** Exports the geometry to GML - @return QDomElement + \returns QDomElement \since QGIS 2.16 */ static QDomElement geometryToGML( const QgsGeometry *geometry, QDomDocument &doc, @@ -84,22 +84,22 @@ class CORE_EXPORT QgsOgcUtils int precision = 17 ); /** Exports the geometry to GML2 or GML3 - @return QDomElement + \returns QDomElement */ static QDomElement geometryToGML( const QgsGeometry *geometry, QDomDocument &doc, const QString &format, int precision = 17 ); /** Exports the geometry to GML2 - @return QDomElement + \returns QDomElement */ static QDomElement geometryToGML( const QgsGeometry *geometry, QDomDocument &doc, int precision = 17 ); /** Exports the rectangle to GML2 Box - @return QDomElement + \returns QDomElement */ static QDomElement rectangleToGMLBox( QgsRectangle *box, QDomDocument &doc, int precision = 17 ); /** Exports the rectangle to GML2 Box - @return QDomElement + \returns QDomElement \since QGIS 2.16 */ static QDomElement rectangleToGMLBox( QgsRectangle *box, QDomDocument &doc, @@ -108,12 +108,12 @@ class CORE_EXPORT QgsOgcUtils int precision = 17 ); /** Exports the rectangle to GML3 Envelope - @return QDomElement + \returns QDomElement */ static QDomElement rectangleToGMLEnvelope( QgsRectangle *env, QDomDocument &doc, int precision = 17 ); /** Exports the rectangle to GML3 Envelope - @return QDomElement + \returns QDomElement \since QGIS 2.16 */ static QDomElement rectangleToGMLEnvelope( QgsRectangle *env, QDomDocument &doc, @@ -130,13 +130,13 @@ class CORE_EXPORT QgsOgcUtils /** Creates OGC filter XML element. Supports minimum standard filter * according to the OGC filter specs (=,!=,<,>,<=,>=,AND,OR,NOT) - * @return valid \verbatim \endverbatim QDomElement on success, + * \returns valid \verbatim \endverbatim QDomElement on success, * otherwise null QDomElement */ static QDomElement expressionToOgcFilter( const QgsExpression &exp, QDomDocument &doc, QString *errorMessage = nullptr ); /** OGC filter version - * @note not available in Python bindings + * \note not available in Python bindings */ typedef enum { @@ -147,10 +147,10 @@ class CORE_EXPORT QgsOgcUtils /** Creates OGC filter XML element. Supports minimum standard filter * according to the OGC filter specs (=,!=,<,>,<=,>=,AND,OR,NOT) - * @return valid \verbatim \endverbatim QDomElement on success, + * \returns valid \verbatim \endverbatim QDomElement on success, * otherwise null QDomElement * \since QGIS 2.16 - * @note not available in Python bindings + * \note not available in Python bindings */ static QDomElement expressionToOgcFilter( const QgsExpression &exp, QDomDocument &doc, @@ -163,13 +163,13 @@ class CORE_EXPORT QgsOgcUtils QString *errorMessage = nullptr ); /** Creates an OGC expression XML element. - * @return valid OGC expression QDomElement on success, + * \returns valid OGC expression QDomElement on success, * otherwise null QDomElement */ static QDomElement expressionToOgcExpression( const QgsExpression &exp, QDomDocument &doc, QString *errorMessage = nullptr ); /** Creates an OGC expression XML element. - * @return valid OGC expression QDomElement on success, + * \returns valid OGC expression QDomElement on success, * otherwise null QDomElement */ static QDomElement expressionToOgcExpression( const QgsExpression &exp, @@ -185,7 +185,7 @@ class CORE_EXPORT QgsOgcUtils /** \ingroup core * Layer properties. Used by SQLStatementToOgcFilter(). * \since QGIS 2.16 - * @note not available in Python bindings + * \note not available in Python bindings */ class LayerProperties { @@ -213,10 +213,10 @@ class CORE_EXPORT QgsOgcUtils * ST_Disjoint(), ST_Overlaps(), ST_Touches(), ST_Within() * ST_DWithin(), ST_Beyond() * custom functions - * @return valid \verbatim \endverbatim QDomElement on success, + * \returns valid \verbatim \endverbatim QDomElement on success, * otherwise null QDomElement * \since QGIS 2.16 - * @note not available in Python bindings + * \note not available in Python bindings */ static QDomElement SQLStatementToOgcFilter( const QgsSQLStatement &statement, QDomDocument &doc, @@ -244,30 +244,30 @@ class CORE_EXPORT QgsOgcUtils static QgsGeometry geometryFromGMLMultiPolygon( const QDomElement &geometryElement ); /** Reads the \verbatim \endverbatim element and extracts the coordinates as points - @param coords list where the found coordinates are appended - @param elem the \verbatim \endverbatim element - @return boolean for success*/ + \param coords list where the found coordinates are appended + \param elem the \verbatim \endverbatim element + \returns boolean for success*/ static bool readGMLCoordinates( QgsPolyline &coords, const QDomElement &elem ); /** Reads the \verbatim \endverbatim or \verbatim \endverbatim and extracts the coordinates as points - @param coords list where the found coordinates are appended - @param elem the \verbatim \endverbatim or + \param coords list where the found coordinates are appended + \param elem the \verbatim \endverbatim or \verbatim \endverbatim element - @return boolean for success*/ + \returns boolean for success*/ static bool readGMLPositions( QgsPolyline &coords, const QDomElement &elem ); /** Create a GML coordinates element from a point list. - @param points list of data points - @param doc the GML document - @return QDomElement */ + \param points list of data points + \param doc the GML document + \returns QDomElement */ static QDomElement createGMLCoordinates( const QgsPolyline &points, QDomDocument &doc ); /** Create a GML pos or posList element from a point list. - @param points list of data points - @param doc the GML document - @return QDomElement */ + \param points list of data points + \param doc the GML document + \returns QDomElement */ static QDomElement createGMLPositions( const QgsPolyline &points, QDomDocument &doc ); //! handle a generic sub-expression @@ -292,7 +292,7 @@ class CORE_EXPORT QgsOgcUtils /** \ingroup core * Internal use by QgsOgcUtils - * @note not available in Python bindings + * \note not available in Python bindings */ class QgsOgcUtilsExprToFilter { @@ -338,7 +338,7 @@ class QgsOgcUtilsExprToFilter /** \ingroup core * Internal use by QgsOgcUtils - * @note not available in Python bindings + * \note not available in Python bindings */ class QgsOgcUtilsSQLStatementToFilter { diff --git a/src/core/qgsogrutils.h b/src/core/qgsogrutils.h index 17e1109a3de7..114ebaf5d04c 100644 --- a/src/core/qgsogrutils.h +++ b/src/core/qgsogrutils.h @@ -36,73 +36,73 @@ class CORE_EXPORT QgsOgrUtils public: /** Reads an OGR feature and converts it to a QgsFeature. - * @param ogrFet OGR feature handle - * @param fields fields collection corresponding to feature - * @param encoding text encoding - * @return valid feature if read was successful + * \param ogrFet OGR feature handle + * \param fields fields collection corresponding to feature + * \param encoding text encoding + * \returns valid feature if read was successful */ static QgsFeature readOgrFeature( OGRFeatureH ogrFet, const QgsFields &fields, QTextCodec *encoding ); /** Reads an OGR feature and returns a corresponding fields collection. - * @param ogrFet OGR feature handle - * @param encoding text encoding - * @returns fields collection if read was successful + * \param ogrFet OGR feature handle + * \param encoding text encoding + * \returns fields collection if read was successful */ static QgsFields readOgrFields( OGRFeatureH ogrFet, QTextCodec *encoding ); /** Retrieves an attribute value from an OGR feature. - * @param ogrFet OGR feature handle - * @param fields fields collection corresponding to feature - * @param attIndex index of attribute to retrieve - * @param encoding text encoding - * @param ok optional storage for success of retrieval - * @returns attribute converted to a QVariant object - * @see readOgrFeatureAttributes() + * \param ogrFet OGR feature handle + * \param fields fields collection corresponding to feature + * \param attIndex index of attribute to retrieve + * \param encoding text encoding + * \param ok optional storage for success of retrieval + * \returns attribute converted to a QVariant object + * \see readOgrFeatureAttributes() */ static QVariant getOgrFeatureAttribute( OGRFeatureH ogrFet, const QgsFields &fields, int attIndex, QTextCodec *encoding, bool *ok = 0 ); /** Reads all attributes from an OGR feature into a QgsFeature. - * @param ogrFet OGR feature handle - * @param fields fields collection corresponding to feature - * @param feature QgsFeature to store attributes in - * @param encoding text encoding - * @returns true if attribute read was successful - * @see getOgrFeatureAttribute() + * \param ogrFet OGR feature handle + * \param fields fields collection corresponding to feature + * \param feature QgsFeature to store attributes in + * \param encoding text encoding + * \returns true if attribute read was successful + * \see getOgrFeatureAttribute() */ static bool readOgrFeatureAttributes( OGRFeatureH ogrFet, const QgsFields &fields, QgsFeature &feature, QTextCodec *encoding ); /** Reads the geometry from an OGR feature into a QgsFeature. - * @param ogrFet OGR feature handle - * @param feature QgsFeature to store geometry in - * @returns true if geometry read was successful - * @see readOgrFeatureAttributes() - * @see ogrGeometryToQgsGeometry() + * \param ogrFet OGR feature handle + * \param feature QgsFeature to store geometry in + * \returns true if geometry read was successful + * \see readOgrFeatureAttributes() + * \see ogrGeometryToQgsGeometry() */ static bool readOgrFeatureGeometry( OGRFeatureH ogrFet, QgsFeature &feature ); /** Converts an OGR geometry representation to a QgsGeometry object - * @param geom OGR geometry handle - * @returns QgsGeometry object. If conversion was not successful the geometry + * \param geom OGR geometry handle + * \returns QgsGeometry object. If conversion was not successful the geometry * will be empty. - * @see readOgrFeatureGeometry() + * \see readOgrFeatureGeometry() */ static QgsGeometry ogrGeometryToQgsGeometry( OGRGeometryH geom ); /** Attempts to parse a string representing a collection of features using OGR. For example, this method can be * used to convert a GeoJSON encoded collection to a list of QgsFeatures. - * @param string string to parse - * @param fields fields collection to use for parsed features (@see stringToFields()) - * @param encoding text encoding - * @returns list of parsed features, or an empty list if no features could be parsed - * @see stringToFields() + * \param string string to parse + * \param fields fields collection to use for parsed features (\see stringToFields()) + * \param encoding text encoding + * \returns list of parsed features, or an empty list if no features could be parsed + * \see stringToFields() */ static QgsFeatureList stringToFeatureList( const QString &string, const QgsFields &fields, QTextCodec *encoding ); /** Attempts to retrieve the fields from a string representing a collection of features using OGR. - * @param string string to parse - * @param encoding text encoding - * @returns retrieved fields collection, or an empty list if no fields could be determined from the string - * @see stringToFeatureList() + * \param string string to parse + * \param encoding text encoding + * \returns retrieved fields collection, or an empty list if no fields could be determined from the string + * \see stringToFeatureList() */ static QgsFields stringToFields( const QString &string, QTextCodec *encoding ); }; diff --git a/src/core/qgsoptional.h b/src/core/qgsoptional.h index a533faeeb68e..4791b0821e7e 100644 --- a/src/core/qgsoptional.h +++ b/src/core/qgsoptional.h @@ -28,7 +28,7 @@ * more internal configuration information that should not be lost when disabling and re-enabling. * * \since QGIS 3.0 - * @note For Python you need to use implementations for specific template classes + * \note For Python you need to use implementations for specific template classes */ template class CORE_EXPORT QgsOptional diff --git a/src/core/qgsowsconnection.h b/src/core/qgsowsconnection.h index 075fa6008f37..6a89a20622af 100644 --- a/src/core/qgsowsconnection.h +++ b/src/core/qgsowsconnection.h @@ -39,8 +39,8 @@ class CORE_EXPORT QgsOwsConnection : public QObject /** * Constructor - * @param service service name: WMS,WFS,WCS - * @param connName connection name + * \param service service name: WMS,WFS,WCS + * \param connName connection name */ QgsOwsConnection( const QString &service, const QString &connName ); diff --git a/src/core/qgspainting.h b/src/core/qgspainting.h index bb21a0151e2f..daa78565be0e 100644 --- a/src/core/qgspainting.h +++ b/src/core/qgspainting.h @@ -6,7 +6,7 @@ #include "qgis_core.h" /** - * @ingroup core + * \ingroup core * Misc painting enums and functions. * * \since QGIS 3.0 diff --git a/src/core/qgspalgeometry.h b/src/core/qgspalgeometry.h index 65cd7fa6b13b..1ea5edab5b2b 100644 --- a/src/core/qgspalgeometry.h +++ b/src/core/qgspalgeometry.h @@ -24,8 +24,8 @@ /** * Class that adds extra information to QgsLabelFeature for text labels * - * @note not part of public API - * @note not available in Python bindings + * \note not part of public API + * \note not available in Python bindings */ class QgsTextLabelFeature : public QgsLabelFeature { @@ -45,7 +45,7 @@ class QgsTextLabelFeature : public QgsLabelFeature } /** Returns the text component corresponding to a specified label part - * @param partId Set to -1 for labels which are not broken into parts (e.g., non-curved labels), or the required + * \param partId Set to -1 for labels which are not broken into parts (e.g., non-curved labels), or the required * part index for labels which are broken into parts (curved labels) * \since QGIS 2.10 */ diff --git a/src/core/qgspallabeling.h b/src/core/qgspallabeling.h index be175a89dade..224fc98596aa 100644 --- a/src/core/qgspallabeling.h +++ b/src/core/qgspallabeling.h @@ -438,7 +438,7 @@ class CORE_EXPORT QgsPalLayerSettings /** Ordered list of predefined label positions for points. Positions earlier * in the list will be prioritized over later positions. Only used when the placement * is set to QgsPalLayerSettings::OrderedPositionsAroundPoint. - * @note not available in Python bindings + * \note not available in Python bindings */ QVector< PredefinedPointPosition > predefinedPositionOrder; @@ -509,12 +509,12 @@ class CORE_EXPORT QgsPalLayerSettings void calculateLabelSize( const QFontMetricsF *fm, QString text, double &labelX, double &labelY, QgsFeature *f = nullptr, QgsRenderContext *context = nullptr ); /** Register a feature for labeling. - * @param f feature to label - * @param context render context. The QgsExpressionContext contained within the render context + * \param f feature to label + * \param context render context. The QgsExpressionContext contained within the render context * must have already had the feature and fields sets prior to calling this method. - * @param labelFeature if using QgsLabelingEngine, this will receive the label feature. Not available + * \param labelFeature if using QgsLabelingEngine, this will receive the label feature. Not available * in Python bindings. - * @param obstacleGeometry optional obstacle geometry, if a different geometry to the feature's geometry + * \param obstacleGeometry optional obstacle geometry, if a different geometry to the feature's geometry * should be used as an obstacle for labels (e.g., if the feature has been rendered with an offset point * symbol, the obstacle geometry should represent the bounds of the offset symbol). If not set, * the feature's original geometry will be used as an obstacle for labels. Not available @@ -537,32 +537,32 @@ class CORE_EXPORT QgsPalLayerSettings /** Returns a reference to the label's property collection, used for data defined overrides. * \since QGIS 3.0 - * @see setDataDefinedProperties() + * \see setDataDefinedProperties() */ QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; } /** Returns a reference to the label's property collection, used for data defined overrides. * \since QGIS 3.0 - * @see setDataDefinedProperties() + * \see setDataDefinedProperties() */ const QgsPropertyCollection &dataDefinedProperties() const { return mDataDefinedProperties; } /** Sets the label's property collection, used for data defined overrides. - * @param collection property collection. Existing properties will be replaced. + * \param collection property collection. Existing properties will be replaced. * \since QGIS 3.0 - * @see dataDefinedProperties() + * \see dataDefinedProperties() */ void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; } /** Returns the label text formatting settings, e.g., font settings, buffer settings, etc. - * @see setFormat() + * \see setFormat() * \since QGIS 3.0 */ const QgsTextFormat &format() const { return mFormat; } /** Sets the label text formatting settings, e.g., font settings, buffer settings, etc. - * @param format label text format - * @see format() + * \param format label text format + * \see format() * \since QGIS 3.0 */ void setFormat( const QgsTextFormat &format ) { mFormat = format; } @@ -628,7 +628,7 @@ class CORE_EXPORT QgsPalLayerSettings void parseDropShadow( QgsRenderContext &context ); /** Checks if a feature is larger than a minimum size (in mm) - @return true if above size, false if below*/ + \returns true if above size, false if below*/ bool checkMinimumSizeMM( const QgsRenderContext &ct, const QgsGeometry &geom, double minSize ) const; /** Registers a feature as an obstacle only (no label rendered) @@ -731,15 +731,15 @@ class CORE_EXPORT QgsPalLabeling /** Returns whether the engine will only draw the outline rectangles of labels, * not the label contents themselves. Used for debugging and testing purposes. - * @see setDrawLabelRectOnly + * \see setDrawLabelRectOnly * \since QGIS 2.12 */ bool drawLabelRectOnly() const; /** Sets whether the engine should only draw the outline rectangles of labels, * not the label contents themselves. Used for debugging and testing purposes. - * @param drawRect set to true to enable rect drawing only - * @see drawLabelRectOnly + * \param drawRect set to true to enable rect drawing only + * \see drawLabelRectOnly * \since QGIS 2.12 */ void setDrawLabelRectOnly( bool drawRect ); @@ -748,7 +748,7 @@ class CORE_EXPORT QgsPalLabeling //! \since QGIS 2.4 static bool staticWillUseLayer( QgsVectorLayer *layer ); - //! @note not available in Python bindings + //! \note not available in Python bindings static void drawLabelCandidateRect( pal::LabelPosition *lp, QPainter *painter, const QgsMapToPixel *xform, QList *candidates = nullptr ); //! load/save engine settings to project file @@ -756,30 +756,30 @@ class CORE_EXPORT QgsPalLabeling void saveEngineSettings(); /** Prepares a geometry for registration with PAL. Handles reprojection, rotation, clipping, etc. - * @param geometry geometry to prepare - * @param context render context - * @param ct coordinate transform, or invalid transform if no transformation required - * @param clipGeometry geometry to clip features to, if applicable - * @returns prepared geometry + * \param geometry geometry to prepare + * \param context render context + * \param ct coordinate transform, or invalid transform if no transformation required + * \param clipGeometry geometry to clip features to, if applicable + * \returns prepared geometry * \since QGIS 2.9 */ static QgsGeometry prepareGeometry( const QgsGeometry &geometry, QgsRenderContext &context, const QgsCoordinateTransform &ct, QgsGeometry *clipGeometry = nullptr ); /** Checks whether a geometry requires preparation before registration with PAL - * @param geometry geometry to prepare - * @param context render context - * @param ct coordinate transform, or invalid transform if no transformation required - * @param clipGeometry geometry to clip features to, if applicable - * @returns true if geometry requires preparation + * \param geometry geometry to prepare + * \param context render context + * \param ct coordinate transform, or invalid transform if no transformation required + * \param clipGeometry geometry to clip features to, if applicable + * \returns true if geometry requires preparation * \since QGIS 2.9 */ static bool geometryRequiresPreparation( const QgsGeometry &geometry, QgsRenderContext &context, const QgsCoordinateTransform &ct, QgsGeometry *clipGeometry = nullptr ); /** Splits a text string to a list of separate lines, using a specified wrap character. * The text string will be split on either newline characters or the wrap character. - * @param text text string to split - * @param wrapCharacter additional character to wrap on - * @returns list of text split to lines + * \param text text string to split + * \param wrapCharacter additional character to wrap on + * \returns list of text split to lines * \since QGIS 2.9 */ static QStringList splitToLines( const QString &text, const QString &wrapCharacter ); @@ -787,8 +787,8 @@ class CORE_EXPORT QgsPalLabeling /** Splits a text string to a list of graphemes, which are the smallest allowable character * divisions in the string. This accounts for scripts were individual characters are not * allowed to be split apart (e.g., Arabic and Indic based scripts) - * @param text string to split - * @returns list of graphemes + * \param text string to split + * \returns list of graphemes * \since QGIS 2.10 */ static QStringList splitToGraphemes( const QString &text ); @@ -820,10 +820,10 @@ class CORE_EXPORT QgsPalLabeling void deleteTemporaryData(); /** Checks whether a geometry exceeds the minimum required size for a geometry to be labeled. - * @param context render context - * @param geom geometry - * @param minSize minimum size for geometry - * @returns true if geometry exceeds minimum size + * \param context render context + * \param geom geometry + * \param minSize minimum size for geometry + * \returns true if geometry exceeds minimum size * \since QGIS 2.9 */ static bool checkMinimumSizeMM( const QgsRenderContext &context, const QgsGeometry *geom, double minSize ); diff --git a/src/core/qgspoint.h b/src/core/qgspoint.h index d0cc23480276..a310b511e497 100644 --- a/src/core/qgspoint.h +++ b/src/core/qgspoint.h @@ -52,8 +52,8 @@ class CORE_EXPORT QgsPoint QgsPoint( const QgsPoint &p ); /** Create a point from x,y coordinates - * @param x x coordinate - * @param y y coordinate + * \param x x coordinate + * \param y y coordinate */ QgsPoint( double x, double y ) : mX( x ) @@ -61,7 +61,7 @@ class CORE_EXPORT QgsPoint {} /** Create a point from a QPointF - * @param point QPointF source + * \param point QPointF source * \since QGIS 2.7 */ QgsPoint( QPointF point ) @@ -70,7 +70,7 @@ class CORE_EXPORT QgsPoint {} /** Create a point from a QPoint - * @param point QPoint source + * \param point QPoint source * \since QGIS 2.7 */ QgsPoint( QPoint point ) @@ -90,7 +90,7 @@ class CORE_EXPORT QgsPoint {} /** Sets the x value of the point - * @param x x coordinate + * \param x x coordinate */ void setX( double x ) { @@ -98,7 +98,7 @@ class CORE_EXPORT QgsPoint } /** Sets the y value of the point - * @param y y coordinate + * \param y y coordinate */ void setY( double y ) { @@ -113,7 +113,7 @@ class CORE_EXPORT QgsPoint } /** Get the x value of the point - * @return x coordinate + * \returns x coordinate */ double x() const { @@ -121,7 +121,7 @@ class CORE_EXPORT QgsPoint } /** Get the y value of the point - * @return y coordinate + * \returns y coordinate */ double y() const { @@ -129,7 +129,7 @@ class CORE_EXPORT QgsPoint } /** Converts a point to a QPointF - * @returns QPointF with same x and y values + * \returns QPointF with same x and y values * \since QGIS 2.7 */ QPointF toQPointF() const; @@ -143,10 +143,10 @@ class CORE_EXPORT QgsPoint /** Return a string representation as degrees minutes seconds. * Its up to the calling function to ensure that this point can * be meaningfully represented in this form. - * @param precision number of decimal points to use for seconds - * @param useSuffix set to true to include a direction suffix (e.g., 'N'), + * \param precision number of decimal points to use for seconds + * \param useSuffix set to true to include a direction suffix (e.g., 'N'), * set to false to use a "-" prefix for west and south coordinates - * @param padded set to true to force minutes and seconds to use two decimals, + * \param padded set to true to force minutes and seconds to use two decimals, * e.g., '05' instead of '5'. */ QString toDegreesMinutesSeconds( int precision, const bool useSuffix = true, const bool padded = false ) const; @@ -154,10 +154,10 @@ class CORE_EXPORT QgsPoint /** Return a string representation as degrees minutes. * Its up to the calling function to ensure that this point can * be meaningfully represented in this form. - * @param precision number of decimal points to use for minutes - * @param useSuffix set to true to include a direction suffix (e.g., 'N'), + * \param precision number of decimal points to use for minutes + * \param useSuffix set to true to include a direction suffix (e.g., 'N'), * set to false to use a "-" prefix for west and south coordinates - * @param padded set to true to force minutes to use two decimals, + * \param padded set to true to force minutes to use two decimals, * e.g., '05' instead of '5'. */ QString toDegreesMinutes( int precision, const bool useSuffix = true, const bool padded = false ) const; @@ -165,31 +165,31 @@ class CORE_EXPORT QgsPoint /** Return the well known text representation for the point. * The wkt is created without an SRID. - * @return Well known text in the form POINT(x y) + * \returns Well known text in the form POINT(x y) */ QString wellKnownText() const; /** Returns the squared distance between this point a specified x, y coordinate. - * @see distance() + * \see distance() */ double sqrDist( double x, double y ) const; /** Returns the squared distance between this point another point. - * @see distance() + * \see distance() */ double sqrDist( const QgsPoint &other ) const; /** Returns the distance between this point and a specified x, y coordinate. - * @param x x-coordniate - * @param y y-coordinate - * @see sqrDist() + * \param x x-coordniate + * \param y y-coordinate + * \see sqrDist() * \since QGIS 2.16 */ double distance( double x, double y ) const; /** Returns the distance between this point and another point. - * @param other other point - * @see sqrDist() + * \param other other point + * \see sqrDist() * \since QGIS 2.16 */ double distance( const QgsPoint &other ) const; @@ -202,16 +202,16 @@ class CORE_EXPORT QgsPoint /** Returns a new point which corresponds to this point projected by a specified distance * in a specified bearing. - * @param distance distance to project - * @param bearing angle to project in, clockwise in degrees starting from north + * \param distance distance to project + * \param bearing angle to project in, clockwise in degrees starting from north * \since QGIS 2.16 */ QgsPoint project( double distance, double bearing ) const; /** Compares this point with another point with a fuzzy tolerance - * @param other point to compare with - * @param epsilon maximum difference for coordinates between the points - * @returns true if points are equal within specified tolerance + * \param other point to compare with + * \param epsilon maximum difference for coordinates between the points + * \returns true if points are equal within specified tolerance * \since QGIS 2.9 */ bool compare( const QgsPoint &other, double epsilon = 4 * DBL_EPSILON ) const; @@ -226,7 +226,7 @@ class CORE_EXPORT QgsPoint void multiply( double scalar ); //! Test if this point is on the segment defined by points a, b - //! @return 0 if this point is not on the open ray through a and b, + //! \returns 0 if this point is not on the open ray through a and b, //! 1 if point is on open ray a, 2 if point is within line segment, //! 3 if point is on open ray b. int onSegment( const QgsPoint &a, const QgsPoint &b ) const; diff --git a/src/core/qgspointlocator.h b/src/core/qgspointlocator.h index f9d678faef52..fb2cca36f6b8 100644 --- a/src/core/qgspointlocator.h +++ b/src/core/qgspointlocator.h @@ -37,7 +37,7 @@ namespace SpatialIndex } /** \ingroup core - * @brief The class defines interface for querying point location: + * \brief The class defines interface for querying point location: * - query nearest vertices / edges to a point * - query vertices / edges in rectangle * - query areas covering a point diff --git a/src/core/qgsproject.cpp b/src/core/qgsproject.cpp index 16cccebb46e6..b917d576d5db 100644 --- a/src/core/qgsproject.cpp +++ b/src/core/qgsproject.cpp @@ -791,7 +791,7 @@ bool QgsProject::read() QgsProjectFileTransform projectFile( *doc, fileVersion ); - //! Shows a warning when an old project file is read. + // Shows a warning when an old project file is read. emit oldProjectVersionWarning( fileVersion.text() ); QgsDebugMsg( "Emitting oldProjectVersionWarning(oldVersion)." ); diff --git a/src/core/qgsproject.h b/src/core/qgsproject.h index 9b52d8db507b..6b33e4541414 100644 --- a/src/core/qgsproject.h +++ b/src/core/qgsproject.h @@ -62,7 +62,7 @@ class QgsLayerTree; /** \ingroup core * Reads and writes project states. * - @note + \note Has two general kinds of state to make persistent. (I.e., to read and write.) First, QGIS proprietary information. Second plug-in information. @@ -99,14 +99,14 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera ~QgsProject(); /** Sets the project's title. - * @param title new title + * \param title new title * \since QGIS 2.4 - * @see title() + * \see title() */ void setTitle( const QString &title ); /** Returns the project's title. - * @see setTitle() + * \see setTitle() */ QString title() const; @@ -117,20 +117,20 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera /** Sets the file name associated with the project. This is the file which contains the project's XML * representation. - * @param name project file name - * @see fileName() + * \param name project file name + * \see fileName() */ void setFileName( const QString &name ); /** Returns the project's file name. This is the file which contains the project's XML * representation. - * @see setFileName() - * @see fileInfo() + * \see setFileName() + * \see fileInfo() */ QString fileName() const; /** Returns QFileInfo object for the project's associated file. - * @see fileName() + * \see fileName() * \since QGIS 2.9 */ QFileInfo fileInfo() const; @@ -138,31 +138,31 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera /** * Returns the project's native coordinate reference system. * \since QGIS 3.0 - * @see setCrs() - * @see ellipsoid() + * \see setCrs() + * \see ellipsoid() */ QgsCoordinateReferenceSystem crs() const; /** * Sets the project's native coordinate reference system. * \since QGIS 3.0 - * @see crs() - * @see setEllipsoid() + * \see crs() + * \see setEllipsoid() */ void setCrs( const QgsCoordinateReferenceSystem &crs ); /** * Returns a proj string representing the project's ellipsoid setting, e.g., "WGS84". - * @see setEllipsoid() - * @see crs() + * \see setEllipsoid() + * \see crs() * \since QGIS 3.0 */ QString ellipsoid() const; /** * Sets the project's ellipsoid from a proj string representation, e.g., "WGS84". - * @see ellipsoid() - * @see setCrs() + * \see ellipsoid() + * \see setCrs() * \since QGIS 3.0 */ void setEllipsoid( const QString &ellipsoid ); @@ -173,40 +173,40 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera void clear(); /** Reads given project file from the given file. - * @param filename name of project file to read - * @returns true if project file has been read successfully + * \param filename name of project file to read + * \returns true if project file has been read successfully */ bool read( const QString &filename ); /** Reads the project from its currently associated file (see fileName() ). - * @returns true if project file has been read successfully + * \returns true if project file has been read successfully */ bool read(); /** Reads the layer described in the associated DOM node. * - * @note This method is mainly for use by QgsProjectBadLayerHandler subclasses + * \note This method is mainly for use by QgsProjectBadLayerHandler subclasses * that may fix definition of bad layers with the user's help in GUI. Calling * this method with corrected DOM node adds the layer back to the project. * - * @param layerNode represents a QgsProject DOM node that encodes a specific layer. + * \param layerNode represents a QgsProject DOM node that encodes a specific layer. */ bool readLayer( const QDomNode &layerNode ); /** * Writes the project to a file. - * @param filename destination file - * @note calling this implicitly sets the project's filename (see setFileName() ) - * @note isDirty() will be set to false if project is successfully written - * @returns true if project was written successfully + * \param filename destination file + * \note calling this implicitly sets the project's filename (see setFileName() ) + * \note isDirty() will be set to false if project is successfully written + * \returns true if project was written successfully * * \since QGIS 3.0 */ bool write( const QString &filename ); /** Writes the project to its current associated file (see fileName() ). - * @note isDirty() will be set to false if project is successfully written - * @returns true if project was written successfully + * \note isDirty() will be set to false if project is successfully written + * \returns true if project was written successfully */ bool write(); @@ -216,8 +216,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera * Keys are '/'-delimited entries, implying * a hierarchy of keys and corresponding values * - * @note The key string must be valid xml tag names in order to be saved to the file. - * @note available in Python bindings as writeEntryBool + * \note The key string must be valid xml tag names in order to be saved to the file. + * \note available in Python bindings as writeEntryBool */ bool writeEntry( const QString &scope, const QString &key, bool value ); @@ -227,8 +227,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera * Keys are '/'-delimited entries, implying * a hierarchy of keys and corresponding values * - * @note The key string must be valid xml tag names in order to be saved to the file. - * @note available in Python bindings as writeEntryDouble + * \note The key string must be valid xml tag names in order to be saved to the file. + * \note available in Python bindings as writeEntryDouble */ bool writeEntry( const QString &scope, const QString &key, double value ); @@ -238,7 +238,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera * Keys are '/'-delimited entries, implying * a hierarchy of keys and corresponding values * - * @note The key string must be valid xml tag names in order to be saved to the file. + * \note The key string must be valid xml tag names in order to be saved to the file. */ bool writeEntry( const QString &scope, const QString &key, int value ); @@ -248,7 +248,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera * Keys are '/'-delimited entries, implying * a hierarchy of keys and corresponding values * - * @note The key string must be valid xml tag names in order to be saved to the file. + * \note The key string must be valid xml tag names in order to be saved to the file. */ bool writeEntry( const QString &scope, const QString &key, const QString &value ); @@ -258,7 +258,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera * Keys are '/'-delimited entries, implying * a hierarchy of keys and corresponding values * - * @note The key string must be valid xml tag names in order to be saved to the file. + * \note The key string must be valid xml tag names in order to be saved to the file. */ bool writeEntry( const QString &scope, const QString &key, const QStringList &value ); @@ -282,13 +282,13 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera /** Return keys with values -- do not return keys that contain other keys * - * @note equivalent to QgsSettings entryList() + * \note equivalent to QgsSettings entryList() */ QStringList entryList( const QString &scope, const QString &key ) const; /** Return keys with keys -- do not return keys that contain only values * - * @note equivalent to QgsSettings subkeyList() + * \note equivalent to QgsSettings subkeyList() */ QStringList subkeyList( const QString &scope, const QString &key ) const; @@ -327,8 +327,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera QString layerIsEmbedded( const QString &id ) const; /** Creates a maplayer instance defined in an arbitrary project file. Caller takes ownership - * @return the layer or 0 in case of error - * @note not available in Python bindings + * \returns the layer or 0 in case of error + * \note not available in Python bindings */ bool createEmbeddedLayer( const QString &layerId, const QString &projectFilePath, QList &brokenNodes, bool saveFlag = true ); @@ -346,35 +346,35 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera /** Convenience function to query default distance measurement units for project. * \since QGIS 2.14 - * @see setDistanceUnits() - * @see areaUnits() + * \see setDistanceUnits() + * \see areaUnits() */ QgsUnitTypes::DistanceUnit distanceUnits() const; /** * Sets the default distance measurement units for the project. * \since QGIS 3.0 - * @see distanceUnits() - * @see setAreaUnits() + * \see distanceUnits() + * \see setAreaUnits() */ void setDistanceUnits( QgsUnitTypes::DistanceUnit unit ); /** Convenience function to query default area measurement units for project. * \since QGIS 2.14 - * @see distanceUnits() + * \see distanceUnits() */ QgsUnitTypes::AreaUnit areaUnits() const; /** * Sets the default area measurement units for the project. * \since QGIS 3.0 - * @see areaUnits() - * @see setDistanceUnits() + * \see areaUnits() + * \see setDistanceUnits() */ void setAreaUnits( QgsUnitTypes::AreaUnit unit ); /** Return project's home path - @return home path of project (or QString::null if not set) */ + \returns home path of project (or QString::null if not set) */ QString homePath() const; QgsRelationManager *relationManager() const; @@ -405,7 +405,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera /** Returns pointer to the project's map theme collection. * \since QGIS 2.12 - * @note renamed in QGIS 3.0, formerly QgsVisibilityPresetCollection + * \note renamed in QGIS 3.0, formerly QgsVisibilityPresetCollection */ QgsMapThemeCollection *mapThemeCollection(); @@ -456,7 +456,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera * QPair( providerKey, connString ) -> transactionGroup * * \since QGIS 2.16 - * @note Not available in Python bindings + * \note Not available in Python bindings */ QMap< QPair< QString, QString>, QgsTransactionGroup *> transactionGroups(); @@ -519,25 +519,25 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera int count() const; /** Retrieve a pointer to a registered layer by layer ID. - * @param layerId ID of layer to retrieve - * @returns matching layer, or nullptr if no matching layer found - * @see mapLayersByName() - * @see mapLayers() + * \param layerId ID of layer to retrieve + * \returns matching layer, or nullptr if no matching layer found + * \see mapLayersByName() + * \see mapLayers() */ QgsMapLayer *mapLayer( const QString &layerId ) const; /** Retrieve a list of matching registered layers by layer name. - * @param layerName name of layers to match - * @returns list of matching layers - * @see mapLayer() - * @see mapLayers() + * \param layerName name of layers to match + * \returns list of matching layers + * \see mapLayer() + * \see mapLayers() */ QList mapLayersByName( const QString &layerName ) const; /** Returns a map of all registered layers by layer ID. - * @see mapLayer() - * @see mapLayersByName() - * @see layers() + * \see mapLayer() + * \see mapLayersByName() + * \see layers() */ QMap mapLayers() const; @@ -547,9 +547,9 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera * * QVector vectorLayers = QgsProject::instance()->layers(); * - * @note not available in Python bindings + * \note not available in Python bindings * \since QGIS 2.16 - * @see mapLayers() + * \see mapLayers() */ template QVector layers() const @@ -568,36 +568,36 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera } /** - * @brief + * \brief * Add a list of layers to the map of loaded layers. * * The layersAdded() and layerWasAdded() signals will always be emitted. * The legendLayersAdded() signal is emitted only if addToLegend is true. * - * @param mapLayers A list of layer which should be added to the registry - * @param addToLegend If true (by default), the layers will be added to the + * \param mapLayers A list of layer which should be added to the registry + * \param addToLegend If true (by default), the layers will be added to the * legend and to the main canvas. If you have a private * layer you can set this parameter to false to hide it. - * @param takeOwnership Ownership will be transferred to the layer registry. + * \param takeOwnership Ownership will be transferred to the layer registry. * If you specify false here you have take care of deleting * the layers yourself. Not available in Python. * - * @return a list of the map layers that were added + * \returns a list of the map layers that were added * successfully. If a layer is invalid, or already exists in the registry, * it will not be part of the returned QList. * - * @note As a side-effect QgsProject is made dirty. - * @note takeOwnership is not available in the Python bindings - the registry will always + * \note As a side-effect QgsProject is made dirty. + * \note takeOwnership is not available in the Python bindings - the registry will always * take ownership * \since QGIS 1.8 - * @see addMapLayer() + * \see addMapLayer() */ QList addMapLayers( const QList &mapLayers, bool addToLegend = true, bool takeOwnership = true ); /** - * @brief + * \brief * Add a layer to the map of loaded layers. * * The layersAdded() and layerWasAdded() signals will always be emitted. @@ -605,85 +605,85 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera * If you are adding multiple layers at once, you should use * addMapLayers() instead. * - * @param mapLayer A layer to add to the registry - * @param addToLegend If true (by default), the layer will be added to the + * \param mapLayer A layer to add to the registry + * \param addToLegend If true (by default), the layer will be added to the * legend and to the main canvas. If you have a private * layer you can set this parameter to false to hide it. - * @param takeOwnership Ownership will be transferred to the layer registry. + * \param takeOwnership Ownership will be transferred to the layer registry. * If you specify false here you have take care of deleting * the layer yourself. Not available in Python. * - * @return nullptr if unable to add layer, otherwise pointer to newly added layer + * \returns nullptr if unable to add layer, otherwise pointer to newly added layer * - * @see addMapLayers + * \see addMapLayers * - * @note As a side-effect QgsProject is made dirty. - * @note Use addMapLayers if adding more than one layer at a time - * @note takeOwnership is not available in the Python bindings - the registry will always + * \note As a side-effect QgsProject is made dirty. + * \note Use addMapLayers if adding more than one layer at a time + * \note takeOwnership is not available in the Python bindings - the registry will always * take ownership - * @see addMapLayers() + * \see addMapLayers() */ QgsMapLayer *addMapLayer( QgsMapLayer *mapLayer, bool addToLegend = true, bool takeOwnership = true ); /** - * @brief + * \brief * Remove a set of layers from the registry by layer ID. * * The specified layers will be removed from the registry. If the registry has ownership * of any layers these layers will also be deleted. * - * @param layerIds list of IDs of the layers to remove + * \param layerIds list of IDs of the layers to remove * - * @note As a side-effect the QgsProject instance is marked dirty. + * \note As a side-effect the QgsProject instance is marked dirty. * \since QGIS 1.8 - * @see removeMapLayer() - * @see removeAllMapLayers() + * \see removeMapLayer() + * \see removeAllMapLayers() */ void removeMapLayers( const QStringList &layerIds ); /** - * @brief + * \brief * Remove a set of layers from the registry. * * The specified layers will be removed from the registry. If the registry has ownership * of any layers these layers will also be deleted. * - * @param layers A list of layers to remove. Null pointers are ignored. + * \param layers A list of layers to remove. Null pointers are ignored. * - * @note As a side-effect the QgsProject instance is marked dirty. - * @see removeMapLayer() - * @see removeAllMapLayers() + * \note As a side-effect the QgsProject instance is marked dirty. + * \see removeMapLayer() + * \see removeAllMapLayers() */ //TODO QGIS 3.0 - add PyName alias to avoid list type conversion error void removeMapLayers( const QList &layers ); /** - * @brief + * \brief * Remove a layer from the registry by layer ID. * * The specified layer will be removed from the registry. If the registry has ownership * of the layer then it will also be deleted. * - * @param layerId ID of the layer to remove + * \param layerId ID of the layer to remove * - * @note As a side-effect the QgsProject instance is marked dirty. - * @see removeMapLayers() - * @see removeAllMapLayers() + * \note As a side-effect the QgsProject instance is marked dirty. + * \see removeMapLayers() + * \see removeAllMapLayers() */ void removeMapLayer( const QString &layerId ); /** - * @brief + * \brief * Remove a layer from the registry. * * The specified layer will be removed from the registry. If the registry has ownership * of the layer then it will also be deleted. * - * @param layer The layer to remove. Null pointers are ignored. + * \param layer The layer to remove. Null pointers are ignored. * - * @note As a side-effect the QgsProject instance is marked dirty. - * @see removeMapLayers() - * @see removeAllMapLayers() + * \note As a side-effect the QgsProject instance is marked dirty. + * \see removeMapLayers() + * \see removeAllMapLayers() */ void removeMapLayer( QgsMapLayer *layer ); @@ -691,18 +691,18 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera * Removes all registered layers. If the registry has ownership * of any layers these layers will also be deleted. * - * @note As a side-effect the QgsProject instance is marked dirty. - * @note Calling this method will cause the removeAll() signal to + * \note As a side-effect the QgsProject instance is marked dirty. + * \note Calling this method will cause the removeAll() signal to * be emitted. - * @see removeMapLayer() - * @see removeMapLayers() + * \see removeMapLayer() + * \see removeMapLayers() */ void removeAllMapLayers(); /** * Reload all registered layer's provider data caches, synchronising the layer * with any changes in the datasource. - * @see QgsMapLayer::reload() + * \see QgsMapLayer::reload() */ void reloadAllLayers(); @@ -718,8 +718,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera * file is done. You can use this signal to read additional information * from the project file. * - * @param mapLayer The map layer which is being initialized - * @param layerNode The layer node from the project file + * \param mapLayer The map layer which is being initialized + * \param layerNode The layer node from the project file */ void readMapLayer( QgsMapLayer *mapLayer, const QDomElement &layerNode ); @@ -727,9 +727,9 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera * Emitted, when a layer is being saved. You can use this method to save * additional information to the layer. * - * @param mapLayer The map layer which is being initialized - * @param layerElem The layer element from the project file - * @param doc The document + * \param mapLayer The map layer which is being initialized + * \param layerElem The layer element from the project file + * \param doc The document */ void writeMapLayer( QgsMapLayer *mapLayer, QDomElement &layerElem, QDomDocument &doc ); @@ -741,8 +741,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera /** * Emitted when a layer from a projects was read. - * @param i current layer - * @param n number of layers + * \param i current layer + * \param n number of layers */ void layerLoaded( int i, int n ); @@ -814,64 +814,64 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera /** * Emitted when one or more layers are about to be removed from the registry. * - * @param layerIds A list of IDs for the layers which are to be removed. - * @see layerWillBeRemoved() - * @see layersRemoved() + * \param layerIds A list of IDs for the layers which are to be removed. + * \see layerWillBeRemoved() + * \see layersRemoved() */ void layersWillBeRemoved( const QStringList &layerIds ); /** * Emitted when one or more layers are about to be removed from the registry. * - * @param layers A list of layers which are to be removed. - * @see layerWillBeRemoved() - * @see layersRemoved() + * \param layers A list of layers which are to be removed. + * \see layerWillBeRemoved() + * \see layersRemoved() */ void layersWillBeRemoved( const QList &layers ); /** * Emitted when a layer is about to be removed from the registry. * - * @param layerId The ID of the layer to be removed. + * \param layerId The ID of the layer to be removed. * - * @note Consider using {@link layersWillBeRemoved()} instead - * @see layersWillBeRemoved() - * @see layerRemoved() + * \note Consider using layersWillBeRemoved() instead + * \see layersWillBeRemoved() + * \see layerRemoved() */ void layerWillBeRemoved( const QString &layerId ); /** * Emitted when a layer is about to be removed from the registry. * - * @param layer The layer to be removed. + * \param layer The layer to be removed. * - * @note Consider using {@link layersWillBeRemoved()} instead - * @see layersWillBeRemoved() - * @see layerRemoved() + * \note Consider using layersWillBeRemoved() instead + * \see layersWillBeRemoved() + * \see layerRemoved() */ void layerWillBeRemoved( QgsMapLayer *layer ); /** * Emitted after one or more layers were removed from the registry. * - * @param layerIds A list of IDs of the layers which were removed. - * @see layersWillBeRemoved() + * \param layerIds A list of IDs of the layers which were removed. + * \see layersWillBeRemoved() */ void layersRemoved( const QStringList &layerIds ); /** * Emitted after a layer was removed from the registry. * - * @param layerId The ID of the layer removed. + * \param layerId The ID of the layer removed. * - * @note Consider using {@link layersRemoved()} instead - * @see layerWillBeRemoved() + * \note Consider using layersRemoved() instead + * \see layerWillBeRemoved() */ void layerRemoved( const QString &layerId ); /** - * Emitted when all layers are removed, before {@link layersWillBeRemoved()} and - * {@link layerWillBeRemoved()} signals are emitted. The layersWillBeRemoved() and + * Emitted when all layers are removed, before layersWillBeRemoved() and + * layerWillBeRemoved() signals are emitted. The layersWillBeRemoved() and * layerWillBeRemoved() signals will still be emitted following this signal. * You can use this signal to do easy (and fast) cleanup. */ @@ -883,28 +883,28 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera * This signal is also emitted for layers added to the registry, * but not to the legend. * - * @param layers List of layers which have been added. + * \param layers List of layers which have been added. * - * @see legendLayersAdded() - * @see layerWasAdded() + * \see legendLayersAdded() + * \see layerWasAdded() */ void layersAdded( const QList &layers ); /** * Emitted when a layer was added to the registry. * - * @note Consider using {@link layersAdded()} instead - * @see layersAdded() + * \note Consider using layersAdded() instead + * \see layersAdded() */ void layerWasAdded( QgsMapLayer *layer ); /** * Emitted, when a layer was added to the registry and the legend. * Layers can also be private layers, which are signalled by - * {@link layersAdded()} and {@link layerWasAdded()} but will not be + * layersAdded() and layerWasAdded() but will not be * advertised by this signal. * - * @param layers List of {@link QgsMapLayer}s which were added to the legend. + * \param layers List of QgsMapLayer which were added to the legend. */ void legendLayersAdded( const QList &layers ); @@ -922,7 +922,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera * be asked to save changes to the project before closing the current project. * * \since QGIS 2.4 - * @note promoted to public slot in 2.16 + * \note promoted to public slot in 2.16 */ void setDirty( bool b = true ); @@ -938,31 +938,31 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera static QgsProject *sProject; /** Read map layers from project file. - * @param doc DOM document to parse - * @param brokenNodes a list of DOM nodes corresponding to layers that we were unable to load; this could be + * \param doc DOM document to parse + * \param brokenNodes a list of DOM nodes corresponding to layers that we were unable to load; this could be * because the layers were removed or re-located after the project was last saved - * @returns true if function worked; else is false + * \returns true if function worked; else is false */ bool _getMapLayers( const QDomDocument &doc, QList &brokenNodes ); /** Set error message from read/write operation - * @note not available in Python bindings + * \note not available in Python bindings */ void setError( const QString &errorMessage ); /** Clear error message - * @note not available in Python bindings + * \note not available in Python bindings */ void clearError(); //! Creates layer and adds it to maplayer registry - //! @note not available in Python bindings + //! \note not available in Python bindings bool addLayer( const QDomElement &layerElem, QList &brokenNodes ); - //! @note not available in Python bindings + //! \note not available in Python bindings void initializeEmbeddedSubtree( const QString &projectFilePath, QgsLayerTreeGroup *group ); - //! @note not available in Python bindings + //! \note not available in Python bindings void loadEmbeddedNodes( QgsLayerTreeGroup *group ); QMap mMapLayers; @@ -1005,7 +1005,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera }; /** Return the version string found in the given DOM document - @returns the version string or an empty string if none found + \returns the version string or an empty string if none found */ CORE_EXPORT QgsProjectVersion getVersion( QDomDocument const &doc ); diff --git a/src/core/qgsprojectfiletransform.h b/src/core/qgsprojectfiletransform.h index a78b9dab6f0b..4ec9af363776 100644 --- a/src/core/qgsprojectfiletransform.h +++ b/src/core/qgsprojectfiletransform.h @@ -43,8 +43,8 @@ class CORE_EXPORT QgsProjectFileTransform //QgsProjectfiletransform() {} /** Create an instance from a Dom and a supplied version - * @param domDocument The Dom document to use as content - * @param version Version number + * \param domDocument The Dom document to use as content + * \param version Version number */ QgsProjectFileTransform( QDomDocument &domDocument, const QgsProjectVersion &version ) diff --git a/src/core/qgsprojectproperty.h b/src/core/qgsprojectproperty.h index 524b76d6093c..0a09d4648f45 100644 --- a/src/core/qgsprojectproperty.h +++ b/src/core/qgsprojectproperty.h @@ -42,7 +42,7 @@ class QDomDocument; * contain either QgsProjectPropertyKey or QgsProjectPropertyValues, thus describing an * hierarchy. QgsProjectPropertyValues are always graph leaves. * - * @note This class is used internally by QgsProject. It's generally recommended that the methods in + * \note This class is used internally by QgsProject. It's generally recommended that the methods in * QgsProject are used to modify project properties rather than using these low-level classes. * \since QGIS 3.0 */ @@ -55,21 +55,21 @@ class CORE_EXPORT QgsProjectProperty /** * Dumps out the keys and values * - * @param tabs is number of tabs to print; used for pretty-printing hierarchy + * \param tabs is number of tabs to print; used for pretty-printing hierarchy */ virtual void dump( int tabs = 0 ) const = 0; /** * Returns true if the property is a QgsProjectPropertyKey. - * @see isValue() - * @see isLeaf() + * \see isValue() + * \see isLeaf() */ virtual bool isKey() const = 0; /** * Returns true if the property is a QgsProjectPropertyValue. - * @see isKey() - * @see isLeaf() + * \see isKey() + * \see isLeaf() */ virtual bool isValue() const = 0; @@ -95,9 +95,9 @@ class CORE_EXPORT QgsProjectProperty * * Used for saving properties to project file. * - * @param nodeName the tag name associated with this element - * @param element the parent (or encompassing) property element - * @param document the overall project file Dom document + * \param nodeName the tag name associated with this element + * \param element the parent (or encompassing) property element + * \param document the overall project file Dom document */ virtual bool writeXml( const QString &nodeName, QDomElement &element, @@ -191,7 +191,7 @@ class CORE_EXPORT QgsProjectPropertyKey : public QgsProjectProperty /** * The name of the property is used as identifier. - * @see setName() + * \see setName() */ QString name() const { return mName; } @@ -199,7 +199,7 @@ class CORE_EXPORT QgsProjectPropertyKey : public QgsProjectProperty * The name of the property is used as identifier. * * \since QGIS 3.0 - * @see name() + * \see name() */ void setName( const QString &name ); @@ -233,9 +233,9 @@ class CORE_EXPORT QgsProjectPropertyKey : public QgsProjectProperty /** * Sets the value associated with this key. - * @param name is the key name - * @param value is the value to set - * @return pointer to property value + * \param name is the key name + * \param value is the value to set + * \returns pointer to property value */ QgsProjectPropertyValue *setValue( const QString &name, const QVariant &value ) { @@ -250,7 +250,7 @@ class CORE_EXPORT QgsProjectPropertyKey : public QgsProjectProperty /** Set the value associated with this key * - * @note that the single value node associated with each key is always + * \note that the single value node associated with each key is always * stored keyed by the current key name */ QgsProjectPropertyValue *setValue( const QVariant &value ) @@ -278,13 +278,13 @@ class CORE_EXPORT QgsProjectPropertyKey : public QgsProjectProperty /** * Returns any sub-keys contained by this property that do not contain other keys. - * @see subkeyList() + * \see subkeyList() */ void entryList( QStringList &entries ) const; /** * Return any sub-keys contained by this property which themselves contain other keys. - * @see entryList() + * \see entryList() */ void subkeyList( QStringList &entries ) const; diff --git a/src/core/qgsprojectversion.cpp b/src/core/qgsprojectversion.cpp index 9f6f97a0b8cc..39524ad80b6d 100644 --- a/src/core/qgsprojectversion.cpp +++ b/src/core/qgsprojectversion.cpp @@ -53,8 +53,6 @@ QgsProjectVersion::QgsProjectVersion( const QString &string ) } -/** Boolean equal operator - */ bool QgsProjectVersion::operator==( const QgsProjectVersion &other ) const { return ( ( mMajor == other.mMajor ) && @@ -62,8 +60,6 @@ bool QgsProjectVersion::operator==( const QgsProjectVersion &other ) const ( mSub == other.mSub ) ); } -/** Boolean equal operator - */ bool QgsProjectVersion::operator!=( const QgsProjectVersion &other ) const { return ( ( mMajor != other.mMajor ) || @@ -71,8 +67,6 @@ bool QgsProjectVersion::operator!=( const QgsProjectVersion &other ) const ( mSub != other.mSub ) ); } -/** Boolean >= operator - */ bool QgsProjectVersion::operator>=( const QgsProjectVersion &other ) const { return ( ( mMajor >= other.mMajor ) || @@ -80,8 +74,6 @@ bool QgsProjectVersion::operator>=( const QgsProjectVersion &other ) const ( ( mMajor == other.mMajor ) && ( mMinor == other.mMinor ) && ( mSub >= other.mSub ) ) ); } -/** Boolean > operator - */ bool QgsProjectVersion::operator>( const QgsProjectVersion &other ) const { return ( ( mMajor > other.mMajor ) || diff --git a/src/core/qgsprojectversion.h b/src/core/qgsprojectversion.h index d489dd14e783..24fe011075b0 100644 --- a/src/core/qgsprojectversion.h +++ b/src/core/qgsprojectversion.h @@ -58,7 +58,7 @@ class CORE_EXPORT QgsProjectVersion */ bool operator==( const QgsProjectVersion &other ) const; - /** Boolean equal operator + /** Boolean not equal operator */ bool operator!=( const QgsProjectVersion &other ) const; diff --git a/src/core/qgsproperty.h b/src/core/qgsproperty.h index f615b7be4a7a..c357a8139f1d 100644 --- a/src/core/qgsproperty.h +++ b/src/core/qgsproperty.h @@ -238,55 +238,55 @@ class CORE_EXPORT QgsProperty /** * Returns whether the property is currently active. - * @see setActive() + * \see setActive() */ bool isActive() const; /** * Sets whether the property is currently active. - * @see isActive() + * \see isActive() */ void setActive( bool active ); /** * Sets the static value for the property. Calling this will * transform the property into an StaticProperty. - * @see staticValue() + * \see staticValue() */ void setStaticValue( const QVariant &value ); /** * Returns the current static value for the property. If the property * is not a StaticProperty this will return an invalid variant. - * @see setStaticValue() + * \see setStaticValue() */ QVariant staticValue() const; /** * Sets the field name the property references. Calling this will * transform the property into an FieldBasedProperty. - * @see field() + * \see field() */ void setField( const QString &field ); /** * Returns the current field name the property references. If the property * is not a FieldBasedProperty this will return an empty string. - * @see setField() + * \see setField() */ QString field() const; /** * Sets the expression to use for the property value. Calling this will * transform the property into an ExpressionBasedProperty. - * @see expressionString() + * \see expressionString() */ void setExpressionString( const QString &expression ); /** * Returns the expression used for the property value. If the property * is not a ExpressionBasedProperty this will return an empty string. - * @see setExpressionString() + * \see setExpressionString() */ QString expressionString() const; @@ -311,87 +311,87 @@ class CORE_EXPORT QgsProperty /** * Calculates the current value of the property, including any transforms which are set for the property - * @param context QgsExpressionContext to evaluate the property for. The variables and functions contained + * \param context QgsExpressionContext to evaluate the property for. The variables and functions contained * in the expression context can be used to alter the calculated value for the property, so that a property * is able to respond to the current environment, layers and features within QGIS. - * @param defaultValue default value to return if the property is not active or cannot be calculated - * @param ok if specified, will be set to true if conversion was successful - * @returns calculated value for property - * @see valueAsString() - * @see valueAsColor() - * @see valueAsDouble() - * @see valueAsInt() - * @see valueAsBool() + * \param defaultValue default value to return if the property is not active or cannot be calculated + * \param ok if specified, will be set to true if conversion was successful + * \returns calculated value for property + * \see valueAsString() + * \see valueAsColor() + * \see valueAsDouble() + * \see valueAsInt() + * \see valueAsBool() */ QVariant value( const QgsExpressionContext &context, const QVariant &defaultValue = QVariant(), bool *ok = nullptr ) const; /** * Calculates the current value of the property and interprets it as a string. - * @param context QgsExpressionContext to evaluate the property for. - * @param defaultString default string to return if the property cannot be calculated as a string - * @param ok if specified, will be set to true if conversion was successful - * @returns value parsed to string - * @see value() - * @see valueAsColor() - * @see valueAsDouble() - * @see valueAsInt() - * @see valueAsBool() + * \param context QgsExpressionContext to evaluate the property for. + * \param defaultString default string to return if the property cannot be calculated as a string + * \param ok if specified, will be set to true if conversion was successful + * \returns value parsed to string + * \see value() + * \see valueAsColor() + * \see valueAsDouble() + * \see valueAsInt() + * \see valueAsBool() */ QString valueAsString( const QgsExpressionContext &context, const QString &defaultString = QString(), bool *ok = nullptr ) const; /** * Calculates the current value of the property and interprets it as a color. - * @param context QgsExpressionContext to evaluate the property for. - * @param defaultColor default color to return if the property cannot be calculated as a color - * @param ok if specified, will be set to true if conversion was successful - * @returns value parsed to color - * @see value() - * @see valueAsString() - * @see valueAsDouble() - * @see valueAsInt() - * @see valueAsBool() + * \param context QgsExpressionContext to evaluate the property for. + * \param defaultColor default color to return if the property cannot be calculated as a color + * \param ok if specified, will be set to true if conversion was successful + * \returns value parsed to color + * \see value() + * \see valueAsString() + * \see valueAsDouble() + * \see valueAsInt() + * \see valueAsBool() */ QColor valueAsColor( const QgsExpressionContext &context, const QColor &defaultColor = QColor(), bool *ok = nullptr ) const; /** * Calculates the current value of the property and interprets it as a double. - * @param context QgsExpressionContext to evaluate the property for. - * @param defaultValue default double to return if the property cannot be calculated as a double - * @param ok if specified, will be set to true if conversion was successful - * @returns value parsed to double - * @see value() - * @see valueAsString() - * @see valueAsColor() - * @see valueAsInt() - * @see valueAsBool() + * \param context QgsExpressionContext to evaluate the property for. + * \param defaultValue default double to return if the property cannot be calculated as a double + * \param ok if specified, will be set to true if conversion was successful + * \returns value parsed to double + * \see value() + * \see valueAsString() + * \see valueAsColor() + * \see valueAsInt() + * \see valueAsBool() */ double valueAsDouble( const QgsExpressionContext &context, double defaultValue = 0.0, bool *ok = nullptr ) const; /** * Calculates the current value of the property and interprets it as an integer. - * @param context QgsExpressionContext to evaluate the property for. - * @param defaultValue default integer to return if the property cannot be calculated as an integer - * @param ok if specified, will be set to true if conversion was successful - * @returns value parsed to integer - * @see value() - * @see valueAsString() - * @see valueAsColor() - * @see valueAsDouble() - * @see valueAsBool() + * \param context QgsExpressionContext to evaluate the property for. + * \param defaultValue default integer to return if the property cannot be calculated as an integer + * \param ok if specified, will be set to true if conversion was successful + * \returns value parsed to integer + * \see value() + * \see valueAsString() + * \see valueAsColor() + * \see valueAsDouble() + * \see valueAsBool() */ int valueAsInt( const QgsExpressionContext &context, int defaultValue = 0, bool *ok = nullptr ) const; /** * Calculates the current value of the property and interprets it as an boolean. - * @param context QgsExpressionContext to evaluate the property for. - * @param defaultValue default boolean to return if the property cannot be calculated as an boolean - * @param ok if specified, will be set to true if conversion was successful - * @returns value parsed to boolean - * @see value() - * @see valueAsString() - * @see valueAsColor() - * @see valueAsDouble() - * @see valueAsInt() + * \param context QgsExpressionContext to evaluate the property for. + * \param defaultValue default boolean to return if the property cannot be calculated as an boolean + * \param ok if specified, will be set to true if conversion was successful + * \returns value parsed to boolean + * \see value() + * \see valueAsString() + * \see valueAsColor() + * \see valueAsDouble() + * \see valueAsInt() */ bool valueAsBool( const QgsExpressionContext &context, bool defaultValue = false, bool *ok = nullptr ) const; @@ -399,7 +399,7 @@ class CORE_EXPORT QgsProperty * Saves this property to a QVariantMap, wrapped in a QVariant. * You can use QgsXmlUtils::writeVariant to save it to an XML document. * - * @see loadVariant() + * \see loadVariant() */ QVariant toVariant() const; @@ -407,21 +407,21 @@ class CORE_EXPORT QgsProperty * Loads this property from a QVariantMap, wrapped in a QVariant. * You can use QgsXmlUtils::readVariant to load it from an XML document. * - * @see toVariant() + * \see toVariant() */ bool loadVariant( const QVariant &property ); /** * Sets an optional transformer to use for manipulating the calculated values for the property. - * @param transformer transformer to install. Ownership is transferred to the property, and any + * \param transformer transformer to install. Ownership is transferred to the property, and any * existing transformer will be deleted. Set to null to remove an existing transformer. - * @see transformer() + * \see transformer() */ void setTransformer( QgsPropertyTransformer *transformer ); /** * Returns the existing transformer used for manipulating the calculated values for the property, if set. - * @see setTransformer() + * \see setTransformer() */ const QgsPropertyTransformer *transformer() const; diff --git a/src/core/qgspropertycollection.h b/src/core/qgspropertycollection.h index f22ca26866e9..7444a6a25fb6 100644 --- a/src/core/qgspropertycollection.h +++ b/src/core/qgspropertycollection.h @@ -49,13 +49,13 @@ class CORE_EXPORT QgsAbstractPropertyCollection /** * Returns the descriptive name of the property collection. - * @see setName() + * \see setName() */ QString name() const { return mName; } /** * Sets the descriptive name for the property collection. - * @see name() + * \see name() */ void setName( const QString &name ) { mName = name; } @@ -71,114 +71,114 @@ class CORE_EXPORT QgsAbstractPropertyCollection /** * Returns true if the collection contains a property with the specified key. - * @param key integer key for property. The intended use case is that a context specific enum is cast to + * \param key integer key for property. The intended use case is that a context specific enum is cast to * int and used for the key value. - * @see property() + * \see property() */ virtual bool hasProperty( int key ) const = 0; /** * Returns a matching property from the collection, if one exists. - * @param key integer key for property to return. The intended use case is that a context specific enum is cast to + * \param key integer key for property to return. The intended use case is that a context specific enum is cast to * int and used for the key value. - * @returns matching property, or null if no matching, active property found. - * @see hasProperty() + * \returns matching property, or null if no matching, active property found. + * \see hasProperty() */ virtual QgsProperty property( int key ) const = 0; /** * Returns the calculated value of the property with the specified key from within the collection. - * @param key integer key for property to return. The intended use case is that a context specific enum is cast to + * \param key integer key for property to return. The intended use case is that a context specific enum is cast to * int and used for the key value. - * @param context expression context to evaluate property against - * @param defaultValue default value to return if no matching, active property found or if the property value + * \param context expression context to evaluate property against + * \param defaultValue default value to return if no matching, active property found or if the property value * cannot be calculated - * @returns calculated property value, or default value if property could not be evaluated - * @see valueAsString() - * @see valueAsColor() - * @see valueAsDouble() - * @see valueAsInt() - * @see valueAsBool() + * \returns calculated property value, or default value if property could not be evaluated + * \see valueAsString() + * \see valueAsColor() + * \see valueAsDouble() + * \see valueAsInt() + * \see valueAsBool() */ virtual QVariant value( int key, const QgsExpressionContext &context, const QVariant &defaultValue = QVariant() ) const = 0; /** * Calculates the current value of the property with the specified key and interprets it as a string. - * @param key integer key for property to return. The intended use case is that a context specific enum is cast to + * \param key integer key for property to return. The intended use case is that a context specific enum is cast to * int and used for the key value. - * @param context QgsExpressionContext to evaluate the property for. - * @param defaultString default string to return if the property cannot be calculated as a string - * @param ok if specified, will be set to true if conversion was successful - * @returns value parsed to string - * @see value() - * @see valueAsColor() - * @see valueAsDouble() - * @see valueAsInt() - * @see valueAsBool() + * \param context QgsExpressionContext to evaluate the property for. + * \param defaultString default string to return if the property cannot be calculated as a string + * \param ok if specified, will be set to true if conversion was successful + * \returns value parsed to string + * \see value() + * \see valueAsColor() + * \see valueAsDouble() + * \see valueAsInt() + * \see valueAsBool() */ QString valueAsString( int key, const QgsExpressionContext &context, const QString &defaultString = QString(), bool *ok = nullptr ) const; /** * Calculates the current value of the property with the specified key and interprets it as a color. - * @param key integer key for property to return. The intended use case is that a context specific enum is cast to + * \param key integer key for property to return. The intended use case is that a context specific enum is cast to * int and used for the key value. - * @param context QgsExpressionContext to evaluate the property for. - * @param defaultColor default color to return if the property cannot be calculated as a color - * @param ok if specified, will be set to true if conversion was successful - * @returns value parsed to color - * @see value() - * @see valueAsString() - * @see valueAsDouble() - * @see valueAsInt() - * @see valueAsBool() + * \param context QgsExpressionContext to evaluate the property for. + * \param defaultColor default color to return if the property cannot be calculated as a color + * \param ok if specified, will be set to true if conversion was successful + * \returns value parsed to color + * \see value() + * \see valueAsString() + * \see valueAsDouble() + * \see valueAsInt() + * \see valueAsBool() */ QColor valueAsColor( int key, const QgsExpressionContext &context, const QColor &defaultColor = QColor(), bool *ok = nullptr ) const; /** * Calculates the current value of the property with the specified key and interprets it as a double. - * @param key integer key for property to return. The intended use case is that a context specific enum is cast to + * \param key integer key for property to return. The intended use case is that a context specific enum is cast to * int and used for the key value. - * @param context QgsExpressionContext to evaluate the property for. - * @param defaultValue default double to return if the property cannot be calculated as a double - * @param ok if specified, will be set to true if conversion was successful - * @returns value parsed to double - * @see value() - * @see valueAsString() - * @see valueAsColor() - * @see valueAsInt() - * @see valueAsBool() + * \param context QgsExpressionContext to evaluate the property for. + * \param defaultValue default double to return if the property cannot be calculated as a double + * \param ok if specified, will be set to true if conversion was successful + * \returns value parsed to double + * \see value() + * \see valueAsString() + * \see valueAsColor() + * \see valueAsInt() + * \see valueAsBool() */ double valueAsDouble( int key, const QgsExpressionContext &context, double defaultValue = 0.0, bool *ok = nullptr ) const; /** * Calculates the current value of the property with the specified key and interprets it as an integer. - * @param key integer key for property to return. The intended use case is that a context specific enum is cast to + * \param key integer key for property to return. The intended use case is that a context specific enum is cast to * int and used for the key value. - * @param context QgsExpressionContext to evaluate the property for. - * @param defaultValue default integer to return if the property cannot be calculated as a integer - * @param ok if specified, will be set to true if conversion was successful - * @returns value parsed to integer - * @see value() - * @see valueAsString() - * @see valueAsColor() - * @see valueAsDouble() - * @see valueAsBool() + * \param context QgsExpressionContext to evaluate the property for. + * \param defaultValue default integer to return if the property cannot be calculated as a integer + * \param ok if specified, will be set to true if conversion was successful + * \returns value parsed to integer + * \see value() + * \see valueAsString() + * \see valueAsColor() + * \see valueAsDouble() + * \see valueAsBool() */ int valueAsInt( int key, const QgsExpressionContext &context, int defaultValue = 0, bool *ok = nullptr ) const; /** * Calculates the current value of the property with the specified key and interprets it as an boolean. - * @param key integer key for property to return. The intended use case is that a context specific enum is cast to + * \param key integer key for property to return. The intended use case is that a context specific enum is cast to * int and used for the key value. - * @param context QgsExpressionContext to evaluate the property for. - * @param defaultValue default boolean to return if the property cannot be calculated as a boolean - * @param ok if specified, will be set to true if conversion was successful - * @returns value parsed to bool - * @see value() - * @see valueAsString() - * @see valueAsColor() - * @see valueAsDouble() - * @see valueAsInt() + * \param context QgsExpressionContext to evaluate the property for. + * \param defaultValue default boolean to return if the property cannot be calculated as a boolean + * \param ok if specified, will be set to true if conversion was successful + * \returns value parsed to bool + * \see value() + * \see valueAsString() + * \see valueAsColor() + * \see valueAsDouble() + * \see valueAsInt() */ bool valueAsBool( int key, const QgsExpressionContext &context, bool defaultValue = false, bool *ok = nullptr ) const; @@ -191,13 +191,13 @@ class CORE_EXPORT QgsAbstractPropertyCollection /** * Returns the set of any fields referenced by the active properties from the collection. - * @param context expression context the properties will be evaluated against. + * \param context expression context the properties will be evaluated against. */ virtual QSet< QString > referencedFields( const QgsExpressionContext &context = QgsExpressionContext() ) const = 0; /** * Returns true if the collection contains an active property with the specified key. - * @param key integer key for property to test. The intended use case is that a context specific enum is cast to + * \param key integer key for property to test. The intended use case is that a context specific enum is cast to * int and used for the key value. */ virtual bool isActive( int key ) const = 0; @@ -205,30 +205,30 @@ class CORE_EXPORT QgsAbstractPropertyCollection /** * Returns true if the collection has any active properties, or false if all properties * within the collection are deactivated. - * @see hasDynamicProperties() + * \see hasDynamicProperties() */ virtual bool hasActiveProperties() const = 0; /** * Returns true if the collection has any active, non-static properties, or false if either all non-static properties * within the collection are deactivated or if the collection only contains static properties. - * @see hasActiveProperties() + * \see hasActiveProperties() */ virtual bool hasDynamicProperties() const = 0; /** * Writes the current state of the property collection into an XML element - * @param collectionElem destination element for the property collection's state - * @param definitions property definitions - * @see readXml() + * \param collectionElem destination element for the property collection's state + * \param definitions property definitions + * \see readXml() */ virtual bool writeXml( QDomElement &collectionElem, const QgsPropertiesDefinition &definitions ) const; /** * Reads property collection state from an XML element. - * @param collectionElem source DOM element for property collection's state - * @param definitions property definitions - * @see writeXml() + * \param collectionElem source DOM element for property collection's state + * \param definitions property definitions + * \see writeXml() */ virtual bool readXml( const QDomElement &collectionElem, const QgsPropertiesDefinition &definitions ); @@ -236,7 +236,7 @@ class CORE_EXPORT QgsAbstractPropertyCollection * Saves this property collection to a QVariantMap, wrapped in a QVariant. * You can use QgsXmlUtils::writeVariant to save it to an XML document. * - * @see loadVariant() + * \see loadVariant() */ virtual QVariant toVariant( const QgsPropertiesDefinition &definitions ) const = 0; @@ -244,7 +244,7 @@ class CORE_EXPORT QgsAbstractPropertyCollection * Loads this property collection from a QVariantMap, wrapped in a QVariant. * You can use QgsXmlUtils::readVariant to save it to an XML document. * - * @see toVariant() + * \see toVariant() */ virtual bool loadVariant( const QVariant &configuration, const QgsPropertiesDefinition &definitions ) = 0; @@ -270,7 +270,7 @@ class CORE_EXPORT QgsPropertyCollection : public QgsAbstractPropertyCollection /** * Constructor for QgsPropertyCollection - * @param name collection name + * \param name collection name */ QgsPropertyCollection( const QString &name = QString() ); @@ -293,10 +293,10 @@ class CORE_EXPORT QgsPropertyCollection : public QgsAbstractPropertyCollection /** * Returns a reference to a matching property from the collection, if one exists. - * @param key integer key for property to return. The intended use case is that a context specific enum is cast to + * \param key integer key for property to return. The intended use case is that a context specific enum is cast to * int and used for the key value. - * @returns matching property, or null if no matching, active property found. - * @see hasProperty() + * \returns matching property, or null if no matching, active property found. + * \see hasProperty() */ virtual QgsProperty &property( int key ); @@ -312,20 +312,20 @@ class CORE_EXPORT QgsPropertyCollection : public QgsAbstractPropertyCollection /** * Adds a property to the collection and takes ownership of it. - * @param key integer key for property. Any existing property with the same key will be removed + * \param key integer key for property. Any existing property with the same key will be removed * and replaced by this property. The intended use case is that a context specific enum is cast to * int and used for the key value. - * @param property property to add. Ownership is transferred to the collection. Setting an invalid property + * \param property property to add. Ownership is transferred to the collection. Setting an invalid property * will remove the property from the collection. */ void setProperty( int key, const QgsProperty &property ); /** * Convience method, creates a QgsStaticProperty and stores it within the collection. - * @param key integer key for property. Any existing property with the same key will be deleted + * \param key integer key for property. Any existing property with the same key will be deleted * and replaced by this property. The intended use case is that a context specific enum is cast to * int and used for the key value. - * @param value static value for property + * \param value static value for property */ void setProperty( int key, const QVariant &value ); @@ -377,77 +377,77 @@ class CORE_EXPORT QgsPropertyCollectionStack : public QgsAbstractPropertyCollect /** * Appends a collection to the end of the stack, and transfers ownership of the collection to the stack. Properties * from the newly added collection will take priority over any existing properties with the same name. - * @param collection collection to append. Ownership is transferred to the stack. + * \param collection collection to append. Ownership is transferred to the stack. */ void appendCollection( QgsPropertyCollection *collection ); /** * Returns the collection at the corresponding index from the stack. - * @param index position of collection, 0 based - * @returns collection if one exists at the specified index + * \param index position of collection, 0 based + * \returns collection if one exists at the specified index */ QgsPropertyCollection *at( int index ); /** * Returns the collection at the corresponding index from the stack. - * @param index position of collection, 0 based - * @returns collection if one exists at the specified index + * \param index position of collection, 0 based + * \returns collection if one exists at the specified index */ const QgsPropertyCollection *at( int index ) const; /** * Returns the first collection with a matching name from the stack. - * @param name name of collection to find - * @returns collection if one exists with the specified name + * \param name name of collection to find + * \returns collection if one exists with the specified name */ QgsPropertyCollection *collection( const QString &name ); /** * Returns true if the collection has any active properties, or false if all properties * within the collection are deactivated. - * @see isActive() - * @see hasDynamicProperties() + * \see isActive() + * \see hasDynamicProperties() */ bool hasActiveProperties() const override; /** * Returns true if the collection has any active, non-static properties, or false if either all non-static properties * within the collection are deactivated or if the collection only contains static properties. - * @see hasActiveProperties() + * \see hasActiveProperties() */ bool hasDynamicProperties() const override; /** * Returns true if the stack contains an active property with the specified key. - * @param key integer key for property to test. The intended use case is that a context specific enum is cast to + * \param key integer key for property to test. The intended use case is that a context specific enum is cast to * int and used for the key value. - * @see hasActiveProperties() + * \see hasActiveProperties() */ bool isActive( int key ) const override; /** * Returns the highest priority property with a matching key from within the stack. - * @param key integer key for property to return. The intended use case is that a context specific enum is cast to + * \param key integer key for property to return. The intended use case is that a context specific enum is cast to * int and used for the key value. - * @returns matching property, or null if no matching, active property found. - * @see hasActiveProperty() + * \returns matching property, or null if no matching, active property found. + * \see hasActiveProperty() */ QgsProperty property( int key ) const override; /** * Returns the calculated value of the highest priority property with the specified key from within the stack. - * @param key integer key for property to calculate. The intended use case is that a context specific enum is cast to + * \param key integer key for property to calculate. The intended use case is that a context specific enum is cast to * int and used for the key value. - * @param context expression context to evaluate property against - * @param defaultValue default value to return if no matching, active property found or if the property value + * \param context expression context to evaluate property against + * \param defaultValue default value to return if no matching, active property found or if the property value * cannot be calculated - * @returns calculated property value, or default value if property could not be evaluated + * \returns calculated property value, or default value if property could not be evaluated */ QVariant value( int key, const QgsExpressionContext &context, const QVariant &defaultValue = QVariant() ) const override; /** * Returns the set of any fields referenced by the active properties from the stack. - * @param context expression context the properties will be evaluated against. + * \param context expression context the properties will be evaluated against. */ QSet< QString > referencedFields( const QgsExpressionContext &context = QgsExpressionContext() ) const override; virtual bool prepare( const QgsExpressionContext &context = QgsExpressionContext() ) const override; diff --git a/src/core/qgspropertytransformer.h b/src/core/qgspropertytransformer.h index 411baedba747..44a32cff96e6 100644 --- a/src/core/qgspropertytransformer.h +++ b/src/core/qgspropertytransformer.h @@ -81,28 +81,28 @@ class CORE_EXPORT QgsCurveTransform /** * Returns a list of the control points for the transform. - * @see setControlPoints() + * \see setControlPoints() */ QList< QgsPoint > controlPoints() const { return mControlPoints; } /** * Sets the list of control points for the transform. Any existing * points are removed. - * @see controlPoints() + * \see controlPoints() */ void setControlPoints( const QList< QgsPoint > &points ); /** * Adds a control point to the transform. Behavior is undefined if duplicate * x values exist in the control points list. - * @see removeControlPoint() + * \see removeControlPoint() */ void addControlPoint( double x, double y ); /** * Removes a control point from the transform. This will have no effect if a * matching control point does not exist. - * @see addControlPoint() + * \see addControlPoint() */ void removeControlPoint( double x, double y ); @@ -120,17 +120,17 @@ class CORE_EXPORT QgsCurveTransform /** * Reads the curve's state from an XML element. - * @param elem source DOM element for transform's state - * @param doc DOM document - * @see writeXml() + * \param elem source DOM element for transform's state + * \param doc DOM document + * \see writeXml() */ bool readXml( const QDomElement &elem, const QDomDocument &doc ); /** * Writes the current state of the transform into an XML element - * @param transformElem destination element for the transform's state - * @param doc DOM document - * @see readXml() + * \param transformElem destination element for the transform's state + * \param doc DOM document + * \see readXml() */ bool writeXml( QDomElement &transformElem, QDomDocument &doc ) const; @@ -138,7 +138,7 @@ class CORE_EXPORT QgsCurveTransform * Saves this curve transformer to a QVariantMap, wrapped in a QVariant. * You can use QgsXmlUtils::writeVariant to save it to an XML document. * - * @see loadVariant() + * \see loadVariant() */ QVariant toVariant() const; @@ -146,7 +146,7 @@ class CORE_EXPORT QgsCurveTransform * Load this curve transformer from a QVariantMap, wrapped in a QVariant. * You can use QgsXmlUtils::writeVariant to load it from an XML document. * - * @see toVariant() + * \see toVariant() */ bool loadVariant( const QVariant &transformer ); @@ -195,14 +195,14 @@ class CORE_EXPORT QgsPropertyTransformer /** * Factory method for creating a new property transformer of the specified type. - * @param type transformer type to create + * \param type transformer type to create */ static QgsPropertyTransformer *create( Type type ) SIP_FACTORY; /** * Constructor for QgsPropertyTransformer - * @param minValue minimum expected value from source property - * @param maxValue maximum expected value from source property + * \param minValue minimum expected value from source property + * \param maxValue maximum expected value from source property */ QgsPropertyTransformer( double minValue = 0.0, double maxValue = 1.0 ); @@ -228,7 +228,7 @@ class CORE_EXPORT QgsPropertyTransformer * Loads this transformer from a QVariantMap, wrapped in a QVariant. * You can use QgsXmlUtils::writeVariant to save it to an XML document. * - * @see loadVariant() + * \see loadVariant() */ virtual bool loadVariant( const QVariant &transformer ); @@ -236,44 +236,44 @@ class CORE_EXPORT QgsPropertyTransformer * Saves this transformer to a QVariantMap, wrapped in a QVariant. * You can use QgsXmlUtils::writeVariant to save it to an XML document. * - * @see toVariant() + * \see toVariant() */ virtual QVariant toVariant() const; /** * Returns the minimum value expected by the transformer. - * @see maxValue() - * @see setMinValue() + * \see maxValue() + * \see setMinValue() */ double minValue() const { return mMinValue; } /** * Sets the minimum value expected by the transformer. - * @param min minimum value - * @see setMaxValue() - * @see minValue() + * \param min minimum value + * \see setMaxValue() + * \see minValue() */ void setMinValue( double min ) { mMinValue = min; } /** * Returns the maximum value expected by the transformer. - * @see minValue() - * @see setMaxValue() + * \see minValue() + * \see setMaxValue() */ double maxValue() const { return mMaxValue; } /** * Sets the maximum value expected by the transformer. - * @param max maximum value - * @see setMinValue() - * @see maxValue() + * \param max maximum value + * \see setMinValue() + * \see maxValue() */ void setMaxValue( double max ) { mMaxValue = max; } /** * Returns the curve transform applied to input values before they are transformed * by the individual transform subclasses. - * @see setCurveTransform() + * \see setCurveTransform() */ QgsCurveTransform *curveTransform() const { return mCurveTransform.get(); } @@ -281,15 +281,15 @@ class CORE_EXPORT QgsPropertyTransformer * Sets a curve transform to apply to input values before they are transformed * by the individual transform subclasses. Ownership of \a transform is transferred * to the property transformer. - * @see curveTransform() + * \see curveTransform() */ void setCurveTransform( QgsCurveTransform *transform SIP_TRANSFER ) { mCurveTransform.reset( transform ); } /** * Calculates the transform of a value. Derived classes must implement this to perform their transformations * on input values - * @param context expression context - * @param value input value to transform + * \param context expression context + * \param value input value to transform */ virtual QVariant transform( const QgsExpressionContext &context, const QVariant &value ) const = 0; @@ -301,14 +301,14 @@ class CORE_EXPORT QgsPropertyTransformer /** * Attempts to parse an expression into a corresponding property transformer. - * @param expression expression to parse - * @param baseExpression will be set to the component of the source expression which + * \param expression expression to parse + * \param baseExpression will be set to the component of the source expression which * is used to calculate the input to the property transformer. This will be set to an * empty string if a field reference is the transformer input. - * @param fieldName will be set to a field name which is used to calculate the input + * \param fieldName will be set to a field name which is used to calculate the input * to the property transformer. This will be set to an * empty string if an expression is the transformer input. - * @returns corresponding property transformer, or nullptr if expression could not + * \returns corresponding property transformer, or nullptr if expression could not * be parsed to a transformer. */ static QgsPropertyTransformer *fromExpression( const QString &expression, QString &baseExpression SIP_OUT, QString &fieldName SIP_OUT ) SIP_FACTORY; @@ -346,12 +346,12 @@ class CORE_EXPORT QgsGenericNumericTransformer : public QgsPropertyTransformer /** * Constructor for QgsGenericNumericTransformer. - * @param minValue minimum expected input value - * @param maxValue maximum expected input value - * @param minOutput minimum value to return - * @param maxOutput maximum value to return - * @param nullOutput value to return for null inputs - * @param exponent optional exponential for non-linear scaling + * \param minValue minimum expected input value + * \param maxValue maximum expected input value + * \param minOutput minimum value to return + * \param maxOutput maximum value to return + * \param nullOutput value to return for null inputs + * \param exponent optional exponential for non-linear scaling */ QgsGenericNumericTransformer( double minValue = 0.0, double maxValue = 1.0, @@ -375,77 +375,77 @@ class CORE_EXPORT QgsGenericNumericTransformer : public QgsPropertyTransformer /** * Attempts to parse an expression into a corresponding QgsSizeScaleTransformer. - * @param expression expression to parse - * @param baseExpression will be set to the component of the source expression which + * \param expression expression to parse + * \param baseExpression will be set to the component of the source expression which * is used to calculate the input to the property transformer. This will be set to an * empty string if a field reference is the transformer input. - * @param fieldName will be set to a field name which is used to calculate the input + * \param fieldName will be set to a field name which is used to calculate the input * to the property transformer. This will be set to an * empty string if an expression is the transformer input. - * @returns corresponding QgsSizeScaleTransformer, or nullptr if expression could not + * \returns corresponding QgsSizeScaleTransformer, or nullptr if expression could not * be parsed to a size scale transformer. */ static QgsGenericNumericTransformer *fromExpression( const QString &expression, QString &baseExpression SIP_OUT, QString &fieldName SIP_OUT ) SIP_FACTORY; /** * Calculates the size corresponding to a specific \a input value. - * @returns calculated size using size scale transformer's parameters and type + * \returns calculated size using size scale transformer's parameters and type */ double value( double input ) const; /** * Returns the minimum calculated size. - * @see setMinSize() - * @see maxSize() + * \see setMinSize() + * \see maxSize() */ double minOutputValue() const { return mMinOutput; } /** * Sets the minimum calculated size. - * @param size minimum size - * @see minSize() - * @see setMaxSize() + * \param size minimum size + * \see minSize() + * \see setMaxSize() */ void setMinOutputValue( double size ) { mMinOutput = size; } /** * Returns the maximum calculated size. - * @see minSize() + * \see minSize() */ double maxOutputValue() const { return mMaxOutput; } /** * Sets the maximum calculated size. - * @param size maximum size - * @see maxSize() - * @see setMinSize() + * \param size maximum size + * \see maxSize() + * \see setMinSize() */ void setMaxOutputValue( double size ) { mMaxOutput = size; } /** * Returns the size value when an expression evaluates to NULL. - * @see setNullSize() + * \see setNullSize() */ double nullOutputValue() const { return mNullOutput; } /** * Sets the size value for when an expression evaluates to NULL. - * @param size null size - * @see nullSize() + * \param size null size + * \see nullSize() */ void setNullOutputValue( double size ) { mNullOutput = size; } /** * Returns the exponent for an exponential expression. - * @see setExponent() - * @see type() + * \see setExponent() + * \see type() */ double exponent() const { return mExponent; } /** * Sets the exponent for an exponential expression. - * @param exponent exponent - * @see exponent() + * \param exponent exponent + * \see exponent() */ void setExponent( double exponent ) { mExponent = exponent; } @@ -480,13 +480,13 @@ class CORE_EXPORT QgsSizeScaleTransformer : public QgsPropertyTransformer /** * Constructor for QgsSizeScaleTransformer. - * @param type scaling type - * @param minValue minimum expected value - * @param maxValue maximum expected value - * @param minSize minimum size to return - * @param maxSize maximum size to return - * @param nullSize size to return for null values - * @param exponent exponent for Exponential scaling method + * \param type scaling type + * \param minValue minimum expected value + * \param maxValue maximum expected value + * \param minSize minimum size to return + * \param maxSize maximum size to return + * \param nullSize size to return for null values + * \param exponent exponent for Exponential scaling method */ QgsSizeScaleTransformer( ScaleType type = Linear, double minValue = 0.0, @@ -511,93 +511,93 @@ class CORE_EXPORT QgsSizeScaleTransformer : public QgsPropertyTransformer /** * Attempts to parse an expression into a corresponding QgsSizeScaleTransformer. - * @param expression expression to parse - * @param baseExpression will be set to the component of the source expression which + * \param expression expression to parse + * \param baseExpression will be set to the component of the source expression which * is used to calculate the input to the property transformer. This will be set to an * empty string if a field reference is the transformer input. - * @param fieldName will be set to a field name which is used to calculate the input + * \param fieldName will be set to a field name which is used to calculate the input * to the property transformer. This will be set to an * empty string if an expression is the transformer input. - * @returns corresponding QgsSizeScaleTransformer, or nullptr if expression could not + * \returns corresponding QgsSizeScaleTransformer, or nullptr if expression could not * be parsed to a size scale transformer. */ static QgsSizeScaleTransformer *fromExpression( const QString &expression, QString &baseExpression SIP_OUT, QString &fieldName SIP_OUT ) SIP_FACTORY; /** * Calculates the size corresponding to a specific value. - * @param value value to calculate size for - * @returns calculated size using size scale transformer's parameters and type + * \param value value to calculate size for + * \returns calculated size using size scale transformer's parameters and type */ double size( double value ) const; /** * Returns the minimum calculated size. - * @see setMinSize() - * @see maxSize() + * \see setMinSize() + * \see maxSize() */ double minSize() const { return mMinSize; } /** * Sets the minimum calculated size. - * @param size minimum size - * @see minSize() - * @see setMaxSize() + * \param size minimum size + * \see minSize() + * \see setMaxSize() */ void setMinSize( double size ) { mMinSize = size; } /** * Returns the maximum calculated size. - * @see minSize() + * \see minSize() */ double maxSize() const { return mMaxSize; } /** * Sets the maximum calculated size. - * @param size maximum size - * @see maxSize() - * @see setMinSize() + * \param size maximum size + * \see maxSize() + * \see setMinSize() */ void setMaxSize( double size ) { mMaxSize = size; } /** * Returns the size value when an expression evaluates to NULL. - * @see setNullSize() + * \see setNullSize() */ double nullSize() const { return mNullSize; } /** * Sets the size value for when an expression evaluates to NULL. - * @param size null size - * @see nullSize() + * \param size null size + * \see nullSize() */ void setNullSize( double size ) { mNullSize = size; } /** * Returns the exponent for an exponential expression. - * @see setExponent() - * @see type() + * \see setExponent() + * \see type() */ double exponent() const { return mExponent; } /** * Sets the exponent for an exponential expression. - * @param exponent exponent - * @see exponent() + * \param exponent exponent + * \see exponent() */ void setExponent( double exponent ) { mExponent = exponent; } /** * Returns the size transformer's scaling type (the method used to calculate * the size from a value). - * @see setType() + * \see setType() */ ScaleType type() const { return mType; } /** * Sets the size transformer's scaling type (the method used to calculate * the size from a value). - * @param type scale type - * @see type() + * \param type scale type + * \see type() */ void setType( ScaleType type ); @@ -624,10 +624,10 @@ class CORE_EXPORT QgsColorRampTransformer : public QgsPropertyTransformer /** * Constructor for QgsColorRampTransformer. - * @param minValue minimum expected value - * @param maxValue maximum expected value - * @param ramp source color ramp. Ownership is transferred to the transformer. - * @param nullColor color to return for null values + * \param minValue minimum expected value + * \param maxValue maximum expected value + * \param ramp source color ramp. Ownership is transferred to the transformer. + * \param nullColor color to return for null values */ QgsColorRampTransformer( double minValue = 0.0, double maxValue = 1.0, @@ -648,41 +648,41 @@ class CORE_EXPORT QgsColorRampTransformer : public QgsPropertyTransformer /** * Calculates the color corresponding to a specific value. - * @param value value to calculate color for - * @returns calculated color using transformer's parameters and type + * \param value value to calculate color for + * \returns calculated color using transformer's parameters and type */ QColor color( double value ) const; /** * Returns the color ramp used for calculating property colors. - * @returns color ramp - * @see setColorRamp() + * \returns color ramp + * \see setColorRamp() */ QgsColorRamp *colorRamp() const; /** * Sets the color ramp to use for calculating property colors. - * @param ramp color ramp, ownership of ramp is transferred to the transformer. - * @see colorRamp() + * \param ramp color ramp, ownership of ramp is transferred to the transformer. + * \see colorRamp() */ void setColorRamp( QgsColorRamp *ramp SIP_TRANSFER ); /** * Returns the color corresponding to a null value. - * @see setNullColor() + * \see setNullColor() */ QColor nullColor() const { return mNullColor; } /** * Sets the color corresponding to a null value. - * @param color null color - * @see nullSize() + * \param color null color + * \see nullSize() */ void setNullColor( const QColor &color ) { mNullColor = color; } /** * Returns the color ramp's name. - * @see setRampName() + * \see setRampName() */ QString rampName() const { return mRampName; } @@ -690,7 +690,7 @@ class CORE_EXPORT QgsColorRampTransformer : public QgsPropertyTransformer * Sets the color ramp's \a name. The ramp name must be set to match * a color ramp available in the style database for conversion to expression * to work correctly. - * @see rampName() + * \see rampName() */ void setRampName( const QString &name ) { mRampName = name; } diff --git a/src/core/qgsproviderregistry.cpp b/src/core/qgsproviderregistry.cpp index 3ff7bc0c137c..4a5b3834b318 100644 --- a/src/core/qgsproviderregistry.cpp +++ b/src/core/qgsproviderregistry.cpp @@ -339,7 +339,7 @@ QDir QgsProviderRegistry::libraryDirectory() const typedef QgsDataProvider *classFactoryFunction_t( const QString * ); -/** Copied from QgsVectorLayer::setDataProvider +/* Copied from QgsVectorLayer::setDataProvider * TODO: Make it work in the generic environment * * TODO: Is this class really the best place to put a data provider loader? diff --git a/src/core/qgsproviderregistry.h b/src/core/qgsproviderregistry.h index c84d132e0034..94efba0f78de 100644 --- a/src/core/qgsproviderregistry.h +++ b/src/core/qgsproviderregistry.h @@ -68,15 +68,15 @@ class CORE_EXPORT QgsProviderRegistry void setLibraryDirectory( const QDir &path ); /** Create an instance of the provider - @param providerKey identificator of the provider - @param dataSource string containing data source for the provider - @return instance of provider or NULL on error + \param providerKey identificator of the provider + \param dataSource string containing data source for the provider + \returns instance of provider or NULL on error */ QgsDataProvider *provider( const QString &providerKey, const QString &dataSource ); /** Return the provider capabilities - @param providerKey identificator of the provider + \param providerKey identificator of the provider \since QGIS 2.6 */ int providerCapabilities( const QString &providerKey ) const; @@ -87,9 +87,9 @@ class CORE_EXPORT QgsProviderRegistry QWidget *parent = nullptr, Qt::WindowFlags fl = Qt::WindowFlags() ); /** Get pointer to provider function - @param providerKey identificator of the provider - @param functionName name of function - @return pointer to function or NULL on error + \param providerKey identificator of the provider + \param functionName name of function + \returns pointer to function or NULL on error */ QFunctionPointer function( const QString &providerKey, const QString &functionName ); @@ -114,7 +114,7 @@ class CORE_EXPORT QgsProviderRegistry This walks through all data providers appending calls to their fileVectorFilters to a string, which is then returned. - @note + \note It'd be nice to eventually be raster/vector neutral. */ @@ -128,7 +128,7 @@ class CORE_EXPORT QgsProviderRegistry This walks through all data providers appending calls to their buildSupportedRasterFileFilter to a string, which is then returned. - @note This replaces QgsRasterLayer::buildSupportedRasterFileFilter() + \note This replaces QgsRasterLayer::buildSupportedRasterFileFilter() */ virtual QString fileRasterFilters() const; //! Return a string containing the available database drivers @@ -151,9 +151,9 @@ class CORE_EXPORT QgsProviderRegistry * * Called by QgsDataManager::open(). * - * @param name could be a file, URI - * @param provider is the key for the dataprovider used to open name - * @return NULL if unable to open vector data source + * \param name could be a file, URI + * \param provider is the key for the dataprovider used to open name + * \returns NULL if unable to open vector data source * * Temporarily always returns false until finished implementing. * diff --git a/src/core/qgsrectangle.cpp b/src/core/qgsrectangle.cpp index a87e89d7e7b6..a650fd27d288 100644 --- a/src/core/qgsrectangle.cpp +++ b/src/core/qgsrectangle.cpp @@ -259,7 +259,6 @@ QString QgsRectangle::asWktPolygon() const return rep; } -//! returns a QRectF with same coordinates. QRectF QgsRectangle::toRectF() const { return QRectF( static_cast< qreal >( xmin ), static_cast< qreal >( ymin ), static_cast< qreal >( xmax - xmin ), static_cast< qreal >( ymax - ymin ) ); diff --git a/src/core/qgsrectangle.h b/src/core/qgsrectangle.h index a0b86a0db52f..4a038de6ea65 100644 --- a/src/core/qgsrectangle.h +++ b/src/core/qgsrectangle.h @@ -126,17 +126,17 @@ class CORE_EXPORT QgsRectangle QString asPolygon() const; /** Comparison operator - * @return True if rectangles are equal + * \returns True if rectangles are equal */ bool operator==( const QgsRectangle &r1 ) const; /** Comparison operator - * @return False if rectangles are equal + * \returns False if rectangles are equal */ bool operator!=( const QgsRectangle &r1 ) const; /** Assignment operator - * @param r1 QgsRectangle to assign from + * \param r1 QgsRectangle to assign from */ QgsRectangle &operator=( const QgsRectangle &r1 ); diff --git a/src/core/qgsrelation.h b/src/core/qgsrelation.h index 5bb4ae9fd07c..c2f080bcfc1c 100644 --- a/src/core/qgsrelation.h +++ b/src/core/qgsrelation.h @@ -51,7 +51,7 @@ class CORE_EXPORT QgsRelation * Often, a relation is only defined by just one FieldPair with the name of the foreign key * column of the referencing (child) table as first element and the name of the primary key column * of the referenced (parent) table as the second element. - * @note not available in Python bindings + * \note not available in Python bindings */ class FieldPair : public QPair< QString, QString > { @@ -80,17 +80,17 @@ class CORE_EXPORT QgsRelation /** * Creates a relation from an XML structure. Used for reading .qgs projects. * - * @param node The dom node containing the relation information + * \param node The dom node containing the relation information * - * @return A relation + * \returns A relation */ static QgsRelation createFromXml( const QDomNode &node ); /** * Writes a relation to an XML structure. Used for saving .qgs projects * - * @param node The parent node in which the relation will be created - * @param doc The document in which the relation will be saved + * \param node The parent node in which the relation will be created + * \param doc The document in which the relation will be saved */ void writeXml( QDomNode &node, QDomDocument &doc ) const; @@ -119,8 +119,8 @@ class CORE_EXPORT QgsRelation * The first element of each pair are the field names of the foreign key. * The second element of each pair are the field names of the matching primary key. * - * @param referencingField The field name on the referencing (child) layer (FK) - * @param referencedField The field name on the referenced (parent) layer (PK) + * \param referencingField The field name on the referencing (child) layer (FK) + * \param referencedField The field name on the referenced (parent) layer (PK) */ void addFieldPair( const QString &referencingField, const QString &referencedField ); @@ -129,8 +129,8 @@ class CORE_EXPORT QgsRelation * The first element of each pair are the field names of the foreign key. * The second element of each pair are the field names of the matching primary key. * - * @param fieldPair A pair of two strings - * @note not available in Python bindings + * \param fieldPair A pair of two strings + * \note not available in Python bindings */ void addFieldPair( const FieldPair &fieldPair ); @@ -138,11 +138,11 @@ class CORE_EXPORT QgsRelation * Creates an iterator which returns all the features on the referencing (child) layer * which have a foreign key pointing to the provided feature. * - * @param feature A feature from the referenced (parent) layer + * \param feature A feature from the referenced (parent) layer * - * @return An iterator with all the referenced features - * @see getRelatedFeaturesRequest() - * @see getRelatedFeaturesFilter() + * \returns An iterator with all the referenced features + * \see getRelatedFeaturesRequest() + * \see getRelatedFeaturesFilter() */ QgsFeatureIterator getRelatedFeatures( const QgsFeature &feature ) const; @@ -150,21 +150,21 @@ class CORE_EXPORT QgsRelation * Creates a request to return all the features on the referencing (child) layer * which have a foreign key pointing to the provided feature. * - * @param feature A feature from the referenced (parent) layer + * \param feature A feature from the referenced (parent) layer * - * @return A request for all the referencing features - * @see getRelatedFeatures() - * @see getRelatedFeaturesFilter() + * \returns A request for all the referencing features + * \see getRelatedFeatures() + * \see getRelatedFeaturesFilter() */ QgsFeatureRequest getRelatedFeaturesRequest( const QgsFeature &feature ) const; /** Returns a filter expression which returns all the features on the referencing (child) layer * which have a foreign key pointing to the provided feature. - * @param feature A feature from the referenced (parent) layer - * @return expression filter string for all the referencing features + * \param feature A feature from the referenced (parent) layer + * \returns expression filter string for all the referencing features * \since QGIS 2.16 - * @see getRelatedFeatures() - * @see getRelatedFeaturesRequest() + * \see getRelatedFeatures() + * \see getRelatedFeaturesRequest() */ QString getRelatedFeaturesFilter( const QgsFeature &feature ) const; @@ -172,10 +172,10 @@ class CORE_EXPORT QgsRelation * Creates a request to return the feature on the referenced (parent) layer * which is referenced by the provided feature. * - * @param attributes An attribute vector containing the foreign key + * \param attributes An attribute vector containing the foreign key * - * @return A request the referenced feature - * @note not available in Python bindings + * \returns A request the referenced feature + * \note not available in Python bindings */ QgsFeatureRequest getReferencedFeatureRequest( const QgsAttributes &attributes ) const; @@ -183,9 +183,9 @@ class CORE_EXPORT QgsRelation * Creates a request to return the feature on the referenced (parent) layer * which is referenced by the provided feature. * - * @param feature A feature from the referencing (child) layer + * \param feature A feature from the referencing (child) layer * - * @return A request the referenced feature + * \returns A request the referenced feature */ QgsFeatureRequest getReferencedFeatureRequest( const QgsFeature &feature ) const; @@ -193,25 +193,25 @@ class CORE_EXPORT QgsRelation * Creates a request to return the feature on the referenced (parent) layer * which is referenced by the provided feature. * - * @param feature A feature from the referencing (child) layer + * \param feature A feature from the referencing (child) layer * - * @return A request the referenced feature + * \returns A request the referenced feature */ QgsFeature getReferencedFeature( const QgsFeature &feature ) const; /** * Returns a human readable name for this relation. Mostly used as title for the children. * - * @see id() + * \see id() * - * @return A name + * \returns A name */ QString name() const; /** * A (project-wide) unique id for this relation * - * @return The id + * \returns The id */ QString id() const; @@ -225,7 +225,7 @@ class CORE_EXPORT QgsRelation * Access the referencing (child) layer's id * This is the layer which has the field(s) which point to another layer * - * @return The id of the referencing layer + * \returns The id of the referencing layer */ QString referencingLayerId() const; @@ -233,21 +233,21 @@ class CORE_EXPORT QgsRelation * Access the referencing (child) layer * This is the layer which has the field(s) which point to another layer * - * @return The referencing layer + * \returns The referencing layer */ QgsVectorLayer *referencingLayer() const; /** * Access the referenced (parent) layer's id * - * @return The id of the referenced layer + * \returns The id of the referenced layer */ QString referencedLayerId() const; /** * Access the referenced (parent) layer * - * @return referenced layer + * \returns referenced layer */ QgsVectorLayer *referencedLayer() const; @@ -256,7 +256,7 @@ class CORE_EXPORT QgsRelation * The first element of each pair are the field names of the foreign key. * The second element of each pair are the field names of the matching primary key. * - * @return The fields forming the relation + * \returns The fields forming the relation */ QList< FieldPair > fieldPairs() const; @@ -264,7 +264,7 @@ class CORE_EXPORT QgsRelation * Returns a list of attributes used to form the referenced fields * (most likely primary key) on the referenced (parent) layer. * - * @return A list of attributes + * \returns A list of attributes */ QgsAttributeList referencedFields() const; @@ -272,22 +272,22 @@ class CORE_EXPORT QgsRelation * Returns a list of attributes used to form the referencing fields * (foreign key) on the referencing (child) layer. * - * @return A list of attributes + * \returns A list of attributes */ QgsAttributeList referencingFields() const; /** * Returns the validity of this relation. Don't use the information if it's not valid. * - * @return true if the relation is valid + * \returns true if the relation is valid */ bool isValid() const; /** * Compares the two QgsRelation, ignoring the name and the ID. * - * @param other The other relation - * @return true if they are similar + * \param other The other relation + * \returns true if they are similar * \since QGIS 3.0 */ bool hasEqualDefinition( const QgsRelation &other ) const; diff --git a/src/core/qgsrelationmanager.h b/src/core/qgsrelationmanager.h index ad222e3d4c09..2097050ef231 100644 --- a/src/core/qgsrelationmanager.h +++ b/src/core/qgsrelationmanager.h @@ -37,60 +37,60 @@ class CORE_EXPORT QgsRelationManager : public QObject public: /** Constructor for QgsRelationManager. - * @param project associated project (used to notify project of changes) + * \param project associated project (used to notify project of changes) */ explicit QgsRelationManager( QgsProject *project = nullptr ); /** * Will set the specified relations and remove any relation currently set. * - * @param relations A list of relations to set. + * \param relations A list of relations to set. */ void setRelations( const QList &relations ); /** * Get access to the relations managed by this class. * - * @return A QMap where the key is the relation id, the value the relation object. + * \returns A QMap where the key is the relation id, the value the relation object. */ QMap relations() const; /** * Add a relation. * - * @param relation The relation to add. + * \param relation The relation to add. */ void addRelation( const QgsRelation &relation ); /** * Remove a relation. * - * @param id The id of the relation to remove. + * \param id The id of the relation to remove. */ void removeRelation( const QString &id ); /** * Remove a relation. * - * @param relation The relation to remove. + * \param relation The relation to remove. */ void removeRelation( const QgsRelation &relation ); /** * Get access to a relation by its id. * - * @param id The id to search for + * \param id The id to search for * - * @return A relation. Invalid if not found. - * @see relationsByName() + * \returns A relation. Invalid if not found. + * \see relationsByName() */ Q_INVOKABLE QgsRelation relation( const QString &id ) const; /** Returns a list of relations with matching names. - * @param name relation name to search for. Searching is case insensitive. - * @returns a list of matching relations + * \param name relation name to search for. Searching is case insensitive. + * \returns a list of matching relations * \since QGIS 2.16 - * @see relation() + * \see relation() */ QList relationsByName( const QString &name ) const; @@ -102,28 +102,28 @@ class CORE_EXPORT QgsRelationManager : public QObject /** * Get all relations where the specified layer (and field) is the referencing part (i.e. the child table with the foreign key). * - * @param layer The layer which should be searched for. - * @param fieldIdx The field which should be part of the foreign key. If not set will return all relations. + * \param layer The layer which should be searched for. + * \param fieldIdx The field which should be part of the foreign key. If not set will return all relations. * - * @return A list of relations matching the given layer and fieldIdx. + * \returns A list of relations matching the given layer and fieldIdx. */ QList referencingRelations( const QgsVectorLayer *layer = nullptr, int fieldIdx = -2 ) const; /** * Get all relations where this layer is the referenced part (i.e. the parent table with the primary key being referenced from another layer). * - * @param layer The layer which should be searched for. + * \param layer The layer which should be searched for. * - * @return A list of relations where the specified layer is the referenced part. + * \returns A list of relations where the specified layer is the referenced part. */ QList referencedRelations( QgsVectorLayer *layer = nullptr ) const; /** * Discover all the relations available from the current layers. * - * @param existingRelations the existing relations to filter them out - * @param layers the current layers - * @return the list of discovered relations + * \param existingRelations the existing relations to filter them out + * \param layers the current layers + * \returns the list of discovered relations * \since QGIS 3.0 */ static QList discoverRelations( const QList &existingRelations, const QList &layers ); diff --git a/src/core/qgsrenderchecker.h b/src/core/qgsrenderchecker.h index 15ed0b70724e..86efd467a87a 100644 --- a/src/core/qgsrenderchecker.h +++ b/src/core/qgsrenderchecker.h @@ -77,7 +77,7 @@ class CORE_EXPORT QgsRenderChecker * The path of the rendered image can be retrieved through that method. * Will return the path set with setRenderedImage() or generated in runTest() * - * @return The path to the rendered image + * \returns The path to the rendered image */ QString renderedImage() { return mRenderedImageFile; } @@ -86,41 +86,41 @@ class CORE_EXPORT QgsRenderChecker /** Set tolerance for color components used by runTest() and compareImages(). * Default value is 0. - * @param colorTolerance is maximum difference for each color component + * \param colorTolerance is maximum difference for each color component * including alpha to be considered correct. * \since QGIS 2.1 */ void setColorTolerance( unsigned int colorTolerance ) { mColorTolerance = colorTolerance; } /** Sets the largest allowable difference in size between the rendered and the expected image. - * @param xTolerance x tolerance in pixels - * @param yTolerance y tolerance in pixels + * \param xTolerance x tolerance in pixels + * \param yTolerance y tolerance in pixels * \since QGIS 2.12 */ void setSizeTolerance( int xTolerance, int yTolerance ) { mMaxSizeDifferenceX = xTolerance; mMaxSizeDifferenceY = yTolerance; } /** * Test using renderer to generate the image to be compared. - * @param testName - to be used as the basis for writing a file to + * \param testName - to be used as the basis for writing a file to * e.g. /tmp/theTestName.png - * @param mismatchCount - defaults to 0 - the number of pixels that + * \param mismatchCount - defaults to 0 - the number of pixels that * are allowed to be different from the control image. In some cases * rendering may be non-deterministic. This parameter allows you to account * for that by providing a tolerance. - * @note make sure to call setExpectedImage and setMapRenderer first + * \note make sure to call setExpectedImage and setMapRenderer first */ bool runTest( const QString &testName, unsigned int mismatchCount = 0 ); /** * Test using two arbitrary images (map renderer will not be used) - * @param testName - to be used as the basis for writing a file to + * \param testName - to be used as the basis for writing a file to * e.g. /tmp/theTestName.png - * @param mismatchCount - defaults to 0 - the number of pixels that + * \param mismatchCount - defaults to 0 - the number of pixels that * are allowed to be different from the control image. In some cases * rendering may be non-deterministic. This parameter allows you to account * for that by providing a tolerance. - * @param renderedImageFile to optionally override the output filename - * @note: make sure to call setExpectedImage and setRenderedImage first. + * \param renderedImageFile to optionally override the output filename + * \note: make sure to call setExpectedImage and setRenderedImage first. */ bool compareImages( const QString &testName, unsigned int mismatchCount = 0, const QString &renderedImageFile = "" ); @@ -129,7 +129,7 @@ class CORE_EXPORT QgsRenderChecker * mismatch), but where the output was still acceptable. If the render * diff matches one of these anomalies we will still consider it to be * acceptable. - * @return a bool indicating if the diff matched one of the anomaly files + * \returns a bool indicating if the diff matched one of the anomaly files */ bool isKnownAnomaly( const QString &diffImageFile ); @@ -141,7 +141,7 @@ class CORE_EXPORT QgsRenderChecker /** * Returns the path to the expected image file * - * @return Path to the expected image file + * \returns Path to the expected image file */ QString expectedImageFile() const { return mExpectedImageFile; } @@ -150,7 +150,7 @@ class CORE_EXPORT QgsRenderChecker * dashMessages() to get access to the buffered messages. If disabled (default) * dash messages will be sent immediately. * - * @param enable Enable or disable buffering + * \param enable Enable or disable buffering */ void enableDashBuffering( bool enable ) { mBufferDashMessages = enable; } @@ -158,8 +158,8 @@ class CORE_EXPORT QgsRenderChecker * 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 + * \returns buffered dash messages + * \note not available in Python bindings */ QVector dartMeasurements() const { return mDashMessages; } @@ -189,10 +189,10 @@ class CORE_EXPORT QgsRenderChecker /** Compare two WKT strings with some tolerance - * @param a first WKT string - * @param b second WKT string - * @param tolerance tolerance to use (optional, defaults to 0.000001) - * @return bool indicating if the WKT are sufficiently equal + * \param a first WKT string + * \param b second WKT string + * \param tolerance tolerance to use (optional, defaults to 0.000001) + * \returns bool indicating if the WKT are sufficiently equal */ inline bool compareWkt( const QString &a, const QString &b, double tolerance = 0.000001 ) diff --git a/src/core/qgsrendercontext.h b/src/core/qgsrendercontext.h index 27c7663592e4..50aeb7be4577 100644 --- a/src/core/qgsrendercontext.h +++ b/src/core/qgsrendercontext.h @@ -104,7 +104,7 @@ class CORE_EXPORT QgsRenderContext /** * Returns the destination QPainter for the render operation. - * @see setPainter() + * \see setPainter() */ QPainter *painter() {return mPainter;} @@ -121,7 +121,7 @@ class CORE_EXPORT QgsRenderContext * Returns the scaling factor for the render to convert painter units * to physical sizes. This is usually equal to the number of pixels * per millimeter. - * @see setScaleFactor() + * \see setScaleFactor() */ double scaleFactor() const {return mScaleFactor;} @@ -142,20 +142,20 @@ class CORE_EXPORT QgsRenderContext /** * Returns the renderer map scale. This will match the desired scale denominator * for the rendered map, eg 1000.0 for a 1:1000 map render. - * @see setRendererScale() + * \see setRendererScale() */ double rendererScale() const {return mRendererScale;} //! Get access to new labeling engine (may be nullptr) - //! @note not available in Python bindings + //! \note not available in Python bindings QgsLabelingEngine *labelingEngine() const { return mLabelingEngine; } QColor selectionColor() const { return mSelectionColor; } /** Returns true if vector selections should be shown in the rendered map - * @returns true if selections should be shown - * @see setShowSelection - * @see selectionColor + * \returns true if selections should be shown + * \see setShowSelection + * \see selectionColor * \since QGIS v2.4 */ bool showSelection() const; @@ -175,14 +175,14 @@ class CORE_EXPORT QgsRenderContext * Sets the scaling factor for the render to convert painter units * to physical sizes. This should usually be equal to the number of pixels * per millimeter. - * @see scaleFactor() + * \see scaleFactor() */ void setScaleFactor( double factor ) {mScaleFactor = factor;} /** * Sets the renderer map scale. This should match the desired scale denominator * for the rendered map, eg 1000.0 for a 1:1000 map render. - * @see rendererScale() + * \see rendererScale() */ void setRendererScale( double scale ) {mRendererScale = scale;} @@ -190,21 +190,21 @@ class CORE_EXPORT QgsRenderContext * Sets the destination QPainter for the render operation. Ownership of the painter * is not transferred and the QPainter destination must stay alive for the duration * of any rendering operations. - * @see painter() + * \see painter() */ void setPainter( QPainter *p ) {mPainter = p;} void setForceVectorOutput( bool force ); //! Assign new labeling engine - //! @note not available in Python bindings + //! \note not available in Python bindings void setLabelingEngine( QgsLabelingEngine *engine2 ) { mLabelingEngine = engine2; } void setSelectionColor( const QColor &color ) { mSelectionColor = color; } /** Sets whether vector selections should be shown in the rendered map - * @param showSelection set to true if selections should be shown - * @see showSelection - * @see setSelectionColor + * \param showSelection set to true if selections should be shown + * \see showSelection + * \see setSelectionColor * \since QGIS v2.4 */ void setShowSelection( const bool showSelection ); @@ -221,23 +221,23 @@ class CORE_EXPORT QgsRenderContext /** Sets the expression context. This context is used for all expression evaluation * associated with this render context. - * @see expressionContext() + * \see expressionContext() * \since QGIS 2.12 */ void setExpressionContext( const QgsExpressionContext &context ) { mExpressionContext = context; } /** Gets the expression context. This context should be used for all expression evaluation * associated with this render context. - * @see setExpressionContext() + * \see setExpressionContext() * \since QGIS 2.12 */ QgsExpressionContext &expressionContext() { return mExpressionContext; } /** Gets the expression context (const version). This context should be used for all expression evaluation * associated with this render context. - * @see setExpressionContext() + * \see setExpressionContext() * \since QGIS 2.12 - * @note not available in Python bindings + * \note not available in Python bindings */ const QgsExpressionContext &expressionContext() const { return mExpressionContext; } @@ -247,27 +247,27 @@ class CORE_EXPORT QgsRenderContext void setGeometry( const QgsAbstractGeometry *geometry ) { mGeometry = geometry; } /** Set a filter feature provider used for additional filtering of rendered features. - * @param ffp the filter feature provider + * \param ffp the filter feature provider * \since QGIS 2.14 - * @see featureFilterProvider() + * \see featureFilterProvider() */ void setFeatureFilterProvider( const QgsFeatureFilterProvider *ffp ); /** Get the filter feature provider used for additional filtering of rendered features. - * @return the filter feature provider + * \returns the filter feature provider * \since QGIS 2.14 - * @see setFeatureFilterProvider() + * \see setFeatureFilterProvider() */ const QgsFeatureFilterProvider *featureFilterProvider() const; /** Sets the segmentation tolerance applied when rendering curved geometries - @param tolerance the segmentation tolerance*/ + \param tolerance the segmentation tolerance*/ void setSegmentationTolerance( double tolerance ) { mSegmentationTolerance = tolerance; } //! Gets the segmentation tolerance applied when rendering curved geometries double segmentationTolerance() const { return mSegmentationTolerance; } /** Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) - @param type the segmentation tolerance typename*/ + \param type the segmentation tolerance typename*/ void setSegmentationToleranceType( QgsAbstractGeometry::SegmentationToleranceType type ) { mSegmentationToleranceType = type; } //! Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) QgsAbstractGeometry::SegmentationToleranceType segmentationToleranceType() const { return mSegmentationToleranceType; } @@ -278,7 +278,7 @@ class CORE_EXPORT QgsRenderContext * Converts a size from the specified units to painter units (pixels). The conversion respects the limits * specified by the optional scale parameter. * \since QGIS 3.0 - * @see convertToMapUnits() + * \see convertToMapUnits() */ double convertToPainterUnits( double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale = QgsMapUnitScale() ) const; @@ -286,14 +286,14 @@ class CORE_EXPORT QgsRenderContext * Converts a size from the specified units to map units. The conversion respects the limits * specified by the optional scale parameter. * \since QGIS 3.0 - * @see convertToPainterUnits() + * \see convertToPainterUnits() */ double convertToMapUnits( double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale = QgsMapUnitScale() ) const; /** * Converts a size from map units to the specified units. * \since QGIS 3.0 - * @see convertToMapUnits() + * \see convertToMapUnits() */ double convertFromMapUnits( double sizeInMapUnits, QgsUnitTypes::RenderUnit outputUnit ) const; diff --git a/src/core/qgsrulebasedlabeling.h b/src/core/qgsrulebasedlabeling.h index 647dc24c9834..43410607023e 100644 --- a/src/core/qgsrulebasedlabeling.h +++ b/src/core/qgsrulebasedlabeling.h @@ -33,9 +33,9 @@ class QgsGeometry; class QgsRuleBasedLabelProvider; /** \ingroup core - * @class QgsRuleBasedLabeling - * @note not available in Python bindings - * @note this class is not a part of public API yet. See notes in QgsLabelingEngine + * \class QgsRuleBasedLabeling + * \note not available in Python bindings + * \note this class is not a part of public API yet. See notes in QgsLabelingEngine */ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling @@ -47,9 +47,9 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling /** * \ingroup core - * @class QgsRuleBasedLabeling::Rule - * @note not available in Python bindings - * @note this class is not a part of public API yet. See notes in QgsLabelingEngine + * \class QgsRuleBasedLabeling::Rule + * \note not available in Python bindings + * \note this class is not a part of public API yet. See notes in QgsLabelingEngine */ class CORE_EXPORT Rule { @@ -79,7 +79,7 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling /** * Determines if scale based labeling is active * - * @return True if scale based labeling is active + * \returns True if scale based labeling is active */ bool dependsOnScale() const { return mScaleMinDenom != 0 || mScaleMaxDenom != 0; } @@ -89,7 +89,7 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling * E.g. Denominator 1000 is a scale of 1:1000, where a rule with minimum denominator * of 900 will not be applied while a rule with 2000 will be applied. * - * @return The minimum scale denominator + * \returns The minimum scale denominator */ int scaleMinDenom() const { return mScaleMinDenom; } @@ -99,34 +99,34 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling * E.g. Denominator 1000 is a scale of 1:1000, where a rule with maximum denominator * of 900 will be applied while a rule with 2000 will not be applied. * - * @return The maximum scale denominator + * \returns The maximum scale denominator */ int scaleMaxDenom() const { return mScaleMaxDenom; } /** * A filter that will check if this rule applies - * @return An expression + * \returns An expression */ QString filterExpression() const { return mFilterExp; } /** * A human readable description for this rule * - * @return Description + * \returns Description */ QString description() const { return mDescription; } /** * Returns if this rule is active * - * @return True if the rule is active + * \returns True if the rule is active */ bool active() const { return mIsActive; } /** * Check if this rule is an ELSE rule * - * @return True if this rule is an else rule + * \returns True if this rule is an else rule */ bool isElse() const { return mElseRule; } @@ -140,7 +140,7 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling * Set the minimum denominator for which this rule shall apply. * E.g. 1000 if it shall be evaluated between 1:1000 and 1:100'000 * Set to 0 to disable the minimum check - * @param scaleMinDenom The minimum scale denominator for this rule + * \param scaleMinDenom The minimum scale denominator for this rule */ void setScaleMinDenom( int scaleMinDenom ) { mScaleMinDenom = scaleMinDenom; } @@ -148,34 +148,34 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling * Set the maximum denominator for which this rule shall apply. * E.g. 100'000 if it shall be evaluated between 1:1000 and 1:100'000 * Set to 0 to disable the maximum check - * @param scaleMaxDenom maximum scale denominator for this rule + * \param scaleMaxDenom maximum scale denominator for this rule */ void setScaleMaxDenom( int scaleMaxDenom ) { mScaleMaxDenom = scaleMaxDenom; } /** * Set the expression used to check if a given feature shall be rendered with this rule * - * @param filterExp An expression + * \param filterExp An expression */ void setFilterExpression( const QString &filterExp ) { mFilterExp = filterExp; initFilter(); } /** * Set a human readable description for this rule * - * @param description Description + * \param description Description */ void setDescription( const QString &description ) { mDescription = description; } /** * Sets if this rule is active - * @param state Determines if the rule should be activated or deactivated + * \param state Determines if the rule should be activated or deactivated */ void setActive( bool state ) { mIsActive = state; } /** * Sets if this rule is an ELSE rule * - * @param iselse If true, this rule is an ELSE rule + * \param iselse If true, this rule is an ELSE rule */ void setIsElse( bool iselse ) { mElseRule = iselse; } @@ -187,35 +187,35 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling /** * Return all children rules of this rule * - * @return A list of rules + * \returns A list of rules */ const RuleList &children() const { return mChildren; } /** * Return all children rules of this rule * - * @return A list of rules + * \returns A list of rules */ RuleList &children() { return mChildren; } /** * Returns all children, grand-children, grand-grand-children, grand-gra... you get it * - * @return A list of descendant rules + * \returns A list of descendant rules */ RuleList descendants() const { RuleList l; Q_FOREACH ( Rule *c, mChildren ) { l += c; l += c->descendants(); } return l; } /** * The parent rule * - * @return Parent rule + * \returns Parent rule */ const Rule *parent() const { return mParent; } /** * The parent rule * - * @return Parent rule + * \returns Parent rule */ Rule *parent() { return mParent; } @@ -238,8 +238,8 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling /** * Create a rule from an XML definition - * @param ruleElem The XML rule element - * @return A new rule + * \param ruleElem The XML rule element + * \returns A new rule */ static Rule *create( const QDomElement &ruleElem ); @@ -271,17 +271,17 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling /** * Check if a given feature shall be labelled by this rule * - * @param f The feature to test - * @param context The context in which the rendering happens - * @return True if the feature shall be rendered + * \param f The feature to test + * \param context The context in which the rendering happens + * \returns True if the feature shall be rendered */ bool isFilterOK( QgsFeature &f, QgsRenderContext &context ) const; /** * Check if this rule applies for a given scale - * @param scale The scale to check. If set to 0, it will always return true. + * \param scale The scale to check. If set to 0, it will always return true. * - * @return If the rule will be evaluated at this scale + * \returns If the rule will be evaluated at this scale */ bool isScaleOK( double scale ) const; @@ -340,9 +340,9 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling /** \ingroup core - * @class QgsRuleBasedLabelProvider - * @note not available in Python bindings - * @note this class is not a part of public API yet. See notes in QgsLabelingEngine + * \class QgsRuleBasedLabelProvider + * \note not available in Python bindings + * \note this class is not a part of public API yet. See notes in QgsLabelingEngine */ class CORE_EXPORT QgsRuleBasedLabelProvider : public QgsVectorLayerLabelProvider { diff --git a/src/core/qgsruntimeprofiler.h b/src/core/qgsruntimeprofiler.h index 388de86a3eaf..25c318959fdb 100644 --- a/src/core/qgsruntimeprofiler.h +++ b/src/core/qgsruntimeprofiler.h @@ -20,44 +20,44 @@ class CORE_EXPORT QgsRuntimeProfiler QgsRuntimeProfiler(); /** - * @brief Begin the group for the profiler. Groups will append {GroupName}/ to the + * \brief Begin the group for the profiler. Groups will append {GroupName}/ to the * front of the profile tag set using start. - * @param name The name of the group. + * \param name The name of the group. */ void beginGroup( const QString &name ); /** - * @brief End the current active group. + * \brief End the current active group. */ void endGroup(); /** - * @brief Start a profile event with the given name. - * @param name The name of the profile event. Will have the name of + * \brief Start a profile event with the given name. + * \param name The name of the profile event. Will have the name of * the active group appended after ending. */ void start( const QString &name ); /** - * @brief End the current profile event. + * \brief End the current profile event. */ void end(); /** - * @brief Return all the current profile times. - * @return A list of profile event names and times. - * @note not available in Python bindings + * \brief Return all the current profile times. + * \returns A list of profile event names and times. + * \note not available in Python bindings */ const QList > profileTimes() const { return mProfileTimes; } /** - * @brief clear Clear all profile data. + * \brief clear Clear all profile data. */ void clear(); /** - * @brief The current total time collected in the profiler. - * @return The current total time collected in the profiler. + * \brief The current total time collected in the profiler. + * \returns The current total time collected in the profiler. */ double totalTime(); diff --git a/src/core/qgsscalecalculator.h b/src/core/qgsscalecalculator.h index 4403131e989d..6524a0218209 100644 --- a/src/core/qgsscalecalculator.h +++ b/src/core/qgsscalecalculator.h @@ -36,27 +36,27 @@ class CORE_EXPORT QgsScaleCalculator /** * Constructor - * @param dpi Monitor resolution in dots per inch - * @param mapUnits Units of the data on the map + * \param dpi Monitor resolution in dots per inch + * \param mapUnits Units of the data on the map */ QgsScaleCalculator( double dpi = 0, QgsUnitTypes::DistanceUnit mapUnits = QgsUnitTypes::DistanceMeters ); /** * Set the dpi to be used in scale calculations - * @param dpi Dots per inch of monitor resolution + * \param dpi Dots per inch of monitor resolution */ void setDpi( double dpi ); /** * Accessor for dpi used in scale calculations - * @return int the dpi used for scale calculations. + * \returns int the dpi used for scale calculations. */ double dpi(); /** * Set the map units - * @param mapUnits Units of the data on the map. Must match a value from the + * \param mapUnits Units of the data on the map. Must match a value from the */ void setMapUnits( QgsUnitTypes::DistanceUnit mapUnits ); @@ -65,9 +65,9 @@ class CORE_EXPORT QgsScaleCalculator /** * Calculate the scale denominator - * @param mapExtent QgsRectangle containing the current map extent - * @param canvasWidth Width of the map canvas in pixel (physical) units - * @return scale denominator of current map view + * \param mapExtent QgsRectangle containing the current map extent + * \param canvasWidth Width of the map canvas in pixel (physical) units + * \returns scale denominator of current map view */ double calculate( const QgsRectangle &mapExtent, int canvasWidth ); @@ -75,7 +75,7 @@ class CORE_EXPORT QgsScaleCalculator * Calculate the distance between two points in geographic coordinates. * Used to calculate scale for map views with geographic (decimal degree) * data. - * @param mapExtent QgsRectangle containing the current map extent + * \param mapExtent QgsRectangle containing the current map extent */ double calculateGeographicDistance( const QgsRectangle &mapExtent ); diff --git a/src/core/qgsscaleutils.h b/src/core/qgsscaleutils.h index 00dc96a7ab06..39155873e334 100644 --- a/src/core/qgsscaleutils.h +++ b/src/core/qgsscaleutils.h @@ -28,20 +28,20 @@ class CORE_EXPORT QgsScaleUtils public: /** Save scales to the given file - * @param fileName the name of the output file - * @param scales the list of scales to save - * @param errorMessage it will contain the error message if something + * \param fileName the name of the output file + * \param scales the list of scales to save + * \param errorMessage it will contain the error message if something * went wrong - * @return true on success and false if failed + * \returns true on success and false if failed */ static bool saveScaleList( const QString &fileName, const QStringList &scales, QString &errorMessage ); /** Load scales from the given file - * @param fileName the name of the file to process - * @param scales it will contain loaded scales - * @param errorMessage it will contain the error message if something + * \param fileName the name of the file to process + * \param scales it will contain loaded scales + * \param errorMessage it will contain the error message if something * went wrong - * @return true on success and false if failed + * \returns true on success and false if failed */ static bool loadScaleList( const QString &fileName, QStringList &scales, QString &errorMessage ); }; diff --git a/src/core/qgssnapper.h b/src/core/qgssnapper.h index 6768b9db6ea4..cc6b8051d3b7 100644 --- a/src/core/qgssnapper.h +++ b/src/core/qgssnapper.h @@ -104,10 +104,10 @@ class CORE_EXPORT QgsSnapper explicit QgsSnapper( const QgsMapSettings &mapSettings ); /** Does the snapping operation - * @param mapCoordPoint the start point for snapping (in map coordinates) - * @param snappingResult the list where the results are inserted (everything in map coordinate system) - * @param excludePoints a list with (map coordinate) points that should be excluded in the snapping result. Useful e.g. for vertex moves where a vertex should not be snapped to its original position - * @return 0 in case of success + * \param mapCoordPoint the start point for snapping (in map coordinates) + * \param snappingResult the list where the results are inserted (everything in map coordinate system) + * \param excludePoints a list with (map coordinate) points that should be excluded in the snapping result. Useful e.g. for vertex moves where a vertex should not be snapped to its original position + * \returns 0 in case of success */ int snapMapPoint( const QgsPoint &mapCoordPoint, QList &snappingResult, const QList &excludePoints = QList() ); diff --git a/src/core/qgssnappingconfig.h b/src/core/qgssnappingconfig.h index a7e5854fe721..f48340f00bee 100644 --- a/src/core/qgssnappingconfig.h +++ b/src/core/qgssnappingconfig.h @@ -65,11 +65,11 @@ class CORE_EXPORT QgsSnappingConfig public: /** - * @brief IndividualLayerSettings - * @param enabled - * @param type - * @param tolerance - * @param units + * \brief IndividualLayerSettings + * \param enabled + * \param type + * \param tolerance + * \param units */ IndividualLayerSettings( bool enabled, QgsSnappingConfig::SnappingType type, double tolerance, QgsTolerance::UnitType units ); @@ -200,7 +200,7 @@ class CORE_EXPORT QgsSnappingConfig * When implementing a long-living QgsSnappingConfig (like the one in QgsProject) * it is best to directly feed this with information from the layer registry. * - * @return True if changes have been done. + * \returns True if changes have been done. * * \since QGIS 3.0 */ @@ -212,7 +212,7 @@ class CORE_EXPORT QgsSnappingConfig * When implementing a long-living QgsSnappingConfig (like the one in QgsProject) * it is best to directly feed this with information from the layer registry. * - * @return True if changes have been done. + * \returns True if changes have been done. * * \since QGIS 3.0 */ diff --git a/src/core/qgssnappingutils.h b/src/core/qgssnappingutils.h index dac4fd5a7f2c..f59ff31cf2db 100644 --- a/src/core/qgssnappingutils.h +++ b/src/core/qgssnappingutils.h @@ -117,10 +117,10 @@ class CORE_EXPORT QgsSnappingUtils : public QObject snapper.setSnapToMapMode(QgsSnappingUtils.SnapAdvanced) ``` - * @param l The vector layer for which this configuration is - * @param t Which parts of the geometry should be snappable - * @param tol The tolerance radius in which the snapping will trigger - * @param u The unit in which the tolerance is specified + * \param l The vector layer for which this configuration is + * \param t Which parts of the geometry should be snappable + * \param tol The tolerance radius in which the snapping will trigger + * \param u The unit in which the tolerance is specified */ LayerConfig( QgsVectorLayer *l, QgsPointLocator::Types t, double tol, QgsTolerance::UnitType u ) : layer( l ) diff --git a/src/core/qgsspatialindex.h b/src/core/qgsspatialindex.h index 9edaddf17f35..7ccefe708455 100644 --- a/src/core/qgsspatialindex.h +++ b/src/core/qgsspatialindex.h @@ -95,9 +95,9 @@ class CORE_EXPORT QgsSpatialIndex QAtomicInt refs() const; protected: - //! @note not available in Python bindings + //! \note not available in Python bindings static SpatialIndex::Region rectToRegion( const QgsRectangle &rect ); - //! @note not available in Python bindings + //! \note not available in Python bindings static bool featureInfo( const QgsFeature &f, SpatialIndex::Region &r, QgsFeatureId &id ); friend class QgsFeatureIteratorDataStream; // for access to featureInfo() diff --git a/src/core/qgssqlexpressioncompiler.h b/src/core/qgssqlexpressioncompiler.h index 67846493faa6..62443a9d0e2c 100644 --- a/src/core/qgssqlexpressioncompiler.h +++ b/src/core/qgssqlexpressioncompiler.h @@ -57,8 +57,8 @@ class CORE_EXPORT QgsSqlExpressionCompiler Q_DECLARE_FLAGS( Flags, Flag ) /** Constructor for expression compiler. - * @param fields fields from provider - * @param flags flags which control how expression is compiled + * \param fields fields from provider + * \param flags flags which control how expression is compiled */ explicit QgsSqlExpressionCompiler( const QgsFields &fields, QgsSqlExpressionCompiler::Flags flags = Flags() ); virtual ~QgsSqlExpressionCompiler() = default; @@ -76,37 +76,37 @@ class CORE_EXPORT QgsSqlExpressionCompiler /** Returns a quoted column identifier, in the format expected by the provider. * Derived classes should override this if special handling of column identifiers * is required. - * @see quotedValue() + * \see quotedValue() */ virtual QString quotedIdentifier( const QString &identifier ); /** Returns a quoted attribute value, in the format expected by the provider. * Derived classes should override this if special handling of attribute values is required. - * @param value value to quote - * @param ok wil be set to true if value can be compiled - * @see quotedIdentifier() + * \param value value to quote + * \param ok wil be set to true if value can be compiled + * \see quotedIdentifier() */ virtual QString quotedValue( const QVariant &value, bool &ok ); /** Compiles an expression node and returns the result of the compilation. - * @param node expression node to compile - * @param str string representing compiled node should be stored in this parameter - * @returns result of node compilation + * \param node expression node to compile + * \param str string representing compiled node should be stored in this parameter + * \returns result of node compilation */ virtual Result compileNode( const QgsExpression::Node *node, QString &str ); /** Return the SQL function for the expression function. * Derived classes should override this to help compile functions - * @param fnName expression function name - * @returns the SQL function name + * \param fnName expression function name + * \returns the SQL function name */ virtual QString sqlFunctionFromFunctionName( const QString &fnName ) const; /** Return the Arguments for SQL function for the expression function. * Derived classes should override this to help compile functions - * @param fnName expression function name - * @param fnArgs arguments from expression - * @returns the arguments updated for SQL Function + * \param fnName expression function name + * \param fnArgs arguments from expression + * \returns the arguments updated for SQL Function */ virtual QStringList sqlArgumentsFromFunctionName( const QString &fnName, const QStringList &fnArgs ) const; diff --git a/src/core/qgssqliteexpressioncompiler.h b/src/core/qgssqliteexpressioncompiler.h index b7b9311616a2..2a259b1649c6 100644 --- a/src/core/qgssqliteexpressioncompiler.h +++ b/src/core/qgssqliteexpressioncompiler.h @@ -36,7 +36,7 @@ class CORE_EXPORT QgsSQLiteExpressionCompiler : public QgsSqlExpressionCompiler public: /** Constructor for expression compiler. - * @param fields fields from provider + * \param fields fields from provider */ explicit QgsSQLiteExpressionCompiler( const QgsFields &fields ); diff --git a/src/core/qgssqlstatement.h b/src/core/qgssqlstatement.h index 050f8bd9ca7b..c5c6ee36d507 100644 --- a/src/core/qgssqlstatement.h +++ b/src/core/qgssqlstatement.h @@ -79,29 +79,29 @@ class CORE_EXPORT QgsSQLStatement QString dump() const; /** Returns a quoted column reference (in double quotes) - * @see quotedString(), quotedIdentifierIfNeeded() + * \see quotedString(), quotedIdentifierIfNeeded() */ static QString quotedIdentifier( QString name ); /** Returns a quoted column reference (in double quotes) if needed, or * otherwise the original string. - * @see quotedString(), quotedIdentifier() + * \see quotedString(), quotedIdentifier() */ static QString quotedIdentifierIfNeeded( const QString &name ); /** Remove double quotes from an identifier. - * @see quotedIdentifier() + * \see quotedIdentifier() */ static QString stripQuotedIdentifier( QString text ); /** Returns a quoted version of a string (in single quotes) - * @see quotedIdentifier(), quotedIdentifierIfNeeded() + * \see quotedIdentifier(), quotedIdentifierIfNeeded() */ static QString quotedString( QString text ); /** - * @brief list of unary operators - * @note if any change is made here, the definition of QgsSQLStatement::UnaryOperatorText[] must be adapted. + * \brief list of unary operators + * \note if any change is made here, the definition of QgsSQLStatement::UnaryOperatorText[] must be adapted. */ enum UnaryOperator { @@ -110,8 +110,8 @@ class CORE_EXPORT QgsSQLStatement }; /** - * @brief list of binary operators - * @note if any change is made here, the definition of QgsSQLStatement::BinaryOperatorText[] must be adapted. + * \brief list of binary operators + * \note if any change is made here, the definition of QgsSQLStatement::BinaryOperatorText[] must be adapted. */ enum BinaryOperator { @@ -147,8 +147,8 @@ class CORE_EXPORT QgsSQLStatement }; /** - * @brief list of join types - * @note if any change is made here, the definition of QgsSQLStatement::JoinTypeText[] must be adapted. + * \brief list of join types + * \note if any change is made here, the definition of QgsSQLStatement::JoinTypeText[] must be adapted. */ enum JoinType { @@ -162,13 +162,13 @@ class CORE_EXPORT QgsSQLStatement jtFull }; - //! @note not available in Python bindings + //! \note not available in Python bindings static const char *BINARY_OPERATOR_TEXT[]; - //! @note not available in Python bindings + //! \note not available in Python bindings static const char *UNARY_OPERATOR_TEXT[]; - //! @note not available in Python bindings + //! \note not available in Python bindings static const char *JOIN_TYPE_TEXT[]; ////// @@ -203,14 +203,14 @@ class CORE_EXPORT QgsSQLStatement /** * Abstract virtual that returns the type of this node. * - * @return The type of this node + * \returns The type of this node */ virtual NodeType nodeType() const = 0; /** * Abstract virtual dump method * - * @return A statement which represents this node as string + * \returns A statement which represents this node as string */ virtual QString dump() const = 0; @@ -220,7 +220,7 @@ class CORE_EXPORT QgsSQLStatement * generated in prepare and context related. * Ownership is transferred to the caller. * - * @return a deep copy of this node. + * \returns a deep copy of this node. */ virtual Node *clone() const = 0; @@ -237,7 +237,7 @@ class CORE_EXPORT QgsSQLStatement * * v.visit( self) * - * @param v A visitor that visits this node. + * \param v A visitor that visits this node. */ virtual void accept( Visitor &v ) const = 0; }; diff --git a/src/core/qgsstatisticalsummary.h b/src/core/qgsstatisticalsummary.h index d66bb4c592e9..0bd278502bea 100644 --- a/src/core/qgsstatisticalsummary.h +++ b/src/core/qgsstatisticalsummary.h @@ -31,10 +31,10 @@ * \class QgsStatisticalSummary * \brief Calculator for summary statistics for a list of doubles. * - * Statistics are calculated by calling @link calculate @endlink and passing a list of doubles. The + * Statistics are calculated by calling calculate() and passing a list of doubles. The * individual statistics can then be retrieved using the associated methods. Note that not all statistics * are calculated by default. Statistics which require slower computations are only calculated by - * specifying the statistic in the constructor or via @link setStatistics @endlink. + * specifying the statistic in the constructor or via setStatistics(). * * \since QGIS 2.9 */ @@ -67,7 +67,7 @@ class CORE_EXPORT QgsStatisticalSummary Q_DECLARE_FLAGS( Statistics, Statistic ) /** Constructor for QgsStatisticalSummary - * @param stats flags for statistics to calculate + * \param stats flags for statistics to calculate */ QgsStatisticalSummary( QgsStatisticalSummary::Statistics stats = All ); @@ -75,14 +75,14 @@ class CORE_EXPORT QgsStatisticalSummary /** Returns flags which specify which statistics will be calculated. Some statistics * are always calculated (e.g., sum, min and max). - * @see setStatistics + * \see setStatistics */ Statistics statistics() const { return mStatistics; } /** Sets flags which specify which statistics will be calculated. Some statistics * are always calculated (e.g., sum, min and max). - * @param stats flags for statistics to calculate - * @see statistics + * \param stats flags for statistics to calculate + * \see statistics */ void setStatistics( Statistics stats ) { mStatistics = stats; } @@ -91,7 +91,7 @@ class CORE_EXPORT QgsStatisticalSummary void reset(); /** Calculates summary statistics for a list of values - * @param values list of doubles + * \param values list of doubles */ void calculate( const QList &values ); @@ -99,14 +99,14 @@ class CORE_EXPORT QgsStatisticalSummary * allows values to be added to the calculation one at a time. For large * quantities of values this may be more efficient then first adding all the * values to a list and calling calculate(). - * @param value value to add - * @note call reset() before adding the first value using this method + * \param value value to add + * \note call reset() before adding the first value using this method * to clear the results from any previous calculations - * @note finalize() must be called after adding the final value and before + * \note finalize() must be called after adding the final value and before * retrieving calculated statistics. - * @see calculate() - * @see addVariant() - * @see finalize() + * \see calculate() + * \see addVariant() + * \see finalize() * \since QGIS 2.16 */ void addValue( double value ); @@ -115,29 +115,29 @@ class CORE_EXPORT QgsStatisticalSummary * allows values to be added to the calculation one at a time. For large * quantities of values this may be more efficient then first adding all the * values to a list and calling calculate(). - * @param value variant containing to add. Non-numeric values are treated as null. - * @note call reset() before adding the first value using this method + * \param value variant containing to add. Non-numeric values are treated as null. + * \note call reset() before adding the first value using this method * to clear the results from any previous calculations - * @note finalize() must be called after adding the final value and before + * \note finalize() must be called after adding the final value and before * retrieving calculated statistics. - * @see addValue() - * @see calculate() - * @see finalize() + * \see addValue() + * \see calculate() + * \see finalize() * \since QGIS 2.16 */ void addVariant( const QVariant &value ); /** Must be called after adding all values with addValues() and before retrieving * any calculated statistics. - * @see addValue() - * @see addVariant() + * \see addValue() + * \see addVariant() * \since QGIS 2.16 */ void finalize(); /** Returns the value of a specified statistic - * @param stat statistic to return - * @returns calculated value of statistic. A NaN value may be returned for invalid + * \param stat statistic to return + * \returns calculated value of statistic. A NaN value may be returned for invalid * statistics. */ double statistic( Statistic stat ) const; @@ -184,14 +184,14 @@ class CORE_EXPORT QgsStatisticalSummary /** Returns population standard deviation. This is only calculated if Statistic::StDev has * been specified in the constructor or via setStatistics. A NaN value may be returned if the standard deviation cannot * be calculated. - * @see sampleStDev + * \see sampleStDev */ double stDev() const { return mStdev; } /** Returns sample standard deviation. This is only calculated if Statistic::StDev has * been specified in the constructor or via setStatistics. A NaN value may be returned if the standard deviation cannot * be calculated. - * @see stDev + * \see stDev */ double sampleStDev() const { return mSampleStdev; } @@ -205,7 +205,7 @@ class CORE_EXPORT QgsStatisticalSummary * This is only calculated if Statistic::Minority has been specified in the constructor * or via setStatistics. A NaN value may be returned if the minority cannot * be calculated. - * @see majority + * \see majority */ double minority() const { return mMinority; } @@ -213,36 +213,36 @@ class CORE_EXPORT QgsStatisticalSummary * This is only calculated if Statistic::Majority has been specified in the constructor * or via setStatistics. A NaN value may be returned if the majority cannot * be calculated. - * @see minority + * \see minority */ double majority() const { return mMajority; } /** Returns the first quartile of the values. The quartile is calculated using the * "Tukey's hinges" method. A NaN value may be returned if the first quartile cannot * be calculated. - * @see thirdQuartile - * @see interQuartileRange + * \see thirdQuartile + * \see interQuartileRange */ double firstQuartile() const { return mFirstQuartile; } /** Returns the third quartile of the values. The quartile is calculated using the * "Tukey's hinges" method. A NaN value may be returned if the third quartile cannot * be calculated. - * @see firstQuartile - * @see interQuartileRange + * \see firstQuartile + * \see interQuartileRange */ double thirdQuartile() const { return mThirdQuartile; } /** Returns the inter quartile range of the values. The quartiles are calculated using the * "Tukey's hinges" method. A NaN value may be returned if the IQR cannot * be calculated. - * @see firstQuartile - * @see thirdQuartile + * \see firstQuartile + * \see thirdQuartile */ double interQuartileRange() const { return qIsNaN( mThirdQuartile ) || qIsNaN( mFirstQuartile ) ? std::numeric_limits::quiet_NaN() : mThirdQuartile - mFirstQuartile; } /** Returns the friendly display name for a statistic - * @param statistic statistic to return name for + * \param statistic statistic to return name for */ static QString displayName( Statistic statistic ); diff --git a/src/core/qgsstringstatisticalsummary.h b/src/core/qgsstringstatisticalsummary.h index 7c3485aa533c..29b940941050 100644 --- a/src/core/qgsstringstatisticalsummary.h +++ b/src/core/qgsstringstatisticalsummary.h @@ -31,10 +31,10 @@ * \class QgsStringStatisticalSummary * \brief Calculator for summary statistics and aggregates for a list of strings. * - * Statistics are calculated by calling @link calculate @endlink and passing a list of strings. The + * Statistics are calculated by calling calculate() and passing a list of strings. The * individual statistics can then be retrieved using the associated methods. Note that not all statistics * are calculated by default. Statistics which require slower computations are only calculated by - * specifying the statistic in the constructor or via @link setStatistics @endlink. + * specifying the statistic in the constructor or via setStatistics(). * * \since QGIS 2.16 */ @@ -59,20 +59,20 @@ class CORE_EXPORT QgsStringStatisticalSummary Q_DECLARE_FLAGS( Statistics, Statistic ) /** Constructor for QgsStringStatistics - * @param stats flags for statistics to calculate + * \param stats flags for statistics to calculate */ QgsStringStatisticalSummary( QgsStringStatisticalSummary::Statistics stats = All ); /** Returns flags which specify which statistics will be calculated. Some statistics * are always calculated (e.g., count). - * @see setStatistics + * \see setStatistics */ Statistics statistics() const { return mStatistics; } /** Sets flags which specify which statistics will be calculated. Some statistics * are always calculated (e.g., count). - * @param stats flags for statistics to calculate - * @see statistics + * \param stats flags for statistics to calculate + * \see statistics */ void setStatistics( Statistics stats ) { mStatistics = stats; } @@ -81,17 +81,17 @@ class CORE_EXPORT QgsStringStatisticalSummary void reset(); /** Calculates summary statistics for an entire list of strings at once. - * @param values list of strings - * @see calculateFromVariants() - * @see addString() + * \param values list of strings + * \see calculateFromVariants() + * \see addString() */ void calculate( const QStringList &values ); /** Calculates summary statistics for an entire list of variants at once. Any * non-string variants will be ignored. - * @param values list of variants - * @see calculate() - * @see addValue() + * \param values list of variants + * \see calculate() + * \see addValue() */ void calculateFromVariants( const QVariantList &values ); @@ -99,14 +99,14 @@ class CORE_EXPORT QgsStringStatisticalSummary * allows strings to be added to the calculation one at a time. For large * quantities of strings this may be more efficient then first adding all the * strings to a list and calling calculate(). - * @param string string to add - * @note call reset() before adding the first string using this method + * \param string string to add + * \note call reset() before adding the first string using this method * to clear the results from any previous calculations - * @note finalize() must be called after adding the final string and before + * \note finalize() must be called after adding the final string and before * retrieving calculated statistics. - * @see calculate() - * @see addValue() - * @see finalize() + * \see calculate() + * \see addValue() + * \see finalize() */ void addString( const QString &string ); @@ -114,25 +114,25 @@ class CORE_EXPORT QgsStringStatisticalSummary * allows variants to be added to the calculation one at a time. For large * quantities of variants this may be more efficient then first adding all the * variants to a list and calling calculateFromVariants(). - * @param value variant to add - * @note call reset() before adding the first string using this method + * \param value variant to add + * \note call reset() before adding the first string using this method * to clear the results from any previous calculations - * @note finalize() must be called after adding the final value and before + * \note finalize() must be called after adding the final value and before * retrieving calculated statistics. - * @see calculateFromVariants() - * @see finalize() + * \see calculateFromVariants() + * \see finalize() */ void addValue( const QVariant &value ); /** Must be called after adding all strings with addString() and before retrieving * any calculated string statistics. - * @see addString() + * \see addString() */ void finalize(); /** Returns the value of a specified statistic - * @param stat statistic to return - * @returns calculated value of statistic + * \param stat statistic to return + * \returns calculated value of statistic */ QVariant statistic( Statistic stat ) const; @@ -141,12 +141,12 @@ class CORE_EXPORT QgsStringStatisticalSummary int count() const { return mCount; } /** Returns the number of distinct string values. - * @see distinctValues() + * \see distinctValues() */ int countDistinct() const { return mValues.count(); } /** Returns the set of distinct string values. - * @see countDistinct() + * \see countDistinct() */ QSet< QString > distinctValues() const { return mValues; } @@ -177,7 +177,7 @@ class CORE_EXPORT QgsStringStatisticalSummary double meanLength() const { return mMeanLength; } /** Returns the friendly display name for a statistic - * @param statistic statistic to return name for + * \param statistic statistic to return name for */ static QString displayName( Statistic statistic ); diff --git a/src/core/qgsstringutils.h b/src/core/qgsstringutils.h index 488da472b91f..1d409f9848dd 100644 --- a/src/core/qgsstringutils.h +++ b/src/core/qgsstringutils.h @@ -37,10 +37,10 @@ class CORE_EXPORT QgsStringReplacement public: /** Constructor for QgsStringReplacement. - * @param match string to match - * @param replacement string to replace match with - * @param caseSensitive set to true for a case sensitive match - * @param wholeWordOnly set to true to match complete words only, or false to allow partial word matches + * \param match string to match + * \param replacement string to replace match with + * \param caseSensitive set to true for a case sensitive match + * \param wholeWordOnly set to true to match complete words only, or false to allow partial word matches */ QgsStringReplacement( const QString &match, const QString &replacement, @@ -60,8 +60,8 @@ class CORE_EXPORT QgsStringReplacement bool wholeWordOnly() const { return mWholeWordOnly; } /** Processes a given input string, applying any valid replacements which should be made. - * @param input input string - * @returns input string with any matches replaced by replacement string + * \param input input string + * \returns input string with any matches replaced by replacement string */ QString process( const QString &input ) const; @@ -74,12 +74,12 @@ class CORE_EXPORT QgsStringReplacement } /** Returns a map of the replacement properties. - * @see fromProperties() + * \see fromProperties() */ QgsStringMap properties() const; /** Creates a new QgsStringReplacement from an encoded properties map. - * @see properties() + * \see properties() */ static QgsStringReplacement fromProperties( const QgsStringMap &properties ); @@ -109,21 +109,21 @@ class CORE_EXPORT QgsStringReplacementCollection public: /** Constructor for QgsStringReplacementCollection - * @param replacements initial list of string replacements + * \param replacements initial list of string replacements */ QgsStringReplacementCollection( const QList< QgsStringReplacement > &replacements = QList< QgsStringReplacement >() ) : mReplacements( replacements ) {} /** Returns the list of string replacements in this collection. - * @see setReplacements() + * \see setReplacements() */ QList< QgsStringReplacement > replacements() const { return mReplacements; } /** Sets the list of string replacements in this collection. - * @param replacements list of string replacements to apply. Replacements are applied in the + * \param replacements list of string replacements to apply. Replacements are applied in the * order they are specified here. - * @see replacements() + * \see replacements() */ void setReplacements( const QList< QgsStringReplacement > &replacements ) { @@ -133,21 +133,21 @@ class CORE_EXPORT QgsStringReplacementCollection /** Processes a given input string, applying any valid replacements which should be made * using QgsStringReplacement objects contained by this collection. Replacements * are made in order of the QgsStringReplacement objects contained in the collection. - * @param input input string - * @returns input string with any matches replaced by replacement string + * \param input input string + * \returns input string with any matches replaced by replacement string */ QString process( const QString &input ) const; /** Writes the collection state to an XML element. - * @param elem target DOM element - * @param doc DOM document - * @see readXml() + * \param elem target DOM element + * \param doc DOM document + * \see readXml() */ void writeXml( QDomElement &elem, QDomDocument &doc ) const; /** Reads the collection state from an XML element. - * @param elem DOM element - * @see writeXml() + * \param elem DOM element + * \see writeXml() */ void readXml( const QDomElement &elem ); @@ -178,9 +178,9 @@ class CORE_EXPORT QgsStringUtils }; /** Converts a string by applying capitalization rules to the string. - * @param string input string - * @param capitalization capitalization type to apply - * @return capitalized string + * \param string input string + * \param capitalization capitalization type to apply + * \returns capitalized string * \since QGIS 3.0 */ static QString capitalize( const QString &string, Capitalization capitalization ); @@ -188,45 +188,45 @@ class CORE_EXPORT QgsStringUtils /** Returns the Levenshtein edit distance between two strings. This equates to the minimum * number of character edits (insertions, deletions or substitutions) required to change * one string to another. - * @param string1 first string - * @param string2 second string - * @param caseSensitive set to true for case sensitive comparison - * @returns edit distance. Lower distances indicate more similar strings. + * \param string1 first string + * \param string2 second string + * \param caseSensitive set to true for case sensitive comparison + * \returns edit distance. Lower distances indicate more similar strings. */ static int levenshteinDistance( const QString &string1, const QString &string2, bool caseSensitive = false ); /** Returns the longest common substring between two strings. This substring is the longest * string that is a substring of the two input strings. For example, the longest common substring * of "ABABC" and "BABCA" is "ABC". - * @param string1 first string - * @param string2 second string - * @param caseSensitive set to true for case sensitive comparison - * @returns longest common substring + * \param string1 first string + * \param string2 second string + * \param caseSensitive set to true for case sensitive comparison + * \returns longest common substring */ static QString longestCommonSubstring( const QString &string1, const QString &string2, bool caseSensitive = false ); /** Returns the Hamming distance between two strings. This equates to the number of characters at * corresponding positions within the input strings where the characters are different. The input * strings must be the same length. - * @param string1 first string - * @param string2 second string - * @param caseSensitive set to true for case sensitive comparison - * @returns Hamming distance between strings, or -1 if strings are different lengths. + * \param string1 first string + * \param string2 second string + * \param caseSensitive set to true for case sensitive comparison + * \returns Hamming distance between strings, or -1 if strings are different lengths. */ static int hammingDistance( const QString &string1, const QString &string2, bool caseSensitive = false ); /** Returns the Soundex representation of a string. Soundex is a phonetic matching algorithm, * so strings with similar sounds should be represented by the same Soundex code. - * @param string input string - * @returns 4 letter Soundex code + * \param string input string + * \returns 4 letter Soundex code */ static QString soundex( const QString &string ); /** Returns a string with any URL (e.g., http(s)/ftp) and mailto: text converted to valid HTML * links. - * @param string string to insert links into - * @param foundLinks if specified, will be set to true if any links were inserted into the string - * @returns string with inserted links + * \param string string to insert links into + * \param foundLinks if specified, will be set to true if any links were inserted into the string + * \returns string with inserted links * \since QGIS 3.0 */ static QString insertLinks( const QString &string, bool *foundLinks = nullptr ); diff --git a/src/core/qgstaskmanager.h b/src/core/qgstaskmanager.h index 44652dcee35f..1c71d5a05e4b 100644 --- a/src/core/qgstaskmanager.h +++ b/src/core/qgstaskmanager.h @@ -74,8 +74,8 @@ class CORE_EXPORT QgsTask : public QObject /** * Constructor for QgsTask. - * @param description text description of task - * @param flags task flags + * \param description text description of task + * \param flags task flags */ QgsTask( const QString &description = QString(), const Flags &flags = AllFlags ); @@ -119,7 +119,7 @@ class CORE_EXPORT QgsTask : public QObject * time. Any subtasks owned by this task will also be canceled. * Derived classes must ensure that the base class implementation is called * from any overridden version. - * @see isCanceled() + * \see isCanceled() */ virtual void cancel(); @@ -128,7 +128,7 @@ class CORE_EXPORT QgsTask : public QObject * (ie it is already running or has finished) then calling this has no effect. * Calling this method only has an effect for tasks which are managed * by a QgsTaskManager. - * @see unhold() + * \see unhold() */ void hold(); @@ -136,7 +136,7 @@ class CORE_EXPORT QgsTask : public QObject * Releases the task from being held. For tasks managed by a QgsTaskManager * calling this will re-add them to the queue. If the * task in not currently being held then calling this has no effect. - * @see hold() + * \see hold() */ void unhold(); @@ -173,14 +173,14 @@ class CORE_EXPORT QgsTask : public QObject /** * Sets a list of layers on which the task depends. The task will automatically * be canceled if any of these layers are about to be removed. - * @see dependentLayerIds() + * \see dependentLayerIds() */ void setDependentLayers( const QList &dependentLayers ); /** * Returns the list of layers on which the task depends. The task will automatically * be canceled if any of these layers are about to be removed. - * @see setDependentLayers() + * \see setDependentLayers() */ QList< QgsMapLayer * > dependentLayers() const; @@ -188,30 +188,30 @@ class CORE_EXPORT QgsTask : public QObject /** * Will be emitted by task when its progress changes. - * @param progress percent of progress, from 0.0 - 100.0 - * @note derived classes should not emit this signal directly, instead they should call + * \param progress percent of progress, from 0.0 - 100.0 + * \note derived classes should not emit this signal directly, instead they should call * setProgress() */ void progressChanged( double progress ); /** * Will be emitted by task when its status changes. - * @param status new task status - * @note derived classes should not emit this signal directly, it will automatically + * \param status new task status + * \note derived classes should not emit this signal directly, it will automatically * be emitted */ void statusChanged( int status ); /** * Will be emitted by task to indicate its commencement. - * @note derived classes should not emit this signal directly, it will automatically + * \note derived classes should not emit this signal directly, it will automatically * be emitted when the task begins */ void begun(); /** * Will be emitted by task to indicate its successful completion. - * @note derived classes should not emit this signal directly, it will automatically + * \note derived classes should not emit this signal directly, it will automatically * be emitted */ void taskCompleted(); @@ -220,7 +220,7 @@ class CORE_EXPORT QgsTask : public QObject * Will be emitted by task if it has terminated for any reason * other then completion (e.g., when a task has been canceled or encountered * an internal error). - * @note derived classes should not emit this signal directly, it will automatically + * \note derived classes should not emit this signal directly, it will automatically * be emitted */ void taskTerminated(); @@ -261,7 +261,7 @@ class CORE_EXPORT QgsTask : public QObject /** * Sets the task's current progress. The derived class should call this method whenever * the task wants to update its progress. Calling will automatically emit the progressChanged signal. - * @param progress percent of progress, from 0.0 - 100.0 + * \param progress percent of progress, from 0.0 - 100.0 */ void setProgress( double progress ); @@ -343,7 +343,7 @@ class CORE_EXPORT QgsTaskManager : public QObject public: /** Constructor for QgsTaskManager. - * @param parent parent QObject + * \param parent parent QObject */ QgsTaskManager( QObject *parent = nullptr ); @@ -381,7 +381,7 @@ class CORE_EXPORT QgsTaskManager : public QObject * the task. The priority argument can be used to control the run queue's * order of execution, with larger numbers * taking precedence over lower priority numbers. - * @returns unique task ID + * \returns unique task ID */ long addTask( QgsTask *task, int priority = 0 ); @@ -391,13 +391,13 @@ class CORE_EXPORT QgsTaskManager : public QObject * manager will be responsible for starting the task. The priority argument can * be used to control the run queue's order of execution, with larger numbers * taking precedence over lower priority numbers. - * @returns unique task ID + * \returns unique task ID */ long addTask( const TaskDefinition &task, int priority = 0 ); /** Returns the task with matching ID. - * @param id task ID - * @returns task if found, or nullptr + * \param id task ID + * \returns task if found, or nullptr */ QgsTask *task( long id ) const; @@ -409,8 +409,8 @@ class CORE_EXPORT QgsTaskManager : public QObject int count() const; /** Returns the unique task ID corresponding to a task managed by the class. - * @param task task to find - * @returns task ID, or -1 if task not found + * \param task task to find + * \returns task ID, or -1 if task not found */ long taskId( QgsTask *task ) const; @@ -425,65 +425,65 @@ class CORE_EXPORT QgsTaskManager : public QObject bool dependenciesSatisfied( long taskId ) const; //! Returns the set of task IDs on which a task is dependent - //! @note not available in Python bindings + //! \note not available in Python bindings QSet< long > dependencies( long taskId ) const; /** Returns a list of layers on which as task is dependent. The task will automatically * be canceled if any of these layers are above to be removed. - * @param taskId task ID - * @returns list of layers - * @see tasksDependentOnLayer() + * \param taskId task ID + * \returns list of layers + * \see tasksDependentOnLayer() */ QList< QgsMapLayer * > dependentLayers( long taskId ) const; /** * Returns a list of tasks which depend on a layer. - * @see dependentLayers() + * \see dependentLayers() */ QList< QgsTask * > tasksDependentOnLayer( QgsMapLayer *layer ) const; /** Returns a list of the active (queued or running) tasks. - * @see countActiveTasks() + * \see countActiveTasks() */ QList< QgsTask * > activeTasks() const; /** Returns the number of active (queued or running) tasks. - * @see activeTasks() - * @see countActiveTasksChanged() + * \see activeTasks() + * \see countActiveTasksChanged() */ int countActiveTasks() const; signals: //! Will be emitted when a task reports a progress change - //! @param taskId ID of task - //! @param progress percent of progress, from 0.0 - 100.0 + //! \param taskId ID of task + //! \param progress percent of progress, from 0.0 - 100.0 void progressChanged( long taskId, double progress ); //! Will be emitted when only a single task remains to complete //! and that task has reported a progress change - //! @param progress percent of progress, from 0.0 - 100.0 + //! \param progress percent of progress, from 0.0 - 100.0 void finalTaskProgressChanged( double progress ); //! Will be emitted when a task reports a status change - //! @param taskId ID of task - //! @param status new task status + //! \param taskId ID of task + //! \param status new task status void statusChanged( long taskId, int status ); //! Emitted when a new task has been added to the manager - //! @param taskId ID of task + //! \param taskId ID of task void taskAdded( long taskId ); //! Emitted when a task is about to be deleted - //! @param taskId ID of task + //! \param taskId ID of task void taskAboutToBeDeleted( long taskId ); //! Emitted when all tasks are complete - //! @see countActiveTasksChanged() + //! \see countActiveTasksChanged() void allTasksFinished(); //! Emitted when the number of active tasks changes - //! @see countActiveTasks() + //! \see countActiveTasks() void countActiveTasksChanged( int count ); private slots: @@ -533,7 +533,7 @@ class CORE_EXPORT QgsTaskManager : public QObject void processQueue(); //! Recursively cancel dependent tasks - //! @param taskId id of terminated task to cancel any other tasks + //! \param taskId id of terminated task to cancel any other tasks //! which are dependent on void cancelDependentTasks( long taskId ); diff --git a/src/core/qgstextlabelfeature.h b/src/core/qgstextlabelfeature.h index af06c4899c3a..b646417ee500 100644 --- a/src/core/qgstextlabelfeature.h +++ b/src/core/qgstextlabelfeature.h @@ -20,7 +20,7 @@ /** \ingroup core * Class that adds extra information to QgsLabelFeature for text labels * - * @note not part of public API + * \note not part of public API */ class QgsTextLabelFeature : public QgsLabelFeature { @@ -32,7 +32,7 @@ class QgsTextLabelFeature : public QgsLabelFeature ~QgsTextLabelFeature(); /** Returns the text component corresponding to a specified label part - * @param partId Set to -1 for labels which are not broken into parts (e.g., non-curved labels), or the required + * \param partId Set to -1 for labels which are not broken into parts (e.g., non-curved labels), or the required * part index for labels which are broken into parts (curved labels) * \since QGIS 2.10 */ diff --git a/src/core/qgstextrenderer.h b/src/core/qgstextrenderer.h index a3e2d38d44f8..49756ed56bfc 100644 --- a/src/core/qgstextrenderer.h +++ b/src/core/qgstextrenderer.h @@ -46,148 +46,148 @@ class CORE_EXPORT QgsTextBufferSettings QgsTextBufferSettings(); /** Copy constructor. - * @param other source settings + * \param other source settings */ QgsTextBufferSettings( const QgsTextBufferSettings &other ); /** Copy constructor. - * @param other source QgsTextBufferSettings + * \param other source QgsTextBufferSettings */ QgsTextBufferSettings &operator=( const QgsTextBufferSettings &other ); ~QgsTextBufferSettings(); /** Returns whether the buffer is enabled. - * @see setEnabled() + * \see setEnabled() */ bool enabled() const; /** Sets whether the text buffer will be drawn. - * @param enabled set to true to draw buffer - * @see enabled() + * \param enabled set to true to draw buffer + * \see enabled() */ void setEnabled( bool enabled ); /** Returns the size of the buffer. - * @see sizeUnit() - * @see setSize() + * \see sizeUnit() + * \see setSize() */ double size() const; /** Sets the size of the buffer. The size units are specified using setSizeUnit(). - * @param size buffer size - * @see size() - * @see setSizeUnit() + * \param size buffer size + * \see size() + * \see setSizeUnit() */ void setSize( double size ); /** Returns the units for the buffer size. - * @see size() - * @see setSizeUnit() + * \see size() + * \see setSizeUnit() */ QgsUnitTypes::RenderUnit sizeUnit() const; /** Sets the units used for the buffer size. - * @param unit size unit - * @see setSize() - * @see sizeUnit() + * \param unit size unit + * \see setSize() + * \see sizeUnit() */ void setSizeUnit( QgsUnitTypes::RenderUnit unit ); /** Returns the map unit scale object for the buffer size. This is only used if the * buffer size is set to QgsUnitTypes::RenderMapUnit. - * @see setSizeMapUnitScale() - * @see sizeUnit() + * \see setSizeMapUnitScale() + * \see sizeUnit() */ QgsMapUnitScale sizeMapUnitScale() const; /** Sets the map unit scale object for the buffer size. This is only used if the * buffer size is set to QgsUnitTypes::RenderMapUnit. - * @param scale scale for buffer size - * @see sizeMapUnitScale() - * @see setSizeUnit() + * \param scale scale for buffer size + * \see sizeMapUnitScale() + * \see setSizeUnit() */ void setSizeMapUnitScale( const QgsMapUnitScale &scale ); /** Returns the color of the buffer. - * @see setColor() + * \see setColor() */ QColor color() const; /** Sets the color for the buffer. - * @param color buffer color - * @see color() + * \param color buffer color + * \see color() */ void setColor( const QColor &color ); /** Returns whether the interior of the buffer will be filled in. If false, only the stroke * of the text will be drawn as the buffer. The effect of this setting is only visible for * semi-transparent text. - * @see setFillBufferInterior() + * \see setFillBufferInterior() */ bool fillBufferInterior() const; /** Sets whether the interior of the buffer will be filled in. - * @param fill set to false to drawn only the stroke of the text as the buffer, or true to also + * \param fill set to false to drawn only the stroke of the text as the buffer, or true to also * shade the area inside the text. The effect of this setting is only visible for semi-transparent text. - * @see fillBufferInterior() + * \see fillBufferInterior() */ void setFillBufferInterior( bool fill ); /** Returns the buffer opacity. The opacity is a double value between 0 (fully transparent) and 1 (totally * opaque). - * @see setOpacity() + * \see setOpacity() */ double opacity() const; /** Sets the buffer opacity. - * @param opacity opacity as a double value between 0 (fully transparent) and 1 (totally + * \param opacity opacity as a double value between 0 (fully transparent) and 1 (totally * opaque) - * @see opacity() + * \see opacity() */ void setOpacity( double opacity ); /** Returns the buffer join style. - * @see setJoinStyle + * \see setJoinStyle */ Qt::PenJoinStyle joinStyle() const; /** Sets the join style used for drawing the buffer. - * @param style join style - * @see joinStyle() + * \param style join style + * \see joinStyle() */ void setJoinStyle( Qt::PenJoinStyle style ); /** Returns the blending mode used for drawing the buffer. - * @see setBlendMode() + * \see setBlendMode() */ QPainter::CompositionMode blendMode() const; /** Sets the blending mode used for drawing the buffer. - * @param mode blending mode - * @see blendMode() + * \param mode blending mode + * \see blendMode() */ void setBlendMode( QPainter::CompositionMode mode ); /** Reads settings from a layer's custom properties. - * @param layer source vector layer - * @see writeToLayer() + * \param layer source vector layer + * \see writeToLayer() */ void readFromLayer( QgsVectorLayer *layer ); /** Writes settings to a layer's custom properties. - * @param layer target vector layer - * @see readFromLayer() + * \param layer target vector layer + * \see readFromLayer() */ void writeToLayer( QgsVectorLayer *layer ) const; /** Read settings from a DOM element. - * @see writeXml() + * \see writeXml() */ void readXml( const QDomElement &elem ); /** Write settings into a DOM element. - * @see readXml() + * \see readXml() */ QDomElement writeXml( QDomDocument &doc ) const; @@ -241,7 +241,7 @@ class CORE_EXPORT QgsTextBackgroundSettings QgsTextBackgroundSettings(); /** Copy constructor. - * @param other source QgsTextBackgroundSettings + * \param other source QgsTextBackgroundSettings */ QgsTextBackgroundSettings( const QgsTextBackgroundSettings &other ); @@ -250,51 +250,51 @@ class CORE_EXPORT QgsTextBackgroundSettings ~QgsTextBackgroundSettings(); /** Returns whether the background is enabled. - * @see setEnabled() + * \see setEnabled() */ bool enabled() const; /** Sets whether the text background will be drawn. - * @param enabled set to true to draw background - * @see enabled() + * \param enabled set to true to draw background + * \see enabled() */ void setEnabled( bool enabled ); /** Returns the type of background shape (e.g., square, ellipse, SVG). - * @see setType() + * \see setType() */ ShapeType type() const; /** Sets the type of background shape to draw (e.g., square, ellipse, SVG). - * @param type shape type - * @see type() + * \param type shape type + * \see type() */ void setType( ShapeType type ); /** Returns the path to the background SVG file, if set. - * @see setSvgFile() + * \see setSvgFile() */ QString svgFile() const; /** Sets the path to the background SVG file. This is only used if type() is set to * QgsTextBackgroundSettings::ShapeSVG. - * @param file SVG file path - * @see svgFile() + * \param file SVG file path + * \see svgFile() */ void setSvgFile( const QString &file ); /** Returns the method used to determine the size of the background shape (e.g., fixed size or buffer * around text). - * @see setSizeType() - * @see size() + * \see setSizeType() + * \see size() */ SizeType sizeType() const; /** Sets the method used to determine the size of the background shape (e.g., fixed size or buffer * around text). - * @param type size method - * @see sizeType() - * @see setSize() + * \param type size method + * \see sizeType() + * \see setSize() */ void setSizeType( SizeType type ); @@ -302,8 +302,8 @@ class CORE_EXPORT QgsTextBackgroundSettings * e.g., for size types of QgsTextBackgroundSettings::SizeFixed the size will represent the actual width and * height of the shape, for QgsTextBackgroundSettings::SizeBuffer the size will represent the horizontal * and vertical margins to add to the text when calculating the size of the shape. - * @see setSize() - * @see sizeType() + * \see setSize() + * \see sizeType() */ QSizeF size() const; @@ -311,279 +311,279 @@ class CORE_EXPORT QgsTextBackgroundSettings * e.g., for size types of QgsTextBackgroundSettings::SizeFixed the size will represent the actual width and * height of the shape, for QgsTextBackgroundSettings::SizeBuffer the size will represent the horizontal * and vertical margins to add to the text when calculating the size of the shape. - * @param size QSizeF representing horizontal and vertical size components for shape - * @see size() - * @see setSizeType() + * \param size QSizeF representing horizontal and vertical size components for shape + * \see size() + * \see setSizeType() */ void setSize( const QSizeF &size ); /** Returns the units used for the shape's size. This value has no meaning if the sizeType() is set to * QgsTextBackgroundSettings::SizePercent. - * @see setSizeUnit() - * @see sizeType() - * @see size() + * \see setSizeUnit() + * \see sizeType() + * \see size() */ QgsUnitTypes::RenderUnit sizeUnit() const; /** Sets the units used for the shape's size. This value has no meaning if the sizeType() is set to * QgsTextBackgroundSettings::SizePercent. - * @param unit size units - * @see sizeUnit() - * @see setSizeType() - * @see setSize() + * \param unit size units + * \see sizeUnit() + * \see setSizeType() + * \see setSize() */ void setSizeUnit( QgsUnitTypes::RenderUnit unit ); /** Returns the map unit scale object for the shape size. This is only used if the * sizeUnit() is set to QgsUnitTypes::RenderMapUnit. - * @see setSizeMapUnitScale() - * @see sizeUnit() + * \see setSizeMapUnitScale() + * \see sizeUnit() */ QgsMapUnitScale sizeMapUnitScale() const; /** Sets the map unit scale object for the shape size. This is only used if the * sizeUnit() is set to QgsUnitTypes::RenderMapUnit. - * @param scale scale for shape size - * @see sizeMapUnitScale() - * @see setSizeUnit() + * \param scale scale for shape size + * \see sizeMapUnitScale() + * \see setSizeUnit() */ void setSizeMapUnitScale( const QgsMapUnitScale &scale ); /** Returns the method used for rotating the background shape. - * @see setRotationType() - * @see rotation() + * \see setRotationType() + * \see rotation() */ RotationType rotationType() const; /** Sets the method used for rotating the background shape. - * @param type rotation method - * @see rotationType() - * @see setRotation() + * \param type rotation method + * \see rotationType() + * \see setRotation() */ void setRotationType( RotationType type ); /** Returns the rotation for the background shape. - * @see rotationType() - * @see setRotation() + * \see rotationType() + * \see setRotation() */ double rotation() const; /** Sets the rotation for the background shape. - * @param rotation angle in degrees to rotate - * @see rotation() - * @see setRotationType() + * \param rotation angle in degrees to rotate + * \see rotation() + * \see setRotationType() */ void setRotation( double rotation ); /** Returns the offset used for drawing the background shape. Units are determined * via offsetUnit(). - * @see setOffset() - * @see offsetUnit() + * \see setOffset() + * \see offsetUnit() */ QPointF offset() const; /** Sets the offset used for drawing the background shape. Units are specified using * setOffsetUnit(). - * @param offset offset for shape - * @see offset() - * @see setOffsetUnit() + * \param offset offset for shape + * \see offset() + * \see setOffsetUnit() */ void setOffset( const QPointF &offset ); /** Returns the units used for the shape's offset. - * @see setOffsetUnit() - * @see offset() + * \see setOffsetUnit() + * \see offset() */ QgsUnitTypes::RenderUnit offsetUnit() const; /** Sets the units used for the shape's offset. - * @param units offset units - * @see offsetUnit() - * @see setOffset() + * \param units offset units + * \see offsetUnit() + * \see setOffset() */ void setOffsetUnit( QgsUnitTypes::RenderUnit units ); /** Returns the map unit scale object for the shape offset. This is only used if the * offsetUnit() is set to QgsUnitTypes::RenderMapUnit. - * @see setOffsetMapUnitScale() - * @see offsetUnit() + * \see setOffsetMapUnitScale() + * \see offsetUnit() */ QgsMapUnitScale offsetMapUnitScale() const; /** Sets the map unit scale object for the shape offset. This is only used if the * offsetUnit() is set to QgsUnitTypes::RenderMapUnit. - * @param scale scale for shape offset - * @see offsetMapUnitScale() - * @see setOffsetUnit() + * \param scale scale for shape offset + * \see offsetMapUnitScale() + * \see setOffsetUnit() */ void setOffsetMapUnitScale( const QgsMapUnitScale &scale ); /** Returns the radii used for rounding the corners of shapes. Units are retrieved * through radiiUnit(). - * @see setRadii() - * @see radiiUnit() + * \see setRadii() + * \see radiiUnit() */ QSizeF radii() const; /** Sets the radii used for rounding the corners of shapes. This is only used if * type() is set to QgsTextBackgroundSettings::ShapeRectangle or QgsTextBackgroundSettings::ShapeSquare. - * @param radii QSizeF representing horizontal and vertical radii for rounded corners. Units are + * \param radii QSizeF representing horizontal and vertical radii for rounded corners. Units are * specified through setRadiiUnit() - * @see radii() - * @see setRadiiUnit() + * \see radii() + * \see setRadiiUnit() */ void setRadii( const QSizeF &radii ); /** Returns the units used for the shape's radii. - * @see setRadiiUnit() - * @see radii() + * \see setRadiiUnit() + * \see radii() */ QgsUnitTypes::RenderUnit radiiUnit() const; /** Sets the units used for the shape's radii. - * @param units radii units - * @see radiiUnit() - * @see setRadii() + * \param units radii units + * \see radiiUnit() + * \see setRadii() */ void setRadiiUnit( QgsUnitTypes::RenderUnit units ); /** Returns the map unit scale object for the shape radii. This is only used if the * radiiUnit() is set to QgsUnitTypes::RenderMapUnit. - * @see setRadiiMapUnitScale() - * @see radiiUnit() + * \see setRadiiMapUnitScale() + * \see radiiUnit() */ QgsMapUnitScale radiiMapUnitScale() const; /** Sets the map unit scale object for the shape radii. This is only used if the * radiiUnit() is set to QgsUnitTypes::RenderMapUnit. - * @param scale scale for shape radii - * @see radiiMapUnitScale() - * @see setRadiiUnit() + * \param scale scale for shape radii + * \see radiiMapUnitScale() + * \see setRadiiUnit() */ void setRadiiMapUnitScale( const QgsMapUnitScale &scale ); /** Returns the background shape's opacity. The opacity is a double value between 0 (fully transparent) and 1 (totally * opaque). - * @see setOpacity() + * \see setOpacity() */ double opacity() const; /** Sets the background shape's opacity. - * @param opacity opacity as a double value between 0 (fully transparent) and 1 (totally + * \param opacity opacity as a double value between 0 (fully transparent) and 1 (totally * opaque) - * @see opacity() + * \see opacity() */ void setOpacity( double opacity ); /** Returns the blending mode used for drawing the background shape. - * @see setBlendMode() + * \see setBlendMode() */ QPainter::CompositionMode blendMode() const; /** Sets the blending mode used for drawing the background shape. - * @param mode blending mode - * @see blendMode() + * \param mode blending mode + * \see blendMode() */ void setBlendMode( QPainter::CompositionMode mode ); /** Returns the color used for filing the background shape. - * @see setFillColor() - * @see strokeColor() + * \see setFillColor() + * \see strokeColor() */ QColor fillColor() const; /** Sets the color used for filing the background shape. - * @param color background color - * @see fillColor() - * @see setStrokeColor() + * \param color background color + * \see fillColor() + * \see setStrokeColor() */ void setFillColor( const QColor &color ); /** Returns the color used for outlining the background shape. - * @see setStrokeColor() - * @see fillColor() + * \see setStrokeColor() + * \see fillColor() */ QColor strokeColor() const; /** Sets the color used for outlining the background shape. - * @param color stroke color - * @see strokeColor() - * @see setFillColor() + * \param color stroke color + * \see strokeColor() + * \see setFillColor() */ void setStrokeColor( const QColor &color ); /** Returns the width of the shape's stroke (stroke). Units are retrieved through * strokeWidthUnit(). - * @see setStrokeWidth() - * @see strokeWidthUnit() + * \see setStrokeWidth() + * \see strokeWidthUnit() */ double strokeWidth() const; /** Sets the width of the shape's stroke (stroke). Units are specified through * setStrokeWidthUnit(). - * @see strokeWidth() - * @see setStrokeWidthUnit() + * \see strokeWidth() + * \see setStrokeWidthUnit() */ void setStrokeWidth( double width ); /** Returns the units used for the shape's stroke width. - * @see setStrokeWidthUnit() - * @see strokeWidth() + * \see setStrokeWidthUnit() + * \see strokeWidth() */ QgsUnitTypes::RenderUnit strokeWidthUnit() const; /** Sets the units used for the shape's stroke width. - * @param units stroke width units - * @see strokeWidthUnit() - * @see setStrokeWidth() + * \param units stroke width units + * \see strokeWidthUnit() + * \see setStrokeWidth() */ void setStrokeWidthUnit( QgsUnitTypes::RenderUnit units ); /** Returns the map unit scale object for the shape stroke width. This is only used if the * strokeWidthUnit() is set to QgsUnitTypes::RenderMapUnit. - * @see setStrokeWidthMapUnitScale() - * @see strokeWidthUnit() + * \see setStrokeWidthMapUnitScale() + * \see strokeWidthUnit() */ QgsMapUnitScale strokeWidthMapUnitScale() const; /** Sets the map unit scale object for the shape stroke width. This is only used if the * strokeWidthUnit() is set to QgsUnitTypes::RenderMapUnit. - * @param scale scale for shape stroke width - * @see strokeWidthMapUnitScale() - * @see setStrokeWidthUnit() + * \param scale scale for shape stroke width + * \see strokeWidthMapUnitScale() + * \see setStrokeWidthUnit() */ void setStrokeWidthMapUnitScale( const QgsMapUnitScale &scale ); /** Returns the join style used for drawing the background shape. - * @see setJoinStyle + * \see setJoinStyle */ Qt::PenJoinStyle joinStyle() const; /** Sets the join style used for drawing the background shape. - * @param style join style - * @see joinStyle() + * \param style join style + * \see joinStyle() */ void setJoinStyle( Qt::PenJoinStyle style ); /** Reads settings from a layer's custom properties. - * @param layer source vector layer - * @see writeToLayer() + * \param layer source vector layer + * \see writeToLayer() */ void readFromLayer( QgsVectorLayer *layer ); /** Writes settings to a layer's custom properties. - * @param layer target vector layer - * @see readFromLayer() + * \param layer target vector layer + * \see readFromLayer() */ void writeToLayer( QgsVectorLayer *layer ) const; /** Read settings from a DOM element. - * @see writeXml() + * \see writeXml() */ void readXml( const QDomElement &elem ); /** Write settings into a DOM element. - * @see readXml() + * \see readXml() */ QDomElement writeXml( QDomDocument &doc ) const; @@ -617,7 +617,7 @@ class CORE_EXPORT QgsTextShadowSettings QgsTextShadowSettings(); /** Copy constructor. - * @param other source QgsTextShadowSettings + * \param other source QgsTextShadowSettings */ QgsTextShadowSettings( const QgsTextShadowSettings &other ); @@ -626,215 +626,215 @@ class CORE_EXPORT QgsTextShadowSettings ~QgsTextShadowSettings(); /** Returns whether the shadow is enabled. - * @see setEnabled() + * \see setEnabled() */ bool enabled() const; /** Sets whether the text shadow will be drawn. - * @param enabled set to true to draw shadow - * @see enabled() + * \param enabled set to true to draw shadow + * \see enabled() */ void setEnabled( bool enabled ); /** Returns the placement for the drop shadow. The placement determines * both the z-order stacking position for the shadow and the what shape (e.g., text, * background shape) is used for casting the shadow. - * @see setShadowPlacement() + * \see setShadowPlacement() */ QgsTextShadowSettings::ShadowPlacement shadowPlacement() const; /** Sets the placement for the drop shadow. The placement determines * both the z-order stacking position for the shadow and the what shape (e.g., text, * background shape) is used for casting the shadow. - * @param placement shadow placement - * @see shadowPlacement() + * \param placement shadow placement + * \see shadowPlacement() */ void setShadowPlacement( QgsTextShadowSettings::ShadowPlacement placement ); /** Returns the angle for offsetting the position of the shadow from the text. - * @see setOffsetAngle - * @see offsetDistance() + * \see setOffsetAngle + * \see offsetDistance() */ int offsetAngle() const; /** Sets the angle for offsetting the position of the shadow from the text. - * @param angle offset angle in degrees - * @see offsetAngle() - * @see setOffsetDistance() + * \param angle offset angle in degrees + * \see offsetAngle() + * \see setOffsetDistance() */ void setOffsetAngle( int angle ); /** Returns the distance for offsetting the position of the shadow from the text. Offset units * are retrieved via offsetUnit(). - * @see setOffsetDistance() - * @see offsetUnit() + * \see setOffsetDistance() + * \see offsetUnit() */ double offsetDistance() const; /** Sets the distance for offsetting the position of the shadow from the text. Offset units * are specified via setOffsetUnit(). - * @param distance offset distance - * @see offsetDistance() - * @see setOffsetUnit() + * \param distance offset distance + * \see offsetDistance() + * \see setOffsetUnit() */ void setOffsetDistance( double distance ); /** Returns the units used for the shadow's offset. - * @see setOffsetUnit() - * @see offsetDistance() + * \see setOffsetUnit() + * \see offsetDistance() */ QgsUnitTypes::RenderUnit offsetUnit() const; /** Sets the units used for the shadow's offset. - * @param units shadow distance units - * @see offsetUnit() - * @see setOffsetDistance() + * \param units shadow distance units + * \see offsetUnit() + * \see setOffsetDistance() */ void setOffsetUnit( QgsUnitTypes::RenderUnit units ); /** Returns the map unit scale object for the shadow offset distance. This is only used if the * offsetUnit() is set to QgsUnitTypes::RenderMapUnit. - * @see setOffsetMapUnitScale() - * @see offsetUnit() + * \see setOffsetMapUnitScale() + * \see offsetUnit() */ QgsMapUnitScale offsetMapUnitScale() const; /** Sets the map unit scale object for the shadow offset distance. This is only used if the * offsetUnit() is set to QgsUnitTypes::RenderMapUnit. - * @param scale scale for shadow offset - * @see offsetMapUnitScale() - * @see setOffsetUnit() + * \param scale scale for shadow offset + * \see offsetMapUnitScale() + * \see setOffsetUnit() */ void setOffsetMapUnitScale( const QgsMapUnitScale &scale ); /** Returns true if the global shadow offset will be used. - * @see setOffsetGlobal() + * \see setOffsetGlobal() */ bool offsetGlobal() const; /** Sets whether the global shadow offset should be used. - * @param global set to true to use global shadow offset. + * \param global set to true to use global shadow offset. */ void setOffsetGlobal( bool global ); /** Returns the blur radius for the shadow. Radius units are retrieved via blurRadiusUnits(). - * @see setBlurRadius() - * @see blurRadiusUnit() + * \see setBlurRadius() + * \see blurRadiusUnit() */ double blurRadius() const; /** Sets the blur radius for the shadow. Radius units are specified via setBlurRadiusUnits(). - * @param blurRadius blur radius - * @see blurRadius() - * @see setBlurRadiusUnit() + * \param blurRadius blur radius + * \see blurRadius() + * \see setBlurRadiusUnit() */ void setBlurRadius( double blurRadius ); /** Returns the units used for the shadow's blur radius. - * @see setBlurRadiusUnit() - * @see blurRadius() + * \see setBlurRadiusUnit() + * \see blurRadius() */ QgsUnitTypes::RenderUnit blurRadiusUnit() const; /** Sets the units used for the shadow's blur radius. - * @param units shadow blur radius units - * @see blurRadiusUnit() - * @see setBlurRadius() + * \param units shadow blur radius units + * \see blurRadiusUnit() + * \see setBlurRadius() */ void setBlurRadiusUnit( QgsUnitTypes::RenderUnit units ); /** Returns the map unit scale object for the shadow blur radius. This is only used if the * blurRadiusUnit() is set to QgsUnitTypes::RenderMapUnit. - * @see setBlurRadiusMapUnitScale() - * @see blurRadiusUnit() + * \see setBlurRadiusMapUnitScale() + * \see blurRadiusUnit() */ QgsMapUnitScale blurRadiusMapUnitScale() const; /** Sets the map unit scale object for the shadow blur radius. This is only used if the * blurRadiusUnit() is set to QgsUnitTypes::RenderMapUnit. - * @param scale scale for shadow blur radius - * @see blurRadiusMapUnitScale() - * @see setBlurRadiusUnit() + * \param scale scale for shadow blur radius + * \see blurRadiusMapUnitScale() + * \see setBlurRadiusUnit() */ void setBlurRadiusMapUnitScale( const QgsMapUnitScale &scale ); /** Returns whether only the alpha channel for the shadow will be blurred. - * @see setBlurAlphaOnly() + * \see setBlurAlphaOnly() */ bool blurAlphaOnly() const; /** Sets whether only the alpha channel for the shadow should be blurred. - * @param alphaOnly set to true to blur only the alpha channel. If false, all channels (including + * \param alphaOnly set to true to blur only the alpha channel. If false, all channels (including * red, green and blue channel) will be blurred. - * @see blurAlphaOnly() + * \see blurAlphaOnly() */ void setBlurAlphaOnly( bool alphaOnly ); /** Returns the shadow's opacity. The opacity is a double value between 0 (fully transparent) and 1 (totally * opaque). - * @see setOpacity() + * \see setOpacity() */ double opacity() const; /** Sets the shadow's opacity. - * @param opacity opacity as a double value between 0 (fully transparent) and 1 (totally + * \param opacity opacity as a double value between 0 (fully transparent) and 1 (totally * opaque) - * @see opacity() + * \see opacity() */ void setOpacity( double opacity ); /** Returns the scaling used for the drop shadow (in percentage of original size). - * @see setScale() + * \see setScale() */ int scale() const; /** Sets the scaling used for the drop shadow (in percentage of original size). - * @param scale scale percent for drop shadow - * @see scale() + * \param scale scale percent for drop shadow + * \see scale() */ void setScale( int scale ); /** Returns the color of the drop shadow. - * @see setColor() + * \see setColor() */ QColor color() const; /** Sets the color for the drop shadow. - * @param color shadow color - * @see color() + * \param color shadow color + * \see color() */ void setColor( const QColor &color ); /** Returns the blending mode used for drawing the drop shadow. - * @see setBlendMode() + * \see setBlendMode() */ QPainter::CompositionMode blendMode() const; /** Sets the blending mode used for drawing the drop shadow. - * @param mode blending mode - * @see blendMode() + * \param mode blending mode + * \see blendMode() */ void setBlendMode( QPainter::CompositionMode mode ); /** Reads settings from a layer's custom properties. - * @param layer source vector layer - * @see writeToLayer() + * \param layer source vector layer + * \see writeToLayer() */ void readFromLayer( QgsVectorLayer *layer ); /** Writes settings to a layer's custom properties. - * @param layer target vector layer - * @see readFromLayer() + * \param layer target vector layer + * \see readFromLayer() */ void writeToLayer( QgsVectorLayer *layer ) const; /** Read settings from a DOM element. - * @see writeXml() + * \see writeXml() */ void readXml( const QDomElement &elem ); /** Write settings into a DOM element. - * @see readXml() + * \see readXml() */ QDomElement writeXml( QDomDocument &doc ) const; @@ -859,7 +859,7 @@ class CORE_EXPORT QgsTextFormat QgsTextFormat(); /** Copy constructor. - * @param other source QgsTextFormat + * \param other source QgsTextFormat */ QgsTextFormat( const QgsTextFormat &other ); @@ -868,204 +868,204 @@ class CORE_EXPORT QgsTextFormat ~QgsTextFormat(); /** Returns a reference to the text buffer settings. - * @see setBuffer() + * \see setBuffer() */ QgsTextBufferSettings &buffer() { return mBufferSettings; } /** Returns a reference to the text buffer settings. - * @see setBuffer() + * \see setBuffer() */ QgsTextBufferSettings buffer() const { return mBufferSettings; } /** Sets the text's buffer settings. - * @param bufferSettings buffer settings - * @see buffer() + * \param bufferSettings buffer settings + * \see buffer() */ void setBuffer( const QgsTextBufferSettings &bufferSettings ) { mBufferSettings = bufferSettings; } /** Returns a reference to the text background settings. - * @see setBackground() + * \see setBackground() */ QgsTextBackgroundSettings &background() { return mBackgroundSettings; } /** Returns a reference to the text background settings. - * @see setBackground() + * \see setBackground() */ QgsTextBackgroundSettings background() const { return mBackgroundSettings; } /** Sets the text's background settings. - * @param backgroundSettings background settings - * @see background() + * \param backgroundSettings background settings + * \see background() */ void setBackground( const QgsTextBackgroundSettings &backgroundSettings ) { mBackgroundSettings = backgroundSettings; } /** Returns a reference to the text drop shadow settings. - * @see setShadow() + * \see setShadow() */ QgsTextShadowSettings &shadow() { return mShadowSettings; } /** Returns a reference to the text drop shadow settings. - * @see setShadow() + * \see setShadow() */ QgsTextShadowSettings shadow() const { return mShadowSettings; } /** Sets the text's drop shadow settings. - * @param shadowSettings shadow settings - * @see shadow() + * \param shadowSettings shadow settings + * \see shadow() */ void setShadow( const QgsTextShadowSettings &shadowSettings ) { mShadowSettings = shadowSettings; } /** Returns the font used for rendering text. Note that the size of the font * is not used, and size() should be called instead to determine the size * of rendered text. - * @see scaledFont() - * @see setFont() - * @see namedStyle() + * \see scaledFont() + * \see setFont() + * \see namedStyle() */ QFont font() const; /** Returns a font with the size scaled to match the format's size settings (including * units and map unit scale) for a specified render context. - * @param context destination render context - * @returns font with scaled size - * @see font() - * @see size() + * \param context destination render context + * \returns font with scaled size + * \see font() + * \see size() */ QFont scaledFont( const QgsRenderContext &context ) const; /** Sets the font used for rendering text. Note that the size of the font * is not used, and setSize() should be called instead to explicitly set the size * of rendered text. - * @param font desired font - * @see font() - * @see setNamedStyle() + * \param font desired font + * \see font() + * \see setNamedStyle() */ void setFont( const QFont &font ); /** Returns the named style for the font used for rendering text (e.g., "bold"). - * @see setNamedStyle() - * @see font() + * \see setNamedStyle() + * \see font() */ QString namedStyle() const; /** Sets the named style for the font used for rendering text. - * @param style named style, e.g., "bold" - * @see namedStyle() - * @see setFont() + * \param style named style, e.g., "bold" + * \see namedStyle() + * \see setFont() */ void setNamedStyle( const QString &style ); /** Returns the size for rendered text. Units are retrieved using sizeUnit(). - * @see setSize() - * @see sizeUnit() + * \see setSize() + * \see sizeUnit() */ double size() const; /** Sets the size for rendered text. - * @param size size of rendered text. Units are set using setSizeUnit() - * @see size() - * @see setSizeUnit() + * \param size size of rendered text. Units are set using setSizeUnit() + * \see size() + * \see setSizeUnit() */ void setSize( double size ); /** Returns the units for the size of rendered text. - * @see size() - * @see setSizeUnit() - * @see sizeMapUnitScale() + * \see size() + * \see setSizeUnit() + * \see sizeMapUnitScale() */ QgsUnitTypes::RenderUnit sizeUnit() const; /** Sets the units for the size of rendered text. - * @param unit size units - * @see setSize() - * @see sizeUnit() - * @see setSizeMapUnitScale() + * \param unit size units + * \see setSize() + * \see sizeUnit() + * \see setSizeMapUnitScale() */ void setSizeUnit( QgsUnitTypes::RenderUnit unit ); /** Returns the map unit scale object for the size. This is only used if the * sizeUnit() is set to QgsUnitTypes::RenderMapUnit. - * @see setSizeMapUnitScale() - * @see sizeUnit() + * \see setSizeMapUnitScale() + * \see sizeUnit() */ QgsMapUnitScale sizeMapUnitScale() const; /** Sets the map unit scale object for the size. This is only used if the * sizeUnit() is set to QgsUnitTypes::RenderMapUnit. - * @see sizeMapUnitScale() - * @see setSizeUnit() + * \see sizeMapUnitScale() + * \see setSizeUnit() */ void setSizeMapUnitScale( const QgsMapUnitScale &scale ); /** Returns the color that text will be rendered in. - * @see setColor() + * \see setColor() */ QColor color() const; /** Sets the color that text will be rendered in. - * @param color text color - * @see color() + * \param color text color + * \see color() */ void setColor( const QColor &color ); /** Returns the text's opacity. The opacity is a double value between 0 (fully transparent) and 1 (totally * opaque). - * @see setOpacity() + * \see setOpacity() */ double opacity() const; /** Sets the text's opacity. - * @param opacity opacity as a double value between 0 (fully transparent) and 1 (totally + * \param opacity opacity as a double value between 0 (fully transparent) and 1 (totally * opaque) - * @see opacity() + * \see opacity() */ void setOpacity( double opacity ); /** Returns the blending mode used for drawing the text. - * @see setBlendMode() + * \see setBlendMode() */ QPainter::CompositionMode blendMode() const; /** Sets the blending mode used for drawing the text. - * @param mode blending mode - * @see blendMode() + * \param mode blending mode + * \see blendMode() */ void setBlendMode( QPainter::CompositionMode mode ); /** Returns the line height for text. This is a number between * 0.0 and 10.0 representing the leading between lines as a * multiplier of line height. - * @see setLineHeight() + * \see setLineHeight() */ double lineHeight() const; /** Sets the line height for text. - * @param height a number between + * \param height a number between * 0.0 and 10.0 representing the leading between lines as a * multiplier of line height. - * @see lineHeight() + * \see lineHeight() */ void setLineHeight( double height ); /** Reads settings from a layer's custom properties. - * @param layer source vector layer - * @see writeToLayer() + * \param layer source vector layer + * \see writeToLayer() */ void readFromLayer( QgsVectorLayer *layer ); /** Writes settings to a layer's custom properties. - * @param layer target vector layer - * @see readFromLayer() + * \param layer target vector layer + * \see readFromLayer() */ void writeToLayer( QgsVectorLayer *layer ) const; /** Read settings from a DOM element. - * @see writeXml() + * \see writeXml() */ void readXml( const QDomElement &elem ); /** Write settings into a DOM element. - * @see readXml() + * \see readXml() */ QDomElement writeXml( QDomDocument &doc ) const; @@ -1076,14 +1076,14 @@ class CORE_EXPORT QgsTextFormat /** Returns true if the specified font was found on the system, or false * if the font was not found and a replacement was used instead. - * @see resolvedFontFamily() + * \see resolvedFontFamily() */ bool fontFound() const { return mTextFontFound; } /** Returns the family for the resolved font, ie if the specified font * was not found on the system this will return the name of the replacement * font. - * @see fontFound() + * \see fontFound() */ QString resolvedFontFamily() const { return mTextFontFamily; } @@ -1129,22 +1129,22 @@ class CORE_EXPORT QgsTextRenderer }; /** Calculates pixel size (considering output size should be in pixel or map units, scale factors and optionally oversampling) - * @param size size to convert - * @param c rendercontext - * @param unit size units - * @param mapUnitScale a mapUnitScale clamper - * @return font pixel size + * \param size size to convert + * \param c rendercontext + * \param unit size units + * \param mapUnitScale a mapUnitScale clamper + * \returns font pixel size */ static int sizeToPixel( double size, const QgsRenderContext &c, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &mapUnitScale = QgsMapUnitScale() ); /** Draws text within a rectangle using the specified settings. - * @param rect destination rectangle for text - * @param rotation text rotation - * @param alignment horizontal alignment - * @param textLines list of lines of text to draw - * @param context render context - * @param format text format - * @param drawAsOutlines set to false to render text as text. This allows outputs to + * \param rect destination rectangle for text + * \param rotation text rotation + * \param alignment horizontal alignment + * \param textLines list of lines of text to draw + * \param context render context + * \param format text format + * \param drawAsOutlines set to false to render text as text. This allows outputs to * formats like SVG to maintain text as text objects, but at the cost of degraded * rendering and may result in side effects like misaligned text buffers. */ @@ -1153,13 +1153,13 @@ class CORE_EXPORT QgsTextRenderer bool drawAsOutlines = true ); /** Draws text at a point origin using the specified settings. - * @param point origin of text - * @param rotation text rotation - * @param alignment horizontal alignment - * @param textLines list of lines of text to draw - * @param context render context - * @param format text format - * @param drawAsOutlines set to false to render text as text. This allows outputs to + * \param point origin of text + * \param rotation text rotation + * \param alignment horizontal alignment + * \param textLines list of lines of text to draw + * \param context render context + * \param format text format + * \param drawAsOutlines set to false to render text as text. This allows outputs to * formats like SVG to maintain text as text objects, but at the cost of degraded * rendering and may result in side effects like misaligned text buffers. */ @@ -1168,16 +1168,16 @@ class CORE_EXPORT QgsTextRenderer bool drawAsOutlines = true ); /** Draws a single component of rendered text using the specified settings. - * @param rect destination rectangle for text - * @param rotation text rotation - * @param alignment horizontal alignment - * @param textLines list of lines of text to draw - * @param context render context - * @param format text format - * @param part component of text to draw. Note that Shadow parts cannot be drawn + * \param rect destination rectangle for text + * \param rotation text rotation + * \param alignment horizontal alignment + * \param textLines list of lines of text to draw + * \param context render context + * \param format text format + * \param part component of text to draw. Note that Shadow parts cannot be drawn * individually and instead are drawn with their associated part (e.g., drawn together * with the text or background parts) - * @param drawAsOutlines set to false to render text as text. This allows outputs to + * \param drawAsOutlines set to false to render text as text. This allows outputs to * formats like SVG to maintain text as text objects, but at the cost of degraded * rendering and may result in side effects like misaligned text buffers. */ @@ -1186,16 +1186,16 @@ class CORE_EXPORT QgsTextRenderer TextPart part, bool drawAsOutlines = true ); /** Draws a single component of rendered text using the specified settings. - * @param origin origin for start of text. Y coordinate will be used as baseline. - * @param rotation text rotation - * @param alignment horizontal alignment - * @param textLines list of lines of text to draw - * @param context render context - * @param format text format - * @param part component of text to draw. Note that Shadow parts cannot be drawn + * \param origin origin for start of text. Y coordinate will be used as baseline. + * \param rotation text rotation + * \param alignment horizontal alignment + * \param textLines list of lines of text to draw + * \param context render context + * \param format text format + * \param part component of text to draw. Note that Shadow parts cannot be drawn * individually and instead are drawn with their associated part (e.g., drawn together * with the text or background parts) - * @param drawAsOutlines set to false to render text as text. This allows outputs to + * \param drawAsOutlines set to false to render text as text. This allows outputs to * formats like SVG to maintain text as text objects, but at the cost of degraded * rendering and may result in side effects like misaligned text buffers. */ diff --git a/src/core/qgstolerance.h b/src/core/qgstolerance.h index c041e5c7e3fe..7acfc925db4c 100644 --- a/src/core/qgstolerance.h +++ b/src/core/qgstolerance.h @@ -46,7 +46,7 @@ class CORE_EXPORT QgsTolerance /** * Static function to get vertex tolerance value. * The value is read from settings and transformed if necessary. - * @return value of vertex tolerance in map units (not layer units) + * \returns value of vertex tolerance in map units (not layer units) * \since QGIS 2.8 */ static double vertexSearchRadius( const QgsMapSettings &mapSettings ); @@ -54,35 +54,35 @@ class CORE_EXPORT QgsTolerance /** * Static function to get vertex tolerance value for a layer. * The value is read from settings and transformed if necessary. - * @return value of vertex tolerance in layer units + * \returns value of vertex tolerance in layer units */ static double vertexSearchRadius( QgsMapLayer *layer, const QgsMapSettings &mapSettings ); /** * Static function to get default tolerance value for a layer. * The value is read from settings and transformed if necessary. - * @return value of default tolerance in layer units + * \returns value of default tolerance in layer units */ static double defaultTolerance( QgsMapLayer *layer, const QgsMapSettings &mapSettings ); /** * Static function to translate tolerance value into map units - * @param tolerance tolerance value to be translated - * @param layer source layer necessary in case tolerance is in layer units - * @param mapSettings settings of the map - * @param units type of units to be translated - * @return value of tolerance in map units + * \param tolerance tolerance value to be translated + * \param layer source layer necessary in case tolerance is in layer units + * \param mapSettings settings of the map + * \param units type of units to be translated + * \returns value of tolerance in map units * \since QGIS 2.8 */ static double toleranceInProjectUnits( double tolerance, QgsMapLayer *layer, const QgsMapSettings &mapSettings, QgsTolerance::UnitType units ); /** * Static function to translate tolerance value into layer units - * @param tolerance tolerance value to be translated - * @param layer reference layer - * @param mapSettings settings of the map - * @param units type of units to be translated - * @return value of tolerance in layer units + * \param tolerance tolerance value to be translated + * \param layer reference layer + * \param mapSettings settings of the map + * \param units type of units to be translated + * \returns value of tolerance in layer units */ static double toleranceInMapUnits( double tolerance, QgsMapLayer *layer, const QgsMapSettings &mapSettings, UnitType units = LayerUnits ); diff --git a/src/core/qgstracer.h b/src/core/qgstracer.h index c7ebb8427c93..487bafef8575 100644 --- a/src/core/qgstracer.h +++ b/src/core/qgstracer.h @@ -89,7 +89,7 @@ class CORE_EXPORT QgsTracer : public QObject //! Given two points, find the shortest path and return points on the way. //! The optional "error" argument may receive error code (PathError enum) if it is not null - //! @return array of points - trace of linestrings of other features (empty array one error) + //! \returns array of points - trace of linestrings of other features (empty array one error) QVector findShortestPath( const QgsPoint &p1, const QgsPoint &p2, PathError *error = nullptr ); //! Find out whether the point is snapped to a vertex or edge (i.e. it can be used for tracing start/stop) diff --git a/src/core/qgstransactiongroup.h b/src/core/qgstransactiongroup.h index 567a77ffcd0c..15616bb60ac2 100644 --- a/src/core/qgstransactiongroup.h +++ b/src/core/qgstransactiongroup.h @@ -43,7 +43,7 @@ class CORE_EXPORT QgsTransactionGroup : public QObject /** * Get the set of layers currently managed by this transaction group. * - * @return Layer set + * \returns Layer set */ QSet layers() const; diff --git a/src/core/qgsunittypes.h b/src/core/qgsunittypes.h index 7f91af1b76d1..2b95041116c0 100644 --- a/src/core/qgsunittypes.h +++ b/src/core/qgsunittypes.h @@ -151,45 +151,45 @@ class CORE_EXPORT QgsUnitTypes Q_INVOKABLE static DistanceUnitType unitType( DistanceUnit unit ); /** Encodes a distance unit to a string. - * @param unit unit to encode - * @returns encoded string - * @see decodeDistanceUnit() + * \param unit unit to encode + * \returns encoded string + * \see decodeDistanceUnit() */ Q_INVOKABLE static QString encodeUnit( QgsUnitTypes::DistanceUnit unit ); /** Decodes a distance unit from a string. - * @param string string to decode - * @param ok optional boolean, will be set to true if string was converted successfully - * @returns decoded units - * @see encodeUnit() + * \param string string to decode + * \param ok optional boolean, will be set to true if string was converted successfully + * \returns decoded units + * \see encodeUnit() */ Q_INVOKABLE static QgsUnitTypes::DistanceUnit decodeDistanceUnit( const QString &string, bool *ok = 0 ); /** Returns a translated string representing a distance unit. - * @param unit unit to convert to string - * @see stringToDistanceUnit() + * \param unit unit to convert to string + * \see stringToDistanceUnit() */ Q_INVOKABLE static QString toString( QgsUnitTypes::DistanceUnit unit ); /** Returns a translated abbreviation representing a distance unit. - * @param unit unit to convert to string - * @see stringToDistanceUnit() + * \param unit unit to convert to string + * \see stringToDistanceUnit() * * \since QGIS 3.0 */ Q_INVOKABLE static QString toAbbreviatedString( QgsUnitTypes::DistanceUnit unit ); /** Converts a translated string to a distance unit. - * @param string string representing a distance unit - * @param ok optional boolean, will be set to true if string was converted successfully - * @see toString() + * \param string string representing a distance unit + * \param ok optional boolean, will be set to true if string was converted successfully + * \see toString() */ Q_INVOKABLE static QgsUnitTypes::DistanceUnit stringToDistanceUnit( const QString &string, bool *ok = 0 ); /** Returns the conversion factor between the specified distance units. - * @param fromUnit distance unit to convert from - * @param toUnit distance unit to convert to - * @returns multiplication factor to convert between units + * \param fromUnit distance unit to convert from + * \param toUnit distance unit to convert to + * \returns multiplication factor to convert between units */ Q_INVOKABLE static double fromUnitToUnitFactor( QgsUnitTypes::DistanceUnit fromUnit, QgsUnitTypes::DistanceUnit toUnit ); @@ -200,88 +200,88 @@ class CORE_EXPORT QgsUnitTypes Q_INVOKABLE static DistanceUnitType unitType( AreaUnit unit ); /** Encodes an areal unit to a string. - * @param unit unit to encode - * @returns encoded string - * @see decodeAreaUnit() + * \param unit unit to encode + * \returns encoded string + * \see decodeAreaUnit() */ Q_INVOKABLE static QString encodeUnit( AreaUnit unit ); /** Decodes an areal unit from a string. - * @param string string to decode - * @param ok optional boolean, will be set to true if string was converted successfully - * @returns decoded units - * @see encodeUnit() + * \param string string to decode + * \param ok optional boolean, will be set to true if string was converted successfully + * \returns decoded units + * \see encodeUnit() */ Q_INVOKABLE static AreaUnit decodeAreaUnit( const QString &string, bool *ok = 0 ); /** Returns a translated string representing an areal unit. - * @param unit unit to convert to string - * @see stringToAreaUnit() + * \param unit unit to convert to string + * \see stringToAreaUnit() */ Q_INVOKABLE static QString toString( AreaUnit unit ); /** Returns a translated abbreviation representing an areal unit. - * @param unit unit to convert to string - * @see stringToAreaUnit() + * \param unit unit to convert to string + * \see stringToAreaUnit() * * \since QGIS 3.0 */ Q_INVOKABLE static QString toAbbreviatedString( AreaUnit unit ); /** Converts a translated string to an areal unit. - * @param string string representing an areal unit - * @param ok optional boolean, will be set to true if string was converted successfully - * @see toString() + * \param string string representing an areal unit + * \param ok optional boolean, will be set to true if string was converted successfully + * \see toString() */ Q_INVOKABLE static AreaUnit stringToAreaUnit( const QString &string, bool *ok = 0 ); /** Returns the conversion factor between the specified areal units. - * @param fromUnit area unit to convert from - * @param toUnit area unit to convert to - * @returns multiplication factor to convert between units + * \param fromUnit area unit to convert from + * \param toUnit area unit to convert to + * \returns multiplication factor to convert between units */ Q_INVOKABLE static double fromUnitToUnitFactor( AreaUnit fromUnit, AreaUnit toUnit ); /** Converts a distance unit to its corresponding area unit, e.g., meters to square meters - * @param distanceUnit distance unit to convert - * @return matching areal unit + * \param distanceUnit distance unit to convert + * \returns matching areal unit */ Q_INVOKABLE static AreaUnit distanceToAreaUnit( QgsUnitTypes::DistanceUnit distanceUnit ); // ANGULAR UNITS /** Encodes an angular unit to a string. - * @param unit unit to encode - * @returns encoded string - * @see decodeAngleUnit() + * \param unit unit to encode + * \returns encoded string + * \see decodeAngleUnit() */ Q_INVOKABLE static QString encodeUnit( AngleUnit unit ); /** Decodes an angular unit from a string. - * @param string string to decode - * @param ok optional boolean, will be set to true if string was converted successfully - * @returns decoded units - * @see encodeUnit() + * \param string string to decode + * \param ok optional boolean, will be set to true if string was converted successfully + * \returns decoded units + * \see encodeUnit() */ Q_INVOKABLE static AngleUnit decodeAngleUnit( const QString &string, bool *ok = 0 ); /** Returns a translated string representing an angular unit. - * @param unit unit to convert to string + * \param unit unit to convert to string */ Q_INVOKABLE static QString toString( AngleUnit unit ); /** Returns the conversion factor between the specified angular units. - * @param fromUnit angle unit to convert from - * @param toUnit angle unit to convert to - * @returns multiplication factor to convert between units + * \param fromUnit angle unit to convert from + * \param toUnit angle unit to convert to + * \returns multiplication factor to convert between units */ Q_INVOKABLE static double fromUnitToUnitFactor( AngleUnit fromUnit, AngleUnit toUnit ); /** Returns an angle formatted as a friendly string. - * @param angle angle to format - * @param decimals number of decimal places to show - * @param unit unit of angle - * @returns formatted angle string + * \param angle angle to format + * \param decimals number of decimal places to show + * \param unit unit of angle + * \returns formatted angle string */ Q_INVOKABLE static QString formatAngle( double angle, int decimals, AngleUnit unit ); @@ -309,43 +309,43 @@ class CORE_EXPORT QgsUnitTypes Q_INVOKABLE static AreaValue scaledArea( double area, QgsUnitTypes::AreaUnit unit, int decimals, bool keepBaseUnit = false ); /** Returns an distance formatted as a friendly string. - * @param distance distance to format - * @param decimals number of decimal places to show - * @param unit unit of distance - * @param keepBaseUnit set to false to allow conversion of large distances to more suitable units, e.g., meters to + * \param distance distance to format + * \param decimals number of decimal places to show + * \param unit unit of distance + * \param keepBaseUnit set to false to allow conversion of large distances to more suitable units, e.g., meters to * kilometers - * @returns formatted distance string + * \returns formatted distance string * \since QGIS 3.0 - * @see formatArea() + * \see formatArea() */ Q_INVOKABLE static QString formatDistance( double distance, int decimals, QgsUnitTypes::DistanceUnit unit, bool keepBaseUnit = false ); /** Returns an area formatted as a friendly string. - * @param area area to format - * @param decimals number of decimal places to show - * @param unit unit of area - * @param keepBaseUnit set to false to allow conversion of large areas to more suitable units, e.g., square meters to + * \param area area to format + * \param decimals number of decimal places to show + * \param unit unit of area + * \param keepBaseUnit set to false to allow conversion of large areas to more suitable units, e.g., square meters to * square kilometers - * @returns formatted area string + * \returns formatted area string * \since QGIS 3.0 - * @see formatDistance() + * \see formatDistance() */ Q_INVOKABLE static QString formatArea( double area, int decimals, QgsUnitTypes::AreaUnit unit, bool keepBaseUnit = false ); // RENDER UNITS /** Encodes a render unit to a string. - * @param unit unit to encode - * @returns encoded string - * @see decodeRenderUnit() + * \param unit unit to encode + * \returns encoded string + * \see decodeRenderUnit() */ Q_INVOKABLE static QString encodeUnit( RenderUnit unit ); /** Decodes a render unit from a string. - * @param string string to decode - * @param ok optional boolean, will be set to true if string was converted successfully - * @returns decoded units - * @see encodeUnit() + * \param string string to decode + * \param ok optional boolean, will be set to true if string was converted successfully + * \returns decoded units + * \see encodeUnit() */ Q_INVOKABLE static RenderUnit decodeRenderUnit( const QString &string, bool *ok = 0 ); diff --git a/src/core/qgsvector.h b/src/core/qgsvector.h index 88da30155aaf..56795a8035da 100644 --- a/src/core/qgsvector.h +++ b/src/core/qgsvector.h @@ -33,8 +33,8 @@ class CORE_EXPORT QgsVector QgsVector(); /** Constructor for QgsVector taking x and y component values. - * @param x x-component - * @param y y-component + * \param x x-component + * \param y y-component */ QgsVector( double x, double y ); @@ -42,12 +42,12 @@ class CORE_EXPORT QgsVector QgsVector operator-() const; /** Returns a vector where the components have been multiplied by a scalar value. - * @param scalar factor to multiply by + * \param scalar factor to multiply by */ QgsVector operator*( double scalar ) const; /** Returns a vector where the components have been divided by a scalar value. - * @param scalar factor to divide by + * \param scalar factor to divide by */ QgsVector operator/( double scalar ) const; @@ -86,12 +86,12 @@ class CORE_EXPORT QgsVector double length() const; /** Returns the vector's x-component. - * @see y() + * \see y() */ double x() const; /** Returns the vector's y-component. - * @see x() + * \see x() */ double y() const; @@ -108,7 +108,7 @@ class CORE_EXPORT QgsVector double angle( QgsVector v ) const; /** Rotates the vector by a specified angle. - * @param rot angle in radians + * \param rot angle in radians */ QgsVector rotateBy( double rot ) const; diff --git a/src/core/qgsvectordataprovider.h b/src/core/qgsvectordataprovider.h index aab8dfda1db8..492c9be12e44 100644 --- a/src/core/qgsvectordataprovider.h +++ b/src/core/qgsvectordataprovider.h @@ -114,7 +114,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider /** * Constructor of the vector provider - * @param uri uniform resource locator (URI) for a dataset + * \param uri uniform resource locator (URI) for a dataset */ QgsVectorDataProvider( const QString &uri = QString() ); @@ -132,7 +132,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider * same time, some synchronization mechanisms must be used (e.g. mutexes) to prevent data corruption. * * \since QGIS 2.4 - * @return new instance of QgsAbstractFeatureSource (caller is responsible for deleting it) + * \returns new instance of QgsAbstractFeatureSource (caller is responsible for deleting it) */ virtual QgsAbstractFeatureSource *featureSource() const = 0; @@ -143,8 +143,8 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider /** * Query the provider for features specified in request. - * @param request feature request describing parameters of features to return - * @returns iterator for matching features from provider + * \param request feature request describing parameters of features to return + * \returns iterator for matching features from provider */ virtual QgsFeatureIterator getFeatures( const QgsFeatureRequest &request = QgsFeatureRequest() ) const = 0; @@ -155,7 +155,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider /** * Number of features in the layer - * @return long containing number of features + * \returns long containing number of features */ virtual long featureCount() const = 0; @@ -172,7 +172,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider /** * Returns the minimum value of an attribute - * @param index the index of the attribute + * \param index the index of the attribute * * Default implementation walks all numeric attributes and caches minimal * and maximal values. If provider has facilities to retrieve minimal @@ -182,7 +182,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider /** * Returns the maximum value of an attribute - * @param index the index of the attribute + * \param index the index of the attribute * * Default implementation walks all numeric attributes and caches minimal * and maximal values. If provider has facilities to retrieve maximal @@ -192,9 +192,9 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider /** * Return unique values of an attribute - * @param index the index of the attribute - * @param uniqueValues values reference to the list to fill - * @param limit maxmum number of the values to return + * \param index the index of the attribute + * \param uniqueValues values reference to the list to fill + * \param limit maxmum number of the values to return * * Default implementation simply iterates the features */ @@ -203,23 +203,23 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider /** * Returns unique string values of an attribute which contain a specified subset string. Subset * matching is done in a case-insensitive manner. - * @param index the index of the attribute - * @param substring substring to match (case insensitive) - * @param limit maxmum number of the values to return, or -1 to return all unique values - * @param feedback optional feedback object for canceling request - * @returns list of unique strings containing substring + * \param index the index of the attribute + * \param substring substring to match (case insensitive) + * \param limit maxmum number of the values to return, or -1 to return all unique values + * \param feedback optional feedback object for canceling request + * \returns list of unique strings containing substring */ virtual QStringList uniqueStringsMatching( int index, const QString &substring, int limit = -1, QgsFeedback *feedback = nullptr ) const; /** Calculates an aggregated value from the layer's features. The base implementation does nothing, * but subclasses can override this method to handoff calculation of aggregates to the provider. - * @param aggregate aggregate to calculate - * @param index the index of the attribute to calculate aggregate over - * @param parameters parameters controlling aggregate calculation - * @param context expression context for filter - * @param ok will be set to true if calculation was successfully performed by the data provider - * @return calculated aggregate value + * \param aggregate aggregate to calculate + * \param index the index of the attribute to calculate aggregate over + * \param parameters parameters controlling aggregate calculation + * \param context expression context for filter + * \param ok will be set to true if calculation was successfully performed by the data provider + * \returns calculated aggregate value * \since QGIS 2.16 */ virtual QVariant aggregate( QgsAggregateCalculator::Aggregate aggregate, @@ -231,31 +231,31 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider /** * Returns the possible enum values of an attribute. Returns an empty stringlist if a provider does not support enum types * or if the given attribute is not an enum type. - * @param index the index of the attribute - * @param enumList reference to the list to fill + * \param index the index of the attribute + * \param enumList reference to the list to fill */ virtual void enumValues( int index, QStringList &enumList ) const { Q_UNUSED( index ); enumList.clear(); } /** * Adds a list of features - * @return true in case of success and false in case of failure + * \returns true in case of success and false in case of failure */ virtual bool addFeatures( QgsFeatureList &flist ); /** * Deletes one or more features from the provider. This requires the DeleteFeatures capability. - * @param id list containing feature ids to delete - * @return true in case of success and false in case of failure - * @see truncate() + * \param id list containing feature ids to delete + * \returns true in case of success and false in case of failure + * \see truncate() */ virtual bool deleteFeatures( const QgsFeatureIds &id ); /** * Removes all features from the layer. This requires either the FastTruncate or DeleteFeatures capability. * Providers with the FastTruncate capability will use an optimised method to truncate the layer. - * @returns true in case of success and false in case of failure. + * \returns true in case of success and false in case of failure. * \since QGIS 3.0 - * @see deleteFeatures() + * \see deleteFeatures() */ virtual bool truncate(); @@ -270,8 +270,8 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider * Deletes existing \a attributes from the provider. * If attributes are deleted using this method then QgsVectorLayer::updateFields() must be called * manually to ensure that the layer's field are correctly reported. - * @param attributes a set containing indices of attributes - * @return true in case of success and false in case of failure + * \param attributes a set containing indices of attributes + * \returns true in case of success and false in case of failure */ virtual bool deleteAttributes( const QgsAttributeIds &attributes ); @@ -279,8 +279,8 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider * Renames existing attributes. * If attributes are renamed using this method then QgsVectorLayer::updateFields() must be called * manually to ensure that the layer's field are correctly reported. - * @param renamedAttributes map of attribute index to new attribute name - * @return true in case of success and false in case of failure + * \param renamedAttributes map of attribute index to new attribute name + * \returns true in case of success and false in case of failure * \since QGIS 2.16 */ virtual bool renameAttributes( const QgsFieldNameMap &renamedAttributes ); @@ -288,8 +288,8 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider /** * Changes attribute values of existing features. This should * succeed if the provider reports the ChangeAttributeValues capability. - * @param attr_map a map containing changed attributes - * @return true in case of success and false in case of failure + * \param attr_map a map containing changed attributes + * \returns true in case of success and false in case of failure */ virtual bool changeAttributeValues( const QgsChangedAttributesMap &attr_map ); @@ -298,11 +298,11 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider * succeed if the provider reports both the ChangeAttributeValues and * ChangeGeometries capabilities. Providers which report the ChangeFeatures * capability implement an optimised version of this method. - * @param attr_map a map containing changed attributes - * @param geometry_map A QgsGeometryMap whose index contains the feature IDs + * \param attr_map a map containing changed attributes + * \param geometry_map A QgsGeometryMap whose index contains the feature IDs * that will have their geometries changed. * The second map parameter being the new geometries themselves - * @return true in case of success and false in case of failure + * \returns true in case of success and false in case of failure */ virtual bool changeFeatures( const QgsChangedAttributesMap &attr_map, const QgsGeometryMap &geometry_map ); @@ -316,7 +316,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider * is calculated as a result of a sequence). It is recommended that you instead use the methods * in QgsVectorLayerUtils such as QgsVectorLayerUtils::createFeature() * so that default value handling and validation is automatically carried out. - * @see defaultValueClause() + * \see defaultValueClause() */ virtual QVariant defaultValue( int fieldIndex ) const; @@ -324,7 +324,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider * Returns any default value clauses which are present at the provider for a specified * field index. These clauses are usually SQL fragments which must be evaluated by the * provider, e.g., sequence values. - * @see defaultValue() + * \see defaultValue() * \since QGIS 3.0 */ virtual QString defaultValueClause( int fieldIndex ) const; @@ -333,7 +333,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider * Returns any constraints which are present at the provider for a specified * field index. * \since QGIS 3.0 - * @see skipConstraintCheck() + * \see skipConstraintCheck() */ QgsFieldConstraints::Constraints fieldConstraints( int fieldIndex ) const; @@ -342,22 +342,22 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider * the value returned by defaultValue() is trusted implicitly. An optional attribute value can be * passed which can help refine the skip constraint check. * \since QGIS 3.0 - * @see fieldConstraints() + * \see fieldConstraints() */ virtual bool skipConstraintCheck( int fieldIndex, QgsFieldConstraints::Constraint constraint, const QVariant &value = QVariant() ) const; /** * Changes geometries of existing features - * @param geometry_map A QgsGeometryMap whose index contains the feature IDs + * \param geometry_map A QgsGeometryMap whose index contains the feature IDs * that will have their geometries changed. * The second map parameter being the new geometries themselves - * @return True in case of success and false in case of failure + * \returns True in case of success and false in case of failure */ virtual bool changeGeometryValues( const QgsGeometryMap &geometry_map ); /** * Creates a spatial index on the datasource (if supported by the provider type). - * @return true in case of success + * \returns true in case of success */ virtual bool createSpatialIndex(); @@ -365,7 +365,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider virtual bool createAttributeIndex( int field ); /** Returns flags containing the supported capabilities - @note, some capabilities may change depending on whether + \note, some capabilities may change depending on whether a spatial filter is active on this provider, so it may be prudent to check this value per intended operation. */ @@ -503,31 +503,31 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider /** * Discover the available relations with the given layers. - * @param self the layer using this data provider. - * @param layers the other layers. - * @return the list of N-1 relations from this provider. + * \param self the layer using this data provider. + * \param layers the other layers. + * \returns the list of N-1 relations from this provider. * \since QGIS 3.0 */ virtual QList discoverRelations( const QgsVectorLayer *self, const QList &layers ) const; /** * Get metadata, dependent on the provider type, that will be display in the metadata tab of the layer properties. - * @return The provider metadata + * \returns The provider metadata */ virtual QVariantMap metadata() const { return QVariantMap(); }; /** * Get the translated metadata key. - * @param mdKey The metadata key - * @return The translated metadata value + * \param mdKey The metadata key + * \returns The translated metadata value */ virtual QString translateMetadataKey( const QString &mdKey ) const { return mdKey; }; /** * Get the translated metadata value. - * @param mdKey The metadata key - * @param value The metadata value - * @return The translated metadata value + * \param mdKey The metadata key + * \param value The metadata value + * \returns The translated metadata value */ virtual QString translateMetadataValue( const QString &mdKey, const QVariant &value ) const { Q_UNUSED( mdKey ); return value.toString(); }; @@ -566,7 +566,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider /** * Converts the geometry to the provider type if possible / necessary - * @return the converted geometry or nullptr if no conversion was necessary or possible + * \returns the converted geometry or nullptr if no conversion was necessary or possible */ QgsGeometry *convertToProviderType( const QgsGeometry &geom ) const; diff --git a/src/core/qgsvectorfilewriter.h b/src/core/qgsvectorfilewriter.h index 993f91414e89..31a467651656 100644 --- a/src/core/qgsvectorfilewriter.h +++ b/src/core/qgsvectorfilewriter.h @@ -190,15 +190,15 @@ class CORE_EXPORT QgsVectorFileWriter virtual ~FieldValueConverter() = default; /** Return a possibly modified field definition. Default implementation will return provided field unmodified. - * @param field original field definition - * @return possibly modified field definition + * \param field original field definition + * \returns possibly modified field definition */ virtual QgsField fieldDefinition( const QgsField &field ); /** Convert the provided value, for field fieldIdxInLayer. Default implementation will return provided value unmodified. - * @param fieldIdxInLayer field index - * @param value original raw value - * @return possibly modified value. + * \param fieldIdxInLayer field index + * \param value original raw value + * \returns possibly modified value. */ virtual QVariant convert( int fieldIdxInLayer, const QVariant &value ); }; @@ -243,26 +243,26 @@ class CORE_EXPORT QgsVectorFileWriter } ActionOnExistingFile; /** Write contents of vector layer to an (OGR supported) vector formt - * @param layer layer to write - * @param fileName file name to write to - * @param fileEncoding encoding to use - * @param destCRS CRS to reproject exported geometries to, or invalid CRS for no reprojection - * @param driverName OGR driver to use - * @param onlySelected write only selected features of layer - * @param errorMessage pointer to buffer fo error message - * @param datasourceOptions list of OGR data source creation options - * @param layerOptions list of OGR layer creation options - * @param skipAttributeCreation only write geometries - * @param newFilename QString pointer which will contain the new file name created (in case it is different to fileName). - * @param symbologyExport symbology to export - * @param symbologyScale scale of symbology - * @param filterExtent if not a null pointer, only features intersecting the extent will be saved (added in QGIS 2.4) - * @param overrideGeometryType set to a valid geometry type to override the default geometry type for the layer. This parameter + * \param layer layer to write + * \param fileName file name to write to + * \param fileEncoding encoding to use + * \param destCRS CRS to reproject exported geometries to, or invalid CRS for no reprojection + * \param driverName OGR driver to use + * \param onlySelected write only selected features of layer + * \param errorMessage pointer to buffer fo error message + * \param datasourceOptions list of OGR data source creation options + * \param layerOptions list of OGR layer creation options + * \param skipAttributeCreation only write geometries + * \param newFilename QString pointer which will contain the new file name created (in case it is different to fileName). + * \param symbologyExport symbology to export + * \param symbologyScale scale of symbology + * \param filterExtent if not a null pointer, only features intersecting the extent will be saved (added in QGIS 2.4) + * \param overrideGeometryType set to a valid geometry type to override the default geometry type for the layer. This parameter * allows for conversion of geometryless tables to null geometries, etc (added in QGIS 2.14) - * @param forceMulti set to true to force creation of multi* geometries (added in QGIS 2.14) - * @param includeZ set to true to include z dimension in output. This option is only valid if overrideGeometryType is set. (added in QGIS 2.14) - * @param attributes attributes to export (empty means all unless skipAttributeCreation is set) - * @param fieldValueConverter field value converter (added in QGIS 2.16) + * \param forceMulti set to true to force creation of multi* geometries (added in QGIS 2.14) + * \param includeZ set to true to include z dimension in output. This option is only valid if overrideGeometryType is set. (added in QGIS 2.14) + * \param attributes attributes to export (empty means all unless skipAttributeCreation is set) + * \param fieldValueConverter field value converter (added in QGIS 2.16) */ static WriterError writeAsVectorFormat( QgsVectorLayer *layer, const QString &fileName, @@ -286,27 +286,27 @@ class CORE_EXPORT QgsVectorFileWriter ); /** Writes a layer out to a vector file. - * @param layer layer to write - * @param fileName file name to write to - * @param fileEncoding encoding to use - * @param ct coordinate transform to reproject exported geometries with, or invalid transform + * \param layer layer to write + * \param fileName file name to write to + * \param fileEncoding encoding to use + * \param ct coordinate transform to reproject exported geometries with, or invalid transform * for no transformation - * @param driverName OGR driver to use - * @param onlySelected write only selected features of layer - * @param errorMessage pointer to buffer fo error message - * @param datasourceOptions list of OGR data source creation options - * @param layerOptions list of OGR layer creation options - * @param skipAttributeCreation only write geometries - * @param newFilename QString pointer which will contain the new file name created (in case it is different to fileName). - * @param symbologyExport symbology to export - * @param symbologyScale scale of symbology - * @param filterExtent if not a null pointer, only features intersecting the extent will be saved (added in QGIS 2.4) - * @param overrideGeometryType set to a valid geometry type to override the default geometry type for the layer. This parameter + * \param driverName OGR driver to use + * \param onlySelected write only selected features of layer + * \param errorMessage pointer to buffer fo error message + * \param datasourceOptions list of OGR data source creation options + * \param layerOptions list of OGR layer creation options + * \param skipAttributeCreation only write geometries + * \param newFilename QString pointer which will contain the new file name created (in case it is different to fileName). + * \param symbologyExport symbology to export + * \param symbologyScale scale of symbology + * \param filterExtent if not a null pointer, only features intersecting the extent will be saved (added in QGIS 2.4) + * \param overrideGeometryType set to a valid geometry type to override the default geometry type for the layer. This parameter * allows for conversion of geometryless tables to null geometries, etc (added in QGIS 2.14) - * @param forceMulti set to true to force creation of multi* geometries (added in QGIS 2.14) - * @param includeZ set to true to include z dimension in output. This option is only valid if overrideGeometryType is set. (added in QGIS 2.14) - * @param attributes attributes to export (empty means all unless skipAttributeCreation is set) - * @param fieldValueConverter field value converter (added in QGIS 2.16) + * \param forceMulti set to true to force creation of multi* geometries (added in QGIS 2.14) + * \param includeZ set to true to include z dimension in output. This option is only valid if overrideGeometryType is set. (added in QGIS 2.14) + * \param attributes attributes to export (empty means all unless skipAttributeCreation is set) + * \param fieldValueConverter field value converter (added in QGIS 2.16) * \since QGIS 2.2 */ static WriterError writeAsVectorFormat( QgsVectorLayer *layer, @@ -401,11 +401,11 @@ class CORE_EXPORT QgsVectorFileWriter }; /** Writes a layer out to a vector file. - * @param layer source layer to write - * @param fileName file name to write to - * @param options options. - * @param newFilename QString pointer which will contain the new file name created (in case it is different to fileName). - * @param errorMessage pointer to buffer fo error message + * \param layer source layer to write + * \param fileName file name to write to + * \param options options. + * \param newFilename QString pointer which will contain the new file name created (in case it is different to fileName). + * \param errorMessage pointer to buffer fo error message * \since QGIS 3.0 */ static WriterError writeAsVectorFormat( QgsVectorLayer *layer, @@ -459,15 +459,15 @@ class CORE_EXPORT QgsVectorFileWriter //! Add feature to the currently opened data source bool addFeature( QgsFeature &feature, QgsFeatureRenderer *renderer = nullptr, QgsUnitTypes::DistanceUnit outputUnit = QgsUnitTypes::DistanceMeters ); - //! @note not available in Python bindings + //! \note not available in Python bindings QMap attrIdxToOgrIdx() { return mAttrIdxToOgrIdx; } //! Close opened shapefile for writing ~QgsVectorFileWriter(); /** Delete a shapefile (and its accompanying shx / dbf / prf) - * @param fileName /path/to/file.shp - * @return bool true if the file was deleted successfully + * \param fileName /path/to/file.shp + * \returns bool true if the file was deleted successfully */ static bool deleteShapeFile( const QString &fileName ); @@ -480,16 +480,16 @@ class CORE_EXPORT QgsVectorFileWriter static bool driverMetadata( const QString &driverName, MetaData &driverMetadata ); /** Returns a list of the default dataset options for a specified driver. - * @param driverName name of OGR driver + * \param driverName name of OGR driver * \since QGIS 3.0 - * @see defaultLayerOptions() + * \see defaultLayerOptions() */ static QStringList defaultDatasetOptions( const QString &driverName ); /** Returns a list of the default layer options for a specified driver. - * @param driverName name of OGR driver + * \param driverName name of OGR driver * \since QGIS 3.0 - * @see defaultDatasetOptions() + * \see defaultDatasetOptions() */ static QStringList defaultLayerOptions( const QString &driverName ); @@ -497,7 +497,7 @@ class CORE_EXPORT QgsVectorFileWriter * Get the ogr geometry type from an internal QGIS wkb type enum. * * Will drop M values and convert Z to 2.5D where required. - * @note not available in Python bindings + * \note not available in Python bindings */ static OGRwkbGeometryType ogrTypeFromWkbType( QgsWkbTypes::Type type ); @@ -524,7 +524,7 @@ class CORE_EXPORT QgsVectorFileWriter const QgsAttributeList &attributes ); protected: - //! @note not available in Python bindings + //! \note not available in Python bindings OGRGeometryH createEmptyGeometry( QgsWkbTypes::Type wkbType ); OGRDataSourceH mDS; @@ -560,19 +560,19 @@ class CORE_EXPORT QgsVectorFileWriter private: /** Create a new vector file writer. - * @param vectorFileName file name to write to - * @param fileEncoding encoding to use - * @param fields fields to write - * @param geometryType geometry type of output file - * @param srs spatial reference system of output file - * @param driverName OGR driver to use - * @param datasourceOptions list of OGR data source creation options - * @param layerOptions list of OGR layer creation options - * @param newFilename potentially modified file name (output parameter) - * @param symbologyExport symbology to export - * @param fieldValueConverter field value converter (added in QGIS 2.16) - * @param layerName layer name. If let empty, it will be derived from the filename (added in QGIS 3.0) - * @param action action on existing file (added in QGIS 3.0) + * \param vectorFileName file name to write to + * \param fileEncoding encoding to use + * \param fields fields to write + * \param geometryType geometry type of output file + * \param srs spatial reference system of output file + * \param driverName OGR driver to use + * \param datasourceOptions list of OGR data source creation options + * \param layerOptions list of OGR layer creation options + * \param newFilename potentially modified file name (output parameter) + * \param symbologyExport symbology to export + * \param fieldValueConverter field value converter (added in QGIS 2.16) + * \param layerName layer name. If let empty, it will be derived from the filename (added in QGIS 3.0) + * \param action action on existing file (added in QGIS 3.0) */ QgsVectorFileWriter( const QString &vectorFileName, const QString &fileEncoding, diff --git a/src/core/qgsvectorlayer.cpp b/src/core/qgsvectorlayer.cpp index 132d1721fe91..bdb6c6643d3e 100644 --- a/src/core/qgsvectorlayer.cpp +++ b/src/core/qgsvectorlayer.cpp @@ -3665,8 +3665,6 @@ QList QgsVectorLayer::getDoubleValues( const QString &fieldOrExpression, return values; } - -//! Write blend mode for features void QgsVectorLayer::setFeatureBlendMode( QPainter::CompositionMode featureBlendMode ) { mFeatureBlendMode = featureBlendMode; @@ -3674,13 +3672,11 @@ void QgsVectorLayer::setFeatureBlendMode( QPainter::CompositionMode featureBlend emit styleChanged(); } -//! Read blend mode for layer QPainter::CompositionMode QgsVectorLayer::featureBlendMode() const { return mFeatureBlendMode; } -//! Write transparency for layer void QgsVectorLayer::setLayerTransparency( int layerTransparency ) { mLayerTransparency = layerTransparency; @@ -3688,7 +3684,6 @@ void QgsVectorLayer::setLayerTransparency( int layerTransparency ) emit styleChanged(); } -//! Read transparency for layer int QgsVectorLayer::layerTransparency() const { return mLayerTransparency; diff --git a/src/core/qgsvectorlayer.h b/src/core/qgsvectorlayer.h index fbf5bba37ddc..687492550027 100644 --- a/src/core/qgsvectorlayer.h +++ b/src/core/qgsvectorlayer.h @@ -347,7 +347,7 @@ typedef QList QgsPointSequence; * Provider to display vector data in a GRASS GIS layer. * * TODO QGIS3: Remove virtual from non-inherited methods (like isModified) - * @see QgsVectorLayerUtils() + * \see QgsVectorLayerUtils() */ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionContextGenerator { @@ -385,11 +385,11 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * interprets the supplied path (url) of the data source to connect to and access the * data. * - * @param path The path or url of the parameter. Typically this encodes + * \param path The path or url of the parameter. Typically this encodes * parameters used by the data provider as url query items. - * @param baseName The name used to represent the layer in the legend - * @param providerLib The name of the data provider, e.g., "memory", "postgres" - * @param loadDefaultStyleFlag whether to load the default style + * \param baseName The name used to represent the layer in the legend + * \param providerLib The name of the data provider, e.g., "memory", "postgres" + * \param loadDefaultStyleFlag whether to load the default style * */ QgsVectorLayer( const QString &path = QString::null, const QString &baseName = QString::null, @@ -417,23 +417,23 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * If the displayExpression is more complex than a simple field, a null string will * be returned. * - * @see displayExpression + * \see displayExpression */ QString displayField() const; /** Set the preview expression, used to create a human readable preview string. - * Used e.g. in the attribute table feature list. Uses { @link QgsExpression }. + * Used e.g. in the attribute table feature list. Uses QgsExpression. * - * @param displayExpression The expression which will be used to preview features + * \param displayExpression The expression which will be used to preview features * for this layer */ void setDisplayExpression( const QString &displayExpression ); /** * Get the preview expression, used to create a human readable preview string. - * Uses { @link QgsExpression } + * Uses QgsExpression * - * @return The expression which will be used to preview features for this layer + * \returns The expression which will be used to preview features for this layer */ QString displayExpression() const; @@ -441,7 +441,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte QgsVectorDataProvider *dataProvider(); /** Returns the data provider in a const-correct manner - * @note not available in Python bindings + * \note not available in Python bindings */ const QgsVectorDataProvider *dataProvider() const SIP_SKIP; @@ -452,12 +452,12 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte void setCoordinateSystem(); /** Joins another vector layer to this layer - @param joinInfo join object containing join layer id, target and source field - @note since 2.6 returns bool indicating whether the join can be added */ + \param joinInfo join object containing join layer id, target and source field + \note since 2.6 returns bool indicating whether the join can be added */ bool addJoin( const QgsVectorLayerJoinInfo &joinInfo ); /** Removes a vector layer join - @returns true if join was found and successfully removed */ + \returns true if join was found and successfully removed */ bool removeJoin( const QString &joinLayerId ); /** @@ -469,19 +469,19 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Sets the list of dependencies. - * @see dependencies() + * \see dependencies() * - * @param layers set of QgsMapLayerDependency. Only user-defined dependencies will be added - * @returns false if a dependency cycle has been detected + * \param layers set of QgsMapLayerDependency. Only user-defined dependencies will be added + * \returns false if a dependency cycle has been detected * \since QGIS 3.0 */ virtual bool setDependencies( const QSet &layers ) override; /** - * Gets the list of dependencies. This includes data dependencies set by the user (@see setDataDependencies) + * Gets the list of dependencies. This includes data dependencies set by the user (\see setDataDependencies) * as well as dependencies given by the provider * - * @returns a set of QgsMapLayerDependency + * \returns a set of QgsMapLayerDependency * \since QGIS 3.0 */ virtual QSet dependencies() const override; @@ -489,10 +489,10 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Add a new field which is calculated by the expression specified * - * @param exp The expression which calculates the field - * @param fld The field to calculate + * \param exp The expression which calculates the field + * \param fld The field to calculate * - * @return The index of the new field + * \returns The index of the new field * * \since QGIS 2.9 */ @@ -501,7 +501,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Remove an expression field * - * @param index The index of the field + * \param index The index of the field * * \since QGIS 2.6 */ @@ -510,9 +510,9 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Returns the expression used for a given expression field * - * @param index An index of an epxression based (virtual) field + * \param index An index of an epxression based (virtual) field * - * @return The expression for the field at index + * \returns The expression for the field at index * * \since QGIS 2.9 */ @@ -521,9 +521,9 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Changes the expression used to define an expression based (virtual) field * - * @param index The index of the expression to change + * \param index The index of the expression to change * - * @param exp The new expression to set + * \param exp The new expression to set * * \since QGIS 2.9 */ @@ -540,53 +540,53 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * The number of features that are selected in this layer * - * @return See description + * \returns See description */ int selectedFeatureCount() const; /** * Select features found within the search rectangle (in layer's coordinates) - * @param rect search rectangle - * @param behavior selection type, allows adding to current selection, removing + * \param rect search rectangle + * \param behavior selection type, allows adding to current selection, removing * from selection, etc. - * @see invertSelectionInRectangle(QgsRectangle & rect) - * @see selectByExpression() - * @see selectByIds() + * \see invertSelectionInRectangle(QgsRectangle & rect) + * \see selectByExpression() + * \see selectByIds() */ void selectByRect( QgsRectangle &rect, SelectBehavior behavior = SetSelection ); /** Select matching features using an expression. - * @param expression expression to evaluate to select features - * @param behavior selection type, allows adding to current selection, removing + * \param expression expression to evaluate to select features + * \param behavior selection type, allows adding to current selection, removing * from selection, etc. * \since QGIS 2.16 - * @see selectByRect() - * @see selectByIds() + * \see selectByRect() + * \see selectByIds() */ void selectByExpression( const QString &expression, SelectBehavior behavior = SetSelection ); /** Select matching features using a list of feature IDs. Will emit the * selectionChanged() signal with the clearAndSelect flag set. - * @param ids feature IDs to select - * @param behavior selection type, allows adding to current selection, removing + * \param ids feature IDs to select + * \param behavior selection type, allows adding to current selection, removing * from selection, etc. * \since QGIS 2.16 - * @see selectByRect() - * @see selectByExpression() + * \see selectByRect() + * \see selectByExpression() */ void selectByIds( const QgsFeatureIds &ids, SelectBehavior behavior = SetSelection ); /** * Modifies the current selection on this layer * - * @param selectIds Select these ids - * @param deselectIds Deselect these ids + * \param selectIds Select these ids + * \param deselectIds Deselect these ids * - * @see select(QgsFeatureIds) - * @see select(QgsFeatureId) - * @see deselect(QgsFeatureIds) - * @see deselect(QgsFeatureId) - * @see selectByExpression() + * \see select(QgsFeatureIds) + * \see select(QgsFeatureId) + * \see deselect(QgsFeatureIds) + * \see deselect(QgsFeatureId) + * \see selectByExpression() */ void modifySelection( const QgsFeatureIds &selectIds, const QgsFeatureIds &deselectIds ); @@ -602,40 +602,40 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Invert selection of features found within the search rectangle (in layer's coordinates) * - * @param rect The rectangle in which the selection of features will be inverted + * \param rect The rectangle in which the selection of features will be inverted * - * @see invertSelection() + * \see invertSelection() */ void invertSelectionInRectangle( QgsRectangle &rect ); /** * Get a copy of the user-selected features * - * @return A list of { @link QgsFeature } 's + * \returns A list of QgsFeature * - * @see selectedFeatureIds() - * @see selectedFeaturesIterator() which is more memory friendly when handling large selections + * \see selectedFeatureIds() + * \see selectedFeaturesIterator() which is more memory friendly when handling large selections */ QgsFeatureList selectedFeatures() const; /** * Get an iterator of the selected features * - * @param request You may specify a request, e.g. to limit the set of requested attributes. + * \param request You may specify a request, e.g. to limit the set of requested attributes. * Any filter on the request will be discarded. * - * @return Iterator over the selected features + * \returns Iterator over the selected features * - * @see selectedFeatureIds() - * @see selectedFeatures() + * \see selectedFeatureIds() + * \see selectedFeatures() */ QgsFeatureIterator selectedFeaturesIterator( QgsFeatureRequest request = QgsFeatureRequest() ) const; /** * Return reference to identifiers of selected features * - * @return A list of { @link QgsFeatureId } 's - * @see selectedFeatures() + * \returns A list of QgsFeatureId + * \see selectedFeatures() */ const QgsFeatureIds &selectedFeatureIds() const; @@ -643,13 +643,13 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte QgsRectangle boundingBoxOfSelected() const; /** Returns whether the layer contains labels which are enabled and should be drawn. - * @return true if layer contains enabled labels + * \returns true if layer contains enabled labels * \since QGIS 2.9 */ bool labelsEnabled() const; /** Returns whether the layer contains diagrams which are enabled and should be drawn. - * @return true if layer contains enabled diagrams + * \returns true if layer contains enabled diagrams * \since QGIS 2.9 */ bool diagramsEnabled() const; @@ -665,7 +665,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte QgsFeatureRenderer *renderer() { return mRenderer; } /** Return const renderer. - * @note not available in Python bindings + * \note not available in Python bindings */ const QgsFeatureRenderer *renderer() const SIP_SKIP { return mRenderer; } @@ -688,12 +688,12 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte QString providerType() const; /** Reads vector layer specific state from project file Dom node. - * @note Called by QgsMapLayer::readXml(). + * \note Called by QgsMapLayer::readXml(). */ virtual bool readXml( const QDomNode &layer_node ) override; /** Write vector layer specific state to project file Dom node. - * @note Called by QgsMapLayer::writeXml(). + * \note Called by QgsMapLayer::writeXml(). */ virtual bool writeXml( QDomNode &layer_node, QDomDocument &doc ) const override; @@ -704,11 +704,11 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Save named and sld style of the layer to the style table in the db. - * @param name - * @param description - * @param useAsDefault - * @param uiFileContent - * @param msgError + * \param name + * \param description + * \param useAsDefault + * \param uiFileContent + * \param msgError */ virtual void saveStyleToDatabase( const QString &name, const QString &description, bool useAsDefault, const QString &uiFileContent, @@ -716,11 +716,11 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Lists all the style in db split into related to the layer and not related to - * @param ids the list in which will be stored the style db ids - * @param names the list in which will be stored the style names - * @param descriptions the list in which will be stored the style descriptions - * @param msgError - * @return the number of styles related to current layer + * \param ids the list in which will be stored the style db ids + * \param names the list in which will be stored the style names + * \param descriptions the list in which will be stored the style descriptions + * \param msgError + * \returns the number of styles related to current layer */ virtual int listStylesInDatabase( QStringList &ids SIP_OUT, QStringList &names SIP_OUT, QStringList &descriptions SIP_OUT, QString &msgError SIP_OUT ); @@ -733,17 +733,17 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Delete a style from the database * \since QGIS 3.0 - * @param styleId the provider's layer_styles table id of the style to delete - * @param msgError reference to string that will be updated with any error messages - * @return true in case of success + * \param styleId the provider's layer_styles table id of the style to delete + * \param msgError reference to string that will be updated with any error messages + * \returns true in case of success */ virtual bool deleteStyleFromDatabase( const QString &styleId, QString &msgError SIP_OUT ); /** * Load a named style from file/local db/datasource db - * @param theURI the URI of the style or the URI of the layer - * @param resultFlag will be set to true if a named style is correctly loaded - * @param loadFromLocalDb if true forces to load from local db instead of datasource one + * \param theURI the URI of the style or the URI of the layer + * \param resultFlag will be set to true if a named style is correctly loaded + * \param loadFromLocalDb if true forces to load from local db instead of datasource one */ virtual QString loadNamedStyle( const QString &theURI, bool &resultFlag SIP_OUT, bool loadFromLocalDb ); @@ -754,42 +754,42 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte virtual QString loadNamedStyle( const QString &theURI, bool &resultFlag SIP_OUT ) override; /** Read the symbology for the current layer from the Dom node supplied. - * @param layerNode node that will contain the symbology definition for this layer. - * @param errorMessage reference to string that will be updated with any error messages - * @return true in case of success. + * \param layerNode node that will contain the symbology definition for this layer. + * \param errorMessage reference to string that will be updated with any error messages + * \returns true in case of success. */ bool readSymbology( const QDomNode &layerNode, QString &errorMessage ) override; /** Read the style for the current layer from the Dom node supplied. - * @param node node that will contain the style definition for this layer. - * @param errorMessage reference to string that will be updated with any error messages - * @return true in case of success. + * \param node node that will contain the style definition for this layer. + * \param errorMessage reference to string that will be updated with any error messages + * \returns true in case of success. */ bool readStyle( const QDomNode &node, QString &errorMessage ) override; /** Write the symbology for the layer into the docment provided. - * @param node the node that will have the style element added to it. - * @param doc the document that will have the QDomNode added. - * @param errorMessage reference to string that will be updated with any error messages - * @return true in case of success. + * \param node the node that will have the style element added to it. + * \param doc the document that will have the QDomNode added. + * \param errorMessage reference to string that will be updated with any error messages + * \returns true in case of success. */ bool writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage ) const override; /** Write just the style information for the layer into the document - * @param node the node that will have the style element added to it. - * @param doc the document that will have the QDomNode added. - * @param errorMessage reference to string that will be updated with any error messages - * @return true in case of success. + * \param node the node that will have the style element added to it. + * \param doc the document that will have the QDomNode added. + * \param errorMessage reference to string that will be updated with any error messages + * \returns true in case of success. */ bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage ) const override; /** * Writes the symbology of the layer into the document provided in SLD 1.1 format - * @param node the node that will have the style element added to it. - * @param doc the document that will have the QDomNode added. - * @param errorMessage reference to string that will be updated with any error messages - * @param props a open ended set of properties that can drive/inform the SLD encoding - * @return true in case of success + * \param node the node that will have the style element added to it. + * \param doc the document that will have the QDomNode added. + * \param errorMessage reference to string that will be updated with any error messages + * \param props a open ended set of properties that can drive/inform the SLD encoding + * \returns true in case of success */ bool writeSld( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsStringMap &props = QgsStringMap() ) const; @@ -798,17 +798,17 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Number of features rendered with specified legend key. Features must be first * calculated by countSymbolFeatures() - * @return number of features rendered by symbol or -1 if failed or counts are not available + * \returns number of features rendered by symbol or -1 if failed or counts are not available */ long featureCount( const QString &legendKey ) const; /** * Update the data source of the layer. The layer's renderer and legend will be preserved only * if the geometry type of the new data source matches the current geometry type of the layer. - * @param dataSource new layer data source - * @param baseName base name of the layer - * @param provider provider string - * @param loadDefaultStyleFlag set to true to reset the layer's style to the default for the + * \param dataSource new layer data source + * \param baseName base name of the layer + * \param provider provider string + * \param loadDefaultStyleFlag set to true to reset the layer's style to the default for the * data source * \since QGIS 2.10 */ @@ -816,30 +816,30 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Count features for symbols. Feature counts may be get by featureCount(). - * @param showProgress show progress dialog - * @return true if calculated, false if failed or was canceled by user + * \param showProgress show progress dialog + * \returns true if calculated, false if failed or was canceled by user */ bool countSymbolFeatures( bool showProgress = true ); /** * Set the string (typically sql) used to define a subset of the layer - * @param subset The subset string. This may be the where clause of a sql statement + * \param subset The subset string. This may be the where clause of a sql statement * or other definition string specific to the underlying dataprovider * and data store. - * @return true, when setting the subset string was successful, false otherwise + * \returns true, when setting the subset string was successful, false otherwise */ virtual bool setSubsetString( const QString &subset ); /** * Get the string (typically sql) used to define a subset of the layer - * @return The subset string or QString::null if not implemented by the provider + * \returns The subset string or QString::null if not implemented by the provider */ virtual QString subsetString() const; /** * Query the layer for features specified in request. - * @param request feature request describing parameters of features to return - * @returns iterator for matching features from provider + * \param request feature request describing parameters of features to return + * \returns iterator for matching features from provider */ QgsFeatureIterator getFeatures( const QgsFeatureRequest &request = QgsFeatureRequest() ) const; @@ -879,17 +879,17 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte } /** Adds a feature - @param feature feature to add - @param alsoUpdateExtent If True, will also go to the effort of e.g. updating the extents. - @return True in case of success and False in case of error + \param feature feature to add + \param alsoUpdateExtent If True, will also go to the effort of e.g. updating the extents. + \returns True in case of success and False in case of error */ bool addFeature( QgsFeature &feature, bool alsoUpdateExtent = true ); /** Updates an existing feature. This method needs to query the datasource - on every call. Consider using {@link changeAttributeValue()} or - {@link changeGeometry()} instead. - @param f Feature to update - @return True in case of success and False in case of error + on every call. Consider using changeAttributeValue() or + changeGeometry() instead. + \param f Feature to update + \returns True in case of success and False in case of error */ bool updateFeature( QgsFeature &f ); @@ -914,26 +914,26 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** Moves the vertex at the given position number, * ring and item (first number is index 0), and feature * to the given coordinates - * @note available in Python as moveVertexV2 + * \note available in Python as moveVertexV2 */ bool moveVertex( const QgsPointV2 &p, QgsFeatureId atFeatureId, int atVertex ) SIP_PYNAME( moveVertexV2 ); /** Deletes a vertex from a feature. - * @param featureId ID of feature to remove vertex from - * @param vertex index of vertex to delete + * \param featureId ID of feature to remove vertex from + * \param vertex index of vertex to delete * \since QGIS 2.14 */ EditResult deleteVertex( QgsFeatureId featureId, int vertex ); /** Deletes the selected features - * @return true in case of success and false otherwise + * \returns true in case of success and false otherwise */ bool deleteSelectedFeatures( int *deletedCount = nullptr ); /** Adds a ring to polygon/multipolygon features - * @param ring ring to add - * @param featureId if specified, feature ID for feature ring was added to will be stored in this parameter - * @return + * \param ring ring to add + * \param featureId if specified, feature ID for feature ring was added to will be stored in this parameter + * \returns * 0 in case of success, * 1 problem with feature type, * 2 ring not closed, @@ -946,20 +946,20 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte int addRing( const QList &ring, QgsFeatureId *featureId = nullptr ); /** Adds a ring to polygon/multipolygon features (takes ownership) - * @param ring ring to add - * @param featureId if specified, feature ID for feature ring was added to will be stored in this parameter - * @return + * \param ring ring to add + * \param featureId if specified, feature ID for feature ring was added to will be stored in this parameter + * \returns * 0 in case of success * 1 problem with feature type * 2 ring not closed * 6 layer not editable - * @note available in Python as addCurvedRing + * \note available in Python as addCurvedRing */ // TODO QGIS 3.0 returns an enum instead of a magic constant int addRing( QgsCurve *ring SIP_TRANSFER, QgsFeatureId *featureId = nullptr ) SIP_PYNAME( addCurvedRing ); /** Adds a new part polygon to a multipart feature - * @return + * \returns * 0 in case of success, * 1 if selected feature is not multipart, * 2 if ring is not a valid geometry, @@ -973,7 +973,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte int addPart( const QList &ring ); /** Adds a new part polygon to a multipart feature - * @return + * \returns * 0 in case of success, * 1 if selected feature is not multipart, * 2 if ring is not a valid geometry, @@ -982,26 +982,26 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * 5 if several features are selected, * 6 if selected geometry not found * 7 layer not editable - * @note available in Python bindings as addPartV2 + * \note available in Python bindings as addPartV2 */ // TODO QGIS 3.0 returns an enum instead of a magic constant int addPart( const QgsPointSequence &ring ) SIP_PYNAME( addPartV2 ); - //! @note available in Python as addCurvedPart + //! \note available in Python as addCurvedPart int addPart( QgsCurve *ring SIP_TRANSFER ) SIP_PYNAME( addCurvedPart ); /** Translates feature by dx, dy - * @param featureId id of the feature to translate - * @param dx translation of x-coordinate - * @param dy translation of y-coordinate - * @return 0 in case of success + * \param featureId id of the feature to translate + * \param dx translation of x-coordinate + * \param dy translation of y-coordinate + * \returns 0 in case of success */ int translateFeature( QgsFeatureId featureId, double dx, double dy ); /** Splits parts cut by the given line - * @param splitLine line that splits the layer features - * @param topologicalEditing true if topological editing is enabled - * @return + * \param splitLine line that splits the layer features + * \param topologicalEditing true if topological editing is enabled + * \returns * 0 in case of success, * 4 if there is a selection but no feature split */ @@ -1009,9 +1009,9 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte int splitParts( const QList &splitLine, bool topologicalEditing = false ); /** Splits features cut by the given line - * @param splitLine line that splits the layer features - * @param topologicalEditing true if topological editing is enabled - * @return + * \param splitLine line that splits the layer features + * \param topologicalEditing true if topological editing is enabled + * \returns * 0 in case of success, * 4 if there is a selection but no feature split */ @@ -1019,9 +1019,9 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte int splitFeatures( const QList &splitLine, bool topologicalEditing = false ); /** Adds topological points for every vertex of the geometry. - * @param geom the geometry where each vertex is added to segments of other features - * @note geom is not going to be modified by the function - * @return 0 in case of success + * \param geom the geometry where each vertex is added to segments of other features + * \note geom is not going to be modified by the function + * \returns 0 in case of success */ int addTopologicalPoints( const QgsGeometry &geom ); @@ -1029,27 +1029,27 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * already have a vertex there. If a feature already has a vertex at position p, * no additional vertex is inserted. This method is useful for topological * editing. - * @param p position of the vertex - * @return 0 in case of success + * \param p position of the vertex + * \returns 0 in case of success */ int addTopologicalPoints( const QgsPoint &p ); /** Inserts vertices to the snapped segments. * This is useful for topological editing if snap to segment is enabled. - * @param snapResults results collected from the snapping operation - * @return 0 in case of success + * \param snapResults results collected from the snapping operation + * \returns 0 in case of success */ int insertSegmentVerticesForSnap( const QList &snapResults ); /** Access to labeling configuration. * \since QGIS 2.12 - * @note not available in Python bindings + * \note not available in Python bindings */ const QgsAbstractVectorLayerLabeling *labeling() const SIP_SKIP { return mLabeling; } /** Set labeling configuration. Takes ownership of the object. * \since QGIS 2.12 - * @note not available in Python bindings + * \note not available in Python bindings */ void setLabeling( QgsAbstractVectorLayerLabeling *labeling ) SIP_SKIP; @@ -1062,19 +1062,19 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte virtual bool isModified() const; /** Snaps a point to the closest vertex if there is one within the snapping tolerance - * @param point The point which is set to the position of a vertex if there is one within the snapping tolerance. + * \param point The point which is set to the position of a vertex if there is one within the snapping tolerance. * If there is no point within this tolerance, point is left unchanged. - * @param tolerance The snapping tolerance - * @return true if the point has been snapped, false if no vertex within search tolerance + * \param tolerance The snapping tolerance + * \returns true if the point has been snapped, false if no vertex within search tolerance */ bool snapPoint( QgsPoint &point, double tolerance ); /** Snaps to segment or vertex within given tolerance - * @param startPoint point to snap (in layer coordinates) - * @param snappingTolerance distance tolerance for snapping - * @param snappingResults snapping results. Key is the distance between startPoint and snapping target - * @param snap_to to segment / to vertex - * @return 0 in case of success + * \param startPoint point to snap (in layer coordinates) + * \param snappingTolerance distance tolerance for snapping + * \param snappingResults snapping results. Key is the distance between startPoint and snapping target + * \param snap_to to segment / to vertex + * \returns 0 in case of success */ int snapWithContext( const QgsPoint &startPoint, double snappingTolerance, @@ -1096,34 +1096,34 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * Returns the list of fields of this layer. * This also includes fields which have not yet been saved to the provider. * - * @return A list of fields + * \returns A list of fields */ inline QgsFields fields() const { return mFields; } /** * Returns the list of fields of this layer. * This also includes fields which have not yet been saved to the provider. - * Alias for {@link fields()} + * Alias for fields() * - * @return A list of fields + * \returns A list of fields */ inline QgsFields pendingFields() const { return mFields; } /** * Returns list of attribute indexes. i.e. a list from 0 ... fieldCount() - * Alias for {@link attributeList()} + * Alias for attributeList() */ inline QgsAttributeList pendingAllAttributesList() const { return mFields.allAttributesList(); } /** * Returns list of attribute indexes. i.e. a list from 0 ... fieldCount() - * Alias for {@link attributeList()} + * Alias for attributeList() */ inline QgsAttributeList attributeList() const { return mFields.allAttributesList(); } /** * Returns list of attributes making up the primary key - * Alias for {@link pkAttributeList()} + * Alias for pkAttributeList() */ inline QgsAttributeList pendingPkAttributesList() const { return pkAttributeList(); } @@ -1132,7 +1132,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Returns feature count including changes which have not yet been committed - * Alias for {@link featureCount()} + * Alias for featureCount() */ inline long pendingFeatureCount() const { return featureCount(); } @@ -1143,7 +1143,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte long featureCount() const; /** Make layer read-only (editing disabled) or not - * @return false if the layer is in editing yet + * \returns false if the layer is in editing yet */ bool setReadOnly( bool readonly = true ); @@ -1153,12 +1153,12 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Changes an attribute value (but does not commit it) * - * @param fid The feature id of the feature to be changed - * @param field The index of the field to be updated - * @param newValue The value which will be assigned to the field - * @param oldValue The previous value to restore on undo (will otherwise be retrieved) + * \param fid The feature id of the feature to be changed + * \param field The index of the field to be updated + * \param newValue The value which will be assigned to the field + * \param oldValue The previous value to restore on undo (will otherwise be retrieved) * - * @return true in case of success + * \returns true in case of success */ bool changeAttributeValue( QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue = QVariant() ); @@ -1182,8 +1182,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte void removeFieldAlias( int index ); /** Renames an attribute field (but does not commit it). - * @param index attribute index - * @param newName new name of field + * \param index attribute index + * \param newName new name of field * \since QGIS 2.16 */ bool renameAttribute( int index, const QString &newName ); @@ -1191,7 +1191,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Returns the alias of an attribute name or a null string if there is no alias. * - * @see {attributeDisplayName( int attributeIndex )} which returns the field name + * \see {attributeDisplayName( int attributeIndex )} which returns the field name * if no alias is defined. */ QString attributeAlias( int index ) const; @@ -1228,8 +1228,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Deletes a list of attribute fields (but does not commit it) * - * @param attrs the indices of the attributes to delete - * @return true if at least one attribute has been deleted + * \param attrs the indices of the attributes to delete + * \returns true if at least one attribute has been deleted * */ bool deleteAttributes( QList attrs ); @@ -1242,9 +1242,9 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Deletes a set of features from the layer (but does not commit it) - * @param fids The feature ids to delete + * \param fids The feature ids to delete * - * @return false if the layer is not in edit mode or does not support deleting + * \returns false if the layer is not in edit mode or does not support deleting * in case of an active transaction depends on the provider implementation */ bool deleteFeatures( const QgsFeatureIds &fids ); @@ -1263,18 +1263,18 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * so if a stage fails, it's difficult to roll back cleanly. * Therefore any error message also includes which stage failed so * that the user has some chance of repairing the damage cleanly. - * @see commitErrors() + * \see commitErrors() */ bool commitChanges(); /** Returns a list containing any error messages generated when attempting * to commit changes to the layer. - * @see commitChanges() + * \see commitChanges() */ QStringList commitErrors() const; /** Stop editing and discard the edits - * @param deleteBuffer whether to delete editing buffer + * \param deleteBuffer whether to delete editing buffer */ bool rollBack( bool deleteBuffer = true ); @@ -1287,8 +1287,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Get relations, where the foreign key is on this layer * - * @param idx Only get relations, where idx forms part of the foreign key - * @return A list of relations + * \param idx Only get relations, where idx forms part of the foreign key + * \returns A list of relations */ QList referencingRelations( int idx ) const; @@ -1296,12 +1296,12 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte QgsVectorLayerEditBuffer *editBuffer() { return mEditBuffer; } //! Buffer with uncommitted editing operations. Only valid after editing has been turned on. - //! @note not available in Python bindings + //! \note not available in Python bindings const QgsVectorLayerEditBuffer *editBuffer() const SIP_SKIP { return mEditBuffer; } /** * Create edit command for undo/redo operations - * @param text text which is to be displayed in undo window + * \param text text which is to be displayed in undo window */ void beginEditCommand( const QString &text ); @@ -1328,36 +1328,36 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** Returns the calculated default value for the specified field index. The default * value may be taken from a client side default value expression (see setDefaultValueExpression()) * or taken from the underlying data provider. - * @param index field index - * @param feature optional feature to use for default value evaluation. If passed, + * \param index field index + * \param feature optional feature to use for default value evaluation. If passed, * then properties from the feature (such as geometry) can be used when calculating * the default value. - * @param context optional expression context to evaluate expressions again. If not + * \param context optional expression context to evaluate expressions again. If not * specified, a default context will be created - * @return calculated default value + * \returns calculated default value * \since QGIS 3.0 - * @see setDefaultValueExpression() + * \see setDefaultValueExpression() */ QVariant defaultValue( int index, const QgsFeature &feature = QgsFeature(), QgsExpressionContext *context = nullptr ) const; /** Sets an expression to use when calculating the default value for a field. - * @param index field index - * @param expression expression to evaluate when calculating default values for field. Pass + * \param index field index + * \param expression expression to evaluate when calculating default values for field. Pass * an empty expression to clear the default. * \since QGIS 3.0 - * @see defaultValue() - * @see defaultValueExpression() + * \see defaultValue() + * \see defaultValueExpression() */ void setDefaultValueExpression( int index, const QString &expression ); /** Returns the expression used when calculating the default value for a field. - * @param index field index - * @returns expression evaluated when calculating default values for field, or an + * \param index field index + * \returns expression evaluated when calculating default values for field, or an * empty string if no default is set * \since QGIS 3.0 - * @see defaultValue() - * @see setDefaultValueExpression() + * \see defaultValue() + * \see setDefaultValueExpression() */ QString defaultValueExpression( int index ) const; @@ -1366,7 +1366,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * field index. These constraints may be inherited from the layer's data provider * or may be set manually on the vector layer from within QGIS. * \since QGIS 3.0 - * @see setFieldConstraint() + * \see setFieldConstraint() */ QgsFieldConstraints::Constraints fieldConstraints( int fieldIndex ) const; @@ -1375,8 +1375,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * data provider will be kept intact and cannot be modified. Ie, calling this method only allows for new * constraints to be added on top of the existing provider constraints. * \since QGIS 3.0 - * @see fieldConstraints() - * @see removeFieldConstraint() + * \see fieldConstraints() + * \see removeFieldConstraint() */ void setFieldConstraint( int index, QgsFieldConstraints::Constraint constraint, QgsFieldConstraints::ConstraintStrength strength = QgsFieldConstraints::ConstraintStrengthHard ); @@ -1384,26 +1384,26 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * Removes a constraint for a specified field index. Any constraints inherited from the layer's * data provider will be kept intact and cannot be removed. * \since QGIS 3.0 - * @see fieldConstraints() - * @see setFieldConstraint() + * \see fieldConstraints() + * \see setFieldConstraint() */ void removeFieldConstraint( int index, QgsFieldConstraints::Constraint constraint ); /** * Returns the constraint expression for for a specified field index, if set. * \since QGIS 3.0 - * @see fieldConstraints() - * @see constraintDescription() - * @see setConstraintExpression() + * \see fieldConstraints() + * \see constraintDescription() + * \see setConstraintExpression() */ QString constraintExpression( int index ) const; /** * Returns the descriptive name for the constraint expression for a specified field index. * \since QGIS 3.0 - * @see constraints() - * @see constraintExpression() - * @see setConstraintExpression() + * \see constraints() + * \see constraintExpression() + * \see setConstraintExpression() */ QString constraintDescription( int index ) const; @@ -1411,9 +1411,9 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * Set the constraint expression for the specified field index. An optional descriptive name for the constraint * can also be set. Setting an empty expression will clear any existing expression constraint. * \since QGIS 3.0 - * @see constraintExpression() - * @see constraintDescription() - * @see constraints() + * \see constraintExpression() + * \see constraintDescription() + * \see constraints() */ void setConstraintExpression( int index, const QString &expression, const QString &description = QString() ); @@ -1435,11 +1435,11 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * may contain outdated values (for instance when the attribute value in a saved feature has * been changed inside the edit buffer then the previous saved value will be included in the * returned list). - * @param index column index for attribute - * @param uniqueValues out: result list - * @param limit maximum number of values to return (or -1 if unlimited) - * @see minimumValue() - * @see maximumValue() + * \param index column index for attribute + * \param uniqueValues out: result list + * \param limit maximum number of values to return (or -1 if unlimited) + * \see minimumValue() + * \see maximumValue() */ void uniqueValues( int index, QList &uniqueValues SIP_OUT, int limit = -1 ) const; @@ -1450,11 +1450,11 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * may contain outdated values (for instance when the attribute value in a saved feature has * been changed inside the edit buffer then the previous saved value will be included in the * returned list). - * @param index column index for attribute - * @param substring substring to match (case insensitive) - * @param limit maxmum number of the values to return, or -1 to return all unique values - * @param feedback optional feedback object for canceling request - * @returns list of unique strings containing substring + * \param index column index for attribute + * \param substring substring to match (case insensitive) + * \param limit maxmum number of the values to return, or -1 to return all unique values + * \param feedback optional feedback object for canceling request + * \returns list of unique strings containing substring */ QStringList uniqueStringsMatching( int index, const QString &substring, int limit = -1, QgsFeedback *feedback = nullptr ) const; @@ -1463,8 +1463,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * Note that in some circumstances when unsaved changes are present for the layer then the * returned value may be outdated (for instance when the attribute value in a saved feature has * been changed inside the edit buffer then the previous saved value may be returned as the minimum). - * @see maximumValue() - * @see uniqueValues() + * \see maximumValue() + * \see uniqueValues() */ QVariant minimumValue( int index ) const; @@ -1472,18 +1472,18 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * Note that in some circumstances when unsaved changes are present for the layer then the * returned value may be outdated (for instance when the attribute value in a saved feature has * been changed inside the edit buffer then the previous saved value may be returned as the maximum). - * @see minimumValue() - * @see uniqueValues() + * \see minimumValue() + * \see uniqueValues() */ QVariant maximumValue( int index ) const; /** Calculates an aggregated value from the layer's features. - * @param aggregate aggregate to calculate - * @param fieldOrExpression source field or expression to use as basis for aggregated values. - * @param parameters parameters controlling aggregate calculation - * @param context expression context for expressions and filters - * @param ok if specified, will be set to true if aggregate calculation was successful - * @return calculated aggregate value + * \param aggregate aggregate to calculate + * \param fieldOrExpression source field or expression to use as basis for aggregated values. + * \param parameters parameters controlling aggregate calculation + * \param context expression context for expressions and filters + * \param ok if specified, will be set to true if aggregate calculation was successful + * \returns calculated aggregate value * \since QGIS 2.16 */ QVariant aggregate( QgsAggregateCalculator::Aggregate aggregate, @@ -1493,26 +1493,26 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte bool *ok = nullptr ) const; /** Fetches all values from a specified field name or expression. - * @param fieldOrExpression field name or an expression string - * @param ok will be set to false if field or expression is invalid, otherwise true - * @param selectedOnly set to true to get values from selected features only - * @param feedback optional feedback object to allow cancelation - * @returns list of fetched values + * \param fieldOrExpression field name or an expression string + * \param ok will be set to false if field or expression is invalid, otherwise true + * \param selectedOnly set to true to get values from selected features only + * \param feedback optional feedback object to allow cancelation + * \returns list of fetched values * \since QGIS 2.9 - * @see getDoubleValues + * \see getDoubleValues */ QList< QVariant > getValues( const QString &fieldOrExpression, bool &ok, bool selectedOnly = false, QgsFeedback *feedback = nullptr ) const; /** Fetches all double values from a specified field name or expression. Null values or * invalid expression results are skipped. - * @param fieldOrExpression field name or an expression string evaluating to a double value - * @param ok will be set to false if field or expression is invalid, otherwise true - * @param selectedOnly set to true to get values from selected features only - * @param nullCount optional pointer to integer to store number of null values encountered in - * @param feedback optional feedback object to allow cancelation - * @returns list of fetched values + * \param fieldOrExpression field name or an expression string evaluating to a double value + * \param ok will be set to false if field or expression is invalid, otherwise true + * \param selectedOnly set to true to get values from selected features only + * \param nullCount optional pointer to integer to store number of null values encountered in + * \param feedback optional feedback object to allow cancelation + * \returns list of fetched values * \since QGIS 2.9 - * @see getValues + * \see getValues */ QList< double > getDoubleValues( const QString &fieldOrExpression, bool &ok, bool selectedOnly = false, int *nullCount = nullptr, QgsFeedback *feedback = nullptr ) const; @@ -1528,7 +1528,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte QString metadata() const override; - //! @note not available in Python bindings + //! \note not available in Python bindings inline QgsGeometryCache *cache() SIP_SKIP { return mCache; } /** Set the simplification settings for fast rendering of features @@ -1542,15 +1542,15 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte inline const QgsVectorSimplifyMethod &simplifyMethod() const { return mSimplifyMethod; } /** Returns whether the VectorLayer can apply the specified simplification hint - * @note Do not use in 3rd party code - may be removed in future version! + * \note Do not use in 3rd party code - may be removed in future version! * \since QGIS 2.2 */ bool simplifyDrawingCanbeApplied( const QgsRenderContext &renderContext, QgsVectorSimplifyMethod::SimplifyHint simplifyHint ) const; /** - * @brief Return the conditional styles that are set for this layer. Style information is + * \brief Return the conditional styles that are set for this layer. Style information is * used to render conditional formatting in the attribute table. - * @return Return a QgsConditionalLayerStyles object holding the conditional attribute + * \returns Return a QgsConditionalLayerStyles object holding the conditional attribute * style information. Style information is generic and can be used for anything. * \since QGIS 2.12 */ @@ -1592,7 +1592,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * Get the configuration of the form used to represent this vector layer. * This is a writable configuration that can directly be changed in place. * - * @return The configuration of this layers' form + * \returns The configuration of this layers' form * * \since QGIS 2.14 */ @@ -1602,7 +1602,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * Get the configuration of the form used to represent this vector layer. * This is a writable configuration that can directly be changed in place. * - * @return The configuration of this layers' form + * \returns The configuration of this layers' form * * \since QGIS 3.0 */ @@ -1613,43 +1613,43 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Select feature by its ID * - * @param featureId The id of the feature to select + * \param featureId The id of the feature to select * - * @see select(QgsFeatureIds) + * \see select(QgsFeatureIds) */ void select( QgsFeatureId featureId ); /** * Select features by their ID * - * @param featureIds The ids of the features to select + * \param featureIds The ids of the features to select * - * @see select(QgsFeatureId) + * \see select(QgsFeatureId) */ void select( const QgsFeatureIds &featureIds ); /** * Deselect feature by its ID * - * @param featureId The id of the feature to deselect + * \param featureId The id of the feature to deselect * - * @see deselect(QgsFeatureIds) + * \see deselect(QgsFeatureIds) */ void deselect( const QgsFeatureId featureId ); /** * Deselect features by their ID * - * @param featureIds The ids of the features to deselect + * \param featureIds The ids of the features to deselect * - * @see deselect(QgsFeatureId) + * \see deselect(QgsFeatureId) */ void deselect( const QgsFeatureIds &featureIds ); /** * Clear selection * - * @see selectByIds() + * \see selectByIds() */ void removeSelection(); @@ -1661,8 +1661,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Make layer editable. * This starts an edit session on this layer. Changes made in this edit session will not - * be made persistent until {@link commitChanges()} is called and can be reverted by calling - * {@link rollBack()}. + * be made persistent until commitChanges() is called and can be reverted by calling + * rollBack(). */ bool startEditing(); @@ -1675,9 +1675,9 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * This signal is emitted when selection was changed * - * @param selected Newly selected feature ids - * @param deselected Ids of all features which have previously been selected but are not any more - * @param clearAndSelect In case this is set to true, the old selection was dismissed and the new selection corresponds to selected + * \param selected Newly selected feature ids + * \param deselected Ids of all features which have previously been selected but are not any more + * \param clearAndSelect In case this is set to true, the old selection was dismissed and the new selection corresponds to selected */ void selectionChanged( const QgsFeatureIds &selected, const QgsFeatureIds &deselected, const bool clearAndSelect ); @@ -1704,44 +1704,44 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Will be emitted, when a new attribute has been added to this vector layer. - * Applies only to types {@link QgsFields::OriginEdit}, {@link QgsFields::OriginProvider} and {@link QgsFields::OriginExpression } + * Applies only to types QgsFields::OriginEdit, QgsFields::OriginProvider and QgsFields::OriginExpression * - * @param idx The index of the new attribute + * \param idx The index of the new attribute * - * @see updatedFields() + * \see updatedFields() */ void attributeAdded( int idx ); /** * Will be emitted, when an expression field is going to be added to this vector layer. - * Applies only to types {@link QgsFields::OriginExpression } + * Applies only to types QgsFields::OriginExpression * - * @param fieldName The name of the attribute to be added + * \param fieldName The name of the attribute to be added */ void beforeAddingExpressionField( const QString &fieldName ); /** * Will be emitted, when an attribute has been deleted from this vector layer. - * Applies only to types {@link QgsFields::OriginEdit}, {@link QgsFields::OriginProvider} and {@link QgsFields::OriginExpression } + * Applies only to types QgsFields::OriginEdit, QgsFields::OriginProvider and QgsFields::OriginExpression * - * @param idx The index of the deleted attribute + * \param idx The index of the deleted attribute * - * @see updatedFields() + * \see updatedFields() */ void attributeDeleted( int idx ); /** * Will be emitted, when an expression field is going to be deleted from this vector layer. - * Applies only to types {@link QgsFields::OriginExpression } + * Applies only to types QgsFields::OriginExpression * - * @param idx The index of the attribute to be deleted + * \param idx The index of the attribute to be deleted */ void beforeRemovingExpressionField( int idx ); /** * Emitted when a new feature has been added to the layer * - * @param fid The id of the new feature + * \param fid The id of the new feature */ void featureAdded( QgsFeatureId fid ); @@ -1749,9 +1749,9 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * Emitted when a feature has been deleted. * * If you do expensive operations in a slot connected to this, you should prever to use - * {@link featuresDeleted( const QgsFeatureIds& )}. + * featuresDeleted( const QgsFeatureIds& ). * - * @param fid The id of the feature which has been deleted + * \param fid The id of the feature which has been deleted */ void featureDeleted( QgsFeatureId fid ); @@ -1762,7 +1762,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * to allow connected slots to minimize the overhead. * If features are deleted outside of an edit command, this signal will be emitted once per feature. * - * @param fids The feature ids that have been deleted. + * \param fids The feature ids that have been deleted. */ void featuresDeleted( const QgsFeatureIds &fids ); @@ -1777,9 +1777,9 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * Is emitted whenever an attribute value change is done in the edit buffer. * Note that at this point the attribute change is not yet saved to the provider. * - * @param fid The id of the changed feature - * @param idx The attribute index of the changed attribute - * @param value The new value of the attribute + * \param fid The id of the changed feature + * \param idx The attribute index of the changed attribute + * \param value The new value of the attribute */ void attributeValueChanged( QgsFeatureId fid, int idx, const QVariant &value ); @@ -1787,8 +1787,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * Is emitted whenever a geometry change is done in the edit buffer. * Note that at this point the geometry change is not yet saved to the provider. * - * @param fid The id of the changed feature - * @param geometry The new geometry + * \param fid The id of the changed feature + * \param geometry The new geometry */ void geometryChanged( QgsFeatureId fid, const QgsGeometry &geometry ); @@ -1817,21 +1817,21 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Signal emitted when a new edit command has been started * - * @param text Description for this edit command + * \param text Description for this edit command */ void editCommandStarted( const QString &text ); /** * Signal emitted, when an edit command successfully ended - * @note This does not mean it is also committed, only that it is written - * to the edit buffer. See {@link beforeCommitChanges()} + * \note This does not mean it is also committed, only that it is written + * to the edit buffer. See beforeCommitChanges() */ void editCommandEnded(); /** * Signal emitted, whan an edit command is destroyed - * @note This is not a rollback, it is only related to the current edit command. - * See {@link beforeRollBack()} + * \note This is not a rollback, it is only related to the current edit command. + * See beforeRollBack() */ void editCommandDestroyed(); @@ -1840,9 +1840,9 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * If there is custom style information saved in the file, you can connect to this signal * and update the layer style accordingly. * - * @param element The XML layer style element. + * \param element The XML layer style element. * - * @param errorMessage Write error messages into this string. + * \param errorMessage Write error messages into this string. */ void readCustomSymbology( const QDomElement &element, QString &errorMessage ); @@ -1851,9 +1851,9 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * If there is custom style information you want to save to the file, you can connect * to this signal and update the element accordingly. * - * @param element The XML element where you can add additional style information to. - * @param doc The XML document that you can use to create new XML nodes. - * @param errorMessage Write error messages into this string. + * \param element The XML element where you can add additional style information to. + * \param doc The XML document that you can use to create new XML nodes. + * \param errorMessage Write error messages into this string. */ void writeCustomSymbology( QDomElement &element, QDomDocument &doc, QString &errorMessage ) const; @@ -1909,7 +1909,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte virtual bool isReadOnly() const override; /** Bind layer to a specific data provider - * @param provider should be "postgres", "ogr", or ?? + * \param provider should be "postgres", "ogr", or ?? * @todo XXX should this return bool? Throw exceptions? */ bool setDataProvider( QString const &provider ); @@ -1918,12 +1918,12 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte QgsFeatureId findFreeId(); /** Snaps to a geometry and adds the result to the multimap if it is within the snapping result - * @param startPoint start point of the snap - * @param featureId id of feature - * @param geom geometry to snap - * @param sqrSnappingTolerance squared search tolerance of the snap - * @param snappingResults list to which the result is appended - * @param snap_to snap to vertex or to segment + * \param startPoint start point of the snap + * \param featureId id of feature + * \param geom geometry to snap + * \param sqrSnappingTolerance squared search tolerance of the snap + * \param snappingResults list to which the result is appended + * \param snap_to snap to vertex or to segment */ void snapToGeometry( const QgsPoint &startPoint, QgsFeatureId featureId, diff --git a/src/core/qgsvectorlayercache.h b/src/core/qgsvectorlayercache.h index 766f70d52b7e..0eaf9512e9c8 100644 --- a/src/core/qgsvectorlayercache.h +++ b/src/core/qgsvectorlayercache.h @@ -30,8 +30,8 @@ class QgsAbstractCacheIndex; /** \ingroup core * This class caches features of a given QgsVectorLayer. * - * @brief - * The cached features can be indexed by @link QgsAbstractCacheIndex @endlink. + * \brief + * The cached features can be indexed by QgsAbstractCacheIndex. * * Proper indexing for a given use-case may speed up performance substantially. */ @@ -43,7 +43,7 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject private: /** - * This is a wrapper class around a cached @link QgsFeature @endlink, which + * This is a wrapper class around a cached QgsFeature, which * will inform the cache, when it has been deleted, so indexes can be * updated that the wrapped feature needs to be fetched again if needed. */ @@ -54,8 +54,8 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject /** * Will create a new cached feature. * - * @param feat The feature to cache. A copy will be made. - * @param vlCache The cache to inform when the feature has been removed from the cache. + * \param feat The feature to cache. A copy will be made. + * \param vlCache The cache to inform when the feature has been removed from the cache. */ QgsCachedFeature( const QgsFeature &feat, QgsVectorLayerCache *vlCache ) : mCache( vlCache ) @@ -89,38 +89,38 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject * Sets the maximum number of features to keep in the cache. Some features will be removed from * the cache if the number is smaller than the previous size of the cache. * - * @param cacheSize indicates the maximum number of features to keep in the cache + * \param cacheSize indicates the maximum number of features to keep in the cache */ void setCacheSize( int cacheSize ); /** - * @brief + * \brief * Returns the maximum number of features this cache will hold. * In case full caching is enabled, this number can change, as new features get added. * - * @return int + * \returns int */ int cacheSize(); /** * Enable or disable the caching of geometries * - * @param cacheGeometry Enable or disable the caching of geometries - * @see cacheGeometry() + * \param cacheGeometry Enable or disable the caching of geometries + * \see cacheGeometry() */ void setCacheGeometry( bool cacheGeometry ); /** * Returns true if the cache will fetch and cache feature geometries. * \since QGIS 3.0 - * @see setCacheGeometry() + * \see setCacheGeometry() */ bool cacheGeometry() const { return mCacheGeometry; } /** * Set the subset of attributes to be cached * - * @param attributes The attributes to be cached + * \param attributes The attributes to be cached */ void setCacheSubsetOfAttributes( const QgsAttributeList &attributes ); @@ -128,51 +128,51 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject * If this is enabled, the subset of cached attributes will automatically be extended * to also include newly added attributes. * - * @param cacheAddedAttributes Automatically cache new attributes + * \param cacheAddedAttributes Automatically cache new attributes */ void setCacheAddedAttributes( bool cacheAddedAttributes ); /** - * @brief + * \brief * This enables or disables full caching. * If enabled, all features will be held in the cache. The cache size will incrementally * be increased to offer space for all features. * When enabled, all features will be read into cache. As this feature will most likely * be used for slow data sources, be aware, that the call to this method might take a long time. * - * @param fullCache True: enable full caching, False: disable full caching - * @note when a cache is invalidated() (e.g. by adding an attribute to a layer) this setting + * \param fullCache True: enable full caching, False: disable full caching + * \note when a cache is invalidated() (e.g. by adding an attribute to a layer) this setting * is reset. A full cache rebuild must be performed by calling setFullCache( true ) again. - * @see hasFullCache() + * \see hasFullCache() */ void setFullCache( bool fullCache ); /** Returns true if the cache is complete, ie it contains all features. This may happen as * a result of a call to setFullCache() or by through a feature request which resulted in * all available features being cached. - * @see setFullCache() + * \see setFullCache() * \since QGIS 3.0 */ bool hasFullCache() const { return mFullCache; } /** - * @brief - * Adds a {@link QgsAbstractCacheIndex} to this cache. Cache indices know about features present - * in this cache and decide, if enough information is present in the cache to respond to a {@link QgsFeatureRequest}. + * \brief + * Adds a QgsAbstractCacheIndex to this cache. Cache indices know about features present + * in this cache and decide, if enough information is present in the cache to respond to a QgsFeatureRequest. * The layer cache will take ownership of the index. * - * @param cacheIndex The cache index to add. + * \param cacheIndex The cache index to add. */ void addCacheIndex( QgsAbstractCacheIndex *cacheIndex ); /** * Query this VectorLayerCache for features. * If the VectorLayerCache (and moreover any of its indices) is able to satisfy - * the request, the returned {@link QgsFeatureIterator} will iterate over cached features. + * the request, the returned QgsFeatureIterator will iterate over cached features. * If it's not possible to fully satisfy the request from the cache, part or all of the features * will be requested from the data provider. - * @param featureRequest The request specifying filter and required data. - * @return An iterator over the requested data. + * \param featureRequest The request specifying filter and required data. + * \returns An iterator over the requested data. */ QgsFeatureIterator getFeatures( const QgsFeatureRequest &featureRequest = QgsFeatureRequest() ); @@ -213,31 +213,31 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject /** * Check if a certain feature id is cached. - * @param fid The feature id to look for - * @return True if this id is in the cache - * @see cachedFeatureIds() + * \param fid The feature id to look for + * \returns True if this id is in the cache + * \see cachedFeatureIds() */ bool isFidCached( const QgsFeatureId fid ) const; /** Returns the set of feature IDs for features which are cached. * \since QGIS 3.0 - * @see isFidCached() + * \see isFidCached() */ QgsFeatureIds cachedFeatureIds() const { return mCache.keys().toSet(); } /** * Gets the feature at the given feature id. Considers the changed, added, deleted and permanent features - * @param featureId The id of the feature to query - * @param feature The result of the operation will be written to this feature - * @param skipCache Will query the layer regardless if the feature is in the cache already - * @return true in case of success + * \param featureId The id of the feature to query + * \param feature The result of the operation will be written to this feature + * \param skipCache Will query the layer regardless if the feature is in the cache already + * \returns true in case of success */ bool featureAtId( QgsFeatureId featureId, QgsFeature &feature, bool skipCache = false ); /** * Removes the feature identified by fid from the cache if present. - * @param fid The id of the feature to delete - * @return true if the feature was removed, false if the feature id was not found in the cache + * \param fid The id of the feature to delete + * \returns true if the feature was removed, false if the feature id was not found in the cache */ bool removeCachedFeature( QgsFeatureId fid ); @@ -249,33 +249,33 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject protected: /** - * @brief + * \brief * Gets called, whenever the full list of feature ids for a certain request is known. * Broadcasts this information to indices, so they can update their tables. * - * @param featureRequest The feature request that was answered - * @param fids The feature ids that have been returned + * \param featureRequest The feature request that was answered + * \param fids The feature ids that have been returned */ void requestCompleted( const QgsFeatureRequest &featureRequest, const QgsFeatureIds &fids ); /** - * @brief + * \brief * Gets called, whenever a feature has been removed. * Broadcasts this information to indices, so they can invalidate their cache if required. * - * @param fid The feature id of the removed feature. + * \param fid The feature id of the removed feature. */ void featureRemoved( QgsFeatureId fid ); /** - * @brief + * \brief * Checks if the information required to complete the request is cached. * i.e. If all attributes required and the geometry is held in the cache. * Please note, that this does not check, if the requested features are cached. * * - * @param featureRequest The {@link QgsFeatureRequest} to be answered - * @return True if the information is being cached, false if not + * \param featureRequest The QgsFeatureRequest to be answered + * \returns True if the information is being cached, false if not */ bool checkInformationCovered( const QgsFeatureRequest &featureRequest ); @@ -286,10 +286,10 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject * When filling the cache, this signal gets emitted periodically to notify about the progress * and to be able to cancel an operation. * - * @param i The number of already fetched features - * @param cancel A reference to a boolean variable. Set to true and the operation will be canceled. + * \param i The number of already fetched features + * \param cancel A reference to a boolean variable. Set to true and the operation will be canceled. * - * @note not available in Python bindings + * \note not available in Python bindings */ void progress( int i, bool &cancel ); @@ -299,14 +299,14 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject void finished(); /** - * @brief Is emitted when the cached layer is deleted. Is emitted when the cached layers layerDelete() + * \brief Is emitted when the cached layer is deleted. Is emitted when the cached layers layerDelete() * signal is being emitted, but before the local reference to it has been set to NULL. So call to - * @link layer() @endlink will still return a valid pointer for cleanup purpose. + * layer() will still return a valid pointer for cleanup purpose. */ void cachedLayerDeleted(); /** - * @brief Is emitted when an attribute is changed. Is re-emitted after the layer itself emits this signal. + * \brief Is emitted when an attribute is changed. Is re-emitted after the layer itself emits this signal. * You should connect to this signal, to be sure, to not get a cached value if querying the cache. */ void attributeValueChanged( QgsFeatureId fid, int field, const QVariant &value ); @@ -316,7 +316,7 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject * You should connect to this signal instead of the layers', if you want to be sure * that this cache has updated information for the new feature * - * @param fid The featureid of the changed feature + * \param fid The featureid of the changed feature */ void featureAdded( QgsFeatureId fid ); @@ -359,10 +359,10 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject friend class QgsCachedFeature; /** Returns true if the cache contains all the features required for a specified request. - * @param featureRequest feature request - * @param it will be set to iterator for matching features - * @returns true if cache can satisfy request - * @note this method only checks for available features, not whether the cache + * \param featureRequest feature request + * \param it will be set to iterator for matching features + * \returns true if cache can satisfy request + * \note this method only checks for available features, not whether the cache * contains required attributes or geometry. For that, use checkInformationCovered() */ bool canUseCacheForRequest( const QgsFeatureRequest &featureRequest, QgsFeatureIterator &it ); diff --git a/src/core/qgsvectorlayerdiagramprovider.h b/src/core/qgsvectorlayerdiagramprovider.h index 4c421c7f7268..765e8e74c0dd 100644 --- a/src/core/qgsvectorlayerdiagramprovider.h +++ b/src/core/qgsvectorlayerdiagramprovider.h @@ -24,8 +24,8 @@ /** \ingroup core * Class that adds extra information to QgsLabelFeature for labeling of diagrams * - * @note this class is not a part of public API yet. See notes in QgsLabelingEngine - * @note not available in Python bindings + * \note this class is not a part of public API yet. See notes in QgsLabelingEngine + * \note not available in Python bindings */ class QgsDiagramLabelFeature : public QgsLabelFeature { @@ -48,12 +48,12 @@ class QgsDiagramLabelFeature : public QgsLabelFeature class QgsAbstractFeatureSource; /** \ingroup core - * @brief The QgsVectorLayerDiagramProvider class implements support for diagrams within + * \brief The QgsVectorLayerDiagramProvider class implements support for diagrams within * the labeling engine. Parameters for the diagrams are taken from the layer settings. * * \since QGIS 2.12 - * @note this class is not a part of public API yet. See notes in QgsLabelingEngine - * @note not available in Python bindings + * \note this class is not a part of public API yet. See notes in QgsLabelingEngine + * \note not available in Python bindings */ class CORE_EXPORT QgsVectorLayerDiagramProvider : public QgsAbstractLabelProvider { @@ -73,19 +73,19 @@ class CORE_EXPORT QgsVectorLayerDiagramProvider : public QgsAbstractLabelProvide /** * Prepare for registration of features. Must be called after provider has been added to engine (uses its map settings) - * @param context render context. - * @param attributeNames list of attribute names to which additional required attributes shall be added - * @return Whether the preparation was successful - if not, the provider shall not be used + * \param context render context. + * \param attributeNames list of attribute names to which additional required attributes shall be added + * \returns Whether the preparation was successful - if not, the provider shall not be used */ virtual bool prepare( const QgsRenderContext &context, QSet &attributeNames ); /** * Register a feature for labeling as one or more QgsLabelFeature objects stored into mFeatures * - * @param feature feature for diagram - * @param context render context. The QgsExpressionContext contained within the render context + * \param feature feature for diagram + * \param context render context. The QgsExpressionContext contained within the render context * must have already had the feature and fields sets prior to calling this method. - * @param obstacleGeometry optional obstacle geometry, if a different geometry to the feature's geometry + * \param obstacleGeometry optional obstacle geometry, if a different geometry to the feature's geometry * should be used as an obstacle for labels (e.g., if the feature has been rendered with an offset point * symbol, the obstacle geometry should represent the bounds of the offset symbol). If not set, * the feature's original geometry will be used as an obstacle for labels. Ownership of obstacleGeometry diff --git a/src/core/qgsvectorlayereditbuffer.h b/src/core/qgsvectorlayereditbuffer.h index aa51d057d9b2..c8a5d82371c0 100644 --- a/src/core/qgsvectorlayereditbuffer.h +++ b/src/core/qgsvectorlayereditbuffer.h @@ -43,8 +43,8 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject /** Adds a feature - @param f feature to add - @return True in case of success and False in case of error + \param f feature to add + \returns True in case of success and False in case of error */ virtual bool addFeature( QgsFeature &f ); @@ -71,8 +71,8 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject virtual bool deleteAttribute( int attr ); /** Renames an attribute field (but does not commit it) - * @param attr attribute index - * @param newName new name of field + * \param attr attribute index + * \param newName new name of field * \since QGIS 2.16 */ virtual bool renameAttribute( int attr, const QString &newName ); @@ -98,38 +98,38 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject virtual void rollBack(); /** Returns a map of new features which are not committed. - * @see isFeatureAdded() + * \see isFeatureAdded() */ QgsFeatureMap addedFeatures() const { return mAddedFeatures; } /** Returns true if the specified feature ID has been added but not committed. - * @param id feature ID + * \param id feature ID * \since QGIS 3.0 - * @see addedFeatures() + * \see addedFeatures() */ bool isFeatureAdded( QgsFeatureId id ) const { return mAddedFeatures.contains( id ); } /** Returns a map of features with changed attributes values which are not committed. - * @see isFeatureAttributesChanged() + * \see isFeatureAttributesChanged() */ QgsChangedAttributesMap changedAttributeValues() const { return mChangedAttributeValues; } /** Returns true if the specified feature ID has had an attribute changed but not committed. - * @param id feature ID + * \param id feature ID * \since QGIS 3.0 - * @see changedAttributeValues() + * \see changedAttributeValues() */ bool isFeatureAttributesChanged( QgsFeatureId id ) const { return mChangedAttributeValues.contains( id ); } /** Returns a list of deleted attributes fields which are not committed. The list is kept sorted. - * @see isAttributeDeleted() + * \see isAttributeDeleted() */ QgsAttributeList deletedAttributeIds() const { return mDeletedAttributeIds; } /** Returns true if the specified attribute has been deleted but not committed. - * @param index attribute index + * \param index attribute index * \since QGIS 3.0 - * @see deletedAttributeIds() + * \see deletedAttributeIds() */ bool isAttributeDeleted( int index ) const { return mDeletedAttributeIds.contains( index ); } @@ -138,26 +138,26 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject QList addedAttributes() const { return mAddedAttributes; } /** Returns a map of features with changed geometries which are not committed. - * @see hasFeatureGeometryChange() + * \see hasFeatureGeometryChange() */ QgsGeometryMap changedGeometries() const { return mChangedGeometries; } /** Returns true if the specified feature ID has had its geometry changed but not committed. - * @param id feature ID + * \param id feature ID * \since QGIS 3.0 - * @see changedGeometries() + * \see changedGeometries() */ bool isFeatureGeometryChanged( QgsFeatureId id ) const { return mChangedGeometries.contains( id ); } /** Returns a list of deleted feature IDs which are not committed. - * @see isFeatureDeleted() + * \see isFeatureDeleted() */ QgsFeatureIds deletedFeatureIds() const { return mDeletedFeatureIds; } /** Returns true if the specified feature ID has been deleted but not committed. - * @param id feature ID + * \param id feature ID * \since QGIS 3.0 - * @see deletedFeatureIds() + * \see deletedFeatureIds() */ bool isFeatureDeleted( QgsFeatureId id ) const { return mDeletedFeatureIds.contains( id ); } @@ -174,8 +174,8 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject void featureDeleted( QgsFeatureId fid ); /** Emitted when a feature's geometry is changed. - * @param fid feature ID - * @param geom new feature geometry + * \param fid feature ID + * \param geom new feature geometry */ void geometryChanged( QgsFeatureId fid, const QgsGeometry &geom ); @@ -184,8 +184,8 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject void attributeDeleted( int idx ); /** Emitted when an attribute has been renamed - * @param idx attribute index - * @param newName new attribute name + * \param idx attribute index + * \param newName new attribute name * \since QGIS 2.16 */ void attributeRenamed( int idx, const QString &newName ); @@ -195,8 +195,8 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject void committedAttributesAdded( const QString &layerId, const QList &addedAttributes ); /** Emitted after committing an attribute rename - * @param layerId ID of layer - * @param renamedAttributes map of field index to new name + * \param layerId ID of layer + * \param renamedAttributes map of field index to new name * \since QGIS 2.16 */ void committedAttributesRenamed( const QString &layerId, const QgsFieldNameMap &renamedAttributes ); diff --git a/src/core/qgsvectorlayereditutils.h b/src/core/qgsvectorlayereditutils.h index 94b00bf9729a..d013a2f8be99 100644 --- a/src/core/qgsvectorlayereditutils.h +++ b/src/core/qgsvectorlayereditutils.h @@ -57,23 +57,23 @@ class CORE_EXPORT QgsVectorLayerEditUtils /** Moves the vertex at the given position number, * ring and item (first number is index 0), and feature * to the given coordinates - * @note available in Python bindings as moveVertexV2 + * \note available in Python bindings as moveVertexV2 */ bool moveVertex( const QgsPointV2 &p, QgsFeatureId atFeatureId, int atVertex ); /** Deletes a vertex from a feature. - * @param featureId ID of feature to remove vertex from - * @param vertex index of vertex to delete + * \param featureId ID of feature to remove vertex from + * \param vertex index of vertex to delete * \since QGIS 2.14 */ QgsVectorLayer::EditResult deleteVertex( QgsFeatureId featureId, int vertex ); /** Adds a ring to polygon/multipolygon features - * @param ring ring to add - * @param targetFeatureIds if specified, only these features will be the candidates for adding a ring. Otherwise + * \param ring ring to add + * \param targetFeatureIds if specified, only these features will be the candidates for adding a ring. Otherwise * all intersecting features are tested and the ring is added to the first valid feature. - * @param modifiedFeatureId if specified, feature ID for feature that ring was added to will be stored in this parameter - * @return + * \param modifiedFeatureId if specified, feature ID for feature that ring was added to will be stored in this parameter + * \returns * 0 in case of success, * 1 problem with feature type, * 2 ring not closed, @@ -85,24 +85,24 @@ class CORE_EXPORT QgsVectorLayerEditUtils int addRing( const QList &ring, const QgsFeatureIds &targetFeatureIds = QgsFeatureIds(), QgsFeatureId *modifiedFeatureId = nullptr ); /** Adds a ring to polygon/multipolygon features - * @param ring ring to add - * @param targetFeatureIds if specified, only these features will be the candidates for adding a ring. Otherwise + * \param ring ring to add + * \param targetFeatureIds if specified, only these features will be the candidates for adding a ring. Otherwise * all intersecting features are tested and the ring is added to the first valid feature. - * @param modifiedFeatureId if specified, feature ID for feature that ring was added to will be stored in this parameter - * @return + * \param modifiedFeatureId if specified, feature ID for feature that ring was added to will be stored in this parameter + * \returns * 0 in case of success, * 1 problem with feature type, * 2 ring not closed, * 3 ring not valid, * 4 ring crosses existing rings, * 5 no feature found where ring can be inserted - * @note available in Python bindings as addCurvedRing + * \note available in Python bindings as addCurvedRing */ // TODO QGIS 3.0 returns an enum instead of a magic constant int addRing( QgsCurve *ring, const QgsFeatureIds &targetFeatureIds = QgsFeatureIds(), QgsFeatureId *modifiedFeatureId = nullptr ); /** Adds a new part polygon to a multipart feature - * @return + * \returns * 0 in case of success, * 1 if selected feature is not multipart, * 2 if ring is not a valid geometry, @@ -115,7 +115,7 @@ class CORE_EXPORT QgsVectorLayerEditUtils int addPart( const QList &ring, QgsFeatureId featureId ); /** Adds a new part polygon to a multipart feature - * @return + * \returns * 0 in case of success, * 1 if selected feature is not multipart, * 2 if ring is not a valid geometry, @@ -123,27 +123,27 @@ class CORE_EXPORT QgsVectorLayerEditUtils * 4 if no feature was selected, * 5 if several features are selected, * 6 if selected geometry not found - * @note available in Python bindings as addPartV2 + * \note available in Python bindings as addPartV2 */ // TODO QGIS 3.0 returns an enum instead of a magic constant int addPart( const QgsPointSequence &ring, QgsFeatureId featureId ); - // @note available in Python bindings as addCurvedPart + // \note available in Python bindings as addCurvedPart // TODO QGIS 3.0 returns an enum instead of a magic constant int addPart( QgsCurve *ring, QgsFeatureId featureId ); /** Translates feature by dx, dy - * @param featureId id of the feature to translate - * @param dx translation of x-coordinate - * @param dy translation of y-coordinate - * @return 0 in case of success + * \param featureId id of the feature to translate + * \param dx translation of x-coordinate + * \param dy translation of y-coordinate + * \returns 0 in case of success */ int translateFeature( QgsFeatureId featureId, double dx, double dy ); /** Splits parts cut by the given line - * @param splitLine line that splits the layer feature parts - * @param topologicalEditing true if topological editing is enabled - * @return + * \param splitLine line that splits the layer feature parts + * \param topologicalEditing true if topological editing is enabled + * \returns * 0 in case of success, * 4 if there is a selection but no feature split */ @@ -151,9 +151,9 @@ class CORE_EXPORT QgsVectorLayerEditUtils int splitParts( const QList &splitLine, bool topologicalEditing = false ); /** Splits features cut by the given line - * @param splitLine line that splits the layer features - * @param topologicalEditing true if topological editing is enabled - * @return + * \param splitLine line that splits the layer features + * \param topologicalEditing true if topological editing is enabled + * \returns * 0 in case of success, * 4 if there is a selection but no feature split */ @@ -161,9 +161,9 @@ class CORE_EXPORT QgsVectorLayerEditUtils int splitFeatures( const QList &splitLine, bool topologicalEditing = false ); /** Adds topological points for every vertex of the geometry. - * @param geom the geometry where each vertex is added to segments of other features - * @note geom is not going to be modified by the function - * @return 0 in case of success + * \param geom the geometry where each vertex is added to segments of other features + * \note geom is not going to be modified by the function + * \returns 0 in case of success */ int addTopologicalPoints( const QgsGeometry &geom ); @@ -171,22 +171,22 @@ class CORE_EXPORT QgsVectorLayerEditUtils * already have a vertex there. If a feature already has a vertex at position p, * no additional vertex is inserted. This method is useful for topological * editing. - * @param p position of the vertex - * @return 0 in case of success + * \param p position of the vertex + * \returns 0 in case of success */ int addTopologicalPoints( const QgsPoint &p ); /** Inserts vertices to the snapped segments. * This is useful for topological editing if snap to segment is enabled. - * @param snapResults results collected from the snapping operation - * @return 0 in case of success + * \param snapResults results collected from the snapping operation + * \returns 0 in case of success */ int insertSegmentVerticesForSnap( const QList &snapResults ); protected: /** Little helper function that gives bounding box from a list of points. - @return 0 in case of success */ + \returns 0 in case of success */ int boundingBoxFromPointList( const QList &list, double &xmin, double &ymin, double &xmax, double &ymax ) const; QgsVectorLayer *L = nullptr; diff --git a/src/core/qgsvectorlayerfeatureiterator.h b/src/core/qgsvectorlayerfeatureiterator.h index d2d053716f30..9cd90dc81838 100644 --- a/src/core/qgsvectorlayerfeatureiterator.h +++ b/src/core/qgsvectorlayerfeatureiterator.h @@ -35,14 +35,14 @@ class QgsVectorLayerFeatureIterator; /** \ingroup core * Partial snapshot of vector layer's state (only the members necessary for access to features) - * @note not available in Python bindings + * \note not available in Python bindings */ class CORE_EXPORT QgsVectorLayerFeatureSource : public QgsAbstractFeatureSource { public: /** Constructor for QgsVectorLayerFeatureSource. - * @param layer source layer + * \param layer source layer */ explicit QgsVectorLayerFeatureSource( const QgsVectorLayer *layer ); @@ -105,34 +105,34 @@ class CORE_EXPORT QgsVectorLayerFeatureIterator : public QgsAbstractFeatureItera //! Setup the simplification of geometries to fetch using the specified simplify method virtual bool prepareSimplification( const QgsSimplifyMethod &simplifyMethod ) override; - //! @note not available in Python bindings + //! \note not available in Python bindings void rewindEditBuffer(); - //! @note not available in Python bindings + //! \note not available in Python bindings void prepareJoin( int fieldIdx ); - //! @note not available in Python bindings + //! \note not available in Python bindings void prepareExpression( int fieldIdx ); - //! @note not available in Python bindings + //! \note not available in Python bindings void prepareFields(); - //! @note not available in Python bindings + //! \note not available in Python bindings void prepareField( int fieldIdx ); - //! @note not available in Python bindings + //! \note not available in Python bindings bool fetchNextAddedFeature( QgsFeature &f ); - //! @note not available in Python bindings + //! \note not available in Python bindings bool fetchNextChangedGeomFeature( QgsFeature &f ); - //! @note not available in Python bindings + //! \note not available in Python bindings bool fetchNextChangedAttributeFeature( QgsFeature &f ); - //! @note not available in Python bindings + //! \note not available in Python bindings void useAddedFeature( const QgsFeature &src, QgsFeature &f ); - //! @note not available in Python bindings + //! \note not available in Python bindings void useChangedAttributeFeature( QgsFeatureId fid, const QgsGeometry &geom, QgsFeature &f ); - //! @note not available in Python bindings + //! \note not available in Python bindings bool nextFeatureFid( QgsFeature &f ); - //! @note not available in Python bindings + //! \note not available in Python bindings void addJoinedAttributes( QgsFeature &f ); /** @@ -141,26 +141,26 @@ class CORE_EXPORT QgsVectorLayerFeatureIterator : public QgsAbstractFeatureItera * - Joined fields * - Expression fields * - * @param f The feature will be modified - * @note not available in Python bindings + * \param f The feature will be modified + * \note not available in Python bindings */ void addVirtualAttributes( QgsFeature &f ); /** Adds an expression based attribute to a feature - * @param f feature - * @param attrIndex attribute index + * \param f feature + * \param attrIndex attribute index * \since QGIS 2.14 - * @note not available in Python bindings + * \note not available in Python bindings */ void addExpressionAttribute( QgsFeature &f, int attrIndex ); /** Update feature with uncommitted attribute updates. - * @note not available in Python bindings + * \note not available in Python bindings */ void updateChangedAttributes( QgsFeature &f ); /** Update feature with uncommitted geometry updates. - * @note not available in Python bindings + * \note not available in Python bindings */ void updateFeatureGeometry( QgsFeature &f ); diff --git a/src/core/qgsvectorlayerimport.h b/src/core/qgsvectorlayerimport.h index 85c8600b351c..9f94fe63fc62 100644 --- a/src/core/qgsvectorlayerimport.h +++ b/src/core/qgsvectorlayerimport.h @@ -56,17 +56,17 @@ class CORE_EXPORT QgsVectorLayerImport /** * Writes the contents of vector layer to a different datasource. - * @param layer source layer - * @param uri URI for destination data source - * @param providerKey string key for destination data provider - * @param destCRS destination CRS, or an invalid (default constructed) CRS if + * \param layer source layer + * \param uri URI for destination data source + * \param providerKey string key for destination data provider + * \param destCRS destination CRS, or an invalid (default constructed) CRS if * not available - * @param onlySelected set to true to export only selected features - * @param errorMessage if non-null, will be set to any error messages - * @param skipAttributeCreation set to true to skip exporting feature attributes - * @param options optional provider dataset options - * @param progress optional progress dialog to show progress of export - * @returns NoError for a successful export, or encountered error + * \param onlySelected set to true to export only selected features + * \param errorMessage if non-null, will be set to any error messages + * \param skipAttributeCreation set to true to skip exporting feature attributes + * \param options optional provider dataset options + * \param progress optional progress dialog to show progress of export + * \returns NoError for a successful export, or encountered error */ static ImportError importLayer( QgsVectorLayer *layer, const QString &uri, @@ -80,15 +80,15 @@ class CORE_EXPORT QgsVectorLayerImport ); /** Constructor for QgsVectorLayerImport. - * @param uri URI for destination data source - * @param provider string key for destination data provider - * @param fields fields to include in created layer - * @param geometryType destination geometry type - * @param crs desired CRS, or an invalid (default constructed) CRS if + * \param uri URI for destination data source + * \param provider string key for destination data provider + * \param fields fields to include in created layer + * \param geometryType destination geometry type + * \param crs desired CRS, or an invalid (default constructed) CRS if * not available - * @param overwrite set to true to overwrite any existing data source - * @param options optional provider dataset options - * @param progress optional progress dialog to show progress of export + * \param overwrite set to true to overwrite any existing data source + * \param options optional provider dataset options + * \param progress optional progress dialog to show progress of export */ QgsVectorLayerImport( const QString &uri, const QString &provider, diff --git a/src/core/qgsvectorlayerjoinbuffer.h b/src/core/qgsvectorlayerjoinbuffer.h index 59abce220834..6fe54fde305c 100644 --- a/src/core/qgsvectorlayerjoinbuffer.h +++ b/src/core/qgsvectorlayerjoinbuffer.h @@ -37,16 +37,16 @@ class CORE_EXPORT QgsVectorLayerJoinBuffer : public QObject QgsVectorLayerJoinBuffer( QgsVectorLayer *layer = nullptr ); /** Joins another vector layer to this layer - @param joinInfo join object containing join layer id, target and source field - @return (since 2.6) whether the join was successfully added */ + \param joinInfo join object containing join layer id, target and source field + \returns (since 2.6) whether the join was successfully added */ bool addJoin( const QgsVectorLayerJoinInfo &joinInfo ); /** Removes a vector layer join - @returns true if join was found and successfully removed */ + \returns true if join was found and successfully removed */ bool removeJoin( const QString &joinLayerId ); /** Updates field map with joined attributes - @param fields map to append joined attributes + \param fields map to append joined attributes */ void updateFields( QgsFields &fields ); @@ -70,9 +70,9 @@ class CORE_EXPORT QgsVectorLayerJoinBuffer : public QObject const QgsVectorJoinList &vectorJoins() const { return mVectorJoins; } /** Finds the vector join for a layer field index. - @param index this layers attribute index - @param fields fields of the vector layer (including joined fields) - @param sourceFieldIndex Output: field's index in source layer */ + \param index this layers attribute index + \param fields fields of the vector layer (including joined fields) + \param sourceFieldIndex Output: field's index in source layer */ const QgsVectorLayerJoinInfo *joinForFieldIndex( int index, const QgsFields &fields, int &sourceFieldIndex ) const; //! Find out what is the first index of the join within fields. Returns -1 if join is not present diff --git a/src/core/qgsvectorlayerlabeling.h b/src/core/qgsvectorlayerlabeling.h index 4221d2e097f5..702c0aa7a027 100644 --- a/src/core/qgsvectorlayerlabeling.h +++ b/src/core/qgsvectorlayerlabeling.h @@ -31,8 +31,8 @@ class QgsVectorLayerLabelProvider; * Abstract base class - its implementations define different approaches to the labeling of a vector layer. * * \since QGIS 2.12 - * @note not available in Python bindings - * @note this class is not a part of public API yet. See notes in QgsLabelingEngine + * \note not available in Python bindings + * \note this class is not a part of public API yet. See notes in QgsLabelingEngine */ class CORE_EXPORT QgsAbstractVectorLayerLabeling { @@ -76,8 +76,8 @@ class CORE_EXPORT QgsAbstractVectorLayerLabeling * The configuration is kept in layer's custom properties for backward compatibility. * * \since QGIS 2.12 - * @note not available in Python bindings - * @note this class is not a part of public API yet. See notes in QgsLabelingEngine + * \note not available in Python bindings + * \note this class is not a part of public API yet. See notes in QgsLabelingEngine */ class CORE_EXPORT QgsVectorLayerSimpleLabeling : public QgsAbstractVectorLayerLabeling { diff --git a/src/core/qgsvectorlayerlabelprovider.h b/src/core/qgsvectorlayerlabelprovider.h index 45636ace80e0..3bf62764d7fa 100644 --- a/src/core/qgsvectorlayerlabelprovider.h +++ b/src/core/qgsvectorlayerlabelprovider.h @@ -25,13 +25,13 @@ class QgsFeatureRenderer; class QgsSymbol; /** \ingroup core - * @brief The QgsVectorLayerLabelProvider class implements a label provider + * \brief The QgsVectorLayerLabelProvider class implements a label provider * for vector layers. Parameters for the labeling are taken from the layer's * custom properties or from the given settings. * * \since QGIS 2.12 - * @note this class is not a part of public API yet. See notes in QgsLabelingEngine - * @note not available in Python bindings + * \note this class is not a part of public API yet. See notes in QgsLabelingEngine + * \note not available in Python bindings */ class CORE_EXPORT QgsVectorLayerLabelProvider : public QgsAbstractLabelProvider { @@ -54,19 +54,19 @@ class CORE_EXPORT QgsVectorLayerLabelProvider : public QgsAbstractLabelProvider /** * Prepare for registration of features. Must be called after provider has been added to engine (uses its map settings) - * @param context render context. - * @param attributeNames list of attribute names to which additional required attributes shall be added - * @return Whether the preparation was successful - if not, the provider shall not be used + * \param context render context. + * \param attributeNames list of attribute names to which additional required attributes shall be added + * \returns Whether the preparation was successful - if not, the provider shall not be used */ virtual bool prepare( const QgsRenderContext &context, QSet &attributeNames ); /** * Register a feature for labeling as one or more QgsLabelFeature objects stored into mLabels * - * @param feature feature to label - * @param context render context. The QgsExpressionContext contained within the render context + * \param feature feature to label + * \param context render context. The QgsExpressionContext contained within the render context * must have already had the feature and fields sets prior to calling this method. - * @param obstacleGeometry optional obstacle geometry, if a different geometry to the feature's geometry + * \param obstacleGeometry optional obstacle geometry, if a different geometry to the feature's geometry * should be used as an obstacle for labels (e.g., if the feature has been rendered with an offset point * symbol, the obstacle geometry should represent the bounds of the offset symbol). If not set, * the feature's original geometry will be used as an obstacle for labels. @@ -76,9 +76,9 @@ class CORE_EXPORT QgsVectorLayerLabelProvider : public QgsAbstractLabelProvider /** Returns the geometry for a point feature which should be used as an obstacle for labels. This * obstacle geometry will respect the dimensions and offsets of the symbol used to render the * point, and ensures that labels will not overlap large or offset points. - * @param fet point feature - * @param context render context - * @param symbols symbols rendered for point feature + * \param fet point feature + * \param context render context + * \param symbols symbols rendered for point feature * \since QGIS 2.14 */ static QgsGeometry *getPointObstacleGeometry( QgsFeature &fet, QgsRenderContext &context, const QgsSymbolList &symbols ); diff --git a/src/core/qgsvectorlayerrenderer.h b/src/core/qgsvectorlayerrenderer.h index 4571f2cfc47f..c9aeb8015f4e 100644 --- a/src/core/qgsvectorlayerrenderer.h +++ b/src/core/qgsvectorlayerrenderer.h @@ -46,7 +46,7 @@ class QgsVectorLayerDiagramProvider; /** \ingroup core * Interruption checker used by QgsVectorLayerRenderer::render() - * @note not available in Python bindings + * \note not available in Python bindings */ class QgsVectorLayerRendererInterruptionChecker: public QgsInterruptionChecker { @@ -62,7 +62,7 @@ class QgsVectorLayerRendererInterruptionChecker: public QgsInterruptionChecker * Implementation of threaded rendering for vector layers. * * \since QGIS 2.4 - * @note not available in Python bindings + * \note not available in Python bindings */ class QgsVectorLayerRenderer : public QgsMapLayerRenderer { @@ -73,14 +73,14 @@ class QgsVectorLayerRenderer : public QgsMapLayerRenderer virtual bool render() override; //! where to save the cached geometries - //! @note The way how geometries are cached is really suboptimal - this method may be removed in future releases + //! \note The way how geometries are cached is really suboptimal - this method may be removed in future releases void setGeometryCachePointer( QgsGeometryCache *cache ); private: /** Registers label and diagram layer - @param layer diagram layer - @param attributeNames attributes needed for labeling and diagrams will be added to the list + \param layer diagram layer + \param attributeNames attributes needed for labeling and diagrams will be added to the list */ void prepareLabeling( QgsVectorLayer *layer, QSet &attributeNames ); void prepareDiagrams( QgsVectorLayer *layer, QSet &attributeNames ); diff --git a/src/core/qgsvectorlayertools.h b/src/core/qgsvectorlayertools.h index 613bfb4dd16f..6dafd237e25b 100644 --- a/src/core/qgsvectorlayertools.h +++ b/src/core/qgsvectorlayertools.h @@ -44,11 +44,11 @@ class CORE_EXPORT QgsVectorLayerTools : public QObject /** * This method should/will be called, whenever a new feature will be added to the layer * - * @param layer The layer to which the feature should be added - * @param defaultValues Default values for the feature to add - * @param defaultGeometry A default geometry to add to the feature - * @param feature Updated feature after adding will be written back to this - * @return True in case of success, False if the operation failed/was aborted + * \param layer The layer to which the feature should be added + * \param defaultValues Default values for the feature to add + * \param defaultGeometry A default geometry to add to the feature + * \param feature Updated feature after adding will be written back to this + * \returns True in case of success, False if the operation failed/was aborted * * TODO QGIS 3: remove const qualifier */ @@ -59,9 +59,9 @@ class CORE_EXPORT QgsVectorLayerTools : public QObject * capability to edit in here. * If successful layer->startEditing() will be called and true returned. * - * @param layer The layer on which to start an edit session + * \param layer The layer on which to start an edit session * - * @return True, if the editing session was started + * \returns True, if the editing session was started * * TODO QGIS 3: remove const qualifier */ @@ -71,9 +71,9 @@ class CORE_EXPORT QgsVectorLayerTools : public QObject * Will be called, when an editing session is ended and the features should be committed. * Appropriate dialogs should be shown like * - * @param layer The layer to commit - * @param allowCancel True if a cancel button should be offered - * @return True if successful + * \param layer The layer to commit + * \param allowCancel True if a cancel button should be offered + * \returns True if successful * * TODO QGIS 3: remove const qualifier */ @@ -82,8 +82,8 @@ class CORE_EXPORT QgsVectorLayerTools : public QObject /** * Should be called, when the features should be committed but the editing session is not ended. * - * @param layer The layer to commit - * @return True if successful + * \param layer The layer to commit + * \returns True if successful * * TODO QGIS 3: remove const qualifier */ @@ -92,12 +92,12 @@ class CORE_EXPORT QgsVectorLayerTools : public QObject /** * Copy and move features with defined translation. * - * @param layer The layer - * @param request The request for the features to be moved. It will be assigned to a new feature request with the newly copied features. - * @param dx The translation on x - * @param dy The translation on y - * @param errorMsg If given, it will contain the error message - * @return True if all features could be copied. + * \param layer The layer + * \param request The request for the features to be moved. It will be assigned to a new feature request with the newly copied features. + * \param dx The translation on x + * \param dy The translation on y + * \param errorMsg If given, it will contain the error message + * \returns True if all features could be copied. * * TODO QGIS 3: remove const qualifier */ diff --git a/src/core/qgsvectorlayerundocommand.h b/src/core/qgsvectorlayerundocommand.h index ac907dfc9f19..b9afc7d339bb 100644 --- a/src/core/qgsvectorlayerundocommand.h +++ b/src/core/qgsvectorlayerundocommand.h @@ -42,7 +42,7 @@ class CORE_EXPORT QgsVectorLayerUndoCommand : public QUndoCommand public: /** Constructor for QgsVectorLayerUndoCommand - * @param buffer associated edit buffer + * \param buffer associated edit buffer */ QgsVectorLayerUndoCommand( QgsVectorLayerEditBuffer *buffer ) : QUndoCommand() @@ -72,8 +72,8 @@ class CORE_EXPORT QgsVectorLayerUndoCommandAddFeature : public QgsVectorLayerUnd public: /** Constructor for QgsVectorLayerUndoCommandAddFeature - * @param buffer associated edit buffer - * @param f feature to add to layer + * \param buffer associated edit buffer + * \param f feature to add to layer */ QgsVectorLayerUndoCommandAddFeature( QgsVectorLayerEditBuffer *buffer, QgsFeature &f ); @@ -95,8 +95,8 @@ class CORE_EXPORT QgsVectorLayerUndoCommandDeleteFeature : public QgsVectorLayer public: /** Constructor for QgsVectorLayerUndoCommandDeleteFeature - * @param buffer associated edit buffer - * @param fid feature ID of feature to delete from layer + * \param buffer associated edit buffer + * \param fid feature ID of feature to delete from layer */ QgsVectorLayerUndoCommandDeleteFeature( QgsVectorLayerEditBuffer *buffer, QgsFeatureId fid ); @@ -118,9 +118,9 @@ class CORE_EXPORT QgsVectorLayerUndoCommandChangeGeometry : public QgsVectorLaye public: /** Constructor for QgsVectorLayerUndoCommandChangeGeometry - * @param buffer associated edit buffer - * @param fid feature ID of feature to modify geometry of - * @param newGeom new geometry for feature + * \param buffer associated edit buffer + * \param fid feature ID of feature to modify geometry of + * \param newGeom new geometry for feature */ QgsVectorLayerUndoCommandChangeGeometry( QgsVectorLayerEditBuffer *buffer, QgsFeatureId fid, const QgsGeometry &newGeom ); @@ -146,11 +146,11 @@ class CORE_EXPORT QgsVectorLayerUndoCommandChangeAttribute : public QgsVectorLay public: /** Constructor for QgsVectorLayerUndoCommandChangeAttribute - * @param buffer associated edit buffer - * @param fid feature ID of feature to modify - * @param fieldIndex index of field to modify - * @param newValue new value of attribute - * @param oldValue previous value of attribute + * \param buffer associated edit buffer + * \param fid feature ID of feature to modify + * \param fieldIndex index of field to modify + * \param newValue new value of attribute + * \param oldValue previous value of attribute */ QgsVectorLayerUndoCommandChangeAttribute( QgsVectorLayerEditBuffer *buffer, QgsFeatureId fid, int fieldIndex, const QVariant &newValue, const QVariant &oldValue ); virtual void undo() override; @@ -174,8 +174,8 @@ class CORE_EXPORT QgsVectorLayerUndoCommandAddAttribute : public QgsVectorLayerU public: /** Constructor for QgsVectorLayerUndoCommandAddAttribute - * @param buffer associated edit buffer - * @param field definition of new field to add + * \param buffer associated edit buffer + * \param field definition of new field to add */ QgsVectorLayerUndoCommandAddAttribute( QgsVectorLayerEditBuffer *buffer, const QgsField &field ); @@ -197,8 +197,8 @@ class CORE_EXPORT QgsVectorLayerUndoCommandDeleteAttribute : public QgsVectorLay public: /** Constructor for QgsVectorLayerUndoCommandDeleteAttribute - * @param buffer associated edit buffer - * @param fieldIndex index of field to delete + * \param buffer associated edit buffer + * \param fieldIndex index of field to delete */ QgsVectorLayerUndoCommandDeleteAttribute( QgsVectorLayerEditBuffer *buffer, int fieldIndex ); @@ -229,9 +229,9 @@ class CORE_EXPORT QgsVectorLayerUndoCommandRenameAttribute : public QgsVectorLay public: /** Constructor for QgsVectorLayerUndoCommandRenameAttribute - * @param buffer associated edit buffer - * @param fieldIndex index of field to rename - * @param newName new name for field + * \param buffer associated edit buffer + * \param fieldIndex index of field to rename + * \param newName new name for field */ QgsVectorLayerUndoCommandRenameAttribute( QgsVectorLayerEditBuffer *buffer, int fieldIndex, const QString &newName ); diff --git a/src/core/qgsvectorlayerutils.h b/src/core/qgsvectorlayerutils.h index 1b4fc9ac7db7..55346ec9cb02 100644 --- a/src/core/qgsvectorlayerutils.h +++ b/src/core/qgsvectorlayerutils.h @@ -35,14 +35,14 @@ class CORE_EXPORT QgsVectorLayerUtils * Returns true if the specified value already exists within a field. This method can be used to test for uniqueness * of values inside a layer's attributes. An optional list of ignored feature IDs can be provided, if so, any features * with IDs within this list are ignored when testing for existence of the value. - * @see createUniqueValue() + * \see createUniqueValue() */ static bool valueExists( const QgsVectorLayer *layer, int fieldIndex, const QVariant &value, const QgsFeatureIds &ignoreIds = QgsFeatureIds() ); /** * Returns a new attribute value for the specified field index which is guaranteed to be unique. The optional seed * value can be used as a basis for generated values. - * @see valueExists() + * \see valueExists() */ static QVariant createUniqueValue( const QgsVectorLayer *layer, int fieldIndex, const QVariant &seed = QVariant() ); diff --git a/src/core/qgswebframe.h b/src/core/qgswebframe.h index 515ff11b5ea2..bf6d588a6b7a 100644 --- a/src/core/qgswebframe.h +++ b/src/core/qgswebframe.h @@ -28,7 +28,7 @@ #include /** \ingroup core - * @brief The QWebFrame class is a collection of stubs to mimic the API of a QWebFrame on systems + * \brief The QWebFrame class is a collection of stubs to mimic the API of a QWebFrame on systems * where QtWebkit is not available. */ class CORE_EXPORT QWebFrame : public QObject diff --git a/src/core/qgswebpage.h b/src/core/qgswebpage.h index c62adfbe51d4..9f59e970b9c3 100644 --- a/src/core/qgswebpage.h +++ b/src/core/qgswebpage.h @@ -33,7 +33,7 @@ /** \ingroup core - * @brief The QWebSettings class is a collection of stubs to mimic the API of a QWebSettings on systems + * \brief The QWebSettings class is a collection of stubs to mimic the API of a QWebSettings on systems * where QtWebkit is not available. */ class CORE_EXPORT QWebSettings : public QObject @@ -94,7 +94,7 @@ class CORE_EXPORT QWebSettings : public QObject /** * \ingroup core - * @brief The QWebPage class is a collection of stubs to mimic the API of a QWebPage on systems + * \brief The QWebPage class is a collection of stubs to mimic the API of a QWebPage on systems * where QtWebkit is not available. */ class CORE_EXPORT QWebPage : public QObject @@ -212,7 +212,7 @@ class CORE_EXPORT QgsWebPage : public QWebPage public: /** Constructor for QgsWebPage. - * @param parent parent object + * \param parent parent object */ explicit QgsWebPage( QObject *parent = 0 ) : QWebPage( parent ) @@ -221,14 +221,14 @@ class CORE_EXPORT QgsWebPage : public QWebPage /** Sets an identifier for the QgsWebPage. The page's identifier is included in messages written to the * log, and should be set to a user-friendly string so that users can identify which QgsWebPage has * logged the message. - * @param identifier identifier string - * @see identifier() + * \param identifier identifier string + * \see identifier() */ void setIdentifier( const QString &identifier ) { mIdentifier = identifier; } /** Returns the QgsWebPage's identifier. The page's identifier is included in messages written to the * log so that users can identify which QgsWebPage has logged the message. - * @see setIdentifier() + * \see setIdentifier() */ QString identifier() const { return mIdentifier; } diff --git a/src/core/qgswebview.h b/src/core/qgswebview.h index 311af76005aa..f44f39c3e49e 100644 --- a/src/core/qgswebview.h +++ b/src/core/qgswebview.h @@ -51,7 +51,7 @@ class QPrinter; /** \ingroup core - * @brief The QgsWebView class is a collection of stubs to mimic the API of QWebView on systems where the real + * \brief The QgsWebView class is a collection of stubs to mimic the API of QWebView on systems where the real * library is not available. It should be used instead of QWebView inside QGIS. * * If QGIS is compiled WITH_QTWEBKIT This will simply be a subclass of QWebView. If it is compiled with diff --git a/src/core/qgsxmlutils.h b/src/core/qgsxmlutils.h index 404eb6f64b70..4938c6eca842 100644 --- a/src/core/qgsxmlutils.h +++ b/src/core/qgsxmlutils.h @@ -34,9 +34,9 @@ class CORE_EXPORT QgsXmlUtils /* reading */ /** Decodes a distance unit from a DOM element. - * @param element DOM element to decode - * @returns distance units - * @see writeMapUnits() + * \param element DOM element to decode + * \returns distance units + * \see writeMapUnits() */ static QgsUnitTypes::DistanceUnit readMapUnits( const QDomElement &element ); @@ -45,10 +45,10 @@ class CORE_EXPORT QgsXmlUtils /* writing */ /** Encodes a distance unit to a DOM element. - * @param units units to encode - * @param doc DOM document - * @returns element containing encoded units - * @see readMapUnits() + * \param units units to encode + * \param doc DOM document + * \returns element containing encoded units + * \see readMapUnits() */ static QDomElement writeMapUnits( QgsUnitTypes::DistanceUnit units, QDomDocument &doc ); diff --git a/src/core/raster/qgscolorrampshader.h b/src/core/raster/qgscolorrampshader.h index 97266447c323..c011f77ecdfe 100644 --- a/src/core/raster/qgscolorrampshader.h +++ b/src/core/raster/qgscolorrampshader.h @@ -56,12 +56,12 @@ class CORE_EXPORT QgsColorRampShader : public QgsRasterShaderFunction }; /** Creates a new color ramp shader. - * @param minimumValue minimum value for the raster shader - * @param maximumValue maximum value for the raster shader - * @param type interpolation type used - * @param classificationMode method used to classify the color ramp shader - * @param colorRamp vector color ramp used to classify the color ramp shader - * @returns new QgsColorRampShader + * \param minimumValue minimum value for the raster shader + * \param maximumValue maximum value for the raster shader + * \param type interpolation type used + * \param classificationMode method used to classify the color ramp shader + * \param colorRamp vector color ramp used to classify the color ramp shader + * \returns new QgsColorRampShader */ QgsColorRampShader( double minimumValue = 0.0, double maximumValue = 255.0, QgsColorRamp *colorRamp = nullptr, Type type = Interpolated, ClassificationMode classificationMode = Continuous ); @@ -113,13 +113,13 @@ class CORE_EXPORT QgsColorRampShader : public QgsRasterShaderFunction /** Get the source color ramp * \since QGIS 3.0 - * @see setSourceColorRamp() + * \see setSourceColorRamp() */ QgsColorRamp *sourceColorRamp() const; /** Set the source color ramp. Ownership is transferred to the renderer. * \since QGIS 3.0 - * @see sourceColorRamp() + * \see sourceColorRamp() */ void setSourceColorRamp( QgsColorRamp *colorramp ); @@ -127,17 +127,17 @@ class CORE_EXPORT QgsColorRampShader : public QgsRasterShaderFunction void setColorRampType( const QString &type ); /** Classify color ramp shader - * @param classes number of classes - * @param band raster band used in classification (only used in quantile mode) - * @param extent extent used in classification (only used in quantile mode) - * @param input raster input used in classification (only used in quantile mode) + * \param classes number of classes + * \param band raster band used in classification (only used in quantile mode) + * \param extent extent used in classification (only used in quantile mode) + * \param input raster input used in classification (only used in quantile mode) */ void classifyColorRamp( const int classes = 0, const int band = -1, const QgsRectangle &extent = QgsRectangle(), QgsRasterInterface *input = nullptr ); /** Classify color ramp shader - * @param band raster band used in classification (quantile mode only) - * @param extent extent used in classification (quantile mode only) - * @param input raster input used in classification (quantile mode only) + * \param band raster band used in classification (quantile mode only) + * \param extent extent used in classification (quantile mode only) + * \param input raster input used in classification (quantile mode only) */ void classifyColorRamp( const int band = -1, const QgsRectangle &extent = QgsRectangle(), QgsRasterInterface *input = nullptr ); @@ -157,13 +157,13 @@ class CORE_EXPORT QgsColorRampShader : public QgsRasterShaderFunction ClassificationMode classificationMode() const { return mClassificationMode; } /** Sets whether the shader should not render values out of range. - * @param clip set to true to clip values which are out of range. - * @see clip() + * \param clip set to true to clip values which are out of range. + * \see clip() */ void setClip( bool clip ) { mClip = clip; } /** Returns whether the shader will clip values which are out of range. - * @see setClip() + * \see setClip() */ bool clip() const { return mClip; } diff --git a/src/core/raster/qgshillshaderenderer.h b/src/core/raster/qgshillshaderenderer.h index 79da29c93d02..58011e7a79ba 100644 --- a/src/core/raster/qgshillshaderenderer.h +++ b/src/core/raster/qgshillshaderenderer.h @@ -29,7 +29,7 @@ class QgsRasterInterface; /** * \ingroup core - * @brief A renderer for generating live hillshade models. + * \brief A renderer for generating live hillshade models. * \since QGIS 2.16 */ class CORE_EXPORT QgsHillshadeRenderer : public QgsRasterRenderer @@ -37,21 +37,21 @@ class CORE_EXPORT QgsHillshadeRenderer : public QgsRasterRenderer public: /** - * @brief A renderer for generating live hillshade models. - * @param input The input raster interface - * @param band The band in the raster to use - * @param lightAzimuth The azimuth of the light source - * @param lightAltitude The altitude of the light source + * \brief A renderer for generating live hillshade models. + * \param input The input raster interface + * \param band The band in the raster to use + * \param lightAzimuth The azimuth of the light source + * \param lightAltitude The altitude of the light source */ QgsHillshadeRenderer( QgsRasterInterface *input, int band, double lightAzimuth, double lightAltitude ); QgsHillshadeRenderer *clone() const override; /** - * @brief Factory method to create a new renderer - * @param elem A DOM element to create the renderer from. - * @param input The raster input interface. - * @return A new QgsHillshadeRenderer. + * \brief Factory method to create a new renderer + * \param elem A DOM element to create the renderer from. + * \param input The raster input interface. + * \returns A new QgsHillshadeRenderer. */ static QgsRasterRenderer *create( const QDomElement &elem, QgsRasterInterface *input ); @@ -66,55 +66,55 @@ class CORE_EXPORT QgsHillshadeRenderer : public QgsRasterRenderer int band() const { return mBand; } /** Sets the band used by the renderer. - * @see band + * \see band */ void setBand( int bandNo ); /** * Returns the direction of the light over the raster between 0-360. - * @see setAzimuth() + * \see setAzimuth() */ double azimuth() const { return mLightAzimuth; } /** Returns the angle of the light source over the raster. - * @see setAltitude() + * \see setAltitude() */ double altitude() const { return mLightAngle; } /** Returns the Z scaling factor. - * @see setZFactor() + * \see setZFactor() */ double zFactor() const { return mZFactor; } /** Returns true if the renderer is using multi-directional hillshading. - * @see setMultiDirectional() + * \see setMultiDirectional() */ bool multiDirectional() const { return mMultiDirectional; } /** - * @brief Set the azimuth of the light source. - * @param azimuth The azimuth of the light source, between 0 and 360.0 - * @see azimuth() + * \brief Set the azimuth of the light source. + * \param azimuth The azimuth of the light source, between 0 and 360.0 + * \see azimuth() */ void setAzimuth( double azimuth ) { mLightAzimuth = azimuth; } /** - * @brief Set the altitude of the light source - * @param altitude the altitude - * @see altitude() + * \brief Set the altitude of the light source + * \param altitude the altitude + * \see altitude() */ void setAltitude( double altitude ) { mLightAngle = altitude; } /** - * @brief Set the Z scaling factor of the result image. - * @param zfactor The z factor - * @see zFactor() + * \brief Set the Z scaling factor of the result image. + * \param zfactor The z factor + * \see zFactor() */ void setZFactor( double zfactor ) { mZFactor = zfactor; } /** Sets whether to render using a multi-directional hillshade algorithm. - * @param isMultiDirectional set to true to use multi directional rendering - * @see multiDirectional() + * \param isMultiDirectional set to true to use multi directional rendering + * \see multiDirectional() */ void setMultiDirectional( bool isMultiDirectional ) { mMultiDirectional = isMultiDirectional; } diff --git a/src/core/raster/qgspalettedrasterrenderer.h b/src/core/raster/qgspalettedrasterrenderer.h index b44fd0e8b716..3094a2bc1897 100644 --- a/src/core/raster/qgspalettedrasterrenderer.h +++ b/src/core/raster/qgspalettedrasterrenderer.h @@ -95,49 +95,49 @@ class CORE_EXPORT QgsPalettedRasterRenderer: public QgsRasterRenderer /** * Set the source color \a ramp. Ownership is transferred to the renderer. - * @note added in QGIS 3.0 - * @see sourceColorRamp() + * \since QGIS 3.0 + * \see sourceColorRamp() */ void setSourceColorRamp( QgsColorRamp *ramp ); /** Get the source color ramp - * @note added in QGIS 3.0 - * @see setSourceColorRamp() + * \since QGIS 3.0 + * \see setSourceColorRamp() */ QgsColorRamp *sourceColorRamp() const; /** * Converts a raster color \a table to paletted renderer class data. - * @note added in QGIS 3.0 + * \since QGIS 3.0 */ static QgsPalettedRasterRenderer::ClassData colorTableToClassData( const QList &table ); /** * Converts a \a string containing a color table or class data to to paletted renderer class data. - * @note added in QGIS 3.0 - * @see classDataFromFile() - * @see classDataToString() + * \since QGIS 3.0 + * \see classDataFromFile() + * \see classDataToString() */ static QgsPalettedRasterRenderer::ClassData classDataFromString( const QString &string ); /** * Opens a color table file and returns corresponding paletted renderer class data. - * @note added in QGIS 3.0 - * @see classDataFromString() + * \since QGIS 3.0 + * \see classDataFromString() */ static QgsPalettedRasterRenderer::ClassData classDataFromFile( const QString &path ); /** * Converts classes to a string representation, using the .clr/gdal color table file format. - * @note added in QGIS 3.0 - * @see classDataFromString() + * \since QGIS 3.0 + * \see classDataFromString() */ static QString classDataToString( const QgsPalettedRasterRenderer::ClassData &classes ); /** * Generates class data from a \a raster, for the specified \a bandNumber. An optional * color \a ramp can be specified to automatically assign colors from the ramp. - * @note added in QGIS 3.0 + * \since QGIS 3.0 */ static QgsPalettedRasterRenderer::ClassData classDataFromRaster( QgsRasterInterface *raster, int bandNumber, QgsColorRamp *ramp = nullptr, QgsRasterBlockFeedback *feedback = nullptr ); diff --git a/src/core/raster/qgsraster.h b/src/core/raster/qgsraster.h index dc900b79b995..b4866031a43e 100644 --- a/src/core/raster/qgsraster.h +++ b/src/core/raster/qgsraster.h @@ -118,18 +118,18 @@ class CORE_EXPORT QgsRaster /** Check if the specified value is representable in the given data type. * Supported are numerical types Byte, UInt16, Int16, UInt32, Int32, Float32, Float64. - * @param value - * @param dataType + * \param value + * \param dataType * \since QGIS 2.16 - * @note not available in Python bindings */ + * \note not available in Python bindings */ static bool isRepresentableValue( double value, Qgis::DataType dataType ); /** Get value representable by given data type. * Supported are numerical types Byte, UInt16, Int16, UInt32, Int32, Float32, Float64. * This is done through C casting, so you have to be sure that the provided value is * representable in the output data type. This can be checked with isRepresentableValue(). - * @param value - * @param dataType + * \param value + * \param dataType * \since QGIS 2.1 */ static double representableValue( double value, Qgis::DataType dataType ); }; diff --git a/src/core/raster/qgsrasterblock.h b/src/core/raster/qgsrasterblock.h index 520423a6a31d..a17c352b4290 100644 --- a/src/core/raster/qgsrasterblock.h +++ b/src/core/raster/qgsrasterblock.h @@ -37,19 +37,19 @@ class CORE_EXPORT QgsRasterBlock QgsRasterBlock(); /** \brief Constructor which allocates data block in memory - * @param dataType raster data type - * @param width width of data matrix - * @param height height of data matrix + * \param dataType raster data type + * \param width width of data matrix + * \param height height of data matrix */ QgsRasterBlock( Qgis::DataType dataType, int width, int height ); virtual ~QgsRasterBlock(); /** \brief Reset block - * @param dataType raster data type - * @param width width of data matrix - * @param height height of data matrix - * @return true on success + * \param dataType raster data type + * \param width width of data matrix + * \param height height of data matrix + * \returns true on success */ bool reset( Qgis::DataType dataType, int width, int height ); @@ -126,129 +126,129 @@ class CORE_EXPORT QgsRasterBlock static Qgis::DataType typeWithNoDataValue( Qgis::DataType dataType, double *noDataValue ); /** True if the block has no data value. - * @return true if the block has no data value - * @see noDataValue(), setNoDataValue(), resetNoDataValue() + * \returns true if the block has no data value + * \see noDataValue(), setNoDataValue(), resetNoDataValue() */ bool hasNoDataValue() const { return mHasNoDataValue; } /** Returns true if the block may contain no data. It does not guarantee * that it really contains any no data. It can be used to speed up processing. * Not the difference between this method and hasNoDataValue(). - * @return true if the block may contain no data */ + * \returns true if the block may contain no data */ bool hasNoData() const; /** Sets cell value that will be considered as "no data". * \since QGIS 3.0 - * @see noDataValue(), hasNoDataValue(), resetNoDataValue() + * \see noDataValue(), hasNoDataValue(), resetNoDataValue() */ void setNoDataValue( double noDataValue ); /** Reset no data value: if there was a no data value previously set, * it will be discarded. * \since QGIS 3.0 - * @see noDataValue(), hasNoDataValue(), setNoDataValue() + * \see noDataValue(), hasNoDataValue(), setNoDataValue() */ void resetNoDataValue(); /** Return no data value. If the block does not have a no data value the * returned value is undefined. - * @return No data value - * @see hasNoDataValue(), setNoDataValue(), resetNoDataValue() + * \returns No data value + * \see hasNoDataValue(), setNoDataValue(), resetNoDataValue() */ double noDataValue() const { return mNoDataValue; } /** Get byte array representing a value. - * @param dataType data type - * @param value value - * @return byte array representing the value */ + * \param dataType data type + * \param value value + * \returns byte array representing the value */ static QByteArray valueBytes( Qgis::DataType dataType, double value ); /** \brief Read a single value if type of block is numeric. If type is color, * returned value is undefined. - * @param row row index - * @param column column index - * @return value */ + * \param row row index + * \param column column index + * \returns value */ double value( int row, int column ) const; /** \brief Read a single value if type of block is numeric. If type is color, * returned value is undefined. - * @param index data matrix index (long type in Python) - * @return value */ + * \param index data matrix index (long type in Python) + * \returns value */ double value( qgssize index ) const; /** \brief Read a single color - * @param row row index - * @param column column index - * @return color */ + * \param row row index + * \param column column index + * \returns color */ QRgb color( int row, int column ) const; /** \brief Read a single value - * @param index data matrix index (long type in Python) - * @return color */ + * \param index data matrix index (long type in Python) + * \returns color */ QRgb color( qgssize index ) const; /** \brief Check if value at position is no data - * @param row row index - * @param column column index - * @return true if value is no data */ + * \param row row index + * \param column column index + * \returns true if value is no data */ bool isNoData( int row, int column ); /** \brief Check if value at position is no data - * @param index data matrix index (long type in Python) - * @return true if value is no data */ + * \param index data matrix index (long type in Python) + * \returns true if value is no data */ bool isNoData( qgssize index ); /** \brief Set value on position - * @param row row index - * @param column column index - * @param value the value to be set - * @return true on success */ + * \param row row index + * \param column column index + * \param value the value to be set + * \returns true on success */ bool setValue( int row, int column, double value ); /** \brief Set value on index (indexed line by line) - * @param index data matrix index (long type in Python) - * @param value the value to be set - * @return true on success */ + * \param index data matrix index (long type in Python) + * \param value the value to be set + * \returns true on success */ bool setValue( qgssize index, double value ); /** \brief Set color on position - * @param row row index - * @param column column index - * @param color the color to be set, QRgb value - * @return true on success */ + * \param row row index + * \param column column index + * \param color the color to be set, QRgb value + * \returns true on success */ bool setColor( int row, int column, QRgb color ); /** \brief Set color on index (indexed line by line) - * @param index data matrix index (long type in Python) - * @param color the color to be set, QRgb value - * @return true on success */ + * \param index data matrix index (long type in Python) + * \param color the color to be set, QRgb value + * \returns true on success */ bool setColor( qgssize index, QRgb color ); /** \brief Set no data on pixel - * @param row row index - * @param column column index - * @return true on success */ + * \param row row index + * \param column column index + * \returns true on success */ bool setIsNoData( int row, int column ); /** \brief Set no data on pixel - * @param index data matrix index (long type in Python) - * @return true on success */ + * \param index data matrix index (long type in Python) + * \returns true on success */ bool setIsNoData( qgssize index ); /** \brief Set the whole block to no data - * @return true on success */ + * \returns true on success */ bool setIsNoData(); /** \brief Set the whole block to no data except specified rectangle - * @return true on success */ + * \returns true on success */ bool setIsNoDataExcept( QRect exceptRect ); /** \brief Remove no data flag on pixel. If the raster block does not have an explicit * no data value set then an internal map of no data pixels is maintained for the block. * In this case it is possible to reset a pixel to flag it as having valid data using this * method. This method has no effect for raster blocks with an explicit no data value set. - * @param row row index - * @param column column index + * \param row row index + * \param column column index * \since QGIS 2.10 */ void setIsData( int row, int column ); @@ -256,7 +256,7 @@ class CORE_EXPORT QgsRasterBlock * no data value set then an internal map of no data pixels is maintained for the block. * In this case it is possible to reset a pixel to flag it as having valid data using this * method. This method has no effect for raster blocks with an explicit no data value set. - * @param index data matrix index (long type in Python) + * \param index data matrix index (long type in Python) * \since QGIS 2.10 */ void setIsData( qgssize index ); @@ -265,7 +265,7 @@ class CORE_EXPORT QgsRasterBlock * owned by the QgsRasterBlock, therefore it is only valid while the QgsRasterBlock object * still exists. Writing to the returned QByteArray will not affect the original data: * a deep copy of the data will be made and only the local copy will be modified. - * @note in Python the method returns ordinary bytes object as the + * \note in Python the method returns ordinary bytes object as the * \since QGIS 3.0 */ QByteArray data() const; @@ -281,65 +281,67 @@ class CORE_EXPORT QgsRasterBlock void setData( const QByteArray &data, int offset = 0 ); /** \brief Get pointer to data - * @param row row index - * @param column column index - * @return pointer to data - * @note not available in Python bindings + * \param row row index + * \param column column index + * \returns pointer to data + * \note not available in Python bindings */ char *bits( int row, int column ); /** \brief Get pointer to data - * @param index data matrix index (long type in Python) - * @return pointer to data - * @note not available in Python bindings + * \param index data matrix index (long type in Python) + * \returns pointer to data + * \note not available in Python bindings */ char *bits( qgssize index ); /** \brief Get pointer to data - * @return pointer to data - * @note not available in Python bindings + * \returns pointer to data + * \note not available in Python bindings */ char *bits(); /** \brief Print double value with all necessary significant digits. * It is ensured that conversion back to double gives the same number. - * @param value the value to be printed - * @return string representing the value*/ + * \param value the value to be printed + * \returns string representing the value*/ static QString printValue( double value ); /** \brief Print float value with all necessary significant digits. * It is ensured that conversion back to float gives the same number. - * @param value the value to be printed - * @return string representing the value + * \param value the value to be printed + * \returns string representing the value * \since QGIS 2.16 - * @note not available in Python bindings + * \note not available in Python bindings */ static QString printValue( float value ); /** \brief Convert data to different type. - * @param destDataType dest data type - * @return true on success */ + * \param destDataType dest data type + * \returns true on success */ bool convert( Qgis::DataType destDataType ); /** \brief Get image if type is color. - * @return image */ + * \returns image */ QImage image() const; /** \brief set image. - * @param image image - * @return true on success */ + * \param image image + * \returns true on success */ bool setImage( const QImage *image ); - //! @note not available in Python bindings + //! \note not available in Python bindings inline static double readValue( void *data, Qgis::DataType type, qgssize index ); - //! @note not available in Python bindings + //! \note not available in Python bindings inline static void writeValue( void *data, Qgis::DataType type, qgssize index, double value ); void applyNoDataValues( const QgsRasterRangeList &rangeList ); - /** Apply band scale and offset to raster block values - * @\since QGIS 2.3 */ + /** + * Apply band scale and offset to raster block values + * \since QGIS 2.3 + */ void applyScaleOffset( double scale, double offset ); //! \brief Get error @@ -353,22 +355,22 @@ class CORE_EXPORT QgsRasterBlock /** \brief For extent and width, height find rectangle covered by subextent. * The output rect has x oriented from left to right and y from top to bottom * (upper-left to lower-right orientation). - * @param extent extent, usually the larger - * @param width numbers of columns in theExtent - * @param height numbers of rows in theExtent - * @param subExtent extent, usually smaller than theExtent - * @return the rectangle covered by sub extent + * \param extent extent, usually the larger + * \param width numbers of columns in theExtent + * \param height numbers of rows in theExtent + * \param subExtent extent, usually smaller than theExtent + * \returns the rectangle covered by sub extent */ static QRect subRect( const QgsRectangle &extent, int width, int height, const QgsRectangle &subExtent ); /** Returns the width (number of columns) of the raster block. - * @see height + * \see height * \since QGIS 2.10 */ int width() const { return mWidth; } /** Returns the height (number of rows) of the raster block. - * @see width + * \see width * \since QGIS 2.10 */ int height() const { return mHeight; } @@ -378,27 +380,27 @@ class CORE_EXPORT QgsRasterBlock static Qgis::DataType dataType( QImage::Format format ); /** Test if value is nodata comparing to noDataValue - * @param value tested value - * @param noDataValue no data value - * @return true if value is nodata */ + * \param value tested value + * \param noDataValue no data value + * \returns true if value is nodata */ static bool isNoDataValue( double value, double noDataValue ); /** Test if value is nodata for specific band - * @param value tested value - * @return true if value is nodata */ + * \param value tested value + * \returns true if value is nodata */ bool isNoDataValue( double value ) const; /** Allocate no data bitmap - * @return true on success */ + * \returns true on success */ bool createNoDataBitmap(); /** \brief Convert block of data from one type to another. Original block memory * is not release. - * @param srcData source data - * @param srcDataType source data type - * @param destDataType dest data type - * @param size block size (width * height) - * @return block of data in destDataType */ + * \param srcData source data + * \param srcDataType source data type + * \param destDataType dest data type + * \param size block size (width * height) + * \returns block of data in destDataType */ static void *convert( void *srcData, Qgis::DataType srcDataType, Qgis::DataType destDataType, qgssize size ); // Valid diff --git a/src/core/raster/qgsrasterchecker.h b/src/core/raster/qgsrasterchecker.h index 6f6fa949e0ba..708962ef000f 100644 --- a/src/core/raster/qgsrasterchecker.h +++ b/src/core/raster/qgsrasterchecker.h @@ -36,10 +36,10 @@ class CORE_EXPORT QgsRasterChecker /** * Test using renderer to generate the image to be compared. - * @param verifiedKey verified provider key - * @param verifiedUri URI of the raster to be verified - * @param expectedKey expected provider key - * @param expectedUri URI of the expected (control) raster + * \param verifiedKey verified provider key + * \param verifiedUri URI of the raster to be verified + * \param expectedKey expected provider key + * \param expectedUri URI of the expected (control) raster */ bool runTest( const QString &verifiedKey, QString verifiedUri, const QString &expectedKey, QString expectedUri ); diff --git a/src/core/raster/qgsrasterdataprovider.h b/src/core/raster/qgsrasterdataprovider.h index aa4083e69935..18fe07be32b9 100644 --- a/src/core/raster/qgsrasterdataprovider.h +++ b/src/core/raster/qgsrasterdataprovider.h @@ -60,13 +60,13 @@ class CORE_EXPORT QgsImageFetcher : public QObject QgsImageFetcher( QObject *parent = 0 ) : QObject( parent ) {} /** Starts the image download - * @note Make sure to connect to "finish" and "error" before starting */ + * \note Make sure to connect to "finish" and "error" before starting */ virtual void start() = 0; signals: /** Emitted when the download completes - * @param legend The downloaded legend image */ + * \param legend The downloaded legend image */ void finish( const QImage &legend ); //! Emitted to report progress void progress( qint64 received, qint64 total ); @@ -245,7 +245,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast * \param mapSettings map settings for legend providers supporting * contextual legends. * - * \return a download handler or null if the provider does not support + * \returns a download handler or null if the provider does not support * legend at all. Ownership of the returned object is transferred * to caller. * @@ -274,7 +274,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast } /** \brief Accessor for the raster layers pyramid list. - * @param overviewList used to construct the pyramid list (optional), when empty the list is defined by the provider. + * \param overviewList used to construct the pyramid list (optional), when empty the list is defined by the provider. * A pyramid list defines the * POTENTIAL pyramids that can be in a raster. To know which of the pyramid layers * ACTUALLY exists you need to look at the existsFlag member in each struct stored in the @@ -302,13 +302,13 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast * * \note The arbitraryness of the returned document is enforced by WMS standards * up to at least v1.3.0 - * @param point coordinates in data source CRS - * @param format result format - * @param boundingBox context bounding box - * @param width context width - * @param height context height - * @param dpi context dpi - * @return QgsRaster::IdentifyFormatValue: map of values for each band, keys are band numbers + * \param point coordinates in data source CRS + * \param format result format + * \param boundingBox context bounding box + * \param width context width + * \param height context height + * \param dpi context dpi + * \returns QgsRaster::IdentifyFormatValue: map of values for each band, keys are band numbers * (from 1). * QgsRaster::IdentifyFormatFeature: map of QgsRasterFeatureList for each sublayer * (WMS) - TODO: it is not consistent with QgsRaster::IdentifyFormatValue. @@ -357,18 +357,18 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast /** Checks whether the provider is in editing mode, i.e. raster write operations will be accepted. * By default providers are not editable. Use setEditable() method to enable/disable editing. - * @see setEditable(), writeBlock() + * \see setEditable(), writeBlock() * \since QGIS 3.0 */ virtual bool isEditable() const { return false; } /** Turns on/off editing mode of the provider. When in editing mode, it is possible * to overwrite data of the provider using writeBlock() calls. - * @note Only some providers support editing mode and even those may fail to turn + * \note Only some providers support editing mode and even those may fail to turn * the underlying data source into editing mode, so it is necessary to check the return * value whether the operation was successful. - * @returns true if the switch to/from editing mode was successful - * @see isEditable(), writeBlock() + * \returns true if the switch to/from editing mode was successful + * \see isEditable(), writeBlock() * \since QGIS 3.0 */ virtual bool setEditable( bool enabled ) { Q_UNUSED( enabled ); return false; } @@ -397,8 +397,8 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast * * Writing is supported only by some data providers. Provider has to be in editing mode * in order to allow write operations. - * @see isEditable(), setEditable() - * @returns true on success + * \see isEditable(), setEditable() + * \returns true on success * \since QGIS 3.0 */ bool writeBlock( QgsRasterBlock *block, int band, int xOffset = 0, int yOffset = 0 ); @@ -413,8 +413,8 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast const QStringList &createOptions = QStringList() ); /** Set no data value on created dataset - * @param bandNo band number - * @param noDataValue no data value + * \param bandNo band number + * \param noDataValue no data value */ virtual bool setNoDataValue( int bandNo, double noDataValue ) { Q_UNUSED( bandNo ); Q_UNUSED( noDataValue ); return false; } @@ -427,14 +427,14 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast static QList > pyramidResamplingMethods( const QString &providerKey ); /** Validates creation options for a specific dataset and destination format. - * @note used by GDAL provider only - * @note see also validateCreationOptionsFormat() in gdal provider for validating options based on format only + * \note used by GDAL provider only + * \note see also validateCreationOptionsFormat() in gdal provider for validating options based on format only */ virtual QString validateCreationOptions( const QStringList &createOptions, const QString &format ) { Q_UNUSED( createOptions ); Q_UNUSED( format ); return QString(); } /** Validates pyramid creation options for a specific dataset and destination format - * @note used by GDAL provider only + * \note used by GDAL provider only */ virtual QString validatePyramidsConfigOptions( QgsRaster::RasterPyramidsFormat pyramidsFormat, const QStringList &configOptions, const QString &fileFormat ) @@ -447,14 +447,14 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast /** * Step width for raster iterations. - * @see stepHeight() + * \see stepHeight() * \since QGIS 3.0 */ virtual int stepWidth() const { return QgsRasterIterator::DEFAULT_MAXIMUM_TILE_WIDTH; } /** * Step height for raster iterations. - * @see stepWidth() + * \see stepWidth() * \since QGIS 3.0 */ virtual int stepHeight() const { return QgsRasterIterator::DEFAULT_MAXIMUM_TILE_HEIGHT; } @@ -469,13 +469,13 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast protected: /** Read block of data - * @note not available in Python bindings + * \note not available in Python bindings */ virtual void readBlock( int bandNo, int xBlock, int yBlock, void *data ) { Q_UNUSED( bandNo ); Q_UNUSED( xBlock ); Q_UNUSED( yBlock ); Q_UNUSED( data ); } /** Read block of data using give extent and size - * @note not available in Python bindings + * \note not available in Python bindings */ virtual void readBlock( int bandNo, QgsRectangle const &viewExtent, int width, int height, void *data, QgsRasterBlockFeedback *feedback = nullptr ) { Q_UNUSED( bandNo ); Q_UNUSED( viewExtent ); Q_UNUSED( width ); Q_UNUSED( height ); Q_UNUSED( data ); Q_UNUSED( feedback ); } @@ -486,7 +486,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast //! Copy member variables from other raster data provider. Useful for implementation of clone() method in subclasses void copyBaseSettings( const QgsRasterDataProvider &other ); - //! @note not available in Python bindings + //! \note not available in Python bindings static QStringList cStringList2Q_( char **stringList ); static QString makeTableCell( const QString &value ); diff --git a/src/core/raster/qgsrasterdrawer.h b/src/core/raster/qgsrasterdrawer.h index 892e527951ba..94a6e9001226 100644 --- a/src/core/raster/qgsrasterdrawer.h +++ b/src/core/raster/qgsrasterdrawer.h @@ -38,23 +38,23 @@ class CORE_EXPORT QgsRasterDrawer QgsRasterDrawer( QgsRasterIterator *iterator ); /** Draws raster data. - * @param p destination QPainter - * @param viewPort viewport to render - * @param qgsMapToPixel map to pixel converter - * @param feedback optional raster feedback object for cancelation/preview. Added in QGIS 3.0. + * \param p destination QPainter + * \param viewPort viewport to render + * \param qgsMapToPixel map to pixel converter + * \param feedback optional raster feedback object for cancelation/preview. Added in QGIS 3.0. */ void draw( QPainter *p, QgsRasterViewPort *viewPort, const QgsMapToPixel *qgsMapToPixel, QgsRasterBlockFeedback *feedback = nullptr ); protected: /** Draws raster part - * @param p the painter to draw to - * @param viewPort view port to draw to - * @param img image to draw - * @param topLeftCol Left position relative to left border of viewport - * @param topLeftRow Top position relative to top border of viewport - * @param mapToPixel map to device coordinate transformation info - * @note not available in Python bindings + * \param p the painter to draw to + * \param viewPort view port to draw to + * \param img image to draw + * \param topLeftCol Left position relative to left border of viewport + * \param topLeftRow Top position relative to top border of viewport + * \param mapToPixel map to device coordinate transformation info + * \note not available in Python bindings */ void drawImage( QPainter *p, QgsRasterViewPort *viewPort, const QImage &img, int topLeftCol, int topLeftRow, const QgsMapToPixel *mapToPixel = nullptr ) const; diff --git a/src/core/raster/qgsrasterfilewriter.h b/src/core/raster/qgsrasterfilewriter.h index ef36942ea3d3..3f609f0f01ae 100644 --- a/src/core/raster/qgsrasterfilewriter.h +++ b/src/core/raster/qgsrasterfilewriter.h @@ -58,8 +58,8 @@ class CORE_EXPORT QgsRasterFileWriter /** Create a raster file with one band without initializing the pixel data. * Returned provider may be used to initialize the raster using writeBlock() calls. * Ownership of the returned provider is passed to the caller. - * @note Does not work with tiled mode enabled. - * @returns Instance of data provider in editing mode (on success) or null on error. + * \note Does not work with tiled mode enabled. + * \returns Instance of data provider in editing mode (on success) or null on error. * \since QGIS 3.0 */ QgsRasterDataProvider *createOneBandRaster( Qgis::DataType dataType, @@ -68,12 +68,12 @@ class CORE_EXPORT QgsRasterFileWriter const QgsCoordinateReferenceSystem &crs ); /** Write raster file - @param pipe raster pipe - @param nCols number of output columns - @param nRows number of output rows (or -1 to automatically calculate row number to have square pixels) - @param outputExtent extent to output - @param crs crs to reproject to - @param p dialog to show progress in */ + \param pipe raster pipe + \param nCols number of output columns + \param nRows number of output rows (or -1 to automatically calculate row number to have square pixels) + \param outputExtent extent to output + \param crs crs to reproject to + \param p dialog to show progress in */ WriterError writeRaster( const QgsRasterPipe *pipe, int nCols, int nRows, const QgsRectangle &outputExtent, const QgsCoordinateReferenceSystem &crs, QProgressDialog *p = nullptr ); @@ -131,13 +131,13 @@ class CORE_EXPORT QgsRasterFileWriter const QgsCoordinateReferenceSystem &crs, QProgressDialog *progressDialog = nullptr ); /** \brief Initialize vrt member variables - * @param xSize width of vrt - * @param ySize height of vrt - * @param crs coordinate system of vrt - * @param geoTransform optional array of transformation matrix values - * @param type datatype of vrt - * @param destHasNoDataValueList true if destination has no data value, indexed from 0 - * @param destNoDataValueList no data value, indexed from 0 + * \param xSize width of vrt + * \param ySize height of vrt + * \param crs coordinate system of vrt + * \param geoTransform optional array of transformation matrix values + * \param type datatype of vrt + * \param destHasNoDataValueList true if destination has no data value, indexed from 0 + * \param destNoDataValueList no data value, indexed from 0 */ void createVRT( int xSize, int ySize, const QgsCoordinateReferenceSystem &crs, double *geoTransform, Qgis::DataType type, const QList &destHasNoDataValueList, const QList &destNoDataValueList ); //write vrt document to disk @@ -153,14 +153,14 @@ class CORE_EXPORT QgsRasterFileWriter const QgsCoordinateReferenceSystem &crs ); /** \brief Init VRT (for tiled mode) or create global output provider (single-file mode) - * @param nCols number of tile columns - * @param nRows number of tile rows - * @param crs coordinate system of vrt - * @param geoTransform optional array of transformation matrix values - * @param nBands number of bands - * @param type datatype of vrt - * @param destHasNoDataValueList true if destination has no data value, indexed from 0 - * @param destNoDataValueList no data value, indexed from 0 + * \param nCols number of tile columns + * \param nRows number of tile rows + * \param crs coordinate system of vrt + * \param geoTransform optional array of transformation matrix values + * \param nBands number of bands + * \param type datatype of vrt + * \param destHasNoDataValueList true if destination has no data value, indexed from 0 + * \param destNoDataValueList no data value, indexed from 0 */ QgsRasterDataProvider *initOutput( int nCols, int nRows, const QgsCoordinateReferenceSystem &crs, double *geoTransform, int nBands, diff --git a/src/core/raster/qgsrasterhistogram.h b/src/core/raster/qgsrasterhistogram.h index 91e8e1e96886..73dbe34cf641 100644 --- a/src/core/raster/qgsrasterhistogram.h +++ b/src/core/raster/qgsrasterhistogram.h @@ -72,7 +72,7 @@ class CORE_EXPORT QgsRasterHistogram bool includeOutOfRange; /** \brief Store the histogram for a given layer - * @note not available via Python binding + * \note not available via Python binding */ HistogramVector histogramVector; diff --git a/src/core/raster/qgsrasteridentifyresult.h b/src/core/raster/qgsrasteridentifyresult.h index 739fd329bcd5..ab5149d478d0 100644 --- a/src/core/raster/qgsrasteridentifyresult.h +++ b/src/core/raster/qgsrasteridentifyresult.h @@ -32,13 +32,13 @@ class CORE_EXPORT QgsRasterIdentifyResult QgsRasterIdentifyResult(); /** \brief Constructor. Creates valid result. - * @param format the result format - * @param results the results + * \param format the result format + * \param results the results */ QgsRasterIdentifyResult( QgsRaster::IdentifyFormat format, const QMap &results ); /** \brief Constructor. Creates invalid result with error. - * @param error the error + * \param error the error */ QgsRasterIdentifyResult( const QgsError &error ); diff --git a/src/core/raster/qgsrasterinterface.h b/src/core/raster/qgsrasterinterface.h index 4c874092f253..eb82edd9b2f4 100644 --- a/src/core/raster/qgsrasterinterface.h +++ b/src/core/raster/qgsrasterinterface.h @@ -47,17 +47,17 @@ class CORE_EXPORT QgsRasterBlockFeedback : public QgsFeedback //! Whether the raster provider should return only data that are already available //! without waiting for full result. By default this flag is not enabled. - //! @see setPreviewOnly() + //! \see setPreviewOnly() bool isPreviewOnly() const { return mPreviewOnly; } //! set flag whether the block request is for preview purposes only - //! @see isPreviewOnly() + //! \see isPreviewOnly() void setPreviewOnly( bool preview ) { mPreviewOnly = preview; } //! Whether our painter is drawing to a temporary image used just by this layer - //! @see setRenderPartialOutput() + //! \see setRenderPartialOutput() bool renderPartialOutput() const { return mRenderPartialOutput; } //! Set whether our painter is drawing to a temporary image used just by this layer - //! @see renderPartialOutput() + //! \see renderPartialOutput() void setRenderPartialOutput( bool enable ) { mRenderPartialOutput = enable; } private: @@ -120,7 +120,7 @@ class CORE_EXPORT QgsRasterInterface /** * Get the extent of the interface. - * @return QgsRectangle containing the extent of the layer + * \returns QgsRectangle containing the extent of the layer */ virtual QgsRectangle extent() const { return mInput ? mInput->extent() : QgsRectangle(); } @@ -146,11 +146,11 @@ class CORE_EXPORT QgsRasterInterface /** Read block of data using given extent and size. * Returns pointer to data. * Caller is responsible to free the memory returned. - * @param bandNo band number - * @param extent extent of block - * @param width pixel width of block - * @param height pixel height of block - * @param feedback optional raster feedback object for cancelation/preview. Added in QGIS 3.0. + * \param bandNo band number + * \param extent extent of block + * \param width pixel width of block + * \param height pixel height of block + * \param feedback optional raster feedback object for cancelation/preview. Added in QGIS 3.0. */ virtual QgsRasterBlock *block( int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback = nullptr ) = 0; @@ -188,12 +188,12 @@ class CORE_EXPORT QgsRasterInterface } /** \brief Get band statistics. - * @param bandNo The band (number). - * @param stats Requested statistics - * @param extent Extent used to calc statistics, if empty, whole raster extent is used. - * @param sampleSize Approximate number of cells in sample. If 0, all cells (whole raster will be used). If raster does not have exact size (WCS without exact size for example), provider decides size of sample. - * @param feedback optional feedback object - * @return Band statistics. + * \param bandNo The band (number). + * \param stats Requested statistics + * \param extent Extent used to calc statistics, if empty, whole raster extent is used. + * \param sampleSize Approximate number of cells in sample. If 0, all cells (whole raster will be used). If raster does not have exact size (WCS without exact size for example), provider decides size of sample. + * \param feedback optional feedback object + * \returns Band statistics. */ virtual QgsRasterBandStats bandStatistics( int bandNo, int stats = QgsRasterBandStats::All, @@ -201,7 +201,7 @@ class CORE_EXPORT QgsRasterInterface int sampleSize = 0, QgsRasterBlockFeedback *feedback = nullptr ); /** \brief Returns true if histogram is available (cached, already calculated). * The parameters are the same as in bandStatistics() - * @return true if statistics are available (ready to use) + * \returns true if statistics are available (ready to use) */ virtual bool hasStatistics( int bandNo, int stats = QgsRasterBandStats::All, @@ -209,16 +209,16 @@ class CORE_EXPORT QgsRasterInterface int sampleSize = 0 ); /** \brief Get histogram. Histograms are cached in providers. - * @param bandNo The band (number). - * @param binCount Number of bins (intervals,buckets). If 0, the number of bins is decided automatically according to data type, raster size etc. - * @param minimum Minimum value, if NaN, raster minimum value will be used. - * @param maximum Maximum value, if NaN, raster minimum value will be used. - * @param extent Extent used to calc histogram, if empty, whole raster extent is used. - * @param sampleSize Approximate number of cells in sample. If 0, all cells (whole raster will be used). If raster does not have exact size (WCS without exact size for example), provider decides size of sample. - * @param includeOutOfRange include out of range values - * @param feedback optional feedback object - * @return Vector of non NULL cell counts for each bin. - * @note binCount, minimum and maximum not optional in Python bindings + * \param bandNo The band (number). + * \param binCount Number of bins (intervals,buckets). If 0, the number of bins is decided automatically according to data type, raster size etc. + * \param minimum Minimum value, if NaN, raster minimum value will be used. + * \param maximum Maximum value, if NaN, raster minimum value will be used. + * \param extent Extent used to calc histogram, if empty, whole raster extent is used. + * \param sampleSize Approximate number of cells in sample. If 0, all cells (whole raster will be used). If raster does not have exact size (WCS without exact size for example), provider decides size of sample. + * \param includeOutOfRange include out of range values + * \param feedback optional feedback object + * \returns Vector of non NULL cell counts for each bin. + * \note binCount, minimum and maximum not optional in Python bindings */ virtual QgsRasterHistogram histogram( int bandNo, int binCount = 0, @@ -229,7 +229,7 @@ class CORE_EXPORT QgsRasterInterface bool includeOutOfRange = false, QgsRasterBlockFeedback *feedback = nullptr ); /** \brief Returns true if histogram is available (cached, already calculated), the parameters are the same as in histogram() - * @note binCount, minimum and maximum not optional in Python bindings + * \note binCount, minimum and maximum not optional in Python bindings */ virtual bool hasHistogram( int bandNo, int binCount, @@ -240,13 +240,13 @@ class CORE_EXPORT QgsRasterInterface bool includeOutOfRange = false ); /** \brief Find values for cumulative pixel count cut. - * @param bandNo The band (number). - * @param lowerCount The lower count as fraction of 1, e.g. 0.02 = 2% - * @param upperCount The upper count as fraction of 1, e.g. 0.98 = 98% - * @param lowerValue Location into which the lower value will be set. - * @param upperValue Location into which the upper value will be set. - * @param extent Extent used to calc histogram, if empty, whole raster extent is used. - * @param sampleSize Approximate number of cells in sample. If 0, all cells (whole raster will be used). If raster does not have exact size (WCS without exact size for example), provider decides size of sample. + * \param bandNo The band (number). + * \param lowerCount The lower count as fraction of 1, e.g. 0.02 = 2% + * \param upperCount The upper count as fraction of 1, e.g. 0.98 = 98% + * \param lowerValue Location into which the lower value will be set. + * \param upperValue Location into which the upper value will be set. + * \param extent Extent used to calc histogram, if empty, whole raster extent is used. + * \param sampleSize Approximate number of cells in sample. If 0, all cells (whole raster will be used). If raster does not have exact size (WCS without exact size for example), provider decides size of sample. */ virtual void cumulativeCut( int bandNo, double lowerCount, @@ -275,7 +275,7 @@ class CORE_EXPORT QgsRasterInterface bool mOn; /** Fill in histogram defaults if not specified - * @note binCount, minimum and maximum not optional in Python bindings + * \note binCount, minimum and maximum not optional in Python bindings */ void initHistogram( QgsRasterHistogram &histogram, int bandNo, int binCount = 0, diff --git a/src/core/raster/qgsrasteriterator.h b/src/core/raster/qgsrasteriterator.h index 5406869e920a..127ac075b709 100644 --- a/src/core/raster/qgsrasteriterator.h +++ b/src/core/raster/qgsrasteriterator.h @@ -36,23 +36,23 @@ class CORE_EXPORT QgsRasterIterator QgsRasterIterator( QgsRasterInterface *input ); /** Start reading of raster band. Raster data can then be retrieved by calling readNextRasterPart until it returns false. - @param bandNumber number of raster band to read - @param nCols number of columns - @param nRows number of rows - @param extent area to read - @param feedback optional raster feedback object for cancelation/preview. Added in QGIS 3.0. + \param bandNumber number of raster band to read + \param nCols number of columns + \param nRows number of rows + \param extent area to read + \param feedback optional raster feedback object for cancelation/preview. Added in QGIS 3.0. */ void startRasterRead( int bandNumber, int nCols, int nRows, const QgsRectangle &extent, QgsRasterBlockFeedback *feedback = nullptr ); /** Fetches next part of raster data, caller takes ownership of the block and caller should delete the block. - @param bandNumber band to read - @param nCols number of columns on output device - @param nRows number of rows on output device - @param block address of block pointer - @param topLeftCol top left column - @param topLeftRow top left row - @return false if the last part was already returned*/ + \param bandNumber band to read + \param nCols number of columns on output device + \param nRows number of rows on output device + \param block address of block pointer + \param topLeftCol top left column + \param topLeftRow top left row + \returns false if the last part was already returned*/ bool readNextRasterPart( int bandNumber, int &nCols, int &nRows, QgsRasterBlock **block, diff --git a/src/core/raster/qgsrasterlayer.cpp b/src/core/raster/qgsrasterlayer.cpp index 066696e41c41..4d090e4e1347 100644 --- a/src/core/raster/qgsrasterlayer.cpp +++ b/src/core/raster/qgsrasterlayer.cpp @@ -1418,7 +1418,7 @@ bool QgsRasterLayer::readStyle( const QDomNode &node, QString &errorMessage ) bool QgsRasterLayer::readXml( const QDomNode &layer_node ) { QgsDebugMsgLevel( "Entered", 4 ); - //! @note Make sure to read the file first so stats etc are initialized properly! + // Make sure to read the file first so stats etc are initialized properly! //process provider key QDomNode pkeyNode = layer_node.namedItem( QStringLiteral( "provider" ) ); diff --git a/src/core/raster/qgsrasterlayer.h b/src/core/raster/qgsrasterlayer.h index 89dcfd1fb0fb..205bfb371f8b 100644 --- a/src/core/raster/qgsrasterlayer.h +++ b/src/core/raster/qgsrasterlayer.h @@ -251,7 +251,7 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer QgsRasterDataProvider *dataProvider(); /** Returns the data provider in a const-correct manner - @note available in Python bindings as constDataProvider() + \note available in Python bindings as constDataProvider() */ const QgsRasterDataProvider *dataProvider() const; @@ -288,11 +288,11 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer double rasterUnitsPerPixelY() const; /** \brief Set contrast enhancement algorithm - * @param algorithm Contrast enhancement algorithm - * @param limits Limits - * @param extent Extent used to calculate limits, if empty, use full layer extent - * @param sampleSize Size of data sample to calculate limits, if 0, use full resolution - * @param generateLookupTableFlag Generate lookup table. */ + * \param algorithm Contrast enhancement algorithm + * \param limits Limits + * \param extent Extent used to calculate limits, if empty, use full layer extent + * \param sampleSize Size of data sample to calculate limits, if 0, use full resolution + * \param generateLookupTableFlag Generate lookup table. */ void setContrastEnhancement( QgsContrastEnhancement::ContrastEnhancementAlgorithm algorithm, @@ -302,19 +302,19 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer bool generateLookupTableFlag = true ); /** \brief Refresh contrast enhancement with new extent. - * @note not available in Python bindings + * \note not available in Python bindings */ // Used by QgisApp::legendLayerStretchUsingCurrentExtent() void refreshContrastEnhancement( const QgsRectangle &extent ); /** \brief Refresh renderer with new extent, if needed - * @note not available in Python bindings + * \note not available in Python bindings */ // Used by QgsRasterLayerRenderer void refreshRendererIfNeeded( QgsRasterRenderer *rasterRenderer, const QgsRectangle &extent ); /** \brief Return default contrast enhancemnt settings for that type of raster. - * @note not available in Python bindings + * \note not available in Python bindings */ bool defaultContrastEnhancementSettings( QgsContrastEnhancement::ContrastEnhancementAlgorithm &myAlgorithm, diff --git a/src/core/raster/qgsrasterlayerrenderer.h b/src/core/raster/qgsrasterlayerrenderer.h index aea505266885..54bc92b1aed6 100644 --- a/src/core/raster/qgsrasterlayerrenderer.h +++ b/src/core/raster/qgsrasterlayerrenderer.h @@ -36,7 +36,7 @@ class QgsRasterLayerRenderer; * Implementation of threaded rendering for raster layers. * * \since QGIS 2.4 - * @note not available in Python bindings + * \note not available in Python bindings */ class QgsRasterLayerRenderer : public QgsMapLayerRenderer { @@ -60,7 +60,7 @@ class QgsRasterLayerRenderer : public QgsMapLayerRenderer /** \ingroup core * Specific internal feedback class to provide preview of raster layer rendering. * \since QGIS 3.0 - * @note not available in Python bindings + * \note not available in Python bindings */ class Feedback : public QgsRasterBlockFeedback { diff --git a/src/core/raster/qgsrasterprojector.h b/src/core/raster/qgsrasterprojector.h index 732880bc55b3..bd8384292f5e 100644 --- a/src/core/raster/qgsrasterprojector.h +++ b/src/core/raster/qgsrasterprojector.h @@ -127,7 +127,7 @@ class ProjectorData /** \brief Get source row and column indexes for current source extent and resolution If source pixel is outside source extent srcRow and srcCol are left unchanged. - @return true if inside source + \returns true if inside source */ bool srcRowCol( int destRow, int destCol, int *srcRow, int *srcCol ); diff --git a/src/core/raster/qgsrasterrange.h b/src/core/raster/qgsrasterrange.h index a5f43d9d91fb..acbb0196c2fb 100644 --- a/src/core/raster/qgsrasterrange.h +++ b/src/core/raster/qgsrasterrange.h @@ -38,8 +38,8 @@ class CORE_EXPORT QgsRasterRange QgsRasterRange(); /** \brief Constructor - * @param min minimum value - * @param max max value + * \param min minimum value + * \param max max value */ QgsRasterRange( double min, double max ); @@ -55,10 +55,10 @@ class CORE_EXPORT QgsRasterRange } /** \brief Test if value is within the list of ranges - * @param value value - * @param rangeList list of ranges - * @return true if value is in at least one of ranges - * @note not available in Python bindings + * \param value value + * \param rangeList list of ranges + * \returns true if value is in at least one of ranges + * \note not available in Python bindings */ static bool contains( double value, const QgsRasterRangeList &rangeList ); diff --git a/src/core/raster/qgssinglebandpseudocolorrenderer.h b/src/core/raster/qgssinglebandpseudocolorrenderer.h index 776641522dab..2220900ef466 100644 --- a/src/core/raster/qgssinglebandpseudocolorrenderer.h +++ b/src/core/raster/qgssinglebandpseudocolorrenderer.h @@ -55,16 +55,16 @@ class CORE_EXPORT QgsSingleBandPseudoColorRenderer: public QgsRasterRenderer //! Returns the raster shader QgsRasterShader *shader() { return mShader.get(); } - //! @note available in Python as constShader + //! \note available in Python as constShader const QgsRasterShader *shader() const { return mShader.get(); } /** Creates a color ramp shader - * @param colorRamp vector color ramp - * @param colorRampType type of color ramp shader - * @param classificationMode classification mode - * @param classes number of classes - * @param clip clip out of range values - * @param extent extent used in classification (only used in quantile mode) + * \param colorRamp vector color ramp + * \param colorRampType type of color ramp shader + * \param classificationMode classification mode + * \param classes number of classes + * \param clip clip out of range values + * \param extent extent used in classification (only used in quantile mode) */ void createShader( QgsColorRamp *colorRamp = nullptr, QgsColorRampShader::Type colorRampType = QgsColorRampShader::Interpolated, QgsColorRampShader::ClassificationMode classificationMode = QgsColorRampShader::Continuous, int classes = 0, bool clip = false, const QgsRectangle &extent = QgsRectangle() ); @@ -80,7 +80,7 @@ class CORE_EXPORT QgsSingleBandPseudoColorRenderer: public QgsRasterRenderer int band() const { return mBand; } /** Sets the band used by the renderer. - * @see band + * \see band * \since QGIS 2.10 */ void setBand( int bandNo ); diff --git a/src/core/symbology-ng/qgs25drenderer.h b/src/core/symbology-ng/qgs25drenderer.h index 3982da0f9782..927d8b733032 100644 --- a/src/core/symbology-ng/qgs25drenderer.h +++ b/src/core/symbology-ng/qgs25drenderer.h @@ -32,7 +32,7 @@ class CORE_EXPORT Qgs25DRenderer : public QgsFeatureRenderer /** * Create a new 2.5D renderer from XML * - * @param element XML information + * \param element XML information */ static QgsFeatureRenderer *create( QDomElement &element ); QDomElement save( QDomDocument &doc ) override; diff --git a/src/core/symbology-ng/qgsarrowsymbollayer.h b/src/core/symbology-ng/qgsarrowsymbollayer.h index 45f7c7227bea..306bf0e4e308 100644 --- a/src/core/symbology-ng/qgsarrowsymbollayer.h +++ b/src/core/symbology-ng/qgsarrowsymbollayer.h @@ -35,9 +35,9 @@ class CORE_EXPORT QgsArrowSymbolLayer : public QgsLineSymbolLayer /** * Create a new QgsArrowSymbolLayer * - * @param properties A property map to deserialize saved information from properties() + * \param properties A property map to deserialize saved information from properties() * - * @return A new QgsArrowSymbolLayer + * \returns A new QgsArrowSymbolLayer */ static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ); diff --git a/src/core/symbology-ng/qgscategorizedsymbolrenderer.h b/src/core/symbology-ng/qgscategorizedsymbolrenderer.h index 0f7559807220..80a29fa46a96 100644 --- a/src/core/symbology-ng/qgscategorizedsymbolrenderer.h +++ b/src/core/symbology-ng/qgscategorizedsymbolrenderer.h @@ -92,8 +92,8 @@ class CORE_EXPORT QgsCategorizedSymbolRenderer : public QgsFeatureRenderer /** Update all the symbols but leave categories and colors. This method also sets the source * symbol for the renderer. - * @param sym source symbol to use for categories. Ownership is not transferred. - * @see setSourceSymbol() + * \param sym source symbol to use for categories. Ownership is not transferred. + * \see setSourceSymbol() */ void updateSymbols( QgsSymbol *sym ); @@ -137,34 +137,34 @@ class CORE_EXPORT QgsCategorizedSymbolRenderer : public QgsFeatureRenderer /** Returns the renderer's source symbol, which is the base symbol used for the each categories' symbol before applying * the categories' color. - * @see setSourceSymbol() - * @see sourceColorRamp() + * \see setSourceSymbol() + * \see sourceColorRamp() */ QgsSymbol *sourceSymbol(); /** Sets the source symbol for the renderer, which is the base symbol used for the each categories' symbol before applying * the categories' color. - * @param sym source symbol, ownership is transferred to the renderer - * @see sourceSymbol() - * @see setSourceColorRamp() + * \param sym source symbol, ownership is transferred to the renderer + * \see sourceSymbol() + * \see setSourceColorRamp() */ void setSourceSymbol( QgsSymbol *sym ); /** Returns the source color ramp, from which each categories' color is derived. - * @see setSourceColorRamp() - * @see sourceSymbol() + * \see setSourceColorRamp() + * \see sourceSymbol() */ QgsColorRamp *sourceColorRamp(); /** Sets the source color ramp. - * @param ramp color ramp. Ownership is transferred to the renderer - * @see sourceColorRamp() - * @see setSourceSymbol() + * \param ramp color ramp. Ownership is transferred to the renderer + * \see sourceColorRamp() + * \see setSourceSymbol() */ void setSourceColorRamp( QgsColorRamp *ramp ); /** Update the color ramp used and all symbols colors. - * @param ramp color ramp. Ownership is transferred to the renderer + * \param ramp color ramp. Ownership is transferred to the renderer * \since QGIS 2.5 */ void updateColorRamp( QgsColorRamp *ramp ); @@ -177,7 +177,7 @@ class CORE_EXPORT QgsCategorizedSymbolRenderer : public QgsFeatureRenderer //! creates a QgsCategorizedSymbolRenderer from an existing renderer. //! \since QGIS 2.5 - //! @returns a new renderer if the conversion was possible, otherwise 0. + //! \returns a new renderer if the conversion was possible, otherwise 0. static QgsCategorizedSymbolRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ); protected: diff --git a/src/core/symbology-ng/qgscptcityarchive.h b/src/core/symbology-ng/qgscptcityarchive.h index c8b46d370a48..6e68142adbd3 100644 --- a/src/core/symbology-ng/qgscptcityarchive.h +++ b/src/core/symbology-ng/qgscptcityarchive.h @@ -59,7 +59,7 @@ class CORE_EXPORT QgsCptCityArchive static QString findFileName( const QString &target, const QString &startDir, const QString &baseDir ); static QMap< QString, QString > copyingInfo( const QString &fileName ); static QMap< QString, QString > description( const QString &fileName ); - //! @note not available in Python bindings + //! \note not available in Python bindings static QMap< double, QPair > gradientColorMap( const QString &fileName ); // archive management diff --git a/src/core/symbology-ng/qgsellipsesymbollayer.h b/src/core/symbology-ng/qgsellipsesymbollayer.h index 03b77eca4975..88e2a4b1029f 100644 --- a/src/core/symbology-ng/qgsellipsesymbollayer.h +++ b/src/core/symbology-ng/qgsellipsesymbollayer.h @@ -75,15 +75,15 @@ class CORE_EXPORT QgsEllipseSymbolLayer: public QgsMarkerSymbolLayer QColor strokeColor() const override { return mStrokeColor; } /** Sets the units for the symbol's width. - * @param unit symbol units - * @see symbolWidthUnit() - * @see setSymbolHeightUnit() + * \param unit symbol units + * \see symbolWidthUnit() + * \see setSymbolHeightUnit() */ void setSymbolWidthUnit( QgsUnitTypes::RenderUnit unit ) { mSymbolWidthUnit = unit; } /** Returns the units for the symbol's width. - * @see setSymbolWidthUnit() - * @see symbolHeightUnit() + * \see setSymbolWidthUnit() + * \see symbolHeightUnit() */ QgsUnitTypes::RenderUnit symbolWidthUnit() const { return mSymbolWidthUnit; } @@ -91,15 +91,15 @@ class CORE_EXPORT QgsEllipseSymbolLayer: public QgsMarkerSymbolLayer const QgsMapUnitScale &symbolWidthMapUnitScale() const { return mSymbolWidthMapUnitScale; } /** Sets the units for the symbol's height. - * @param unit symbol units - * @see symbolHeightUnit() - * @see setSymbolWidthUnit() + * \param unit symbol units + * \see symbolHeightUnit() + * \see setSymbolWidthUnit() */ void setSymbolHeightUnit( QgsUnitTypes::RenderUnit unit ) { mSymbolHeightUnit = unit; } /** Returns the units for the symbol's height. - * @see setSymbolHeightUnit() - * @see symbolWidthUnit() + * \see setSymbolHeightUnit() + * \see symbolWidthUnit() */ QgsUnitTypes::RenderUnit symbolHeightUnit() const { return mSymbolHeightUnit; } @@ -107,13 +107,13 @@ class CORE_EXPORT QgsEllipseSymbolLayer: public QgsMarkerSymbolLayer const QgsMapUnitScale &symbolHeightMapUnitScale() const { return mSymbolHeightMapUnitScale; } /** Sets the units for the symbol's stroke width. - * @param unit symbol units - * @see strokeWidthUnit() + * \param unit symbol units + * \see strokeWidthUnit() */ void setStrokeWidthUnit( QgsUnitTypes::RenderUnit unit ) { mStrokeWidthUnit = unit; } /** Returns the units for the symbol's stroke width. - * @see setStrokeWidthUnit() + * \see setStrokeWidthUnit() */ QgsUnitTypes::RenderUnit strokeWidthUnit() const { return mStrokeWidthUnit; } @@ -149,11 +149,11 @@ class CORE_EXPORT QgsEllipseSymbolLayer: public QgsMarkerSymbolLayer QBrush mBrush; /** Setup mPainterPath - @param symbolName name of symbol - @param context render context - @param scaledWidth optional width - @param scaledHeight optional height - @param f optional feature to render (0 if no data defined rendering) + \param symbolName name of symbol + \param context render context + \param scaledWidth optional width + \param scaledHeight optional height + \param f optional feature to render (0 if no data defined rendering) */ void preparePath( const QString &symbolName, QgsSymbolRenderContext &context, double *scaledWidth = nullptr, double *scaledHeight = nullptr, const QgsFeature *f = nullptr ); QSizeF calculateSize( QgsSymbolRenderContext &context, double *scaledWidth = nullptr, double *scaledHeight = nullptr ); diff --git a/src/core/symbology-ng/qgsfillsymbollayer.h b/src/core/symbology-ng/qgsfillsymbollayer.h index 68aae10b0761..4dc281fb5477 100644 --- a/src/core/symbology-ng/qgsfillsymbollayer.h +++ b/src/core/symbology-ng/qgsfillsymbollayer.h @@ -90,13 +90,13 @@ class CORE_EXPORT QgsSimpleFillSymbolLayer : public QgsFillSymbolLayer QPointF offset() { return mOffset; } /** Sets the units for the width of the fill's stroke. - * @param unit width units - * @see strokeWidthUnit() + * \param unit width units + * \see strokeWidthUnit() */ void setStrokeWidthUnit( QgsUnitTypes::RenderUnit unit ) { mStrokeWidthUnit = unit; } /** Returns the units for the width of the fill's stroke. - * @see setStrokeWidthUnit() + * \see setStrokeWidthUnit() */ QgsUnitTypes::RenderUnit strokeWidthUnit() const { return mStrokeWidthUnit; } @@ -104,13 +104,13 @@ class CORE_EXPORT QgsSimpleFillSymbolLayer : public QgsFillSymbolLayer const QgsMapUnitScale &strokeWidthMapUnitScale() const { return mStrokeWidthMapUnitScale; } /** Sets the units for the fill's offset. - * @param unit offset units - * @see offsetUnit() + * \param unit offset units + * \see offsetUnit() */ void setOffsetUnit( QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; } /** Returns the units for the fill's offset. - * @see setOffsetUnit() + * \see setOffsetUnit() */ QgsUnitTypes::RenderUnit offsetUnit() const { return mOffsetUnit; } @@ -230,16 +230,16 @@ class CORE_EXPORT QgsGradientFillSymbolLayer : public QgsFillSymbolLayer /** Returns the color ramp used for the gradient fill. This is only * used if the gradient color type is set to ColorRamp. - * @see setColorRamp() - * @see gradientColorType() + * \see setColorRamp() + * \see gradientColorType() */ QgsColorRamp *colorRamp() { return mGradientRamp; } /** Sets the color ramp used for the gradient fill. This is only * used if the gradient color type is set to ColorRamp. - * @param ramp color ramp. Ownership is transferred. - * @see colorRamp() - * @see setGradientColorType() + * \param ramp color ramp. Ownership is transferred. + * \see colorRamp() + * \see setGradientColorType() */ void setColorRamp( QgsColorRamp *ramp ); @@ -363,67 +363,67 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer double estimateMaxBleed( const QgsRenderContext &context ) const override; /** Sets the blur radius, which controls the amount of blurring applied to the fill. - * @param blurRadius Radius for fill blur. Values between 0 - 17 are valid, where higher values results in a stronger blur. Set to 0 to disable blur. + * \param blurRadius Radius for fill blur. Values between 0 - 17 are valid, where higher values results in a stronger blur. Set to 0 to disable blur. * \since QGIS 2.3 - * @see blurRadius + * \see blurRadius */ void setBlurRadius( int blurRadius ) { mBlurRadius = blurRadius; } /** Returns the blur radius, which controls the amount of blurring applied to the fill. - * @returns Integer representing the radius for fill blur. Higher values indicate a stronger blur. A 0 value indicates that blurring is disabled. + * \returns Integer representing the radius for fill blur. Higher values indicate a stronger blur. A 0 value indicates that blurring is disabled. * \since QGIS 2.3 - * @see setBlurRadius + * \see setBlurRadius */ int blurRadius() const { return mBlurRadius; } /** Sets whether the shapeburst fill should be drawn using the entire shape. - * @param useWholeShape Set to true if shapeburst should cover entire shape. If false, setMaxDistance is used to calculate how far from the boundary of the shape should + * \param useWholeShape Set to true if shapeburst should cover entire shape. If false, setMaxDistance is used to calculate how far from the boundary of the shape should * be shaded * \since QGIS 2.3 - * @see useWholeShape - * @see setMaxDistance + * \see useWholeShape + * \see setMaxDistance */ void setUseWholeShape( bool useWholeShape ) { mUseWholeShape = useWholeShape; } /** Returns whether the shapeburst fill is set to cover the entire shape. - * @returns True if shapeburst fill will cover the entire shape. If false, shapeburst is drawn to a distance of maxDistance from the polygon's boundary. + * \returns True if shapeburst fill will cover the entire shape. If false, shapeburst is drawn to a distance of maxDistance from the polygon's boundary. * \since QGIS 2.3 - * @see setUseWholeShape - * @see maxDistance + * \see setUseWholeShape + * \see maxDistance */ bool useWholeShape() const { return mUseWholeShape; } /** Sets the maximum distance to shape inside of the shape from the polygon's boundary. - * @param maxDistance distance from boundary to shade. setUseWholeShape must be set to false for this parameter to take effect. Distance unit is controlled by setDistanceUnit. + * \param maxDistance distance from boundary to shade. setUseWholeShape must be set to false for this parameter to take effect. Distance unit is controlled by setDistanceUnit. * \since QGIS 2.3 - * @see maxDistance - * @see setUseWholeShape - * @see setDistanceUnit + * \see maxDistance + * \see setUseWholeShape + * \see setDistanceUnit */ void setMaxDistance( double maxDistance ) { mMaxDistance = maxDistance; } /** Returns the maximum distance from the shape's boundary which is shaded. This parameter is only effective if useWholeShape is false. - * @returns the maximum distance from the polygon's boundary which is shaded. Distance units are indicated by distanceUnit. + * \returns the maximum distance from the polygon's boundary which is shaded. Distance units are indicated by distanceUnit. * \since QGIS 2.3 - * @see useWholeShape - * @see setMaxDistance - * @see distanceUnit + * \see useWholeShape + * \see setMaxDistance + * \see distanceUnit */ double maxDistance() const { return mMaxDistance; } /** Sets the unit for the maximum distance to shade inside of the shape from the polygon's boundary. - * @param unit distance unit for the maximum distance + * \param unit distance unit for the maximum distance * \since QGIS 2.3 - * @see setMaxDistance - * @see distanceUnit + * \see setMaxDistance + * \see distanceUnit */ void setDistanceUnit( QgsUnitTypes::RenderUnit unit ) { mDistanceUnit = unit; } /** Returns the unit for the maximum distance to shade inside of the shape from the polygon's boundary. - * @returns distance unit for the maximum distance + * \returns distance unit for the maximum distance * \since QGIS 2.3 - * @see maxDistance - * @see setDistanceUnit + * \see maxDistance + * \see setDistanceUnit */ QgsUnitTypes::RenderUnit distanceUnit() const { return mDistanceUnit; } @@ -432,102 +432,102 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer /** Sets the color mode to use for the shapeburst fill. Shapeburst can either be drawn using a QgsColorRamp color ramp * or by simply specificing a start and end color. setColorType is used to specify which mode to use for the fill. - * @param colorType color type to use for shapeburst fill + * \param colorType color type to use for shapeburst fill * \since QGIS 2.3 - * @see colorType - * @see setColor - * @see setColor2 - * @see setColorRamp + * \see colorType + * \see setColor + * \see setColor2 + * \see setColorRamp */ void setColorType( ShapeburstColorType colorType ) { mColorType = colorType; } /** Returns the color mode used for the shapeburst fill. Shapeburst can either be drawn using a QgsColorRamp color ramp * or by simply specificing a start and end color. - * @returns current color mode used for the shapeburst fill + * \returns current color mode used for the shapeburst fill * \since QGIS 2.3 - * @see setColorType - * @see color - * @see color2 - * @see colorRamp + * \see setColorType + * \see color + * \see color2 + * \see colorRamp */ ShapeburstColorType colorType() const { return mColorType; } /** Sets the color ramp used to draw the shapeburst fill. Color ramps are only used if setColorType is set ShapeburstColorType::ColorRamp. - * @param ramp color ramp to use for shapeburst fill + * \param ramp color ramp to use for shapeburst fill * \since QGIS 2.3 - * @see setColorType - * @see colorRamp + * \see setColorType + * \see colorRamp */ void setColorRamp( QgsColorRamp *ramp ); /** Returns the color ramp used for the shapeburst fill. The color ramp is only used if the colorType is set to ShapeburstColorType::ColorRamp - * @returns a QgsColorRamp color ramp + * \returns a QgsColorRamp color ramp * \since QGIS 2.3 - * @see setColorRamp - * @see colorType + * \see setColorRamp + * \see colorType */ QgsColorRamp *colorRamp() { return mGradientRamp; } /** Sets the color for the endpoint of the shapeburst fill. This color is only used if setColorType is set ShapeburstColorType::SimpleTwoColor. - * @param color2 QColor to use for endpoint of gradient + * \param color2 QColor to use for endpoint of gradient * \since QGIS 2.3 - * @see setColorType - * @see color2 + * \see setColorType + * \see color2 */ void setColor2( const QColor &color2 ) { mColor2 = color2; } /** Returns the color used for the endpoint of the shapeburst fill. This color is only used if the colorType is set to ShapeburstColorType::SimpleTwoColor - * @returns a QColor indicating the color of the endpoint of the gradient + * \returns a QColor indicating the color of the endpoint of the gradient * \since QGIS 2.3 - * @see setColor2 - * @see colorType + * \see setColor2 + * \see colorType */ QColor color2() const { return mColor2; } /** Sets whether the shapeburst fill should ignore polygon rings when calculating * the buffered shading. - * @param ignoreRings Set to true if buffers should ignore interior rings for polygons. + * \param ignoreRings Set to true if buffers should ignore interior rings for polygons. * \since QGIS 2.3 - * @see ignoreRings + * \see ignoreRings */ void setIgnoreRings( bool ignoreRings ) { mIgnoreRings = ignoreRings; } /** Returns whether the shapeburst fill is set to ignore polygon interior rings. - * @returns True if the shapeburst fill will ignore interior rings when calculating buffered shading. + * \returns True if the shapeburst fill will ignore interior rings when calculating buffered shading. * \since QGIS 2.3 - * @see setIgnoreRings + * \see setIgnoreRings */ bool ignoreRings() const { return mIgnoreRings; } /** Sets the offset for the shapeburst fill. - * @param offset QPointF indicating the horizontal/vertical offset amount + * \param offset QPointF indicating the horizontal/vertical offset amount * \since QGIS 2.3 - * @see offset - * @see setOffsetUnit + * \see offset + * \see setOffsetUnit */ void setOffset( QPointF offset ) { mOffset = offset; } /** Returns the offset for the shapeburst fill. - * @returns a QPointF indicating the horizontal/vertical offset amount + * \returns a QPointF indicating the horizontal/vertical offset amount * \since QGIS 2.3 - * @see setOffset - * @see offsetUnit + * \see setOffset + * \see offsetUnit */ QPointF offset() const { return mOffset; } /** Sets the units used for the offset for the shapeburst fill. - * @param unit units for fill offset + * \param unit units for fill offset * \since QGIS 2.3 - * @see setOffset - * @see offsetUnit + * \see setOffset + * \see offsetUnit */ void setOffsetUnit( QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; } /** Returns the units used for the offset of the shapeburst fill. - * @returns units used for the fill offset + * \returns units used for the fill offset * \since QGIS 2.3 - * @see offset - * @see setOffsetUnit + * \see offset + * \see setOffsetUnit */ QgsUnitTypes::RenderUnit offsetUnit() const { return mOffsetUnit; } @@ -592,13 +592,13 @@ class CORE_EXPORT QgsImageFillSymbolLayer: public QgsFillSymbolLayer virtual bool setSubSymbol( QgsSymbol *symbol ) override; /** Sets the units for the symbol's stroke width. - * @param unit symbol units - * @see strokeWidthUnit() + * \param unit symbol units + * \see strokeWidthUnit() */ void setStrokeWidthUnit( QgsUnitTypes::RenderUnit unit ) { mStrokeWidthUnit = unit; } /** Returns the units for the symbol's stroke width. - * @see setStrokeWidthUnit() + * \see setStrokeWidthUnit() */ QgsUnitTypes::RenderUnit strokeWidthUnit() const { return mStrokeWidthUnit; } @@ -668,138 +668,138 @@ class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer virtual bool setSubSymbol( QgsSymbol *symbol ) override; /** Sets the path to the raster image used for the fill. - * @param imagePath path to image file - * @see imageFilePath + * \param imagePath path to image file + * \see imageFilePath */ void setImageFilePath( const QString &imagePath ); /** The path to the raster image used for the fill. - * @returns path to image file - * @see setImageFilePath + * \returns path to image file + * \see setImageFilePath */ QString imageFilePath() const { return mImageFilePath; } /** Set the coordinate mode for fill. Controls how the top left corner of the image * fill is positioned relative to the feature. - * @param mode coordinate mode - * @see coordinateMode + * \param mode coordinate mode + * \see coordinateMode */ void setCoordinateMode( const FillCoordinateMode mode ); /** Coordinate mode for fill. Controls how the top left corner of the image * fill is positioned relative to the feature. - * @returns coordinate mode - * @see setCoordinateMode + * \returns coordinate mode + * \see setCoordinateMode */ FillCoordinateMode coordinateMode() const { return mCoordinateMode; } /** Sets the opacity for the raster image used in the fill. - * @param alpha opacity value between 0 (fully transparent) and 1 (fully opaque) - * @see alpha + * \param alpha opacity value between 0 (fully transparent) and 1 (fully opaque) + * \see alpha */ void setAlpha( const double alpha ); /** The opacity for the raster image used in the fill. - * @returns opacity value between 0 (fully transparent) and 1 (fully opaque) - * @see setAlpha + * \returns opacity value between 0 (fully transparent) and 1 (fully opaque) + * \see setAlpha */ double alpha() const { return mAlpha; } /** Sets the offset for the fill. - * @param offset offset for fill - * @see offset - * @see setOffsetUnit - * @see setOffsetMapUnitScale + * \param offset offset for fill + * \see offset + * \see setOffsetUnit + * \see setOffsetMapUnitScale */ void setOffset( QPointF offset ) { mOffset = offset; } /** Returns the offset for the fill. - * @returns offset for fill - * @see setOffset - * @see offsetUnit - * @see offsetMapUnitScale + * \returns offset for fill + * \see setOffset + * \see offsetUnit + * \see offsetMapUnitScale */ QPointF offset() const { return mOffset; } /** Sets the units for the fill's offset. - * @param unit units for offset - * @see offsetUnit - * @see setOffset - * @see setOffsetMapUnitScale + * \param unit units for offset + * \see offsetUnit + * \see setOffset + * \see setOffsetMapUnitScale */ void setOffsetUnit( const QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; } /** Returns the units for the fill's offset. - * @returns units for offset - * @see setOffsetUnit - * @see offset - * @see offsetMapUnitScale + * \returns units for offset + * \see setOffsetUnit + * \see offset + * \see offsetMapUnitScale */ QgsUnitTypes::RenderUnit offsetUnit() const { return mOffsetUnit; } /** Sets the map unit scale for the fill's offset. - * @param scale map unit scale for offset - * @see offsetMapUnitScale - * @see setOffset - * @see setOffsetUnit + * \param scale map unit scale for offset + * \see offsetMapUnitScale + * \see setOffset + * \see setOffsetUnit */ void setOffsetMapUnitScale( const QgsMapUnitScale &scale ) { mOffsetMapUnitScale = scale; } /** Returns the map unit scale for the fill's offset. - * @returns map unit scale for offset - * @see setOffsetMapUnitScale - * @see offset - * @see offsetUnit + * \returns map unit scale for offset + * \see setOffsetMapUnitScale + * \see offset + * \see offsetUnit */ const QgsMapUnitScale &offsetMapUnitScale() const { return mOffsetMapUnitScale; } /** Sets the width for scaling the image used in the fill. The image's height will also be * scaled to maintain the image's aspect ratio. - * @param width width for scaling the image - * @see width - * @see setWidthUnit - * @see setWidthMapUnitScale + * \param width width for scaling the image + * \see width + * \see setWidthUnit + * \see setWidthMapUnitScale */ void setWidth( const double width ) { mWidth = width; } /** Returns the width used for scaling the image used in the fill. The image's height is * scaled to maintain the image's aspect ratio. - * @returns width used for scaling the image - * @see setWidth - * @see widthUnit - * @see widthMapUnitScale + * \returns width used for scaling the image + * \see setWidth + * \see widthUnit + * \see widthMapUnitScale */ double width() const { return mWidth; } /** Sets the units for the image's width. - * @param unit units for width - * @see widthUnit - * @see setWidth - * @see setWidthMapUnitScale + * \param unit units for width + * \see widthUnit + * \see setWidth + * \see setWidthMapUnitScale */ void setWidthUnit( const QgsUnitTypes::RenderUnit unit ) { mWidthUnit = unit; } /** Returns the units for the image's width. - * @returns units for width - * @see setWidthUnit - * @see width - * @see widthMapUnitScale + * \returns units for width + * \see setWidthUnit + * \see width + * \see widthMapUnitScale */ QgsUnitTypes::RenderUnit widthUnit() const { return mWidthUnit; } /** Sets the map unit scale for the image's width. - * @param scale map unit scale for width - * @see widthMapUnitScale - * @see setWidth - * @see setWidthUnit + * \param scale map unit scale for width + * \see widthMapUnitScale + * \see setWidth + * \see setWidthUnit */ void setWidthMapUnitScale( const QgsMapUnitScale &scale ) { mWidthMapUnitScale = scale; } /** Returns the map unit scale for the image's width. - * @returns map unit scale for width - * @see setWidthMapUnitScale - * @see width - * @see widthUnit + * \returns map unit scale for width + * \see setWidthMapUnitScale + * \see width + * \see widthUnit */ const QgsMapUnitScale &widthMapUnitScale() const { return mWidthMapUnitScale; } @@ -868,13 +868,13 @@ class CORE_EXPORT QgsSVGFillSymbolLayer: public QgsImageFillSymbolLayer double svgStrokeWidth() const { return mSvgStrokeWidth; } /** Sets the units for the width of the SVG images in the pattern. - * @param unit width units - * @see patternWidthUnit() + * \param unit width units + * \see patternWidthUnit() */ void setPatternWidthUnit( QgsUnitTypes::RenderUnit unit ) { mPatternWidthUnit = unit; } /** Returns the units for the width of the SVG images in the pattern. - * @see setPatternWidthUnit() + * \see setPatternWidthUnit() */ QgsUnitTypes::RenderUnit patternWidthUnit() const { return mPatternWidthUnit; } @@ -882,13 +882,13 @@ class CORE_EXPORT QgsSVGFillSymbolLayer: public QgsImageFillSymbolLayer const QgsMapUnitScale &patternWidthMapUnitScale() const { return mPatternWidthMapUnitScale; } /** Sets the units for the stroke width. - * @param unit width units - * @see svgStrokeWidthUnit() + * \param unit width units + * \see svgStrokeWidthUnit() */ void setSvgStrokeWidthUnit( QgsUnitTypes::RenderUnit unit ) { mSvgStrokeWidthUnit = unit; } /** Returns the units for the stroke width. - * @see setSvgStrokeWidthUnit() + * \see setSvgStrokeWidthUnit() */ QgsUnitTypes::RenderUnit svgStrokeWidthUnit() const { return mSvgStrokeWidthUnit; } @@ -968,15 +968,15 @@ class CORE_EXPORT QgsLinePatternFillSymbolLayer: public QgsImageFillSymbolLayer double lineAngle() const { return mLineAngle; } /** Sets the distance between lines in the fill pattern. - * @param d distance. Units are specified by setDistanceUnit() - * @see distance() - * @see setDistanceUnit() + * \param d distance. Units are specified by setDistanceUnit() + * \see distance() + * \see setDistanceUnit() */ void setDistance( double d ) { mDistance = d; } /** Returns the distance between lines in the fill pattern. Units are retrieved by distanceUnit(). - * @see setDistance() - * @see distanceUnit() + * \see setDistance() + * \see distanceUnit() */ double distance() const { return mDistance; } @@ -988,15 +988,15 @@ class CORE_EXPORT QgsLinePatternFillSymbolLayer: public QgsImageFillSymbolLayer double offset() const { return mOffset; } /** Sets the units for the distance between lines in the fill pattern. - * @param unit distance units - * @see distanceUnit() - * @see setDistance() + * \param unit distance units + * \see distanceUnit() + * \see setDistance() */ void setDistanceUnit( QgsUnitTypes::RenderUnit unit ) { mDistanceUnit = unit; } /** Returns the units for the distance between lines in the fill pattern. - * @see setDistanceUnit() - * @see distance() + * \see setDistanceUnit() + * \see distance() */ QgsUnitTypes::RenderUnit distanceUnit() const { return mDistanceUnit; } @@ -1004,13 +1004,13 @@ class CORE_EXPORT QgsLinePatternFillSymbolLayer: public QgsImageFillSymbolLayer const QgsMapUnitScale &distanceMapUnitScale() const { return mDistanceMapUnitScale; } /** Sets the units for the line's width. - * @param unit width units - * @see lineWidthUnit() + * \param unit width units + * \see lineWidthUnit() */ void setLineWidthUnit( QgsUnitTypes::RenderUnit unit ) { mLineWidthUnit = unit; } /** Returns the units for the line's width. - * @see setLineWidthUnit() + * \see setLineWidthUnit() */ QgsUnitTypes::RenderUnit lineWidthUnit() const { return mLineWidthUnit; } @@ -1018,13 +1018,13 @@ class CORE_EXPORT QgsLinePatternFillSymbolLayer: public QgsImageFillSymbolLayer const QgsMapUnitScale &lineWidthMapUnitScale() const { return mLineWidthMapUnitScale; } /** Sets the units for the line pattern's offset. - * @param unit offset units - * @see offsetUnit() + * \param unit offset units + * \see offsetUnit() */ void setOffsetUnit( QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; } /** Returns the units for the line pattern's offset. - * @see setOffsetUnit() + * \see setOffsetUnit() */ QgsUnitTypes::RenderUnit offsetUnit() const { return mOffsetUnit; } @@ -1112,15 +1112,15 @@ class CORE_EXPORT QgsPointPatternFillSymbolLayer: public QgsImageFillSymbolLayer virtual QgsSymbol *subSymbol() override { return mMarkerSymbol; } /** Sets the units for the horizontal distance between points in the pattern. - * @param unit distance units - * @see distanceXUnit() - * @see setDistanceYUnit() + * \param unit distance units + * \see distanceXUnit() + * \see setDistanceYUnit() */ void setDistanceXUnit( QgsUnitTypes::RenderUnit unit ) { mDistanceXUnit = unit; } /** Returns the units for the horizontal distance between points in the pattern. - * @see setDistanceXUnit() - * @see distanceYUnit() + * \see setDistanceXUnit() + * \see distanceYUnit() */ QgsUnitTypes::RenderUnit distanceXUnit() const { return mDistanceXUnit; } @@ -1128,15 +1128,15 @@ class CORE_EXPORT QgsPointPatternFillSymbolLayer: public QgsImageFillSymbolLayer const QgsMapUnitScale &distanceXMapUnitScale() const { return mDistanceXMapUnitScale; } /** Sets the units for the vertical distance between points in the pattern. - * @param unit distance units - * @see distanceYUnit() - * @see setDistanceXUnit() + * \param unit distance units + * \see distanceYUnit() + * \see setDistanceXUnit() */ void setDistanceYUnit( QgsUnitTypes::RenderUnit unit ) { mDistanceYUnit = unit; } /** Returns the units for the vertical distance between points in the pattern. - * @see setDistanceYUnit() - * @see distanceXUnit() + * \see setDistanceYUnit() + * \see distanceXUnit() */ QgsUnitTypes::RenderUnit distanceYUnit() const { return mDistanceYUnit; } @@ -1144,15 +1144,15 @@ class CORE_EXPORT QgsPointPatternFillSymbolLayer: public QgsImageFillSymbolLayer const QgsMapUnitScale &distanceYMapUnitScale() const { return mDistanceYMapUnitScale; } /** Sets the units for the horizontal displacement between rows in the pattern. - * @param unit displacement units - * @see displacementXUnit() - * @see setDisplacementYUnit() + * \param unit displacement units + * \see displacementXUnit() + * \see setDisplacementYUnit() */ void setDisplacementXUnit( QgsUnitTypes::RenderUnit unit ) { mDisplacementXUnit = unit; } /** Returns the units for the horizontal displacement between rows in the pattern. - * @see setDisplacementXUnit() - * @see displacementYUnit() + * \see setDisplacementXUnit() + * \see displacementYUnit() */ QgsUnitTypes::RenderUnit displacementXUnit() const { return mDisplacementXUnit; } @@ -1160,15 +1160,15 @@ class CORE_EXPORT QgsPointPatternFillSymbolLayer: public QgsImageFillSymbolLayer const QgsMapUnitScale &displacementXMapUnitScale() const { return mDisplacementXMapUnitScale; } /** Sets the units for the vertical displacement between rows in the pattern. - * @param unit displacement units - * @see displacementYUnit() - * @see setDisplacementXUnit() + * \param unit displacement units + * \see displacementYUnit() + * \see setDisplacementXUnit() */ void setDisplacementYUnit( QgsUnitTypes::RenderUnit unit ) { mDisplacementYUnit = unit; } /** Returns the units for the vertical displacement between rows in the pattern. - * @see setDisplacementYUnit() - * @see displacementXUnit() + * \see setDisplacementYUnit() + * \see displacementXUnit() */ QgsUnitTypes::RenderUnit displacementYUnit() const { return mDisplacementYUnit; } diff --git a/src/core/symbology-ng/qgsgeometrygeneratorsymbollayer.h b/src/core/symbology-ng/qgsgeometrygeneratorsymbollayer.h index 1cc9252eed9f..20981b2cbbb9 100644 --- a/src/core/symbology-ng/qgsgeometrygeneratorsymbollayer.h +++ b/src/core/symbology-ng/qgsgeometrygeneratorsymbollayer.h @@ -35,7 +35,7 @@ class CORE_EXPORT QgsGeometryGeneratorSymbolLayer : public QgsSymbolLayer * Set the type of symbol which should be created. * Should match with the return type of the expression. * - * @param symbolType The symbol type which shall be used below this symbol. + * \param symbolType The symbol type which shall be used below this symbol. */ void setSymbolType( QgsSymbol::SymbolType symbolType ); @@ -43,7 +43,7 @@ class CORE_EXPORT QgsGeometryGeneratorSymbolLayer : public QgsSymbolLayer * Access the symbol type. This defines the type of geometry * that is created by this generator. * - * @return Symbol type + * \returns Symbol type */ QgsSymbol::SymbolType symbolType() const { return mSymbolType; } @@ -85,7 +85,7 @@ class CORE_EXPORT QgsGeometryGeneratorSymbolLayer : public QgsSymbolLayer * which contains a QgsRenderContext which in turn contains an expression * context which is available to the evaluated expression. * - * @param context The rendering context which will be used to render and to + * \param context The rendering context which will be used to render and to * construct a geometry. */ virtual void render( QgsSymbolRenderContext &context ); diff --git a/src/core/symbology-ng/qgsgraduatedsymbolrenderer.h b/src/core/symbology-ng/qgsgraduatedsymbolrenderer.h index 1633aa60c88c..264a7e7f0d98 100644 --- a/src/core/symbology-ng/qgsgraduatedsymbolrenderer.h +++ b/src/core/symbology-ng/qgsgraduatedsymbolrenderer.h @@ -55,10 +55,10 @@ class CORE_EXPORT QgsRendererRange QString dump() const; /** Creates a DOM element representing the range in SLD format. - * @param doc DOM document - * @param element destination DOM element - * @param props graduated renderer properties - * @param firstRange set to true if the range is the first range, where the lower value uses a <= test + * \param doc DOM document + * \param element destination DOM element + * \param props graduated renderer properties + * \param firstRange set to true if the range is the first range, where the lower value uses a <= test * rather than a < test. */ void toSld( QDomDocument &doc, QDomElement &element, QgsStringMap props, bool firstRange = false ) const; @@ -98,7 +98,7 @@ class CORE_EXPORT QgsRendererRangeLabelFormat bool trimTrailingZeroes() const { return mTrimTrailingZeroes; } void setTrimTrailingZeroes( bool trimTrailingZeroes ) { mTrimTrailingZeroes = trimTrailingZeroes; } - //! @note labelForLowerUpper in Python bindings + //! \note labelForLowerUpper in Python bindings QString labelForRange( double lower, double upper ) const; QString labelForRange( const QgsRendererRange &range ) const; QString formatNumber( double value ) const; @@ -158,15 +158,15 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer bool updateRangeRenderState( int rangeIndex, bool render ); void addClass( QgsSymbol *symbol ); - //! @note available in Python bindings as addClassRange + //! \note available in Python bindings as addClassRange void addClass( const QgsRendererRange &range ); - //! @note available in Python bindings as addClassLowerUpper + //! \note available in Python bindings as addClassLowerUpper void addClass( double lower, double upper ); /** Add a breakpoint by splitting existing classes so that the specified * value becomes a break between two classes. - * @param breakValue position to insert break - * @param updateSymbols set to true to reapply ramp colors to the new + * \param breakValue position to insert break + * \param updateSymbols set to true to reapply ramp colors to the new * symbol ranges * \since QGIS 2.9 */ @@ -179,13 +179,13 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer void moveClass( int from, int to ); /** Tests whether classes assigned to the renderer have ranges which overlap. - * @returns true if ranges overlap + * \returns true if ranges overlap * \since QGIS 2.10 */ bool rangesOverlap() const; /** Tests whether classes assigned to the renderer have gaps between the ranges. - * @returns true if ranges have gaps + * \returns true if ranges have gaps * \since QGIS 2.10 */ bool rangesHaveGaps() const; @@ -206,9 +206,9 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer Mode mode() const { return mMode; } void setMode( Mode mode ) { mMode = mode; } //! Recalculate classes for a layer - //! @param vlayer The layer being rendered (from which data values are calculated) - //! @param mode The calculation mode - //! @param nclasses The number of classes to calculate (approximate for some modes) + //! \param vlayer The layer being rendered (from which data values are calculated) + //! \param mode The calculation mode + //! \param nclasses The number of classes to calculate (approximate for some modes) //! \since QGIS 2.6 void updateClasses( QgsVectorLayer *vlayer, Mode mode, int nclasses ); @@ -216,25 +216,25 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer //! \since QGIS 2.6 const QgsRendererRangeLabelFormat &labelFormat() const { return mLabelFormat; } //! Set the label format used to generate default classification labels - //! @param labelFormat The string appended to classification labels - //! @param updateRanges If true then ranges ending with the old unit string are updated to the new. + //! \param labelFormat The string appended to classification labels + //! \param updateRanges If true then ranges ending with the old unit string are updated to the new. //! \since QGIS 2.6 void setLabelFormat( const QgsRendererRangeLabelFormat &labelFormat, bool updateRanges = false ); //! Reset the label decimal places to a numberbased on the minimum class interval - //! @param updateRanges if true then ranges currently using the default label will be updated + //! \param updateRanges if true then ranges currently using the default label will be updated //! \since QGIS 2.6 void calculateLabelPrecision( bool updateRanges = true ); /** Creates a new graduated renderer. - * @param vlayer vector layer - * @param attrName attribute to classify - * @param classes number of classes - * @param mode classification mode - * @param symbol base symbol - * @param ramp color ramp for classes - * @param legendFormat - * @returns new QgsGraduatedSymbolRenderer object + * \param vlayer vector layer + * \param attrName attribute to classify + * \param classes number of classes + * \param mode classification mode + * \param symbol base symbol + * \param ramp color ramp for classes + * \param legendFormat + * \returns new QgsGraduatedSymbolRenderer object */ static QgsGraduatedSymbolRenderer *createRenderer( QgsVectorLayer *vlayer, @@ -257,45 +257,45 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer /** Returns the renderer's source symbol, which is the base symbol used for the each classes' symbol before applying * the classes' color. - * @see setSourceSymbol() - * @see sourceColorRamp() + * \see setSourceSymbol() + * \see sourceColorRamp() */ QgsSymbol *sourceSymbol(); /** Sets the source symbol for the renderer, which is the base symbol used for the each classes' symbol before applying * the classes' color. - * @param sym source symbol, ownership is transferred to the renderer - * @see sourceSymbol() - * @see setSourceColorRamp() + * \param sym source symbol, ownership is transferred to the renderer + * \see sourceSymbol() + * \see setSourceColorRamp() */ void setSourceSymbol( QgsSymbol *sym ); /** Returns the source color ramp, from which each classes' color is derived. - * @see setSourceColorRamp() - * @see sourceSymbol() + * \see setSourceColorRamp() + * \see sourceSymbol() */ QgsColorRamp *sourceColorRamp(); /** Sets the source color ramp. - * @param ramp color ramp. Ownership is transferred to the renderer + * \param ramp color ramp. Ownership is transferred to the renderer */ void setSourceColorRamp( QgsColorRamp *ramp ); /** Update the color ramp used. Also updates all symbols colors. * Doesn't alter current breaks. - * @param ramp color ramp. Ownership is transferred to the renderer + * \param ramp color ramp. Ownership is transferred to the renderer */ void updateColorRamp( QgsColorRamp *ramp = nullptr ); /** Update all the symbols but leave breaks and colors. This method also sets the source * symbol for the renderer. - * @param sym source symbol to use for classes. Ownership is not transferred. - * @see setSourceSymbol() + * \param sym source symbol to use for classes. Ownership is not transferred. + * \see setSourceSymbol() */ void updateSymbols( QgsSymbol *sym ); //! set varying symbol size for classes - //! @note the classes must already be set so that symbols exist + //! \note the classes must already be set so that symbols exist //! \since QGIS 2.10 void setSymbolSizes( double minSize, double maxSize ); @@ -325,7 +325,7 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer //! creates a QgsGraduatedSymbolRenderer from an existing renderer. //! \since QGIS 2.6 - //! @returns a new renderer if the conversion was possible, otherwise 0. + //! \returns a new renderer if the conversion was possible, otherwise 0. static QgsGraduatedSymbolRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ); protected: @@ -348,7 +348,7 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer */ QString legendKeyForValue( double value ) const; - //! @note not available in Python bindings + //! \note not available in Python bindings static const char *graduatedMethodStr( GraduatedMethod method ); private: diff --git a/src/core/symbology-ng/qgsheatmaprenderer.h b/src/core/symbology-ng/qgsheatmaprenderer.h index 06f7bb25c84a..9ba211019fb1 100644 --- a/src/core/symbology-ng/qgsheatmaprenderer.h +++ b/src/core/symbology-ng/qgsheatmaprenderer.h @@ -46,9 +46,9 @@ class CORE_EXPORT QgsHeatmapRenderer : public QgsFeatureRenderer virtual void startRender( QgsRenderContext &context, const QgsFields &fields ) override; virtual bool renderFeature( QgsFeature &feature, QgsRenderContext &context, int layer = -1, bool selected = false, bool drawVertexMarker = false ) override; virtual void stopRender( QgsRenderContext &context ) override; - //! @note symbolForFeature2 in Python bindings + //! \note symbolForFeature2 in Python bindings virtual QgsSymbol *symbolForFeature( QgsFeature &feature, QgsRenderContext &context ) override; - //! @note symbol2 in Python bindings + //! \note symbol2 in Python bindings virtual QgsSymbolList symbols( QgsRenderContext &context ) override; virtual QString dump() const override; virtual QSet usedAttributes( const QgsRenderContext &context ) const override; @@ -63,102 +63,102 @@ class CORE_EXPORT QgsHeatmapRenderer : public QgsFeatureRenderer //heatmap specific methods /** Returns the color ramp used for shading the heatmap. - * @returns color ramp for heatmap - * @see setColorRamp + * \returns color ramp for heatmap + * \see setColorRamp */ QgsColorRamp *colorRamp() const { return mGradientRamp; } /** Sets the color ramp to use for shading the heatmap. - * @param ramp color ramp for heatmap. Ownership of ramp is transferred to the renderer. - * @see colorRamp + * \param ramp color ramp for heatmap. Ownership of ramp is transferred to the renderer. + * \see colorRamp */ void setColorRamp( QgsColorRamp *ramp ); /** Returns the radius for the heatmap - * @returns heatmap radius - * @see setRadius - * @see radiusUnit - * @see radiusMapUnitScale + * \returns heatmap radius + * \see setRadius + * \see radiusUnit + * \see radiusMapUnitScale */ double radius() const { return mRadius; } /** Sets the radius for the heatmap - * @param radius heatmap radius - * @see radius - * @see setRadiusUnit - * @see setRadiusMapUnitScale + * \param radius heatmap radius + * \see radius + * \see setRadiusUnit + * \see setRadiusMapUnitScale */ void setRadius( const double radius ) { mRadius = radius; } /** Returns the units used for the heatmap's radius - * @returns units for heatmap radius - * @see radius - * @see setRadiusUnit - * @see radiusMapUnitScale + * \returns units for heatmap radius + * \see radius + * \see setRadiusUnit + * \see radiusMapUnitScale */ QgsUnitTypes::RenderUnit radiusUnit() const { return mRadiusUnit; } /** Sets the units used for the heatmap's radius - * @param unit units for heatmap radius - * @see radiusUnit - * @see setRadius - * @see radiusMapUnitScale + * \param unit units for heatmap radius + * \see radiusUnit + * \see setRadius + * \see radiusMapUnitScale */ void setRadiusUnit( const QgsUnitTypes::RenderUnit unit ) { mRadiusUnit = unit; } /** Returns the map unit scale used for the heatmap's radius - * @returns map unit scale for heatmap's radius - * @see radius - * @see radiusUnit - * @see setRadiusMapUnitScale + * \returns map unit scale for heatmap's radius + * \see radius + * \see radiusUnit + * \see setRadiusMapUnitScale */ const QgsMapUnitScale &radiusMapUnitScale() const { return mRadiusMapUnitScale; } /** Sets the map unit scale used for the heatmap's radius - * @param scale map unit scale for heatmap's radius - * @see setRadius - * @see setRadiusUnit - * @see radiusMapUnitScale + * \param scale map unit scale for heatmap's radius + * \see setRadius + * \see setRadiusUnit + * \see radiusMapUnitScale */ void setRadiusMapUnitScale( const QgsMapUnitScale &scale ) { mRadiusMapUnitScale = scale; } /** Returns the maximum value used for shading the heatmap. - * @returns maximum value for heatmap shading. If 0, then maximum value will be automatically + * \returns maximum value for heatmap shading. If 0, then maximum value will be automatically * calculated. - * @see setMaximumValue + * \see setMaximumValue */ double maximumValue() const { return mExplicitMax; } /** Sets the maximum value used for shading the heatmap. - * @param value maximum value for heatmap shading. Set to 0 for automatic calculation of + * \param value maximum value for heatmap shading. Set to 0 for automatic calculation of * maximum value. - * @see maximumValue + * \see maximumValue */ void setMaximumValue( const double value ) { mExplicitMax = value; } /** Returns the render quality used for drawing the heatmap. - * @returns render quality. A value of 1 indicates maximum quality, and increasing the + * \returns render quality. A value of 1 indicates maximum quality, and increasing the * value will result in faster drawing but lower quality rendering. - * @see setRenderQuality + * \see setRenderQuality */ double renderQuality() const { return mRenderQuality; } /** Sets the render quality used for drawing the heatmap. - * @param quality render quality. A value of 1 indicates maximum quality, and increasing the + * \param quality render quality. A value of 1 indicates maximum quality, and increasing the * value will result in faster drawing but lower quality rendering. - * @see renderQuality + * \see renderQuality */ void setRenderQuality( const int quality ) { mRenderQuality = quality; } /** Returns the expression used for weighting points when generating the heatmap. - * @returns point weight expression. If empty, all points are equally weighted. - * @see setWeightExpression + * \returns point weight expression. If empty, all points are equally weighted. + * \see setWeightExpression */ QString weightExpression() const { return mWeightExpressionString; } /** Sets the expression used for weighting points when generating the heatmap. - * @param expression point weight expression. If set to empty, all points are equally weighted. - * @see weightExpression + * \param expression point weight expression. If set to empty, all points are equally weighted. + * \see weightExpression */ void setWeightExpression( const QString &expression ) { mWeightExpressionString = expression; } diff --git a/src/core/symbology-ng/qgsinvertedpolygonrenderer.h b/src/core/symbology-ng/qgsinvertedpolygonrenderer.h index fea1b396393a..892eec8f1a95 100644 --- a/src/core/symbology-ng/qgsinvertedpolygonrenderer.h +++ b/src/core/symbology-ng/qgsinvertedpolygonrenderer.h @@ -41,7 +41,7 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRenderer public: /** Constructor - * @param embeddedRenderer optional embeddedRenderer. If null, a default one will be assigned. + * \param embeddedRenderer optional embeddedRenderer. If null, a default one will be assigned. * Ownership will be transferred. */ QgsInvertedPolygonRenderer( QgsFeatureRenderer *embeddedRenderer = nullptr ); @@ -56,12 +56,12 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRenderer /** Renders a given feature. * This will here collect features. The actual rendering will be postponed to stopRender() - * @param feature the feature to render - * @param context the rendering context - * @param layer the symbol layer to render, if that makes sense - * @param selected whether this feature has been selected (this will add decorations) - * @param drawVertexMarker whether this feature has vertex markers (in edit mode usually) - * @returns true if the rendering was ok + * \param feature the feature to render + * \param context the rendering context + * \param layer the symbol layer to render, if that makes sense + * \param selected whether this feature has been selected (this will add decorations) + * \param drawVertexMarker whether this feature has vertex markers (in edit mode usually) + * \returns true if the rendering was ok */ virtual bool renderFeature( QgsFeature &feature, QgsRenderContext &context, int layer = -1, bool selected = false, bool drawVertexMarker = false ) override; @@ -101,7 +101,7 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRenderer virtual QgsLegendSymbologyList legendSymbologyItems( QSize iconSize ) override; /** Proxy that will call this method on the embedded renderer. - * @note not available in Python bindings + * \note not available in Python bindings */ virtual QgsLegendSymbolList legendSymbolItems( double scaleDenominator = -1, const QString &rule = "" ) override; @@ -123,11 +123,11 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRenderer virtual bool legendSymbolItemChecked( const QString &key ) override; virtual void checkLegendSymbolItem( const QString &key, bool state = true ) override; - //! @returns true if the geometries are to be preprocessed (merged with an union) before rendering. + //! \returns true if the geometries are to be preprocessed (merged with an union) before rendering. bool preprocessingEnabled() const { return mPreprocessingEnabled; } /** - * @param enabled enables or disables the preprocessing. + * \param enabled enables or disables the preprocessing. * When enabled, geometries will be merged with an union before being rendered. * It allows fixing some rendering artifacts (when rendering overlapping polygons for instance). * This will involve some CPU-demanding computations and is thus disabled by default. @@ -136,7 +136,7 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRenderer /** Creates a QgsInvertedPolygonRenderer by a conversion from an existing renderer. * \since QGIS 2.5 - * @returns a new renderer if the conversion was possible, otherwise 0. + * \returns a new renderer if the conversion was possible, otherwise 0. */ static QgsInvertedPolygonRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ); @@ -152,7 +152,7 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRenderer QgsFeature feature; //< one feature (for attriute-based rendering) }; typedef QVector FeatureCategoryVector; - //! Where features are stored, based on the index of their symbol category @see mSymbolCategories + //! Where features are stored, based on the index of their symbol category \see mSymbolCategories FeatureCategoryVector mFeaturesCategories; //! Maps a category to an index diff --git a/src/core/symbology-ng/qgslegendsymbolitem.h b/src/core/symbology-ng/qgslegendsymbolitem.h index e7f9c945f06d..006e0190bfaf 100644 --- a/src/core/symbology-ng/qgslegendsymbolitem.h +++ b/src/core/symbology-ng/qgslegendsymbolitem.h @@ -26,7 +26,7 @@ class QgsSymbol; * The class stores information about one class/rule of a vector layer renderer in a unified way * that can be used by legend model for rendering of legend. * - * @see QgsSymbolLegendNode + * \see QgsSymbolLegendNode * \since QGIS 2.6 */ class CORE_EXPORT QgsLegendSymbolItem diff --git a/src/core/symbology-ng/qgslinesymbollayer.h b/src/core/symbology-ng/qgslinesymbollayer.h index 12e230ba0b30..e65023f0ff64 100644 --- a/src/core/symbology-ng/qgslinesymbollayer.h +++ b/src/core/symbology-ng/qgslinesymbollayer.h @@ -89,13 +89,13 @@ class CORE_EXPORT QgsSimpleLineSymbolLayer : public QgsLineSymbolLayer void setUseCustomDashPattern( bool b ) { mUseCustomDashPattern = b; } /** Sets the units for lengths used in the custom dash pattern. - * @param unit length units - * @see customDashPatternUnit() + * \param unit length units + * \see customDashPatternUnit() */ void setCustomDashPatternUnit( QgsUnitTypes::RenderUnit unit ) { mCustomDashPatternUnit = unit; } /** Returns the units for lengths used in the custom dash pattern. - * @see setCustomDashPatternUnit() + * \see setCustomDashPatternUnit() */ QgsUnitTypes::RenderUnit customDashPatternUnit() const { return mCustomDashPatternUnit; } @@ -171,18 +171,18 @@ class CORE_EXPORT QgsMarkerLineSymbolLayer : public QgsLineSymbolLayer /** * Create a new MarkerLineSymbolLayerV2 * - * @param properties A property map to deserialize saved information from properties() + * \param properties A property map to deserialize saved information from properties() * - * @return A new MarkerLineSymbolLayerV2 + * \returns A new MarkerLineSymbolLayerV2 */ static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ); /** * Create a new MarkerLineSymbolLayerV2 from SLD * - * @param element An SLD XML DOM element + * \param element An SLD XML DOM element * - * @return A new MarkerLineSymbolLayerV2 + * \returns A new MarkerLineSymbolLayerV2 */ static QgsSymbolLayer *createFromSld( QDomElement &element ); @@ -220,7 +220,7 @@ class CORE_EXPORT QgsMarkerLineSymbolLayer : public QgsLineSymbolLayer /** * Shall the marker be rotated. * - * @return True if the marker should be rotated. + * \returns True if the marker should be rotated. */ bool rotateMarker() const { return mRotateMarker; } @@ -231,16 +231,16 @@ class CORE_EXPORT QgsMarkerLineSymbolLayer : public QgsLineSymbolLayer /** * Returns the interval between individual markers. Units are specified through intervalUnits(). - * @see setInterval() - * @see intervalUnit() + * \see setInterval() + * \see intervalUnit() */ double interval() const { return mInterval; } /** * Sets the interval between individual markers. - * @param interval interval size. Units are specified through setIntervalUnits() - * @see interval() - * @see setIntervalUnits() + * \param interval interval size. Units are specified through setIntervalUnits() + * \see interval() + * \see setIntervalUnits() */ void setInterval( double interval ) { mInterval = interval; } @@ -258,11 +258,11 @@ class CORE_EXPORT QgsMarkerLineSymbolLayer : public QgsLineSymbolLayer * between the start of the line and the first marker. For FirstVertex and LastVertex placements, this is the * distance between the marker and the start of the line or the end of the line respectively. * This setting has no effect for Vertex or CentralPoint placements. - * @returns The offset along the line. The unit for the offset is retrievable via offsetAlongLineUnit. + * \returns The offset along the line. The unit for the offset is retrievable via offsetAlongLineUnit. * \since QGIS 2.3 - * @see setOffsetAlongLine - * @see offsetAlongLineUnit - * @see placement + * \see setOffsetAlongLine + * \see offsetAlongLineUnit + * \see placement */ double offsetAlongLine() const { return mOffsetAlongLine; } @@ -270,49 +270,49 @@ class CORE_EXPORT QgsMarkerLineSymbolLayer : public QgsLineSymbolLayer * between the start of the line and the first marker. For FirstVertex and LastVertex placements, this is the * distance between the marker and the start of the line or the end of the line respectively. * This setting has no effect for Vertex or CentralPoint placements. - * @param offsetAlongLine Distance to offset markers along the line. The offset + * \param offsetAlongLine Distance to offset markers along the line. The offset * unit is set via setOffsetAlongLineUnit. * \since QGIS 2.3 - * @see offsetAlongLine - * @see setOffsetAlongLineUnit - * @see setPlacement + * \see offsetAlongLine + * \see setOffsetAlongLineUnit + * \see setPlacement */ void setOffsetAlongLine( double offsetAlongLine ) { mOffsetAlongLine = offsetAlongLine; } /** Returns the unit used for calculating the offset along line for markers. - * @returns Offset along line unit type. - * @see setOffsetAlongLineUnit - * @see offsetAlongLine + * \returns Offset along line unit type. + * \see setOffsetAlongLineUnit + * \see offsetAlongLine */ QgsUnitTypes::RenderUnit offsetAlongLineUnit() const { return mOffsetAlongLineUnit; } /** Sets the unit used for calculating the offset along line for markers. - * @param unit Offset along line unit type. - * @see offsetAlongLineUnit - * @see setOffsetAlongLine + * \param unit Offset along line unit type. + * \see offsetAlongLineUnit + * \see setOffsetAlongLine */ void setOffsetAlongLineUnit( QgsUnitTypes::RenderUnit unit ) { mOffsetAlongLineUnit = unit; } /** Returns the map unit scale used for calculating the offset in map units along line for markers. - * @returns Offset along line map unit scale. + * \returns Offset along line map unit scale. */ const QgsMapUnitScale &offsetAlongLineMapUnitScale() const { return mOffsetAlongLineMapUnitScale; } /** Sets the map unit scale used for calculating the offset in map units along line for markers. - * @param scale Offset along line map unit scale. + * \param scale Offset along line map unit scale. */ void setOffsetAlongLineMapUnitScale( const QgsMapUnitScale &scale ) { mOffsetAlongLineMapUnitScale = scale; } /** Sets the units for the interval between markers. - * @param unit interval units - * @see intervalUnit() - * @see setInterval() + * \param unit interval units + * \see intervalUnit() + * \see setInterval() */ void setIntervalUnit( QgsUnitTypes::RenderUnit unit ) { mIntervalUnit = unit; } /** Returns the units for the interval between markers. - * @see setIntervalUnit() - * @see interval() + * \see setIntervalUnit() + * \see interval() */ QgsUnitTypes::RenderUnit intervalUnit() const { return mIntervalUnit; } @@ -350,14 +350,14 @@ class CORE_EXPORT QgsMarkerLineSymbolLayer : public QgsLineSymbolLayer private: /** Renders a marker by offsetting a vertex along the line by a specified distance. - * @param points vertices making up the line - * @param vertex vertex number to begin offset at - * @param distance distance to offset from vertex. If distance is positive, offset is calculated + * \param points vertices making up the line + * \param vertex vertex number to begin offset at + * \param distance distance to offset from vertex. If distance is positive, offset is calculated * moving forward along the line. If distance is negative, offset is calculated moving backward * along the line's vertices. - * @param context render context - * @see setoffsetAlongLine - * @see setOffsetAlongLineUnit + * \param context render context + * \see setoffsetAlongLine + * \see setOffsetAlongLineUnit */ void renderOffsetVertexAlongLine( const QPolygonF &points, int vertex, double distance, QgsSymbolRenderContext &context ); }; diff --git a/src/core/symbology-ng/qgsmarkersymbollayer.h b/src/core/symbology-ng/qgsmarkersymbollayer.h index 09ebdd98486e..804ba30ca7e1 100644 --- a/src/core/symbology-ng/qgsmarkersymbollayer.h +++ b/src/core/symbology-ng/qgsmarkersymbollayer.h @@ -74,16 +74,16 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer static QList< Shape > availableShapes(); /** Returns true if a symbol shape has a fill. - * @param shape shape to test - * @returns true if shape uses a fill, or false if shape uses lines only + * \param shape shape to test + * \returns true if shape uses a fill, or false if shape uses lines only */ static bool shapeIsFilled( Shape shape ); /** Constructor for QgsSimpleMarkerSymbolLayerBase. - * @param shape symbol shape for markers - * @param size symbol size (in mm) - * @param angle symbol rotation angle - * @param scaleMethod scaling method for data defined scaling + * \param shape symbol shape for markers + * \param size symbol size (in mm) + * \param angle symbol rotation angle + * \param scaleMethod scaling method for data defined scaling */ QgsSimpleMarkerSymbolLayerBase( Shape shape = Circle, double size = DEFAULT_SIMPLEMARKER_SIZE, @@ -91,29 +91,29 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer QgsSymbol::ScaleMethod scaleMethod = DEFAULT_SCALE_METHOD ); /** Returns the shape for the rendered marker symbol. - * @see setShape() + * \see setShape() */ Shape shape() const { return mShape; } /** Sets the rendered marker shape. - * @param shape new marker shape - * @see shape() + * \param shape new marker shape + * \see shape() */ void setShape( Shape shape ) { mShape = shape; } /** Attempts to decode a string representation of a shape name to the corresponding * shape. - * @param name encoded shape name - * @param ok if specified, will be set to true if shape was successfully decoded - * @return decoded name - * @see encodeShape() + * \param name encoded shape name + * \param ok if specified, will be set to true if shape was successfully decoded + * \returns decoded name + * \see encodeShape() */ static Shape decodeShape( const QString &name, bool *ok = nullptr ); /** Encodes a shape to its string representation. - * @param shape shape to encode - * @returns encoded string - * @see decodeShape() + * \param shape shape to encode + * \returns encoded string + * \see decodeShape() */ static QString encodeShape( Shape shape ); @@ -125,36 +125,36 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer protected: //! Prepares the layer for drawing the specified shape (QPolygonF version) - //! @note not available in Python bindings + //! \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 + //! \note not available in Python bindings bool prepareMarkerPath( Shape symbol ); /** Creates a polygon representing the specified shape. - * @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 + * \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; /** Calculates the desired size of the marker, considering data defined size overrides. - * @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 + * \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; /** Calculates the marker offset and rotation. - * @param context symbol render context - * @param scaledSize size of symbol to render - * @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 + * \param context symbol render context + * \param scaledSize size of symbol to render + * \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; @@ -170,11 +170,11 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer private: /** Derived classes must implement draw() to handle drawing the generated shape onto the painter surface. - * @param context symbol render context - * @param shape shape to draw - * @param polygon polygon representing transformed marker shape. May be empty, in which case the shape will be specified + * \param context symbol render context + * \param shape shape to draw + * \param polygon polygon representing transformed marker shape. May be empty, in which case the shape will be specified * in the path argument. - * @param path transformed painter path representing shape to draw + * \param path transformed painter path representing shape to draw */ virtual void draw( QgsSymbolRenderContext &context, Shape shape, const QPolygonF &polygon, const QPainterPath &path ) = 0; }; @@ -188,13 +188,13 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer public: /** Constructor for QgsSimpleMarkerSymbolLayer. - * @param shape symbol shape - * @param size symbol size (in mm) - * @param angle symbol rotation angle - * @param scaleMethod scaling method for data defined scaling - * @param color fill color for symbol - * @param strokeColor stroke color for symbol - * @param penJoinStyle join style for stroke pen + * \param shape symbol shape + * \param size symbol size (in mm) + * \param angle symbol rotation angle + * \param scaleMethod scaling method for data defined scaling + * \param color fill color for symbol + * \param strokeColor stroke color for symbol + * \param penJoinStyle join style for stroke pen */ QgsSimpleMarkerSymbolLayer( Shape shape = Circle, double size = DEFAULT_SIMPLEMARKER_SIZE, @@ -207,14 +207,14 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer // static methods /** Creates a new QgsSimpleMarkerSymbolLayer. - * @param properties a property map containing symbol properties (see properties()) - * @returns new QgsSimpleMarkerSymbolLayer + * \param properties a property map containing symbol properties (see properties()) + * \returns new QgsSimpleMarkerSymbolLayer */ static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ); /** Creates a new QgsSimpleMarkerSymbolLayer from an SLD XML element. - * @param element XML element containing SLD definition of symbol - * @returns new QgsSimpleMarkerSymbolLayer + * \param element XML element containing SLD definition of symbol + * \returns new QgsSimpleMarkerSymbolLayer */ static QgsSymbolLayer *createFromSld( QDomElement &element ); @@ -241,110 +241,110 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer // new methods /** Returns the marker's stroke color. - * @see setStrokeColor() - * @see strokeStyle() - * @see penJoinStyle() + * \see setStrokeColor() + * \see strokeStyle() + * \see penJoinStyle() */ QColor strokeColor() const override { return mStrokeColor; } /** Sets the marker's stroke color. - * @param color stroke color - * @see strokeColor() - * @see setStrokeStyle() - * @see setPenJoinStyle() + * \param color stroke color + * \see strokeColor() + * \see setStrokeStyle() + * \see setPenJoinStyle() */ void setStrokeColor( const QColor &color ) override { mStrokeColor = color; } /** Returns the marker's stroke style (e.g., solid, dashed, etc) * \since QGIS 2.4 - * @see setStrokeStyle() - * @see strokeColor() - * @see penJoinStyle() + * \see setStrokeStyle() + * \see strokeColor() + * \see penJoinStyle() */ Qt::PenStyle strokeStyle() const { return mStrokeStyle; } /** Sets the marker's stroke style (e.g., solid, dashed, etc) - * @param strokeStyle style + * \param strokeStyle style * \since QGIS 2.4 - * @see strokeStyle() - * @see setStrokeColor() - * @see setPenJoinStyle() + * \see strokeStyle() + * \see setStrokeColor() + * \see setPenJoinStyle() */ void setStrokeStyle( Qt::PenStyle strokeStyle ) { mStrokeStyle = strokeStyle; } /** Returns the marker's stroke join style (e.g., miter, bevel, etc). * \since QGIS 2.16 - * @see setPenJoinStyle() - * @see strokeColor() - * @see strokeStyle() + * \see setPenJoinStyle() + * \see strokeColor() + * \see strokeStyle() */ Qt::PenJoinStyle penJoinStyle() const { return mPenJoinStyle; } /** Sets the marker's stroke join style (e.g., miter, bevel, etc). - * @param style join style + * \param style join style * \since QGIS 2.16 - * @see penJoinStyle() - * @see setStrokeColor() - * @see setStrokeStyle() + * \see penJoinStyle() + * \see setStrokeColor() + * \see setStrokeStyle() */ void setPenJoinStyle( Qt::PenJoinStyle style ) { mPenJoinStyle = style; } /** Returns the width of the marker's stroke. - * @see setStrokeWidth() - * @see strokeWidthUnit() - * @see strokeWidthMapUnitScale() + * \see setStrokeWidth() + * \see strokeWidthUnit() + * \see strokeWidthMapUnitScale() */ double strokeWidth() const { return mStrokeWidth; } /** Sets the width of the marker's stroke. - * @param w stroke width. See strokeWidthUnit() for units. - * @see strokeWidth() - * @see setStrokeWidthUnit() - * @see setStrokeWidthMapUnitScale() + * \param w stroke width. See strokeWidthUnit() for units. + * \see strokeWidth() + * \see setStrokeWidthUnit() + * \see setStrokeWidthMapUnitScale() */ void setStrokeWidth( double w ) { mStrokeWidth = w; } /** Sets the unit for the width of the marker's stroke. - * @param u stroke width unit - * @see strokeWidthUnit() - * @see setStrokeWidth() - * @see setStrokeWidthMapUnitScale() + * \param u stroke width unit + * \see strokeWidthUnit() + * \see setStrokeWidth() + * \see setStrokeWidthMapUnitScale() */ void setStrokeWidthUnit( QgsUnitTypes::RenderUnit u ) { mStrokeWidthUnit = u; } /** Returns the unit for the width of the marker's stroke. - * @see setStrokeWidthUnit() - * @see strokeWidth() - * @see strokeWidthMapUnitScale() + * \see setStrokeWidthUnit() + * \see strokeWidth() + * \see strokeWidthMapUnitScale() */ QgsUnitTypes::RenderUnit strokeWidthUnit() const { return mStrokeWidthUnit; } /** Sets the map scale for the width of the marker's stroke. - * @param scale stroke width map unit scale - * @see strokeWidthMapUnitScale() - * @see setStrokeWidth() - * @see setStrokeWidthUnit() + * \param scale stroke width map unit scale + * \see strokeWidthMapUnitScale() + * \see setStrokeWidth() + * \see setStrokeWidthUnit() */ void setStrokeWidthMapUnitScale( const QgsMapUnitScale &scale ) { mStrokeWidthMapUnitScale = scale; } /** Returns the map scale for the width of the marker's stroke. - * @see setStrokeWidthMapUnitScale() - * @see strokeWidth() - * @see strokeWidthUnit() + * \see setStrokeWidthMapUnitScale() + * \see strokeWidth() + * \see strokeWidthUnit() */ const QgsMapUnitScale &strokeWidthMapUnitScale() const { return mStrokeWidthMapUnitScale; } protected: /** Draws the marker shape in the specified painter. - * @param p destination QPainter - * @param context symbol context - * @note this method does not handle setting the painter pen or brush to match the symbol's fill or stroke + * \param p destination QPainter + * \param context symbol context + * \note this method does not handle setting the painter pen or brush to match the symbol's fill or stroke */ void drawMarker( QPainter *p, QgsSymbolRenderContext &context ); /** Prepares cache image - * @returns true in case of success, false if cache image size too large + * \returns true in case of success, false if cache image size too large */ bool prepareCache( QgsSymbolRenderContext &context ); @@ -395,10 +395,10 @@ class CORE_EXPORT QgsFilledMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer public: /** Constructor for QgsFilledMarkerSymbolLayer. - * @param shape symbol shape - * @param size symbol size (in mm) - * @param angle symbol rotation angle - * @param scaleMethod size scaling method + * \param shape symbol shape + * \param size symbol size (in mm) + * \param angle symbol rotation angle + * \param scaleMethod size scaling method */ QgsFilledMarkerSymbolLayer( Shape shape = Circle, double size = DEFAULT_SIMPLEMARKER_SIZE, @@ -406,8 +406,8 @@ class CORE_EXPORT QgsFilledMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer QgsSymbol::ScaleMethod scaleMethod = DEFAULT_SCALE_METHOD ); /** Creates a new QgsFilledMarkerSymbolLayer. - * @param properties a property map containing symbol properties (see properties()) - * @returns new QgsFilledMarkerSymbolLayer + * \param properties a property map containing symbol properties (see properties()) + * \returns new QgsFilledMarkerSymbolLayer */ static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ); @@ -482,13 +482,13 @@ class CORE_EXPORT QgsSvgMarkerSymbolLayer : public QgsMarkerSymbolLayer void setStrokeWidth( double w ) { mStrokeWidth = w; } /** Sets the units for the stroke width. - * @param unit width units - * @see strokeWidthUnit() + * \param unit width units + * \see strokeWidthUnit() */ void setStrokeWidthUnit( QgsUnitTypes::RenderUnit unit ) { mStrokeWidthUnit = unit; } /** Returns the units for the stroke width. - * @see strokeWidthUnit() + * \see strokeWidthUnit() */ QgsUnitTypes::RenderUnit strokeWidthUnit() const { return mStrokeWidthUnit; } diff --git a/src/core/symbology-ng/qgsnullsymbolrenderer.h b/src/core/symbology-ng/qgsnullsymbolrenderer.h index e0829ad0783a..0779d61bb28c 100644 --- a/src/core/symbology-ng/qgsnullsymbolrenderer.h +++ b/src/core/symbology-ng/qgsnullsymbolrenderer.h @@ -47,16 +47,16 @@ class CORE_EXPORT QgsNullSymbolRenderer : public QgsFeatureRenderer virtual QgsSymbolList symbols( QgsRenderContext &context ) override; /** Creates a null renderer from XML element. - * @param element DOM element - * @returns new null symbol renderer + * \param element DOM element + * \returns new null symbol renderer */ static QgsFeatureRenderer *create( QDomElement &element ); virtual QDomElement save( QDomDocument &doc ) override; /** Creates a QgsNullSymbolRenderer from an existing renderer. - * @param renderer renderer to convert from - * @returns a new renderer if the conversion was possible, otherwise nullptr. + * \param renderer renderer to convert from + * \returns a new renderer if the conversion was possible, otherwise nullptr. */ static QgsNullSymbolRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ); diff --git a/src/core/symbology-ng/qgspointclusterrenderer.h b/src/core/symbology-ng/qgspointclusterrenderer.h index 2caac034fdc7..c1920ee2a539 100644 --- a/src/core/symbology-ng/qgspointclusterrenderer.h +++ b/src/core/symbology-ng/qgspointclusterrenderer.h @@ -42,18 +42,18 @@ class CORE_EXPORT QgsPointClusterRenderer: public QgsPointDistanceRenderer static QgsFeatureRenderer *create( QDomElement &symbologyElem ); /** Returns the symbol used for rendering clustered groups (but not ownership of the symbol). - * @see setClusterSymbol() + * \see setClusterSymbol() */ QgsMarkerSymbol *clusterSymbol(); /** Sets the symbol for rendering clustered groups. - * @param symbol new cluster symbol. Ownership is transferred to the renderer. - * @see clusterSymbol() + * \param symbol new cluster symbol. Ownership is transferred to the renderer. + * \see clusterSymbol() */ void setClusterSymbol( QgsMarkerSymbol *symbol ); /** Creates a QgsPointClusterRenderer from an existing renderer. - * @returns a new renderer if the conversion was possible, otherwise nullptr. + * \returns a new renderer if the conversion was possible, otherwise nullptr. */ static QgsPointClusterRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ); diff --git a/src/core/symbology-ng/qgspointdisplacementrenderer.h b/src/core/symbology-ng/qgspointdisplacementrenderer.h index 7985f421a2bc..0de65b7379cd 100644 --- a/src/core/symbology-ng/qgspointdisplacementrenderer.h +++ b/src/core/symbology-ng/qgspointdisplacementrenderer.h @@ -38,7 +38,7 @@ class CORE_EXPORT QgsPointDisplacementRenderer: public QgsPointDistanceRenderer }; /** Constructor for QgsPointDisplacementRenderer. - * @param labelAttributeName optional attribute name for labeling points + * \param labelAttributeName optional attribute name for labeling points */ QgsPointDisplacementRenderer( const QString &labelAttributeName = QString() ); @@ -52,69 +52,69 @@ class CORE_EXPORT QgsPointDisplacementRenderer: public QgsPointDistanceRenderer static QgsFeatureRenderer *create( QDomElement &symbologyElem ); /** Sets the line width for the displacement group circle. - * @param width line width in mm - * @see circleWidth() - * @see setCircleColor() + * \param width line width in mm + * \see circleWidth() + * \see setCircleColor() */ void setCircleWidth( double width ) { mCircleWidth = width; } /** Returns the line width for the displacement group circle in mm. - * @see setCircleWidth() - * @see circleColor() + * \see setCircleWidth() + * \see circleColor() */ double circleWidth() const { return mCircleWidth; } /** Sets the color used for drawing the displacement group circle. - * @param color circle color - * @see circleColor() - * @see setCircleWidth() + * \param color circle color + * \see circleColor() + * \see setCircleWidth() */ void setCircleColor( const QColor &color ) { mCircleColor = color; } /** Returns the color used for drawing the displacement group circle. - * @see setCircleColor() - * @see circleWidth() + * \see setCircleColor() + * \see circleWidth() */ QColor circleColor() const { return mCircleColor; } /** Sets a factor for increasing the ring size of displacement groups. - * @param distance addition factor - * @see circleRadiusAddition() + * \param distance addition factor + * \see circleRadiusAddition() */ void setCircleRadiusAddition( double distance ) { mCircleRadiusAddition = distance; } /** Returns the factor for increasing the ring size of displacement groups. - * @see setCircleRadiusAddition() + * \see setCircleRadiusAddition() */ double circleRadiusAddition() const { return mCircleRadiusAddition; } /** Returns the placement method used for dispersing the points. - * @see setPlacement() + * \see setPlacement() * \since QGIS 2.12 */ Placement placement() const { return mPlacement; } /** Sets the placement method used for dispersing the points. - * @param placement placement method - * @see placement() + * \param placement placement method + * \see placement() * \since QGIS 2.12 */ void setPlacement( Placement placement ) { mPlacement = placement; } /** Returns the symbol for the center of a displacement group (but not ownership of the symbol). - * @see setCenterSymbol() + * \see setCenterSymbol() */ QgsMarkerSymbol *centerSymbol(); /** Sets the center symbol for a displacement group. - * @param symbol new center symbol. Ownership is transferred to the renderer. - * @see centerSymbol() + * \param symbol new center symbol. Ownership is transferred to the renderer. + * \see centerSymbol() */ void setCenterSymbol( QgsMarkerSymbol *symbol ); /** Creates a QgsPointDisplacementRenderer from an existing renderer. * \since QGIS 2.5 - * @returns a new renderer if the conversion was possible, otherwise nullptr. + * \returns a new renderer if the conversion was possible, otherwise nullptr. */ static QgsPointDisplacementRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ); diff --git a/src/core/symbology-ng/qgspointdistancerenderer.h b/src/core/symbology-ng/qgspointdistancerenderer.h index fe9b3b988408..1e53695d2247 100644 --- a/src/core/symbology-ng/qgspointdistancerenderer.h +++ b/src/core/symbology-ng/qgspointdistancerenderer.h @@ -42,10 +42,10 @@ class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer { /** Constructor for GroupedFeature. - * @param feature feature - * @param symbol base symbol for rendering feature - * @param isSelected set to true if feature is selected and should be rendered in a selected state - * @param label optional label text, or empty string for no label + * \param feature feature + * \param symbol base symbol for rendering feature + * \param isSelected set to true if feature is selected and should be rendered in a selected state + * \param label optional label text, or empty string for no label */ GroupedFeature( const QgsFeature &feature, QgsMarkerSymbol *symbol, bool isSelected, const QString &label = QString() ) : feature( feature ) @@ -71,8 +71,8 @@ class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer typedef QList< GroupedFeature > ClusteredGroup; /** Constructor for QgsPointDistanceRenderer. - * @param rendererName name of renderer for registry - * @param labelAttributeName optional attribute for labeling points + * \param rendererName name of renderer for registry + * \param labelAttributeName optional attribute for labeling points */ QgsPointDistanceRenderer( const QString &rendererName, const QString &labelAttributeName = QString() ); @@ -100,108 +100,108 @@ class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer virtual QString filter( const QgsFields &fields = QgsFields() ) override; /** Sets the attribute name for labeling points. - * @param name attribute name, or empty string to avoid labeling features by the renderer - * @see labelAttributeName() - * @see setLabelFont() - * @see setLabelColor() - * @see setMaxLabelScaleDenominator() + * \param name attribute name, or empty string to avoid labeling features by the renderer + * \see labelAttributeName() + * \see setLabelFont() + * \see setLabelColor() + * \see setMaxLabelScaleDenominator() */ void setLabelAttributeName( const QString &name ) { mLabelAttributeName = name; } /** Returns the attribute name used for labeling points, or an empty string if no labeling * will be done by the renderer. - * @see setLabelAttributeName() - * @see labelFont() - * @see maxLabelScaleDenominator() - * @see labelColor() + * \see setLabelAttributeName() + * \see labelFont() + * \see maxLabelScaleDenominator() + * \see labelColor() */ QString labelAttributeName() const { return mLabelAttributeName; } /** Sets the font used for labeling points. - * @param font label font - * @see labelFont() - * @see setLabelAttributeName() - * @see setLabelColor() + * \param font label font + * \see labelFont() + * \see setLabelAttributeName() + * \see setLabelColor() */ void setLabelFont( const QFont &font ) { mLabelFont = font; } /** Returns the font used for labeling points. - * @see setLabelFont() - * @see labelAttributeName() - * @see labelColor() + * \see setLabelFont() + * \see labelAttributeName() + * \see labelColor() */ QFont labelFont() const { return mLabelFont;} /** Sets the maximum scale at which points should be labeled by the renderer. - * @param denominator maximum scale denominator - * @see maxLabelScaleDenominator() - * @see setLabelAttributeName() + * \param denominator maximum scale denominator + * \see maxLabelScaleDenominator() + * \see setLabelAttributeName() */ void setMaxLabelScaleDenominator( double denominator ) { mMaxLabelScaleDenominator = denominator; } /** Returns the denominator for the maximum scale at which points should be labeled by the renderer. - * @see setMaxLabelScaleDenominator() - * @see labelAttributeName() + * \see setMaxLabelScaleDenominator() + * \see labelAttributeName() */ double maxLabelScaleDenominator() const { return mMaxLabelScaleDenominator; } /** Sets the color to use for for labeling points. - * @param color label color - * @see labelColor() - * @see setLabelAttributeName() - * @see setLabelFont() + * \param color label color + * \see labelColor() + * \see setLabelAttributeName() + * \see setLabelFont() */ void setLabelColor( const QColor &color ) { mLabelColor = color;} /** Returns the color used for for labeling points. - * @see setLabelColor() - * @see labelAttributeName() - * @see labelFont() + * \see setLabelColor() + * \see labelAttributeName() + * \see labelFont() */ QColor labelColor() const { return mLabelColor; } /** Sets the tolerance distance for grouping points. Units are specified using * setToleranceUnit(). - * @param distance tolerance distance - * @see tolerance() - * @see setToleranceUnit() + * \param distance tolerance distance + * \see tolerance() + * \see setToleranceUnit() */ void setTolerance( double distance ) { mTolerance = distance; } /** Returns the tolerance distance for grouping points. Units are retrieved using * toleranceUnit(). - * @see setTolerance() - * @see toleranceUnit() + * \see setTolerance() + * \see toleranceUnit() */ double tolerance() const { return mTolerance; } /** Sets the units for the tolerance distance. - * @param unit tolerance distance units - * @see setTolerance() - * @see toleranceUnit() + * \param unit tolerance distance units + * \see setTolerance() + * \see toleranceUnit() * \since QGIS 2.12 */ void setToleranceUnit( QgsUnitTypes::RenderUnit unit ) { mToleranceUnit = unit; } /** Returns the units for the tolerance distance. - * @see tolerance() - * @see setToleranceUnit() + * \see tolerance() + * \see setToleranceUnit() * \since QGIS 2.12 */ QgsUnitTypes::RenderUnit toleranceUnit() const { return mToleranceUnit; } /** Sets the map unit scale object for the distance tolerance. This is only used if the * toleranceUnit() is set to QgsUnitTypes::RenderMapUnits. - * @param scale scale for distance tolerance - * @see toleranceMapUnitScale() - * @see setToleranceUnit() + * \param scale scale for distance tolerance + * \see toleranceMapUnitScale() + * \see setToleranceUnit() */ void setToleranceMapUnitScale( const QgsMapUnitScale &scale ) { mToleranceMapUnitScale = scale; } /** Returns the map unit scale object for the distance tolerance. This is only used if the * toleranceUnit() is set to QgsUnitTypes::RenderMapUnits. - * @see setToleranceMapUnitScale() - * @see toleranceUnit() + * \see setToleranceMapUnitScale() + * \see toleranceUnit() */ const QgsMapUnitScale &toleranceMapUnitScale() const { return mToleranceMapUnitScale; } @@ -245,20 +245,20 @@ class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer QgsSpatialIndex *mSpatialIndex = nullptr; /** Renders the labels for a group. - * @param centerPoint center point of group - * @param context destination render context - * @param labelShifts displacement for individual label positions - * @param group group of clustered features to label - * @note may not be available in Python bindings on some platforms + * \param centerPoint center point of group + * \param context destination render context + * \param labelShifts displacement for individual label positions + * \param group group of clustered features to label + * \note may not be available in Python bindings on some platforms */ void drawLabels( QPointF centerPoint, QgsSymbolRenderContext &context, const QList &labelShifts, const ClusteredGroup &group ); private: /** Draws a group of clustered points. - * @param centerPoint central point (geographic centroid) of all points contained within the cluster - * @param context destination render context - * @param group contents of group + * \param centerPoint central point (geographic centroid) of all points contained within the cluster + * \param context destination render context + * \param group contents of group */ virtual void drawGroup( QPointF centerPoint, QgsRenderContext &context, const ClusteredGroup &group ) = 0; @@ -275,14 +275,14 @@ class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer void drawGroup( const ClusteredGroup &group, QgsRenderContext &context ); /** Returns first symbol from the embedded renderer for a feature or nullptr if none - * @param feature source feature - * @param context target render context + * \param feature source feature + * \param context target render context */ QgsMarkerSymbol *firstSymbolForFeature( QgsFeature &feature, QgsRenderContext &context ); /** Creates an expression context scope for a clustered group, with variables reflecting the group's properties. - * @param group clustered group - * @returns new expression context scope + * \param group clustered group + * \returns new expression context scope */ QgsExpressionContextScope *createGroupScope( const ClusteredGroup &group ) const; diff --git a/src/core/symbology-ng/qgsrenderer.h b/src/core/symbology-ng/qgsrenderer.h index d9414b697b37..fa025fef4b96 100644 --- a/src/core/symbology-ng/qgsrenderer.h +++ b/src/core/symbology-ng/qgsrenderer.h @@ -95,9 +95,9 @@ class CORE_EXPORT QgsFeatureRenderer /** To be overridden * * Must be called between startRender() and stopRender() calls. - * @param feature feature - * @param context render context - * @return returns pointer to symbol or 0 if symbol was not found + * \param feature feature + * \param context render context + * \returns returns pointer to symbol or 0 if symbol was not found * \since QGIS 2.12 */ virtual QgsSymbol *symbolForFeature( QgsFeature &feature, QgsRenderContext &context ) = 0; @@ -119,9 +119,9 @@ class CORE_EXPORT QgsFeatureRenderer /** * Needs to be called when a new render cycle is started * - * @param context Additional information passed to the renderer about the job which will be rendered - * @param fields The fields available for rendering - * @return Information passed back from the renderer that can e.g. be used to reduce the amount of requested features + * \param context Additional information passed to the renderer about the job which will be rendered + * \param fields The fields available for rendering + * \returns Information passed back from the renderer that can e.g. be used to reduce the amount of requested features */ virtual void startRender( QgsRenderContext &context, const QgsFields &fields ) = 0; @@ -133,13 +133,13 @@ class CORE_EXPORT QgsFeatureRenderer /** * If a renderer does not require all the features this method may be overridden * and return an expression used as where clause. - * This will be called once after {@link startRender()} and before the first call - * to {@link renderFeature()}. + * This will be called once after startRender() and before the first call + * to renderFeature(). * By default this returns a null string and all features will be requested. * You do not need to specify the extent in here, this is taken care of separately and * will be combined with a filter returned from this method. * - * @return An expression used as where clause + * \returns An expression used as where clause */ virtual QString filter( const QgsFields &fields = QgsFields() ) { Q_UNUSED( fields ); return QString::null; } @@ -147,7 +147,7 @@ class CORE_EXPORT QgsFeatureRenderer * Return a list of attributes required by this renderer. Attributes not listed in here may * not have been requested from the provider at rendering time. * - * @return A set of attributes + * \returns A set of attributes */ virtual QSet usedAttributes( const QgsRenderContext &context ) const = 0; @@ -162,7 +162,7 @@ class CORE_EXPORT QgsFeatureRenderer * Create a deep copy of this renderer. Should be implemented by all subclasses * and generate a proper subclass. * - * @return A copy of this renderer + * \returns A copy of this renderer */ virtual QgsFeatureRenderer *clone() const = 0; @@ -210,7 +210,7 @@ class CORE_EXPORT QgsFeatureRenderer virtual Capabilities capabilities() { return 0; } /** Returns list of symbols used by the renderer. - * @param context render context + * \param context render context * \since QGIS 2.12 */ virtual QgsSymbolList symbols( QgsRenderContext &context ) { Q_UNUSED( context ); return QgsSymbolList(); } @@ -230,13 +230,13 @@ class CORE_EXPORT QgsFeatureRenderer /** Create a new renderer according to the information contained in * the UserStyle element of a SLD style document - * @param node the node in the SLD document whose the UserStyle element + * \param node the node in the SLD document whose the UserStyle element * is a child - * @param geomType the geometry type of the features, used to convert + * \param geomType the geometry type of the features, used to convert * Symbolizer elements - * @param errorMessage it will contain the error message if something + * \param errorMessage it will contain the error message if something * went wrong - * @return the renderer + * \returns the renderer */ static QgsFeatureRenderer *loadSld( const QDomNode &node, QgsWkbTypes::GeometryType geomType, QString &errorMessage ); @@ -263,14 +263,14 @@ class CORE_EXPORT QgsFeatureRenderer virtual void checkLegendSymbolItem( const QString &key, bool state = true ); /** Sets the symbol to be used for a legend symbol item. - * @param key rule key for legend symbol - * @param symbol new symbol for legend item. Ownership is transferred to renderer. + * \param key rule key for legend symbol + * \param symbol new symbol for legend item. Ownership is transferred to renderer. * \since QGIS 2.14 */ virtual void setLegendSymbolItem( const QString &key, QgsSymbol *symbol ); //! return a list of item text / symbol - //! @note not available in Python bindings + //! \note not available in Python bindings virtual QgsLegendSymbolList legendSymbolItems( double scaleDenominator = -1, const QString &rule = "" ); //! Return a list of symbology items for the legend. Better choice than legendSymbolItems(). @@ -306,38 +306,38 @@ class CORE_EXPORT QgsFeatureRenderer virtual QgsSymbolList originalSymbolsForFeature( QgsFeature &feat, QgsRenderContext &context ); /** Allows for a renderer to modify the extent of a feature request prior to rendering - * @param extent reference to request's filter extent. Modify extent to change the + * \param extent reference to request's filter extent. Modify extent to change the * extent of feature request - * @param context render context + * \param context render context * \since QGIS 2.7 */ virtual void modifyRequestExtent( QgsRectangle &extent, QgsRenderContext &context ) { Q_UNUSED( extent ); Q_UNUSED( context ); } /** Returns the current paint effect for the renderer. - * @returns paint effect + * \returns paint effect * \since QGIS 2.9 - * @see setPaintEffect + * \see setPaintEffect */ QgsPaintEffect *paintEffect() const; /** Sets the current paint effect for the renderer. - * @param effect paint effect. Ownership is transferred to the renderer. + * \param effect paint effect. Ownership is transferred to the renderer. * \since QGIS 2.9 - * @see paintEffect + * \see paintEffect */ void setPaintEffect( QgsPaintEffect *effect ); /** Returns whether the renderer must render as a raster. * \since QGIS 2.12 - * @see setForceRasterRender + * \see setForceRasterRender */ bool forceRasterRender() const { return mForceRaster; } /** Sets whether the renderer should be rendered to a raster destination. - * @param forceRaster set to true if renderer must be drawn on a raster surface. + * \param forceRaster set to true if renderer must be drawn on a raster surface. * This may be desirable for highly detailed layers where rendering as a vector * would result in a large, complex vector output. - * @see forceRasterRender + * \see forceRasterRender * \since QGIS 2.12 */ void setForceRasterRender( bool forceRaster ) { mForceRaster = forceRaster; } @@ -345,47 +345,47 @@ class CORE_EXPORT QgsFeatureRenderer /** * Get the order in which features shall be processed by this renderer. * \since QGIS 2.14 - * @note this property has no effect if orderByEnabled() is false - * @see orderByEnabled() + * \note this property has no effect if orderByEnabled() is false + * \see orderByEnabled() */ QgsFeatureRequest::OrderBy orderBy() const; /** * Define the order in which features shall be processed by this renderer. - * @note this property has no effect if orderByEnabled() is false + * \note this property has no effect if orderByEnabled() is false * \since QGIS 2.14 - * @see setOrderByEnabled() + * \see setOrderByEnabled() */ void setOrderBy( const QgsFeatureRequest::OrderBy &orderBy ); /** * Returns whether custom ordering will be applied before features are processed by this renderer. * \since QGIS 2.14 - * @see orderBy() - * @see setOrderByEnabled() + * \see orderBy() + * \see setOrderByEnabled() */ bool orderByEnabled() const; /** * Sets whether custom ordering should be applied before features are processed by this renderer. - * @param enabled set to true to enable custom feature ordering + * \param enabled set to true to enable custom feature ordering * \since QGIS 2.14 - * @see setOrderBy() - * @see orderByEnabled() + * \see setOrderBy() + * \see orderByEnabled() */ void setOrderByEnabled( bool enabled ); /** Sets an embedded renderer (subrenderer) for this feature renderer. The base class implementation * does nothing with subrenderers, but individual derived classes can use these to modify their behavior. - * @param subRenderer the embedded renderer. Ownership will be transferred. - * @see embeddedRenderer() + * \param subRenderer the embedded renderer. Ownership will be transferred. + * \see embeddedRenderer() * \since QGIS 2.16 */ virtual void setEmbeddedRenderer( QgsFeatureRenderer *subRenderer ) { delete subRenderer; } /** Returns the current embedded renderer (subrenderer) for this feature renderer. The base class * implementation does not use subrenderers and will always return null. - * @see setEmbeddedRenderer() + * \see setEmbeddedRenderer() * \since QGIS 2.16 */ virtual const QgsFeatureRenderer *embeddedRenderer() const { return nullptr; } @@ -419,7 +419,7 @@ class CORE_EXPORT QgsFeatureRenderer * * Order By * * Paint Effect * - * @param destRenderer destination renderer for copied effect + * \param destRenderer destination renderer for copied effect */ void copyRendererData( QgsFeatureRenderer *destRenderer ) const; @@ -436,12 +436,12 @@ class CORE_EXPORT QgsFeatureRenderer bool mForceRaster; - /** @note this function is used to convert old sizeScale expressions to symbol + /** \note this function is used to convert old sizeScale expressions to symbol * level DataDefined size */ static void convertSymbolSizeScale( QgsSymbol *symbol, QgsSymbol::ScaleMethod method, const QString &field ); - /** @note this function is used to convert old rotations expressions to symbol + /** \note this function is used to convert old rotations expressions to symbol * level DataDefined angle */ static void convertSymbolRotation( QgsSymbol *symbol, const QString &field ); diff --git a/src/core/symbology-ng/qgsrendererregistry.h b/src/core/symbology-ng/qgsrendererregistry.h index a0e5d402737d..bb30572be378 100644 --- a/src/core/symbology-ng/qgsrendererregistry.h +++ b/src/core/symbology-ng/qgsrendererregistry.h @@ -31,7 +31,7 @@ class QgsRendererWidget; /** \ingroup core Stores metadata about one renderer class. - @note It's necessary to implement createRenderer() function. + \note It's necessary to implement createRenderer() function. In C++ you can use QgsRendererMetadata convenience class. */ class CORE_EXPORT QgsRendererAbstractMetadata @@ -109,7 +109,7 @@ class CORE_EXPORT QgsRendererMetadata : public QgsRendererAbstractMetadata public: //! Construct metadata - //! @note not available in Python bindings + //! \note not available in Python bindings QgsRendererMetadata( const QString &name, const QString &visibleName, QgsRendererCreateFunc pfCreate, @@ -123,7 +123,7 @@ class CORE_EXPORT QgsRendererMetadata : public QgsRendererAbstractMetadata , mLayerTypes( layerTypes ) {} - //! @note not available in Python bindings + //! \note not available in Python bindings QgsRendererMetadata( const QString &name, const QString &visibleName, QgsRendererCreateFunc pfCreate, @@ -146,14 +146,14 @@ class CORE_EXPORT QgsRendererMetadata : public QgsRendererAbstractMetadata virtual QgsFeatureRenderer *createRendererFromSld( QDomElement &elem, QgsWkbTypes::GeometryType geomType ) override { return mCreateFromSldFunc ? mCreateFromSldFunc( elem, geomType ) : nullptr; } - //! @note not available in Python bindings + //! \note not available in Python bindings QgsRendererCreateFunc createFunction() const { return mCreateFunc; } - //! @note not available in Python bindings + //! \note not available in Python bindings QgsRendererWidgetFunc widgetFunction() const { return mWidgetFunc; } - //! @note not available in Python bindings + //! \note not available in Python bindings QgsRendererCreateFromSldFunc createFromSldFunction() const { return mCreateFromSldFunc; } - //! @note not available in Python bindings + //! \note not available in Python bindings void setWidgetFunction( QgsRendererWidgetFunc f ) { mWidgetFunc = f; } virtual QgsRendererAbstractMetadata::LayerTypes compatibleLayerTypes() const override { return mLayerTypes; } @@ -194,14 +194,14 @@ class CORE_EXPORT QgsRendererRegistry QgsRendererRegistry &operator=( const QgsRendererRegistry &rh ) = delete; //! Adds a renderer to the registry. Takes ownership of the metadata object. - //! @param metadata renderer metadata - //! @returns true if renderer was added successfully, or false if renderer could not + //! \param metadata renderer metadata + //! \returns true if renderer was added successfully, or false if renderer could not //! be added (e.g., a renderer with a duplicate name already exists) bool addRenderer( QgsRendererAbstractMetadata *metadata ); //! Removes a renderer from registry. - //! @param rendererName name of renderer to remove from registry - //! @returns true if renderer was successfully removed, or false if matching + //! \param rendererName name of renderer to remove from registry + //! \returns true if renderer was successfully removed, or false if matching //! renderer could not be found bool removeRenderer( const QString &rendererName ); @@ -210,11 +210,11 @@ class CORE_EXPORT QgsRendererRegistry QgsRendererAbstractMetadata *rendererMetadata( const QString &rendererName ); //! Returns a list of available renderers. - //! @param layerTypes flags to filter the renderers by compatible layer types + //! \param layerTypes flags to filter the renderers by compatible layer types QStringList renderersList( QgsRendererAbstractMetadata::LayerTypes layerTypes = QgsRendererAbstractMetadata::All ) const; //! Returns a list of available renderers which are compatible with a specified layer. - //! @param layer vector layer + //! \param layer vector layer //! \since QGIS 2.16 QStringList renderersList( const QgsVectorLayer *layer ) const; diff --git a/src/core/symbology-ng/qgsrulebasedrenderer.h b/src/core/symbology-ng/qgsrulebasedrenderer.h index 2bba6157d829..3cddf0f7bdb1 100644 --- a/src/core/symbology-ng/qgsrulebasedrenderer.h +++ b/src/core/symbology-ng/qgsrulebasedrenderer.h @@ -131,14 +131,14 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer /** * Dump for debug purpose - * @param indent How many characters to indent. Will increase by two with every of the recursive calls - * @return A string representing this rule + * \param indent How many characters to indent. Will increase by two with every of the recursive calls + * \returns A string representing this rule */ QString dump( int indent = 0 ) const; /** * Return the attributes used to evaluate the expression of this rule - * @return A set of attribute names + * \returns A set of attribute names */ QSet usedAttributes( const QgsRenderContext &context ) const; @@ -147,10 +147,10 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer */ bool needsGeometry() const; - //! @note available in Python bindings as symbol2 + //! \note available in Python bindings as symbol2 QgsSymbolList symbols( const QgsRenderContext &context = QgsRenderContext() ) const; - //! @note not available in Python bindings + //! \note not available in Python bindings QgsLegendSymbolList legendSymbolItems( double scaleDenominator = -1, const QString &rule = "" ) const; //! \since QGIS 2.6 @@ -159,17 +159,17 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer /** * Check if a given feature shall be rendered by this rule * - * @param f The feature to test - * @param context The context in which the rendering happens - * @return True if the feature shall be rendered + * \param f The feature to test + * \param context The context in which the rendering happens + * \returns True if the feature shall be rendered */ bool isFilterOK( QgsFeature &f, QgsRenderContext *context = nullptr ) const; /** * Check if this rule applies for a given scale - * @param scale The scale to check. If set to 0, it will always return true. + * \param scale The scale to check. If set to 0, it will always return true. * - * @return If the rule will be evaluated at this scale + * \returns If the rule will be evaluated at this scale */ bool isScaleOK( double scale ) const; @@ -181,27 +181,27 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer /** * A filter that will check if this rule applies - * @return An expression + * \returns An expression */ QgsExpression *filter() const { return mFilter; } /** * A filter that will check if this rule applies - * @return An expression + * \returns An expression */ QString filterExpression() const { return mFilterExp; } /** * A human readable description for this rule * - * @return Description + * \returns Description */ QString description() const { return mDescription; } /** * Returns if this rule is active * - * @return True if the rule is active + * \returns True if the rule is active */ bool active() const { return mIsActive; } @@ -220,7 +220,7 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer * Set the minimum denominator for which this rule shall apply. * E.g. 1000 if it shall be evaluated between 1:1000 and 1:100'000 * Set to 0 to disable the minimum check - * @param scaleMinDenom The minimum scale denominator for this rule + * \param scaleMinDenom The minimum scale denominator for this rule */ void setScaleMinDenom( int scaleMinDenom ) { mScaleMinDenom = scaleMinDenom; } @@ -228,27 +228,27 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer * Set the maximum denominator for which this rule shall apply. * E.g. 100'000 if it shall be evaluated between 1:1000 and 1:100'000 * Set to 0 to disable the maximum check - * @param scaleMaxDenom maximum scale denominator for this rule + * \param scaleMaxDenom maximum scale denominator for this rule */ void setScaleMaxDenom( int scaleMaxDenom ) { mScaleMaxDenom = scaleMaxDenom; } /** * Set the expression used to check if a given feature shall be rendered with this rule * - * @param filterExp An expression + * \param filterExp An expression */ void setFilterExpression( const QString &filterExp ); /** * Set a human readable description for this rule * - * @param description Description + * \param description Description */ void setDescription( const QString &description ) { mDescription = description; } /** * Sets if this rule is active - * @param state Determines if the rule should be activated or deactivated + * \param state Determines if the rule should be activated or deactivated */ void setActive( bool state ) { mIsActive = state; } @@ -271,16 +271,16 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer QSet collectZLevels(); //! assign normalized z-levels [0..N-1] for this rule's symbol for quick access during rendering - //! @note not available in Python bindings + //! \note not available in Python bindings void setNormZLevels( const QMap &zLevelsToNormLevels ); /** * Render a given feature, will recursively call subclasses and only render if the constraints apply. * - * @param featToRender The feature to render - * @param context The rendering context - * @param renderQueue The rendering queue to which the feature should be added - * @return The result of the rendering. In explicit if the feature is added to the queue or + * \param featToRender The feature to render + * \param context The rendering context + * \param renderQueue The rendering queue to which the feature should be added + * \returns The result of the rendering. In explicit if the feature is added to the queue or * the reason for not rendering the feature. */ RenderResult renderFeature( FeatureToRender &featToRender, QgsRenderContext &context, RenderQueue &renderQueue ); @@ -302,38 +302,38 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer /** * Stop a rendering process. Used to clean up the internal state of this rule * - * @param context The rendering context + * \param context The rendering context */ void stopRender( QgsRenderContext &context ); /** * Create a rule from an XML definition * - * @param ruleElem The XML rule element - * @param symbolMap Symbol map + * \param ruleElem The XML rule element + * \param symbolMap Symbol map * - * @return A new rule + * \returns A new rule */ static Rule *create( QDomElement &ruleElem, QgsSymbolMap &symbolMap ); /** * Return all children rules of this rule * - * @return A list of rules + * \returns A list of rules */ RuleList &children() { return mChildren; } /** * Returns all children, grand-children, grand-grand-children, grand-gra... you get it * - * @return A list of descendant rules + * \returns A list of descendant rules */ RuleList descendants() const { RuleList l; Q_FOREACH ( Rule *c, mChildren ) { l += c; l += c->descendants(); } return l; } /** * The parent rule * - * @return Parent rule + * \returns Parent rule */ Rule *parent() { return mParent; } @@ -362,14 +362,14 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer /** * Sets if this rule is an ELSE rule * - * @param iselse If true, this rule is an ELSE rule + * \param iselse If true, this rule is an ELSE rule */ void setIsElse( bool iselse ); /** * Check if this rule is an ELSE rule * - * @return True if this rule is an else rule + * \returns True if this rule is an else rule */ bool isElse() { return mElseRule; } @@ -467,7 +467,7 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer //! creates a QgsRuleBasedRenderer from an existing renderer. //! \since QGIS 2.5 - //! @returns a new renderer if the conversion was possible, otherwise 0. + //! \returns a new renderer if the conversion was possible, otherwise 0. static QgsRuleBasedRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ); //! helper function to convert the size scale and rotation fields present in some other renderers to data defined symbology diff --git a/src/core/symbology-ng/qgssinglesymbolrenderer.h b/src/core/symbology-ng/qgssinglesymbolrenderer.h index f2f30e2f653b..9626920f8b26 100644 --- a/src/core/symbology-ng/qgssinglesymbolrenderer.h +++ b/src/core/symbology-ng/qgssinglesymbolrenderer.h @@ -60,7 +60,7 @@ class CORE_EXPORT QgsSingleSymbolRenderer : public QgsFeatureRenderer //! creates a QgsSingleSymbolRenderer from an existing renderer. //! \since QGIS 2.5 - //! @returns a new renderer if the conversion was possible, otherwise 0. + //! \returns a new renderer if the conversion was possible, otherwise 0. static QgsSingleSymbolRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ); protected: diff --git a/src/core/symbology-ng/qgsstyle.h b/src/core/symbology-ng/qgsstyle.h index ddeba17d15f4..750c3613aefe 100644 --- a/src/core/symbology-ng/qgsstyle.h +++ b/src/core/symbology-ng/qgsstyle.h @@ -86,7 +86,7 @@ class CORE_EXPORT QgsStyle : public QObject * \param name is the name of the symbol being added or updated * \param symbol is the Vector symbol * \param update set to true when the style DB has to be updated, by default it is false - * \return success status of the operation + * \returns success status of the operation */ bool addSymbol( const QString &name, QgsSymbol *symbol, bool update = false ); @@ -95,14 +95,14 @@ class CORE_EXPORT QgsStyle : public QObject * \param name is the name of the color ramp being added or updated * \param colorRamp is the color ramp. Ownership is transferred. * \param update set to true when the style DB has to be updated, by default it is false - * \return success status of the operation + * \returns success status of the operation */ bool addColorRamp( const QString &name, QgsColorRamp *colorRamp, bool update = false ); /** Adds a new tag and returns the tag's id * * \param tagName the name of the new tag to be created - * \return returns an int, which is the DB id of the new tag created, 0 if the tag couldn't be created + * \returns returns an int, which is the DB id of the new tag created, 0 if the tag couldn't be created */ int addTag( const QString &tagName ); @@ -117,7 +117,7 @@ class CORE_EXPORT QgsStyle : public QObject /** Returns a list of all tags in the style database * * \since QGIS 2.16 - * @see addTag() + * \see addTag() */ QStringList tags() const; @@ -152,7 +152,7 @@ class CORE_EXPORT QgsStyle : public QObject * \param type is either SymbolEntity or ColorrampEntity * \param symbol is the name of the symbol or colorramp as QString * \param tags is the list of the tags that are to be applied as QStringList - * \return returns the success state of the operation + * \returns returns the success state of the operation */ bool tagSymbol( StyleEntity type, const QString &symbol, const QStringList &tags ); @@ -162,7 +162,7 @@ class CORE_EXPORT QgsStyle : public QObject * \param type is either SymbolEntity or ColorrampEntity * \param symbol is the name of the symbol or colorramp * \param tags is the list of tags that are to be removed as QStringList - * \return returns the success state of the operation + * \returns returns the success state of the operation */ bool detagSymbol( StyleEntity type, const QString &symbol, const QStringList &tags ); @@ -171,7 +171,7 @@ class CORE_EXPORT QgsStyle : public QObject * Removes all tags for the specified symbol or colorramp * \param type is either SymbolEntity or ColorrampEntity * \param symbol is the name of the symbol or colorramp - * \return returns the success state of the operation + * \returns returns the success state of the operation */ bool detagSymbol( StyleEntity type, const QString &symbol ); @@ -205,7 +205,7 @@ class CORE_EXPORT QgsStyle : public QObject /** Returns the symbol names which are flagged as favorite * * \param type is either SymbolEntity or ColorampEntity - * \return A QStringList of the symbol or colorramp names flagged as favorite + * \returns A QStringList of the symbol or colorramp names flagged as favorite */ QStringList symbolsOfFavorite( StyleEntity type ) const; @@ -213,7 +213,7 @@ class CORE_EXPORT QgsStyle : public QObject * * \param type is either SymbolEntity or ColorampEntity * \param tagid is id of the tag which has been applied over the symbol as int - * \return A QStringList of the symbol or colorramp names for the given tag id + * \returns A QStringList of the symbol or colorramp names for the given tag id */ QStringList symbolsWithTag( StyleEntity type, int tagid ) const; @@ -221,7 +221,7 @@ class CORE_EXPORT QgsStyle : public QObject * * \param type is either SymbolEntity of ColorrampEntity * \param name is the name of the symbol or coloramp whose is to be added to favorites - * \return returns the success state as bool + * \returns returns the success state as bool */ bool addFavorite( StyleEntity type, const QString &name ); @@ -229,7 +229,7 @@ class CORE_EXPORT QgsStyle : public QObject * * \param type is either SymbolEntity of ColorrampEntity * \param name is the name of the symbol or coloramp whose is to be removed from favorites - * \return returns the success state as bool + * \returns returns the success state as bool */ bool removeFavorite( StyleEntity type, const QString &name ); @@ -254,7 +254,7 @@ class CORE_EXPORT QgsStyle : public QObject * \param symbol is the pointer to the new QgsSymbol being saved * \param favorite is a boolean value to specify whether the symbol should be added to favorites * \param tags is a list of tags that are associated with the symbol as a QStringList. - * \return returns the success state of the save operation + * \returns returns the success state of the save operation */ bool saveSymbol( const QString &name, QgsSymbol *symbol, bool favorite, const QStringList &tags ); @@ -264,7 +264,7 @@ class CORE_EXPORT QgsStyle : public QObject * \param ramp is the pointer to the new QgsColorRamp being saved * \param favorite is a boolean value to specify whether the colorramp should be added to favorites * \param tags is a list of tags that are associated with the color ramp as a QStringList. - * \return returns the success state of the save operation + * \returns returns the success state of the save operation */ bool saveColorRamp( const QString &name, QgsColorRamp *ramp, bool favorite, const QStringList &tags ); @@ -277,7 +277,7 @@ class CORE_EXPORT QgsStyle : public QObject /** Creates an on-disk database * * This function creates a new on-disk permanent style database. - * \return returns the success state of the database creation + * \returns returns the success state of the database creation * \since QGIS 3.0 * \see createMemoryDb() */ @@ -286,7 +286,7 @@ class CORE_EXPORT QgsStyle : public QObject /** Creates a temporary memory database * * This function is used to create a temporary style database in case a permanent on-disk database is not needed. - * \return returns the success state of the temporary memory database creation + * \returns returns the success state of the temporary memory database creation * \since QGIS 3.0 * \see createDb() */ @@ -295,7 +295,7 @@ class CORE_EXPORT QgsStyle : public QObject /** Creates tables structure for new database * * This function is used to create the tables structure in a newly-created database. - * \return returns the success state of the temporary memory database creation + * \returns returns the success state of the temporary memory database creation * \since QGIS 3.0 * \see createDB(), createMemoryDB() */ @@ -305,7 +305,7 @@ class CORE_EXPORT QgsStyle : public QObject * * This function will load an on-disk database and populate styles. * \param filename location of the database to load styles from - * \return returns the success state of the database being loaded + * \returns returns the success state of the database being loaded */ bool load( const QString &filename ); @@ -322,7 +322,7 @@ class CORE_EXPORT QgsStyle : public QObject * * \param type is either SymbolEntity or ColorrampEntity * \param qword is the query string to search the symbols or colorramps. - * \return A QStringList of the matched symbols or colorramps + * \returns A QStringList of the matched symbols or colorramps * */ QStringList findSymbols( StyleEntity type, const QString &qword ); @@ -330,7 +330,7 @@ class CORE_EXPORT QgsStyle : public QObject * * \param type is either SymbolEntity or ColorrampEntity * \param symbol is the name of the symbol or color ramp - * \return A QStringList of the tags that have been applied to that symbol/colorramp + * \returns A QStringList of the tags that have been applied to that symbol/colorramp */ QStringList tagsOfSymbol( StyleEntity type, const QString &symbol ); @@ -339,7 +339,7 @@ class CORE_EXPORT QgsStyle : public QObject * \param type is either SymbolEntity or ColorrampEntity * \param symbol is the name of the symbol or color ramp * \param tag the name of the tag to look for - * \return A boolean value identicating whether a tag was found attached to the symbol + * \returns A boolean value identicating whether a tag was found attached to the symbol */ bool symbolHasTag( StyleEntity type, const QString &symbol, const QString &tag ); @@ -394,7 +394,7 @@ class CORE_EXPORT QgsStyle : public QObject * * \param query query to run * \param freeQuery release query memory - * \return success true on success + * \returns success true on success */ bool runEmptyQuery( char *query, bool freeQuery = true ); @@ -409,7 +409,7 @@ class CORE_EXPORT QgsStyle : public QObject * \note This should not be called separately, only called through addSymbol or addColorRamp * \param type is either SymbolEntity or ColorrampEntity * \param name is the name of an existing symbol or a color ramp - * \return Success state of the update operation + * \returns Success state of the update operation */ bool updateSymbol( StyleEntity type, const QString &name ); diff --git a/src/core/symbology-ng/qgssvgcache.h b/src/core/symbology-ng/qgssvgcache.h index 5be6cb052592..638e3426f076 100644 --- a/src/core/symbology-ng/qgssvgcache.h +++ b/src/core/symbology-ng/qgssvgcache.h @@ -42,13 +42,13 @@ class CORE_EXPORT QgsSvgCacheEntry QgsSvgCacheEntry(); /** Constructor. - * @param file Absolute path to SVG file (relative paths are not resolved). - * @param size - * @param strokeWidth width of stroke - * @param widthScaleFactor width scale factor - * @param fill color of fill - * @param stroke color of stroke - * @param lookupKey the key string used in QgsSvgCache for quick lookup of this entry (relative or absolute path) + * \param file Absolute path to SVG file (relative paths are not resolved). + * \param size + * \param strokeWidth width of stroke + * \param widthScaleFactor width scale factor + * \param fill color of fill + * \param stroke color of stroke + * \param lookupKey the key string used in QgsSvgCache for quick lookup of this entry (relative or absolute path) */ QgsSvgCacheEntry( const QString &file, double size, double strokeWidth, double widthScaleFactor, const QColor &fill, const QColor &stroke, const QString &lookupKey = QString() ); ~QgsSvgCacheEntry(); @@ -111,37 +111,37 @@ class CORE_EXPORT QgsSvgCache : public QObject ~QgsSvgCache(); /** Get SVG as QImage. - * @param file Absolute or relative path to SVG file. - * @param size size of cached image - * @param fill color of fill - * @param stroke color of stroke - * @param strokeWidth width of stroke - * @param widthScaleFactor width scale factor - * @param fitsInCache + * \param file Absolute or relative path to SVG file. + * \param size size of cached image + * \param fill color of fill + * \param stroke color of stroke + * \param strokeWidth width of stroke + * \param widthScaleFactor width scale factor + * \param fitsInCache */ QImage svgAsImage( const QString &file, double size, const QColor &fill, const QColor &stroke, double strokeWidth, double widthScaleFactor, bool &fitsInCache ); /** Get SVG as QPicture&. - * @param file Absolute or relative path to SVG file. - * @param size size of cached image - * @param fill color of fill - * @param stroke color of stroke - * @param strokeWidth width of stroke - * @param widthScaleFactor width scale factor - * @param forceVectorOutput + * \param file Absolute or relative path to SVG file. + * \param size size of cached image + * \param fill color of fill + * \param stroke color of stroke + * \param strokeWidth width of stroke + * \param widthScaleFactor width scale factor + * \param forceVectorOutput */ QPicture svgAsPicture( const QString &file, double size, const QColor &fill, const QColor &stroke, double strokeWidth, double widthScaleFactor, bool forceVectorOutput = false ); /** Calculates the viewbox size of a (possibly cached) SVG file. - * @param file Absolute or relative path to SVG file. - * @param size size of cached image - * @param fill color of fill - * @param stroke color of stroke - * @param strokeWidth width of stroke - * @param widthScaleFactor width scale factor - * @returns viewbox size set in SVG file + * \param file Absolute or relative path to SVG file. + * \param size size of cached image + * \param fill color of fill + * \param stroke color of stroke + * \param strokeWidth width of stroke + * \param widthScaleFactor width scale factor + * \returns viewbox size set in SVG file * \since QGIS 2.14 */ QSizeF svgViewboxSize( const QString &file, double size, const QColor &fill, const QColor &stroke, double strokeWidth, @@ -154,23 +154,23 @@ class CORE_EXPORT QgsSvgCache : public QObject /** Tests if an svg file contains parameters for fill, stroke color, stroke width. If yes, possible default values are returned. If there are several * default values in the svg file, only the first one is considered. - * @param path path to SVG file - * @param hasFillParam will be true if fill param present in SVG - * @param hasDefaultFillParam will be true if fill param has a default value specified - * @param defaultFillColor will be set to default fill color specified in SVG, if present - * @param hasFillOpacityParam will be true if fill opacity param present in SVG - * @param hasDefaultFillOpacity will be true if fill opacity param has a default value specified - * @param defaultFillOpacity will be set to default fill opacity specified in SVG, if present - * @param hasStrokeParam will be true if stroke param present in SVG - * @param hasDefaultStrokeColor will be true if stroke param has a default value specified - * @param defaultStrokeColor will be set to default stroke color specified in SVG, if present - * @param hasStrokeWidthParam will be true if stroke width param present in SVG - * @param hasDefaultStrokeWidth will be true if stroke width param has a default value specified - * @param defaultStrokeWidth will be set to default stroke width specified in SVG, if present - * @param hasStrokeOpacityParam will be true if stroke opacity param present in SVG - * @param hasDefaultStrokeOpacity will be true if stroke opacity param has a default value specified - * @param defaultStrokeOpacity will be set to default stroke opacity specified in SVG, if present - * @note available in Python bindings as containsParamsV3 + * \param path path to SVG file + * \param hasFillParam will be true if fill param present in SVG + * \param hasDefaultFillParam will be true if fill param has a default value specified + * \param defaultFillColor will be set to default fill color specified in SVG, if present + * \param hasFillOpacityParam will be true if fill opacity param present in SVG + * \param hasDefaultFillOpacity will be true if fill opacity param has a default value specified + * \param defaultFillOpacity will be set to default fill opacity specified in SVG, if present + * \param hasStrokeParam will be true if stroke param present in SVG + * \param hasDefaultStrokeColor will be true if stroke param has a default value specified + * \param defaultStrokeColor will be set to default stroke color specified in SVG, if present + * \param hasStrokeWidthParam will be true if stroke width param present in SVG + * \param hasDefaultStrokeWidth will be true if stroke width param has a default value specified + * \param defaultStrokeWidth will be set to default stroke width specified in SVG, if present + * \param hasStrokeOpacityParam will be true if stroke opacity param present in SVG + * \param hasDefaultStrokeOpacity will be true if stroke opacity param has a default value specified + * \param defaultStrokeOpacity will be set to default stroke opacity specified in SVG, if present + * \note available in Python bindings as containsParamsV3 * \since QGIS 2.14 */ void containsParams( const QString &path, bool &hasFillParam, bool &hasDefaultFillParam, QColor &defaultFillColor, @@ -193,13 +193,13 @@ class CORE_EXPORT QgsSvgCache : public QObject protected: /** Creates new cache entry and returns pointer to it - * @param file Absolute or relative path to SVG file. If the path is relative the file is searched by QgsSymbolLayerUtils::symbolNameToPath() in SVG paths. + * \param file Absolute or relative path to SVG file. If the path is relative the file is searched by QgsSymbolLayerUtils::symbolNameToPath() in SVG paths. * in settings svg/searchPathsForSVG - * @param size size of cached image - * @param fill color of fill - * @param stroke color of stroke - * @param strokeWidth width of stroke - * @param widthScaleFactor width scale factor + * \param size size of cached image + * \param fill color of fill + * \param stroke color of stroke + * \param strokeWidth width of stroke + * \param widthScaleFactor width scale factor */ QgsSvgCacheEntry *insertSVG( const QString &file, double size, const QColor &fill, const QColor &stroke, double strokeWidth, double widthScaleFactor ); diff --git a/src/core/symbology-ng/qgssymbol.h b/src/core/symbology-ng/qgssymbol.h index 818738ac3651..53dfbfb8654f 100644 --- a/src/core/symbology-ng/qgssymbol.h +++ b/src/core/symbology-ng/qgssymbol.h @@ -101,44 +101,44 @@ class CORE_EXPORT QgsSymbol // symbol layers handling /** Returns list of symbol layers contained in the symbol. - * @returns symbol layers list + * \returns symbol layers list * \since QGIS 2.7 - * @see symbolLayer - * @see symbolLayerCount + * \see symbolLayer + * \see symbolLayerCount */ QgsSymbolLayerList symbolLayers() { return mLayers; } /** Returns a specific symbol layers contained in the symbol. - * @param layer layer number - * @returns corresponding symbol layer + * \param layer layer number + * \returns corresponding symbol layer * \since QGIS 2.7 - * @see symbolLayers - * @see symbolLayerCount + * \see symbolLayers + * \see symbolLayerCount */ QgsSymbolLayer *symbolLayer( int layer ); /** Returns total number of symbol layers contained in the symbol. - * @returns count of symbol layers + * \returns count of symbol layers * \since QGIS 2.7 - * @see symbolLayers - * @see symbolLayer + * \see symbolLayers + * \see symbolLayer */ int symbolLayerCount() { return mLayers.count(); } /** * Insert symbol layer to specified index * Ownership will be transferred. - * @param index The index at which the layer should be added - * @param layer The symbol layer to add - * @return True if the layer is added, False if the index or the layer is bad + * \param index The index at which the layer should be added + * \param layer The symbol layer to add + * \returns True if the layer is added, False if the index or the layer is bad */ bool insertSymbolLayer( int index, QgsSymbolLayer *layer ); /** * Append symbol layer at the end of the list * Ownership will be transferred. - * @param layer The layer to add - * @return True if the layer is added, False if the layer is bad + * \param layer The layer to add + * \returns True if the layer is added, False if the layer is bad */ bool appendSymbolLayer( QgsSymbolLayer *layer ); @@ -148,8 +148,8 @@ class CORE_EXPORT QgsSymbol /** * Remove symbol layer from the list and return pointer to it. * Ownership is handed to the caller. - * @param index The index of the layer to remove - * @return A pointer to the removed layer + * \param index The index of the layer to remove + * \returns A pointer to the removed layer */ QgsSymbolLayer *takeSymbolLayer( int index ); @@ -158,18 +158,18 @@ class CORE_EXPORT QgsSymbol /** Begins the rendering process for the symbol. This must be called before renderFeature(), * and should be followed by a call to stopRender(). - * @param context render context which symbol will be drawn using - * @param fields fields for features to be rendered (usually the associated + * \param context render context which symbol will be drawn using + * \param fields fields for features to be rendered (usually the associated * vector layer's fields). Required for correct calculation of data defined * overrides. - * @see stopRender() + * \see stopRender() */ void startRender( QgsRenderContext &context, const QgsFields &fields = QgsFields() ); /** Ends the rendering process. This should be called after rendering all desired features. - * @param context render context, must match the context specified when startRender() + * \param context render context, must match the context specified when startRender() * was called. - * @see startRender() + * \see startRender() */ void stopRender( QgsRenderContext &context ); @@ -188,7 +188,7 @@ class CORE_EXPORT QgsSymbol QImage asImage( QSize size, QgsRenderContext *customContext = nullptr ); /** Returns a large (roughly 100x100 pixel) preview image for the symbol. - * @param expressionContext optional expression context, for evaluation of + * \param expressionContext optional expression context, for evaluation of * data defined symbol properties */ QImage bigSymbolPreviewImage( QgsExpressionContext *expressionContext = nullptr ); @@ -208,8 +208,8 @@ class CORE_EXPORT QgsSymbol * symbol layer definitions will interpret this in different ways, e.g., a marker symbol * may use it to specify the units for the marker size, while a line symbol * may use it to specify the units for the line width. - * @returns output unit, or QgsUnitTypes::RenderUnknownUnit if the symbol contains mixed units - * @see setOutputUnit() + * \returns output unit, or QgsUnitTypes::RenderUnknownUnit if the symbol contains mixed units + * \see setOutputUnit() */ QgsUnitTypes::RenderUnit outputUnit() const; @@ -217,8 +217,8 @@ class CORE_EXPORT QgsSymbol * symbol definitions will interpret this in different ways, e.g., a marker symbol * may use it to specify the units for the marker size, while a line symbol * may use it to specify the units for the line width. - * @param unit output units - * @see outputUnit() + * \param unit output units + * \see outputUnit() */ void setOutputUnit( QgsUnitTypes::RenderUnit unit ); @@ -231,12 +231,12 @@ class CORE_EXPORT QgsSymbol void setAlpha( qreal alpha ) { mAlpha = alpha; } /** Sets rendering hint flags for the symbol. - * @see renderHints() + * \see renderHints() */ void setRenderHints( RenderHints hints ) { mRenderHints = hints; } /** Returns the rendering hint flags for the symbol. - * @see setRenderHints() + * \see setRenderHints() */ RenderHints renderHints() const { return mRenderHints; } @@ -244,9 +244,9 @@ class CORE_EXPORT QgsSymbol * extent. If this option is enabled then features which are partially outside the extent * will be clipped. This speeds up rendering of the feature, but may have undesirable * side effects for certain symbol types. - * @param clipFeaturesToExtent set to true to enable clipping (defaults to true) + * \param clipFeaturesToExtent set to true to enable clipping (defaults to true) * \since QGIS 2.9 - * @see clipFeaturesToExtent + * \see clipFeaturesToExtent */ void setClipFeaturesToExtent( bool clipFeaturesToExtent ) { mClipFeaturesToExtent = clipFeaturesToExtent; } @@ -254,9 +254,9 @@ class CORE_EXPORT QgsSymbol * extent. If this option is enabled then features which are partially outside the extent * will be clipped. This speeds up rendering of the feature, but may have undesirable * side effects for certain symbol types. - * @returns true if features will be clipped + * \returns true if features will be clipped * \since QGIS 2.9 - * @see setClipFeaturesToExtent + * \see setClipFeaturesToExtent */ bool clipFeaturesToExtent() const { return mClipFeaturesToExtent; } @@ -272,7 +272,7 @@ class CORE_EXPORT QgsSymbol */ bool hasDataDefinedProperties() const; - //! @note the layer will be NULL after stopRender + //! \note the layer will be NULL after stopRender void setLayer( const QgsVectorLayer *layer ) { mLayer = layer; } const QgsVectorLayer *layer() const { return mLayer; } @@ -285,7 +285,7 @@ class CORE_EXPORT QgsSymbol /** * Returns the symbol render context. Only valid between startRender and stopRender calls. * - * @return The symbol render context + * \returns The symbol render context */ QgsSymbolRenderContext *symbolRenderContext(); @@ -381,14 +381,14 @@ class CORE_EXPORT QgsSymbolRenderContext public: /** Constructor for QgsSymbolRenderContext - * @param c - * @param u - * @param alpha - * @param selected set to true if symbol should be drawn in a "selected" state - * @param renderHints flags controlling rendering behavior - * @param f - * @param fields - * @param mapUnitScale + * \param c + * \param u + * \param alpha + * \param selected set to true if symbol should be drawn in a "selected" state + * \param renderHints flags controlling rendering behavior + * \param f + * \param fields + * \param mapUnitScale */ QgsSymbolRenderContext( QgsRenderContext &c, QgsUnitTypes::RenderUnit u, qreal alpha = 1.0, bool selected = false, QgsSymbol::RenderHints renderHints = 0, const QgsFeature *f = nullptr, const QgsFields &fields = QgsFields(), const QgsMapUnitScale &mapUnitScale = QgsMapUnitScale() ); ~QgsSymbolRenderContext(); @@ -397,7 +397,7 @@ class CORE_EXPORT QgsSymbolRenderContext const QgsRenderContext &renderContext() const { return mRenderContext; } /** Sets the original value variable value for data defined symbology - * @param value value for original value variable. This usually represents the symbol property value + * \param value value for original value variable. This usually represents the symbol property value * before any data defined overrides have been applied. * \since QGIS 2.12 */ @@ -421,12 +421,12 @@ class CORE_EXPORT QgsSymbolRenderContext void setSelected( bool selected ) { mSelected = selected; } /** Returns the rendering hint flags for the symbol. - * @see setRenderHints() + * \see setRenderHints() */ QgsSymbol::RenderHints renderHints() const { return mRenderHints; } /** Sets rendering hint flags for the symbol. - * @see renderHints() + * \see renderHints() */ void setRenderHints( QgsSymbol::RenderHints hints ) { mRenderHints = hints; } @@ -436,7 +436,7 @@ class CORE_EXPORT QgsSymbolRenderContext /** * Sets the geometry type for the original feature geometry being rendered. - * @see originalGeometryType() + * \see originalGeometryType() * \since QGIS 3.0 */ void setOriginalGeometryType( QgsWkbTypes::GeometryType type ) { mOriginalGeometryType = type; } @@ -446,7 +446,7 @@ class CORE_EXPORT QgsSymbolRenderContext * useful if symbol layers alter their appearance based on geometry type - eg offsetting a * simple line style will look different if the simple line is rendering a polygon feature * (a closed buffer) vs a line feature (an unclosed offset line). - * @see originalGeometryType() + * \see originalGeometryType() * \since QGIS 3.0 */ QgsWkbTypes::GeometryType originalGeometryType() const { return mOriginalGeometryType; } @@ -486,7 +486,7 @@ class CORE_EXPORT QgsSymbolRenderContext /** * This scope is always available when a symbol of this type is being rendered. * - * @return An expression scope for details about this symbol + * \returns An expression scope for details about this symbol */ QgsExpressionContextScope *expressionContextScope(); @@ -495,7 +495,7 @@ class CORE_EXPORT QgsSymbolRenderContext * * Will take ownership. * - * @param contextScope An expression scope for details about this symbol + * \param contextScope An expression scope for details about this symbol */ void setExpressionContextScope( QgsExpressionContextScope *contextScope ); @@ -538,8 +538,8 @@ class CORE_EXPORT QgsMarkerSymbol : public QgsSymbol /** Sets the angle for the whole symbol. Individual symbol layer sizes * will be rotated to maintain their current relative angle to the whole symbol angle. - * @param symbolAngle new symbol angle - * @see angle() + * \param symbolAngle new symbol angle + * \see angle() */ void setAngle( double symbolAngle ); @@ -547,73 +547,73 @@ class CORE_EXPORT QgsMarkerSymbol : public QgsSymbol * multiple symbol layers, this will correspond just to the angle of * the first symbol layer. * \since QGIS 2.16 - * @see setAngle() + * \see setAngle() */ double angle() const; /** Set data defined angle for whole symbol (including all symbol layers). * \since QGIS 3.0 - * @see dataDefinedAngle() + * \see dataDefinedAngle() */ void setDataDefinedAngle( const QgsProperty &property ); /** Returns data defined angle for whole symbol (including all symbol layers). - * @returns data defined angle, or invalid property if angle is not set + * \returns data defined angle, or invalid property if angle is not set * at the marker level. * \since QGIS 3.0 - * @see setDataDefinedAngle() + * \see setDataDefinedAngle() */ QgsProperty dataDefinedAngle() const; /** Sets the line angle modification for the symbol's angle. This angle is added to * the marker's rotation and data defined rotation before rendering the symbol, and * is usually used for orienting symbols to match a line's angle. - * @param lineAngle Angle in degrees, valid values are between 0 and 360 + * \param lineAngle Angle in degrees, valid values are between 0 and 360 * \since QGIS 2.9 */ void setLineAngle( double lineAngle ); /** Sets the size for the whole symbol. Individual symbol layer sizes * will be scaled to maintain their current relative size to the whole symbol size. - * @param size new symbol size - * @see size() - * @see setSizeUnit() - * @see setSizeMapUnitScale() + * \param size new symbol size + * \see size() + * \see setSizeUnit() + * \see setSizeMapUnitScale() */ void setSize( double size ); /** Returns the size for the whole symbol, which is the maximum size of * all marker symbol layers in the symbol. - * @see setSize() - * @see sizeUnit() - * @see sizeMapUnitScale() + * \see setSize() + * \see sizeUnit() + * \see sizeMapUnitScale() */ double size() const; /** Sets the size units for the whole symbol (including all symbol layers). - * @param unit size units + * \param unit size units * \since QGIS 2.16 - * @see sizeUnit() - * @see setSizeMapUnitScale() - * @see setSize() + * \see sizeUnit() + * \see setSizeMapUnitScale() + * \see setSize() */ void setSizeUnit( QgsUnitTypes::RenderUnit unit ); /** Returns the size units for the whole symbol (including all symbol layers). - * @returns size units, or mixed units if symbol layers have different units + * \returns size units, or mixed units if symbol layers have different units * \since QGIS 2.16 - * @see setSizeUnit() - * @see sizeMapUnitScale() - * @see size() + * \see setSizeUnit() + * \see sizeMapUnitScale() + * \see size() */ QgsUnitTypes::RenderUnit sizeUnit() const; /** Sets the size map unit scale for the whole symbol (including all symbol layers). - * @param scale map unit scale + * \param scale map unit scale * \since QGIS 2.16 - * @see sizeMapUnitScale() - * @see setSizeUnit() - * @see setSize() + * \see sizeMapUnitScale() + * \see setSizeUnit() + * \see setSize() */ void setSizeMapUnitScale( const QgsMapUnitScale &scale ); @@ -621,23 +621,23 @@ class CORE_EXPORT QgsMarkerSymbol : public QgsSymbol * multiple symbol layers, this will correspond just to the map unit scale * for the first symbol layer. * \since QGIS 2.16 - * @see setSizeMapUnitScale() - * @see sizeUnit() - * @see size() + * \see setSizeMapUnitScale() + * \see sizeUnit() + * \see size() */ QgsMapUnitScale sizeMapUnitScale() const; /** Set data defined size for whole symbol (including all symbol layers). * \since QGIS 3.0 - * @see dataDefinedSize() + * \see dataDefinedSize() */ void setDataDefinedSize( const QgsProperty &property ); /** Returns data defined size for whole symbol (including all symbol layers). - * @returns data defined size, or invalid property if size is not set + * \returns data defined size, or invalid property if size is not set * at the marker level. * \since QGIS 3.0 - * @see setDataDefinedSize + * \see setDataDefinedSize */ QgsProperty dataDefinedSize() const; @@ -649,11 +649,11 @@ class CORE_EXPORT QgsMarkerSymbol : public QgsSymbol /** Returns the approximate bounding box of the marker symbol, which includes the bounding box * of all symbol layers for the symbol. It is recommended to use this method only between startRender() * and stopRender() calls, or data defined rotation and offset will not be correctly calculated. - * @param point location of rendered point in painter units - * @param context render context - * @param feature feature being rendered at point (optional). If not specified, the bounds calculation will not + * \param point location of rendered point in painter units + * \param context render context + * \param feature feature being rendered at point (optional). If not specified, the bounds calculation will not * include data defined parameters such as offset and rotation - * @returns approximate symbol bounds, in painter units + * \returns approximate symbol bounds, in painter units * \since QGIS 2.14 */ QRectF bounds( QPointF point, QgsRenderContext &context, const QgsFeature &feature = QgsFeature() ) const; @@ -685,16 +685,16 @@ class CORE_EXPORT QgsLineSymbol : public QgsSymbol double width() const; /** Set data defined width for whole symbol (including all symbol layers). - * @see dataDefinedWidth() + * \see dataDefinedWidth() * \since QGIS 3.0 */ void setDataDefinedWidth( const QgsProperty &property ); /** Returns data defined width for whole symbol (including all symbol layers). - * @returns data defined width, or invalid property if size is not set + * \returns data defined width, or invalid property if size is not set * at the line level. Caller takes responsibility for deleting the returned object. * \since QGIS 3.0 - * @see setDataDefinedWidth + * \see setDataDefinedWidth */ QgsProperty dataDefinedWidth() const; diff --git a/src/core/symbology-ng/qgssymbollayer.h b/src/core/symbology-ng/qgssymbollayer.h index 293a23942441..9c02b783a499 100644 --- a/src/core/symbology-ng/qgssymbollayer.h +++ b/src/core/symbology-ng/qgssymbollayer.h @@ -120,7 +120,7 @@ class CORE_EXPORT QgsSymbolLayer /** * Returns true if symbol layer is enabled and will be drawn. * \since QGIS 3.0 - * @see setEnabled() + * \see setEnabled() */ bool enabled() const { return mEnabled; } @@ -129,7 +129,7 @@ class CORE_EXPORT QgsSymbolLayer * layers are not drawn, but remain part of the symbol and can be re-enabled * when desired. * \since QGIS 3.0 - * @see enabled() + * \see enabled() */ void setEnabled( bool enabled ) { mEnabled = enabled; } @@ -210,8 +210,8 @@ class CORE_EXPORT QgsSymbolLayer * symbol layer subclasses will interpret this in different ways, e.g., a marker symbol * layer may use it to specify the units for the marker size, while a line symbol * layer may use it to specify the units for the line width. - * @param unit output units - * @see outputUnit() + * \param unit output units + * \see outputUnit() */ virtual void setOutputUnit( QgsUnitTypes::RenderUnit unit ) { Q_UNUSED( unit ); } @@ -219,8 +219,8 @@ class CORE_EXPORT QgsSymbolLayer * symbol layer subclasses will interpret this in different ways, e.g., a marker symbol * layer may use it to specify the units for the marker size, while a line symbol * layer may use it to specify the units for the line width. - * @returns output unit, or QgsUnitTypes::RenderUnknownUnit if the symbol layer contains mixed units - * @see setOutputUnit() + * \returns output unit, or QgsUnitTypes::RenderUnknownUnit if the symbol layer contains mixed units + * \see setOutputUnit() */ virtual QgsUnitTypes::RenderUnit outputUnit() const { return QgsUnitTypes::RenderUnknownUnit; } @@ -239,8 +239,8 @@ class CORE_EXPORT QgsSymbolLayer /** Sets a data defined property for the layer. Any existing property with the same key * will be overwritten. * \since QGIS 3.0 - * @see getDataDefinedProperty - * @see removeDataDefinedProperty + * \see getDataDefinedProperty + * \see removeDataDefinedProperty */ virtual void setDataDefinedProperty( Property key, const QgsProperty &property ); @@ -272,42 +272,42 @@ class CORE_EXPORT QgsSymbolLayer virtual Qt::BrushStyle dxfBrushStyle() const; /** Returns the current paint effect for the layer. - * @returns paint effect + * \returns paint effect * \since QGIS 2.9 - * @see setPaintEffect + * \see setPaintEffect */ QgsPaintEffect *paintEffect() const; /** Sets the current paint effect for the layer. - * @param effect paint effect. Ownership is transferred to the layer. + * \param effect paint effect. Ownership is transferred to the layer. * \since QGIS 2.9 - * @see paintEffect + * \see paintEffect */ void setPaintEffect( QgsPaintEffect *effect ); /** Prepares all data defined property expressions for evaluation. This should * be called prior to evaluating data defined properties. - * @param context symbol render context + * \param context symbol render context * \since QGIS 2.12 */ virtual void prepareExpressions( const QgsSymbolRenderContext &context ); /** Returns a reference to the symbol layer's property collection, used for data defined overrides. * \since QGIS 3.0 - * @see setProperties() + * \see setProperties() */ QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; } /** Returns a reference to the symbol layer's property collection, used for data defined overrides. * \since QGIS 3.0 - * @see setProperties() + * \see setProperties() */ const QgsPropertyCollection &dataDefinedProperties() const { return mDataDefinedProperties; } /** Sets the symbol layer's property collection, used for data defined overrides. - * @param collection property collection. Existing properties will be replaced. + * \param collection property collection. Existing properties will be replaced. * \since QGIS 3.0 - * @see properties() + * \see properties() */ void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; } @@ -343,12 +343,12 @@ class CORE_EXPORT QgsSymbolLayer void restoreOldDataDefinedProperties( const QgsStringMap &stringMap ); /** Copies all data defined properties of this layer to another symbol layer. - * @param destLayer destination layer + * \param destLayer destination layer */ void copyDataDefinedProperties( QgsSymbolLayer *destLayer ) const; /** Copies paint effect of this layer to another symbol layer - * @param destLayer destination layer + * \param destLayer destination layer * \since QGIS 2.9 */ void copyPaintEffect( QgsSymbolLayer *destLayer ) const; @@ -391,174 +391,174 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer /** Renders a marker at the specified point. Derived classes must implement this to * handle drawing the point. - * @param point position at which to render point, in painter units - * @param context symbol render context + * \param point position at which to render point, in painter units + * \param context symbol render context */ virtual void renderPoint( QPointF point, QgsSymbolRenderContext &context ) = 0; void drawPreviewIcon( QgsSymbolRenderContext &context, QSize size ) override; /** Sets the rotation angle for the marker. - * @param angle angle in degrees clockwise from north. - * @see angle() - * @see setLineAngle() + * \param angle angle in degrees clockwise from north. + * \see angle() + * \see setLineAngle() */ void setAngle( double angle ) { mAngle = angle; } /** Returns the rotation angle for the marker, in degrees clockwise from north. - * @see setAngle() + * \see setAngle() */ double angle() const { return mAngle; } /** Sets the line angle modification for the symbol's angle. This angle is added to * the marker's rotation and data defined rotation before rendering the symbol, and * is usually used for orienting symbols to match a line's angle. - * @param lineAngle Angle in degrees clockwise from north, valid values are between 0 and 360 + * \param lineAngle Angle in degrees clockwise from north, valid values are between 0 and 360 * \since QGIS 2.9 - * @see setAngle() - * @see angle() + * \see setAngle() + * \see angle() */ void setLineAngle( double lineAngle ) { mLineAngle = lineAngle; } /** Sets the symbol size. - * @param size symbol size. Units are specified by sizeUnit(). - * @see size() - * @see setSizeUnit() - * @see setSizeMapUnitScale() + * \param size symbol size. Units are specified by sizeUnit(). + * \see size() + * \see setSizeUnit() + * \see setSizeMapUnitScale() */ void setSize( double size ) { mSize = size; } /** Returns the symbol size. Units are specified by sizeUnit(). - * @see setSize() - * @see sizeUnit() - * @see sizeUnitMapScale() + * \see setSize() + * \see sizeUnit() + * \see sizeUnitMapScale() */ double size() const { return mSize; } /** Sets the units for the symbol's size. - * @param unit size units - * @see sizeUnit() - * @see setSize() - * @see setSizeMapUnitScale() + * \param unit size units + * \see sizeUnit() + * \see setSize() + * \see setSizeMapUnitScale() */ void setSizeUnit( QgsUnitTypes::RenderUnit unit ) { mSizeUnit = unit; } /** Returns the units for the symbol's size. - * @see setSizeUnit() - * @see size() - * @see sizeMapUnitScale() + * \see setSizeUnit() + * \see size() + * \see sizeMapUnitScale() */ QgsUnitTypes::RenderUnit sizeUnit() const { return mSizeUnit; } /** Sets the map unit scale for the symbol's size. - * @param scale size map unit scale - * @see sizeMapUnitScale() - * @see setSize() - * @see setSizeUnit() + * \param scale size map unit scale + * \see sizeMapUnitScale() + * \see setSize() + * \see setSizeUnit() */ void setSizeMapUnitScale( const QgsMapUnitScale &scale ) { mSizeMapUnitScale = scale; } /** Returns the map unit scale for the symbol's size. - * @see setSizeMapUnitScale() - * @see size() - * @see sizeUnit() + * \see setSizeMapUnitScale() + * \see size() + * \see sizeUnit() */ const QgsMapUnitScale &sizeMapUnitScale() const { return mSizeMapUnitScale; } /** Sets the method to use for scaling the marker's size. - * @param scaleMethod scale method - * @see scaleMethod() + * \param scaleMethod scale method + * \see scaleMethod() */ void setScaleMethod( QgsSymbol::ScaleMethod scaleMethod ) { mScaleMethod = scaleMethod; } /** Returns the method to use for scaling the marker's size. - * @see setScaleMethod() + * \see setScaleMethod() */ QgsSymbol::ScaleMethod scaleMethod() const { return mScaleMethod; } /** Sets the marker's offset, which is the horizontal and vertical displacement which the rendered marker * should have from the original feature's geometry. - * @param offset marker offset. Units are specified by offsetUnit() - * @see offset() - * @see setOffsetUnit() - * @see setOffsetMapUnitScale() + * \param offset marker offset. Units are specified by offsetUnit() + * \see offset() + * \see setOffsetUnit() + * \see setOffsetMapUnitScale() */ void setOffset( QPointF offset ) { mOffset = offset; } /** Returns the marker's offset, which is the horizontal and vertical displacement which the rendered marker * will have from the original feature's geometry. Units are specified by offsetUnit(). - * @see setOffset() - * @see offsetUnit() - * @see offsetMapUnitScale() + * \see setOffset() + * \see offsetUnit() + * \see offsetMapUnitScale() */ QPointF offset() const { return mOffset; } /** Sets the units for the symbol's offset. - * @param unit offset units - * @see offsetUnit() - * @see setOffset() - * @see setOffsetMapUnitScale() + * \param unit offset units + * \see offsetUnit() + * \see setOffset() + * \see setOffsetMapUnitScale() */ void setOffsetUnit( QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; } /** Returns the units for the symbol's offset. - * @see setOffsetUnit() - * @see offset() - * @see offsetMapUnitScale() + * \see setOffsetUnit() + * \see offset() + * \see offsetMapUnitScale() */ QgsUnitTypes::RenderUnit offsetUnit() const { return mOffsetUnit; } /** Sets the map unit scale for the symbol's offset. - * @param scale offset map unit scale - * @see offsetMapUnitScale() - * @see setOffset() - * @see setOffsetUnit() + * \param scale offset map unit scale + * \see offsetMapUnitScale() + * \see setOffset() + * \see setOffsetUnit() */ void setOffsetMapUnitScale( const QgsMapUnitScale &scale ) { mOffsetMapUnitScale = scale; } /** Returns the map unit scale for the symbol's offset. - * @see setOffsetMapUnitScale() - * @see offset() - * @see offsetUnit() + * \see setOffsetMapUnitScale() + * \see offset() + * \see offsetUnit() */ const QgsMapUnitScale &offsetMapUnitScale() const { return mOffsetMapUnitScale; } /** Sets the horizontal anchor point for positioning the symbol. - * @param h anchor point. Symbol will be drawn so that the horizontal anchor point is aligned with + * \param h anchor point. Symbol will be drawn so that the horizontal anchor point is aligned with * the marker's desired location. - * @see horizontalAnchorPoint() - * @see setVerticalAnchorPoint() + * \see horizontalAnchorPoint() + * \see setVerticalAnchorPoint() */ void setHorizontalAnchorPoint( HorizontalAnchorPoint h ) { mHorizontalAnchorPoint = h; } /** Returns the horizontal anchor point for positioning the symbol. The symbol will be drawn so that * the horizontal anchor point is aligned with the marker's desired location. - * @see setHorizontalAnchorPoint() - * @see verticalAnchorPoint() + * \see setHorizontalAnchorPoint() + * \see verticalAnchorPoint() */ HorizontalAnchorPoint horizontalAnchorPoint() const { return mHorizontalAnchorPoint; } /** Sets the vertical anchor point for positioning the symbol. - * @param v anchor point. Symbol will be drawn so that the vertical anchor point is aligned with + * \param v anchor point. Symbol will be drawn so that the vertical anchor point is aligned with * the marker's desired location. - * @see verticalAnchorPoint() - * @see setHorizontalAnchorPoint() + * \see verticalAnchorPoint() + * \see setHorizontalAnchorPoint() */ void setVerticalAnchorPoint( VerticalAnchorPoint v ) { mVerticalAnchorPoint = v; } /** Returns the vertical anchor point for positioning the symbol. The symbol will be drawn so that * the vertical anchor point is aligned with the marker's desired location. - * @see setVerticalAnchorPoint() - * @see horizontalAnchorPoint() + * \see setVerticalAnchorPoint() + * \see horizontalAnchorPoint() */ VerticalAnchorPoint verticalAnchorPoint() const { return mVerticalAnchorPoint; } virtual void toSld( QDomDocument &doc, QDomElement &element, const QgsStringMap &props ) const override; /** Writes the symbol layer definition as a SLD XML element. - * @param doc XML document - * @param element parent XML element - * @param props symbol layer definition (see properties()) + * \param doc XML document + * \param element parent XML element + * \param props symbol layer definition (see properties()) */ virtual void writeSldMarker( QDomDocument &doc, QDomElement &element, const QgsStringMap &props ) const { Q_UNUSED( props ); element.appendChild( doc.createComment( QStringLiteral( "QgsMarkerSymbolLayer %1 not implemented yet" ).arg( layerType() ) ) ); } @@ -570,7 +570,7 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer /** Returns the approximate bounding box of the marker symbol layer, taking into account * any data defined overrides and offsets which are set for the marker layer. - * @returns approximate symbol bounds, in painter units + * \returns approximate symbol bounds, in painter units * \since QGIS 2.14 */ virtual QRectF bounds( QPointF point, QgsSymbolRenderContext &context ) = 0; @@ -578,39 +578,39 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer protected: /** Constructor for QgsMarkerSymbolLayer. - * @param locked set to true to lock symbol color + * \param locked set to true to lock symbol color */ QgsMarkerSymbolLayer( bool locked = false ); /** Calculates the required marker offset, including both the symbol offset * and any displacement required to align with the marker's anchor point. - * @param context symbol render context - * @param offsetX will be set to required horizontal offset (in painter units) - * @param offsetY will be set to required vertical offset (in painter units) + * \param context symbol render context + * \param offsetX will be set to required horizontal offset (in painter units) + * \param offsetY will be set to required vertical offset (in painter units) */ void markerOffset( QgsSymbolRenderContext &context, double &offsetX, double &offsetY ) const; /** Calculates the required marker offset, including both the symbol offset * and any displacement required to align with the marker's anchor point. - * @param context symbol render context - * @param width marker width - * @param height marker height - * @param offsetX will be set to required horizontal offset (in painter units) - * @param offsetY will be set to required vertical offset (in painter units) - * @note available in Python as markerOffsetWithWidthAndHeight + * \param context symbol render context + * \param width marker width + * \param height marker height + * \param offsetX will be set to required horizontal offset (in painter units) + * \param offsetY will be set to required vertical offset (in painter units) + * \note available in Python as markerOffsetWithWidthAndHeight */ void markerOffset( QgsSymbolRenderContext &context, double width, double height, double &offsetX, double &offsetY ) const; - //! @note available in Python bindings as markerOffset2 + //! \note available in Python bindings as markerOffset2 void markerOffset( QgsSymbolRenderContext &context, double width, double height, QgsUnitTypes::RenderUnit widthUnit, QgsUnitTypes::RenderUnit heightUnit, double &offsetX, double &offsetY, const QgsMapUnitScale &widthMapUnitScale, const QgsMapUnitScale &heightMapUnitScale ) const; /** Adjusts a marker offset to account for rotation. - * @param offset offset prior to rotation - * @param angle rotation angle in degrees clockwise from north - * @return adjusted offset + * \param offset offset prior to rotation + * \param angle rotation angle in degrees clockwise from north + * \returns adjusted offset */ static QPointF _rotatedOffset( QPointF offset, double angle ); @@ -659,13 +659,13 @@ class CORE_EXPORT QgsLineSymbolLayer : public QgsSymbolLayer void setOffset( double offset ) { mOffset = offset; } /** Sets the units for the line's width. - * @param unit width units - * @see widthUnit() + * \param unit width units + * \see widthUnit() */ void setWidthUnit( QgsUnitTypes::RenderUnit unit ) { mWidthUnit = unit; } /** Returns the units for the line's width. - * @see setWidthUnit() + * \see setWidthUnit() */ QgsUnitTypes::RenderUnit widthUnit() const { return mWidthUnit; } @@ -673,13 +673,13 @@ class CORE_EXPORT QgsLineSymbolLayer : public QgsSymbolLayer const QgsMapUnitScale &widthMapUnitScale() const { return mWidthMapUnitScale; } /** Sets the units for the line's offset. - * @param unit offset units - * @see offsetUnit() + * \param unit offset units + * \see offsetUnit() */ void setOffsetUnit( QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; } /** Returns the units for the line's offset. - * @see setOffsetUnit() + * \see setOffsetUnit() */ QgsUnitTypes::RenderUnit offsetUnit() const { return mOffsetUnit; } diff --git a/src/core/symbology-ng/qgssymbollayerregistry.h b/src/core/symbology-ng/qgssymbollayerregistry.h index 4e04cb4de040..6bc3b5e3ad6a 100644 --- a/src/core/symbology-ng/qgssymbollayerregistry.h +++ b/src/core/symbology-ng/qgssymbollayerregistry.h @@ -25,7 +25,7 @@ class QgsSymbolLayerWidget; /** \ingroup core Stores metadata about one symbol layer class. - @note It's necessary to implement createSymbolLayer() function. + \note It's necessary to implement createSymbolLayer() function. In C++ you can use QgsSymbolLayerMetadata convenience class. */ class CORE_EXPORT QgsSymbolLayerAbstractMetadata @@ -67,7 +67,7 @@ typedef QgsSymbolLayer *( *QgsSymbolLayerCreateFromSldFunc )( QDomElement & ); class CORE_EXPORT QgsSymbolLayerMetadata : public QgsSymbolLayerAbstractMetadata { public: - //! @note not available in Python bindings + //! \note not available in Python bindings QgsSymbolLayerMetadata( const QString &name, const QString &visibleName, QgsSymbol::SymbolType type, QgsSymbolLayerCreateFunc pfCreate, @@ -78,7 +78,7 @@ class CORE_EXPORT QgsSymbolLayerMetadata : public QgsSymbolLayerAbstractMetadata , mCreateFromSldFunc( nullptr ) {} - //! @note not available in Python bindings + //! \note not available in Python bindings QgsSymbolLayerMetadata( const QString &name, const QString &visibleName, QgsSymbol::SymbolType type, QgsSymbolLayerCreateFunc pfCreate, @@ -90,14 +90,14 @@ class CORE_EXPORT QgsSymbolLayerMetadata : public QgsSymbolLayerAbstractMetadata , mCreateFromSldFunc( pfCreateFromSld ) {} - //! @note not available in Python bindings + //! \note not available in Python bindings QgsSymbolLayerCreateFunc createFunction() const { return mCreateFunc; } - //! @note not available in Python bindings + //! \note not available in Python bindings QgsSymbolLayerWidgetFunc widgetFunction() const { return mWidgetFunc; } - //! @note not available in Python bindings + //! \note not available in Python bindings QgsSymbolLayerCreateFromSldFunc createFromSldFunction() const { return mCreateFromSldFunc; } - //! @note not available in Python bindings + //! \note not available in Python bindings void setWidgetFunction( QgsSymbolLayerWidgetFunc f ) { mWidgetFunc = f; } virtual QgsSymbolLayer *createSymbolLayer( const QgsStringMap &map ) override { return mCreateFunc ? mCreateFunc( map ) : nullptr; } diff --git a/src/core/symbology-ng/qgssymbollayerutils.h b/src/core/symbology-ng/qgssymbollayerutils.h index a02793e87c48..45aac651b99f 100644 --- a/src/core/symbology-ng/qgssymbollayerutils.h +++ b/src/core/symbology-ng/qgssymbollayerutils.h @@ -84,27 +84,27 @@ class CORE_EXPORT QgsSymbolLayerUtils static Qt::BrushStyle decodeSldBrushStyle( const QString &str ); /** Encodes a QPointF to a string. - * @see decodePoint() - * @see encodeSize() + * \see decodePoint() + * \see encodeSize() */ static QString encodePoint( QPointF point ); /** Decodes a QSizeF from a string. - * @see encodePoint() - * @see decodeSize() + * \see encodePoint() + * \see decodeSize() */ static QPointF decodePoint( const QString &string ); /** Encodes a QSizeF to a string. - * @see decodeSize() - * @see encodePoint() + * \see decodeSize() + * \see encodePoint() * \since QGIS 3.0 */ static QString encodeSize( QSizeF size ); /** Decodes a QSizeF from a string. - * @see encodeSize() - * @see decodePoint() + * \see encodeSize() + * \see decodePoint() * \since QGIS 3.0 */ static QSizeF decodeSize( const QString &string ); @@ -119,18 +119,18 @@ class CORE_EXPORT QgsSymbolLayerUtils static QVector decodeSldRealVector( const QString &s ); /** Encodes a render unit into an SLD unit of measure string. - * @param unit unit to encode - * @param scaleFactor if specified, will be set to scale factor for unit of measure - * @returns encoded string - * @see decodeSldUom() + * \param unit unit to encode + * \param scaleFactor if specified, will be set to scale factor for unit of measure + * \returns encoded string + * \see decodeSldUom() */ static QString encodeSldUom( QgsUnitTypes::RenderUnit unit, double *scaleFactor ); /** Decodes a SLD unit of measure string to a render unit. - * @param str string to decode - * @param scaleFactor if specified, will be set to scale factor for unit of measure - * @returns matching render unit - * @see encodeSldUom() + * \param str string to decode + * \param scaleFactor if specified, will be set to scale factor for unit of measure + * \returns matching render unit + * \see encodeSldUom() */ static QgsUnitTypes::RenderUnit decodeSldUom( const QString &str, double *scaleFactor ); @@ -140,57 +140,57 @@ class CORE_EXPORT QgsSymbolLayerUtils static QPainter::CompositionMode decodeBlendMode( const QString &s ); /** Returns an icon preview for a color ramp. - * @param symbol symbol - * @param size target pixmap size - * @param padding space between icon edge and symbol - * @see symbolPreviewPixmap() + * \param symbol symbol + * \param size target pixmap size + * \param padding space between icon edge and symbol + * \see symbolPreviewPixmap() */ static QIcon symbolPreviewIcon( QgsSymbol *symbol, QSize size, int padding = 0 ); /** Returns a pixmap preview for a color ramp. - * @param symbol symbol - * @param size target pixmap size - * @param padding space between icon edge and symbol - * @param customContext render context to use when rendering symbol + * \param symbol symbol + * \param size target pixmap size + * \param padding space between icon edge and symbol + * \param customContext render context to use when rendering symbol * \note Parameter customContext added in QGIS 2.6 - * @see symbolPreviewIcon() + * \see symbolPreviewIcon() */ static QPixmap symbolPreviewPixmap( QgsSymbol *symbol, QSize size, int padding = 0, QgsRenderContext *customContext = nullptr ); /** Draws a symbol layer preview to a QPicture - * @param layer symbol layer to draw - * @param units size units - * @param size target size of preview picture - * @param scale map unit scale for preview - * @returns QPicture containing symbol layer preview + * \param layer symbol layer to draw + * \param units size units + * \param size target size of preview picture + * \param scale map unit scale for preview + * \returns QPicture containing symbol layer preview * \since QGIS 2.9 - * @see symbolLayerPreviewIcon() + * \see symbolLayerPreviewIcon() */ static QPicture symbolLayerPreviewPicture( QgsSymbolLayer *layer, QgsUnitTypes::RenderUnit units, QSize size, const QgsMapUnitScale &scale = QgsMapUnitScale() ); /** Draws a symbol layer preview to an icon. - * @param layer symbol layer to draw - * @param u size units - * @param size target size of preview icon - * @param scale map unit scale for preview - * @returns icon containing symbol layer preview - * @see symbolLayerPreviewPicture() + * \param layer symbol layer to draw + * \param u size units + * \param size target size of preview icon + * \param scale map unit scale for preview + * \returns icon containing symbol layer preview + * \see symbolLayerPreviewPicture() */ static QIcon symbolLayerPreviewIcon( QgsSymbolLayer *layer, QgsUnitTypes::RenderUnit u, QSize size, const QgsMapUnitScale &scale = QgsMapUnitScale() ); /** Returns an icon preview for a color ramp. - * @param ramp color ramp - * @param size target icon size - * @param padding space between icon edge and color ramp - * @see colorRampPreviewPixmap() + * \param ramp color ramp + * \param size target icon size + * \param padding space between icon edge and color ramp + * \see colorRampPreviewPixmap() */ static QIcon colorRampPreviewIcon( QgsColorRamp *ramp, QSize size, int padding = 0 ); /** Returns a pixmap preview for a color ramp. - * @param ramp color ramp - * @param size target pixmap size - * @param padding space between icon edge and color ramp - * @see colorRampPreviewIcon() + * \param ramp color ramp + * \param size target pixmap size + * \param padding space between icon edge and color ramp + * \see colorRampPreviewIcon() */ static QPixmap colorRampPreviewPixmap( QgsColorRamp *ramp, QSize size, int padding = 0 ); @@ -200,16 +200,16 @@ class CORE_EXPORT QgsSymbolLayerUtils static double estimateMaxSymbolBleed( QgsSymbol *symbol, const QgsRenderContext &context ); /** Attempts to load a symbol from a DOM element - * @param element DOM element representing symbol - * @returns decoded symbol, if possible + * \param element DOM element representing symbol + * \returns decoded symbol, if possible */ static QgsSymbol *loadSymbol( const QDomElement &element ); /** Attempts to load a symbol from a DOM element and cast it to a particular symbol * type. - * @param element DOM element representing symbol - * @returns decoded symbol cast to specified type, if possible - * @note not available in Python bindings + * \param element DOM element representing symbol + * \returns decoded symbol cast to specified type, if possible + * \note not available in Python bindings */ template static SymbolType *loadSymbol( const QDomElement &element ) { @@ -260,7 +260,7 @@ class CORE_EXPORT QgsSymbolLayerUtils static bool fillFromSld( QDomElement &element, Qt::BrushStyle &brushStyle, QColor &color ); - //! @note not available in Python bindings + //! \note not available in Python bindings static void lineToSld( QDomDocument &doc, QDomElement &element, Qt::PenStyle penStyle, const QColor &color, double width = -1, const Qt::PenJoinStyle *penJoinStyle = nullptr, const Qt::PenCapStyle *penCapStyle = nullptr, @@ -281,7 +281,7 @@ class CORE_EXPORT QgsSymbolLayerUtils const QString &name, const QColor &color, const QColor &strokeColor, Qt::PenStyle strokeStyle, double strokeWidth = -1, double size = -1 ); - //! @note available in Python as wellKnownMarkerFromSld2 + //! \note available in Python as wellKnownMarkerFromSld2 static bool wellKnownMarkerFromSld( QDomElement &element, QString &name, QColor &color, QColor &strokeColor, Qt::PenStyle &strokeStyle, double &strokeWidth, double &size ); @@ -305,7 +305,7 @@ class CORE_EXPORT QgsSymbolLayerUtils const QVector *dashPattern = nullptr ); /** Create ogr feature style string for brush - @param fillColr fill color*/ + \param fillColr fill color*/ static QString ogrFeatureStyleBrush( const QColor &fillColr ); static void createRotationElement( QDomDocument &doc, QDomElement &element, const QString &rotationFunc ); @@ -325,10 +325,10 @@ class CORE_EXPORT QgsSymbolLayerUtils /** * Creates a OGC Expression element based on the provided function expression - * @param doc The document owning the element - * @param element The element parent - * @param function The expression to be encoded - * @return + * \param doc The document owning the element + * \param element The element parent + * \param function The expression to be encoded + * \returns */ static bool createExpressionElement( QDomDocument &doc, QDomElement &element, const QString &function ); static bool createFunctionElement( QDomDocument &doc, QDomElement &element, const QString &function ); @@ -349,18 +349,18 @@ class CORE_EXPORT QgsSymbolLayerUtils static void clearSymbolMap( QgsSymbolMap &symbols ); /** Creates a color ramp from the settings encoded in an XML element - * @param element DOM element - * @returns new color ramp. Caller takes responsibility for deleting the returned value. - * @see saveColorRamp() + * \param element DOM element + * \returns new color ramp. Caller takes responsibility for deleting the returned value. + * \see saveColorRamp() */ static QgsColorRamp *loadColorRamp( QDomElement &element ); /** Encodes a color ramp's settings to an XML element - * @param name name of ramp - * @param ramp color ramp to save - * @param doc XML document - * @returns DOM element representing state of color ramp - * @see loadColorRamp() + * \param name name of ramp + * \param ramp color ramp to save + * \param doc XML document + * \returns DOM element representing state of color ramp + * \see loadColorRamp() */ static QDomElement saveColorRamp( const QString &name, QgsColorRamp *ramp, QDomDocument &doc ); @@ -368,7 +368,7 @@ class CORE_EXPORT QgsSymbolLayerUtils * Saves a color ramp to a QVariantMap, wrapped in a QVariant. * You can use QgsXmlUtils::writeVariant to save it to an XML document. * - * @see loadColorRamp( const QVariant &value ) + * \see loadColorRamp( const QVariant &value ) */ static QVariant colorRampToVariant( const QString &name, QgsColorRamp *ramp ); @@ -376,14 +376,14 @@ class CORE_EXPORT QgsSymbolLayerUtils * Load a color ramp from a QVariantMap, wrapped in a QVariant. * You can use QgsXmlUtils::readVariant to load it from an XML document. * - * @see colorRampToVariant() + * \see colorRampToVariant() */ static QgsColorRamp *loadColorRamp( const QVariant &value ); /** * Returns a friendly display name for a color - * @param color source color - * @returns display name for color + * \param color source color + * \returns display name for color * \since QGIS 2.5 */ static QString colorToName( const QColor &color ); @@ -391,8 +391,8 @@ class CORE_EXPORT QgsSymbolLayerUtils /** * Attempts to parse a string as a list of colors using a variety of common formats, including hex * codes, rgb and rgba strings. - * @param colorStr string representing the color list - * @returns list of parsed colors + * \param colorStr string representing the color list + * \returns list of parsed colors * \since QGIS 2.5 */ static QList< QColor > parseColorList( const QString &colorStr ); @@ -400,18 +400,18 @@ class CORE_EXPORT QgsSymbolLayerUtils /** * Creates mime data from a color. Sets both the mime data's color data, and the * mime data's text with the color's hex code. - * @param color color to encode as mime data - * @see colorFromMimeData + * \param color color to encode as mime data + * \see colorFromMimeData * \since QGIS 2.5 */ static QMimeData *colorToMimeData( const QColor &color ); /** * Attempts to parse mime data as a color - * @param data mime data to parse - * @param hasAlpha will be set to true if mime data was interpreted as a color containing + * \param data mime data to parse + * \param hasAlpha will be set to true if mime data was interpreted as a color containing * an explicit alpha value - * @returns valid color if mimedata could be interpreted as a color, otherwise an + * \returns valid color if mimedata could be interpreted as a color, otherwise an * invalid color * \since QGIS 2.5 */ @@ -419,47 +419,47 @@ class CORE_EXPORT QgsSymbolLayerUtils /** * Attempts to parse mime data as a list of named colors - * @param data mime data to parse - * @returns list of parsed colors + * \param data mime data to parse + * \returns list of parsed colors * \since QGIS 2.5 */ static QgsNamedColorList colorListFromMimeData( const QMimeData *data ); /** * Creates mime data from a list of named colors - * @param colorList list of named colors - * @param allFormats set to true to include additional mime formats, include text/plain and application/x-color - * @returns mime data containing encoded colors + * \param colorList list of named colors + * \param allFormats set to true to include additional mime formats, include text/plain and application/x-color + * \returns mime data containing encoded colors * \since QGIS 2.5 */ static QMimeData *colorListToMimeData( const QgsNamedColorList &colorList, const bool allFormats = true ); /** * Exports colors to a gpl GIMP palette file - * @param file destination file - * @param paletteName name of palette, which is stored in gpl file - * @param colors colors to export - * @returns true if export was successful - * @see importColorsFromGpl + * \param file destination file + * \param paletteName name of palette, which is stored in gpl file + * \param colors colors to export + * \returns true if export was successful + * \see importColorsFromGpl */ static bool saveColorsToGpl( QFile &file, const QString &paletteName, const QgsNamedColorList &colors ); /** * Imports colors from a gpl GIMP palette file - * @param file source gpl file - * @param ok will be true if file was successfully read - * @param name will be set to palette name from gpl file, if present - * @returns list of imported colors - * @see saveColorsToGpl + * \param file source gpl file + * \param ok will be true if file was successfully read + * \param name will be set to palette name from gpl file, if present + * \returns list of imported colors + * \see saveColorsToGpl */ static QgsNamedColorList importColorsFromGpl( QFile &file, bool &ok, QString &name ); /** * Attempts to parse a string as a color using a variety of common formats, including hex * codes, rgb and rgba strings. - * @param colorStr string representing the color - * @param strictEval set to true for stricter color parsing rules - * @returns parsed color + * \param colorStr string representing the color + * \param strictEval set to true for stricter color parsing rules + * \returns parsed color * \since QGIS 2.3 */ static QColor parseColor( const QString &colorStr, bool strictEval = false ); @@ -467,10 +467,10 @@ class CORE_EXPORT QgsSymbolLayerUtils /** * Attempts to parse a string as a color using a variety of common formats, including hex * codes, rgb and rgba strings. - * @param colorStr string representing the color - * @param containsAlpha if colorStr contains an explicit alpha value then containsAlpha will be set to true - * @param strictEval set to true for stricter color parsing rules - * @returns parsed color + * \param colorStr string representing the color + * \param containsAlpha if colorStr contains an explicit alpha value then containsAlpha will be set to true + * \param strictEval set to true for stricter color parsing rules + * \returns parsed color * \since QGIS 2.3 */ static QColor parseColorWithAlpha( const QString &colorStr, bool &containsAlpha, bool strictEval = false ); diff --git a/src/core/symbology-ng/qgsvectorfieldsymbollayer.h b/src/core/symbology-ng/qgsvectorfieldsymbollayer.h index 93c745f9a381..1682c2ea0beb 100644 --- a/src/core/symbology-ng/qgsvectorfieldsymbollayer.h +++ b/src/core/symbology-ng/qgsvectorfieldsymbollayer.h @@ -92,13 +92,13 @@ class CORE_EXPORT QgsVectorFieldSymbolLayer: public QgsMarkerSymbolLayer QgsMapUnitScale mapUnitScale() const override; /** Sets the units for the distance. - * @param unit distance units - * @see distanceUnit() + * \param unit distance units + * \see distanceUnit() */ void setDistanceUnit( QgsUnitTypes::RenderUnit unit ) { mDistanceUnit = unit; } /** Returns the units for the distance. - * @see setDistanceUnit() + * \see setDistanceUnit() */ QgsUnitTypes::RenderUnit distanceUnit() const { return mDistanceUnit; } diff --git a/src/gui/attributetable/qgsattributetabledelegate.h b/src/gui/attributetable/qgsattributetabledelegate.h index 3f0fa36818a7..d5e80f9191ec 100644 --- a/src/gui/attributetable/qgsattributetabledelegate.h +++ b/src/gui/attributetable/qgsattributetabledelegate.h @@ -41,7 +41,7 @@ class GUI_EXPORT QgsAttributeTableDelegate : public QItemDelegate /** * Constructor - * @param parent parent object + * \param parent parent object */ QgsAttributeTableDelegate( QObject *parent = nullptr ) : QItemDelegate( parent ) @@ -63,16 +63,16 @@ class GUI_EXPORT QgsAttributeTableDelegate : public QItemDelegate /** * Sets data from editor back to model. Overloads default method - * @param editor editor which was created by create editor function in this class - * @param model model where data should be updated - * @param index index of field which is to be modified + * \param editor editor which was created by create editor function in this class + * \param model model where data should be updated + * \param index index of field which is to be modified */ void setModelData( QWidget *editor, QAbstractItemModel *model, const QModelIndex &index ) const override; /** * Sets data from model into the editor. Overloads default method - * @param editor editor which was created by create editor function in this class - * @param index index of field which is to be retrieved + * \param editor editor which was created by create editor function in this class + * \param index index of field which is to be retrieved */ void setEditorData( QWidget *editor, const QModelIndex &index ) const override; @@ -84,7 +84,7 @@ class GUI_EXPORT QgsAttributeTableDelegate : public QItemDelegate * Is emitted when an action column item is painted. * The consumer of this signal can initialize the index widget. * - * @note This signal is emitted repeatedly whenever the item is being painted. + * \note This signal is emitted repeatedly whenever the item is being painted. * It is the consumers responsibility to check if initialization has already * happened before. */ diff --git a/src/gui/attributetable/qgsattributetablefiltermodel.h b/src/gui/attributetable/qgsattributetablefiltermodel.h index 89ad0c56ea58..ddab3c851848 100644 --- a/src/gui/attributetable/qgsattributetablefiltermodel.h +++ b/src/gui/attributetable/qgsattributetablefiltermodel.h @@ -45,7 +45,7 @@ class GUI_EXPORT QgsAttributeTableFilterModel: public QSortFilterProxyModel, pub ShowAll, //!< Show all features ShowSelected, //!< Show only selected features ShowVisible, //!< Show only visible features (depends on the map canvas) - ShowFilteredList, //!< Show only features whose ids are on the filter list. {@see setFilteredFeatures} + ShowFilteredList, //!< Show only features whose ids are on the filter list. {\see setFilteredFeatures} ShowEdited //!< Show only features which have unsaved changes }; @@ -72,16 +72,16 @@ class GUI_EXPORT QgsAttributeTableFilterModel: public QSortFilterProxyModel, pub /** * Make sure, the master model is already loaded, so the selection will get synchronized. * - * @param parent parent object (owner) - * @param sourceModel The QgsAttributeTableModel to use as source (mostly referred to as master model) - * @param canvas The mapCanvas. Used to identify the currently visible features. + * \param parent parent object (owner) + * \param sourceModel The QgsAttributeTableModel to use as source (mostly referred to as master model) + * \param canvas The mapCanvas. Used to identify the currently visible features. */ QgsAttributeTableFilterModel( QgsMapCanvas *canvas, QgsAttributeTableModel *sourceModel, QObject *parent = nullptr ); /** * Set the attribute table model that backs this model * - * @param sourceModel The model + * \param sourceModel The model * * \since QGIS 2.0 */ @@ -91,14 +91,14 @@ class GUI_EXPORT QgsAttributeTableFilterModel: public QSortFilterProxyModel, pub * Changes the sort order of the features. If set to true, selected features * will be sorted on top, regardless of the current sort column * - * @param selectedOnTop Specify, if selected features should be sorted on top + * \param selectedOnTop Specify, if selected features should be sorted on top */ void setSelectedOnTop( bool selectedOnTop ); /** * Returns if selected features are currently shown on top * - * @return True if selected are shown on top + * \returns True if selected are shown on top */ bool selectedOnTop(); @@ -106,21 +106,21 @@ class GUI_EXPORT QgsAttributeTableFilterModel: public QSortFilterProxyModel, pub * Specify a list of features, which the filter will accept. * The filter mode will automatically be adjusted to show only these features (ShowFilteredList). * - * @param ids The list of feature ids which will be accepted by the filter + * \param ids The list of feature ids which will be accepted by the filter */ virtual void setFilteredFeatures( const QgsFeatureIds &ids ); /** * Get a list of currently filtered feature ids * - * @return A list of feature ids + * \returns A list of feature ids */ QgsFeatureIds filteredFeatures(); /** * Set the filter mode the filter will use. * - * @param filterMode Sets the current mode of the filter + * \param filterMode Sets the current mode of the filter */ void setFilterMode( FilterMode filterMode ); @@ -132,30 +132,30 @@ class GUI_EXPORT QgsAttributeTableFilterModel: public QSortFilterProxyModel, pub /** * Returns the layer this filter acts on. * - * @return Abovementioned layer + * \returns Abovementioned layer */ inline QgsVectorLayer *layer() const { return masterModel()->layer(); } /** * Returns the layerCache this filter acts on. * - * @return The layer cache + * \returns The layer cache */ inline QgsVectorLayerCache *layerCache() const { return masterModel()->layerCache(); } /** * Returns the table model this filter is using * - * @return the table model in quesion + * \returns the table model in quesion */ inline QgsAttributeTableModel *masterModel() const { return mTableModel; } /** * Returns the feature id for a given model index. * - * @param row A model index of the row in question + * \param row A model index of the row in question * - * @return The feature id of the feature visible in the provided row + * \returns The feature id of the feature visible in the provided row */ QgsFeatureId rowToId( const QModelIndex &row ); @@ -177,8 +177,8 @@ class GUI_EXPORT QgsAttributeTableFilterModel: public QSortFilterProxyModel, pub * Sort by the given column using the given order. * Prefetches all the data from the layer to speed up sorting. * - * @param column The column which should be sorted - * @param order The order ( Qt::AscendingOrder or Qt::DescendingOrder ) + * \param column The column which should be sorted + * \param order The order ( Qt::AscendingOrder or Qt::DescendingOrder ) */ virtual void sort( int column, Qt::SortOrder order = Qt::AscendingOrder ) override; @@ -186,8 +186,8 @@ class GUI_EXPORT QgsAttributeTableFilterModel: public QSortFilterProxyModel, pub * Sort by the given expression using the given order. * Prefetches all the data from the layer to speed up sorting. * - * @param expression The expression which should be used for sorting - * @param order The order ( Qt::AscendingOrder or Qt::DescendingOrder ) + * \param expression The expression which should be used for sorting + * \param order The order ( Qt::AscendingOrder or Qt::DescendingOrder ) */ void sort( const QString &expression, Qt::SortOrder order = Qt::AscendingOrder ); @@ -222,8 +222,8 @@ class GUI_EXPORT QgsAttributeTableFilterModel: public QSortFilterProxyModel, pub /** * Is emitted whenever the sort column is changed - * @param column The sort column - * @param order The sort order + * \param column The sort column + * \param order The sort order */ void sortColumnChanged( int column, Qt::SortOrder order ); @@ -232,8 +232,8 @@ class GUI_EXPORT QgsAttributeTableFilterModel: public QSortFilterProxyModel, pub /** * Returns true if the source row will be accepted * - * @param sourceRow row from the source model - * @param sourceParent parent index in the source model + * \param sourceRow row from the source model + * \param sourceParent parent index in the source model */ bool filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent ) const override; diff --git a/src/gui/attributetable/qgsattributetablemodel.h b/src/gui/attributetable/qgsattributetablemodel.h index 7eaa97e6915c..e6a1f91dfad8 100644 --- a/src/gui/attributetable/qgsattributetablemodel.h +++ b/src/gui/attributetable/qgsattributetablemodel.h @@ -36,14 +36,14 @@ class QgsEditorWidgetFactory; class QgsFieldFormatter; /** \ingroup gui - * A model backed by a {@link QgsVectorLayerCache} which is able to provide + * A model backed by a QgsVectorLayerCache which is able to provide * feature/attribute information to a QAbstractItemView. * - * @brief + * \brief * Is able to generate editor widgets for its QModelIndexes as well. * Is mostly referred to as "master model" within this doc and the source. * - * @see Qt Model View Programming + * \see Qt Model View Programming */ class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel { @@ -62,56 +62,56 @@ class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel /** * Constructor - * @param layerCache A layer cache to use as backend - * @param parent The parent QObject (owner) + * \param layerCache A layer cache to use as backend + * \param parent The parent QObject (owner) */ QgsAttributeTableModel( QgsVectorLayerCache *layerCache, QObject *parent = nullptr ); /** * Returns the number of rows - * @param parent parent index + * \param parent parent index */ virtual int rowCount( const QModelIndex &parent = QModelIndex() ) const override; /** * Returns the number of columns - * @param parent parent index + * \param parent parent index */ int columnCount( const QModelIndex &parent = QModelIndex() ) const override; /** * Returns header data - * @param section required section - * @param orientation horizontal or vertical orientation - * @param role data role + * \param section required section + * \param orientation horizontal or vertical orientation + * \param role data role */ QVariant headerData( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const override; /** * Returns data on the given index - * @param index model index - * @param role data role + * \param index model index + * \param role data role */ virtual QVariant data( const QModelIndex &index, int role ) const override; /** * Updates data on given index - * @param index model index - * @param value new data value - * @param role data role + * \param index model index + * \param value new data value + * \param role data role */ virtual bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ) override; /** * Returns item flags for the index - * @param index model index + * \param index model index */ Qt::ItemFlags flags( const QModelIndex &index ) const override; /** * Reloads the model data between indices - * @param index1 start index - * @param index2 end index + * \param index1 start index + * \param index2 end index */ void reload( const QModelIndex &index1, const QModelIndex &index2 ); @@ -129,7 +129,7 @@ class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel /** * Maps feature id to table row - * @param id feature id + * \param id feature id */ int idToRow( QgsFeatureId id ) const; @@ -149,14 +149,14 @@ class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel /** * Maps row to feature id - * @param row row number + * \param row row number */ QgsFeatureId rowToId( int row ) const; /** * Swaps two rows - * @param a first row - * @param b second row + * \param a first row + * \param b second row */ void swapRows( QgsFeatureId a, QgsFeatureId b ); @@ -182,7 +182,7 @@ class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel /** * Return the feature attributes at given model index - * @return feature attributes at given model index + * \returns feature attributes at given model index */ QgsFeature feature( const QModelIndex &idx ) const; @@ -191,7 +191,7 @@ class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel * so the data does not have to be fetched for every single comparison. * Specify -1 as column to invalidate the cache * - * @param column The column index of the field to catch + * \param column The column index of the field to catch */ void prefetchColumnData( int column ); @@ -199,7 +199,7 @@ class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel * Prefetches the entire data for one expression. Based on this cached information * the sorting can later be done in a performant way. * - * @param expression The expression to cache + * \param expression The expression to cache */ void prefetchSortData( const QString &expression ); @@ -213,7 +213,7 @@ class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel * In contrast to a filter, the request will constrain the data shown without the possibility * to dynamically adjust it. * - * @param request The request to use to fill this table model. + * \param request The request to use to fill this table model. */ void setRequest( const QgsFeatureRequest &request ); @@ -227,7 +227,7 @@ class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel * Sets the context in which this table is shown. * Will be forwarded to any editor widget created when editing data on this model. * - * @param context The context + * \param context The context */ void setEditorContext( const QgsAttributeEditorContext &context ) { mEditorContext = context; } @@ -235,7 +235,7 @@ class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel * Returns the context in which this table is shown. * Will be forwarded to any editor widget created when editing data on this model. * - * @return The context + * \returns The context */ const QgsAttributeEditorContext &editorContext() const { return mEditorContext; } @@ -260,7 +260,7 @@ class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel virtual void loadLayer(); /** Handles updating the model when the conditional style for a field changes. - * @param fieldName name of field whose conditional style has changed + * \param fieldName name of field whose conditional style has changed * \since QGIS 2.12 */ void fieldConditionalStyleChanged( const QString &fieldName ); @@ -272,7 +272,7 @@ class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel */ void modelChanged(); - //! @note not available in Python bindings + //! \note not available in Python bindings void progress( int i, bool &cancel ); void finished(); @@ -297,21 +297,21 @@ class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel /** * Launched when attribute value has been changed - * @param fid feature id - * @param idx attribute index - * @param value new value + * \param fid feature id + * \param idx attribute index + * \param value new value */ virtual void attributeValueChanged( QgsFeatureId fid, int idx, const QVariant &value ); /** * Launched when eatures have been deleted - * @param fids feature ids + * \param fids feature ids */ virtual void featuresDeleted( const QgsFeatureIds &fids ); /** * Launched when a feature has been added - * @param fid feature id + * \param fid feature id */ virtual void featureAdded( QgsFeatureId fid ); @@ -348,9 +348,9 @@ class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel /** * Load feature fid into local cache (mFeat) * - * @param fid feature id + * \param fid feature id * - * @return feature exists + * \returns feature exists */ virtual bool loadFeatureAtId( QgsFeatureId fid ) const; diff --git a/src/gui/attributetable/qgsattributetableview.h b/src/gui/attributetable/qgsattributetableview.h index 4d5607780f05..5c056ff95efa 100644 --- a/src/gui/attributetable/qgsattributetableview.h +++ b/src/gui/attributetable/qgsattributetableview.h @@ -35,11 +35,11 @@ class QProgressDialog; class QgsAttributeTableConfig; /** \ingroup gui - * @brief - * Provides a table view of features of a @link QgsVectorLayer @endlink. + * \brief + * Provides a table view of features of a QgsVectorLayer. * * This can either be used as a standalone widget. QgsBrowser features a reference implementation. - * Or this can be used within the @link QgsDualView @endlink stacked widget. + * Or this can be used within the QgsDualView stacked widget. */ class GUI_EXPORT QgsAttributeTableView : public QTableView @@ -52,8 +52,8 @@ class GUI_EXPORT QgsAttributeTableView : public QTableView virtual void setModel( QgsAttributeTableFilterModel *filterModel ); /** - * @brief setFeatureSelectionManager - * @param featureSelectionManager We will take ownership + * \brief setFeatureSelectionManager + * \param featureSelectionManager We will take ownership */ void setFeatureSelectionManager( QgsIFeatureSelectionManager *featureSelectionManager ); @@ -62,10 +62,10 @@ class GUI_EXPORT QgsAttributeTableView : public QTableView * events. These are used to disable / enable live synchronisation with the map canvas selection * which can be slow due to recurring canvas repaints. * - * @param object The object which is the target of the event. - * @param event The intercepted event + * \param object The object which is the target of the event. + * \param event The intercepted event * - * @return Returns always false, so the event gets processed + * \returns Returns always false, so the event gets processed */ virtual bool eventFilter( QObject *object, QEvent *event ) override; @@ -82,7 +82,7 @@ class GUI_EXPORT QgsAttributeTableView : public QTableView * Called for mouse press events on a table cell. * Disables selection change for these events. * - * @param event The mouse event + * \param event The mouse event */ void mousePressEvent( QMouseEvent *event ) override; @@ -90,7 +90,7 @@ class GUI_EXPORT QgsAttributeTableView : public QTableView * Called for mouse release events on a table cell. * Disables selection change for these events. * - * @param event The mouse event + * \param event The mouse event */ void mouseReleaseEvent( QMouseEvent *event ) override; @@ -98,7 +98,7 @@ class GUI_EXPORT QgsAttributeTableView : public QTableView * Called for mouse move events on a table cell. * Disables selection change for these events. * - * @param event The mouse event + * \param event The mouse event */ void mouseMoveEvent( QMouseEvent *event ) override; @@ -106,40 +106,40 @@ class GUI_EXPORT QgsAttributeTableView : public QTableView * Called for key press events * Disables selection change by only pressing an arrow key * - * @param event The mouse event + * \param event The mouse event */ void keyPressEvent( QKeyEvent *event ) override; /** - * @brief - * Is called when the context menu will be shown. Emits a @link willShowContextMenu @endlink signal, + * \brief + * Is called when the context menu will be shown. Emits a willShowContextMenu() signal, * so the menu can be populated by other parts of the application. * - * @param event The associated event object. + * \param event The associated event object. */ void contextMenuEvent( QContextMenuEvent *event ) override; /** * Saves geometry to the settings on close - * @param event not used + * \param event not used */ void closeEvent( QCloseEvent *event ) override; signals: /** - * @brief + * \brief * Is emitted, in order to provide a hook to add additional* menu entries to the context menu. * - * @param menu If additional QMenuItems are added, they will show up in the context menu. - * @param atIndex The QModelIndex, to which the context menu belongs. Relative to the source model. - * In most cases, this will be a @link QgsAttributeTableFilterModel @endlink + * \param menu If additional QMenuItems are added, they will show up in the context menu. + * \param atIndex The QModelIndex, to which the context menu belongs. Relative to the source model. + * In most cases, this will be a QgsAttributeTableFilterModel */ void willShowContextMenu( QMenu *menu, const QModelIndex &atIndex ); /** Emitted when a column in the view has been resized. - * @param column column index (starts at 0) - * @param width new width in pixel + * \param column column index (starts at 0) + * \param width new width in pixel * \since QGIS 2.16 */ void columnResized( int column, int width ); diff --git a/src/gui/attributetable/qgsdualview.h b/src/gui/attributetable/qgsdualview.h index 281fee1cd9b0..59b33676b10a 100644 --- a/src/gui/attributetable/qgsdualview.h +++ b/src/gui/attributetable/qgsdualview.h @@ -32,7 +32,7 @@ class QgsMapLayerAction; class QgsScrollArea; /** \ingroup gui - * This widget is used to show the attributes of a set of features of a {@link QgsVectorLayer}. + * This widget is used to show the attributes of a set of features of a QgsVectorLayer. * The attributes can be edited. * It supports two different layouts: the table layout, in which the attributes for the features * are shown in a table and the editor layout, where the features are shown as a selectable list @@ -67,20 +67,20 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas }; /** - * @brief Constructor - * @param parent The parent widget + * \brief Constructor + * \param parent The parent widget */ explicit QgsDualView( QWidget *parent = nullptr ); /** * Has to be called to initialize the dual view. * - * @param layer The layer which should be used to fetch features - * @param mapCanvas The mapCanvas (used for the FilterMode - * {@link QgsAttributeTableFilterModel::ShowVisible} - * @param request Use a modified request to limit the shown features - * @param context The context in which this view is shown - * @param loadFeatures whether to initially load all features into the view. If set to + * \param layer The layer which should be used to fetch features + * \param mapCanvas The mapCanvas (used for the FilterMode + * QgsAttributeTableFilterModel::ShowVisible) + * \param request Use a modified request to limit the shown features + * \param context The context in which this view is shown + * \param loadFeatures whether to initially load all features into the view. If set to * false, limited features can later be loaded using setFilterMode() */ void init( QgsVectorLayer *layer, QgsMapCanvas *mapCanvas, const QgsFeatureRequest &request = QgsFeatureRequest(), const QgsAttributeEditorContext &context = QgsAttributeEditorContext(), @@ -89,14 +89,14 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas /** * Change the current view mode. * - * @param view The view mode to set - * @see view() + * \param view The view mode to set + * \see view() */ void setView( ViewMode view ); /** * Returns the current view mode. - * @see setView() + * \see setView() * \since QGIS 2.16 */ ViewMode view() const; @@ -104,21 +104,21 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas /** * Set the filter mode * - * @param filterMode + * \param filterMode */ void setFilterMode( QgsAttributeTableFilterModel::FilterMode filterMode ); /** * Get the filter mode * - * @return the filter mode + * \returns the filter mode */ QgsAttributeTableFilterModel::FilterMode filterMode() { return mFilterModel->filterMode(); } /** * Toggle the selectedOnTop flag. If enabled, selected features will be moved to top. * - * @param selectedOnTop True: Show selected features on top. + * \param selectedOnTop True: Show selected features on top. * False: Use defined sorting column. */ void setSelectedOnTop( bool selectedOnTop ); @@ -126,7 +126,7 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas /** * Returns the number of features on the layer. * - * @return Number of features + * \returns Number of features */ int featureCount(); @@ -134,14 +134,14 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas * Returns the number of features which are currently visible, according to the * filter restrictions * - * @return Number of features + * \returns Number of features */ int filteredFeatureCount(); /** * Set a list of currently visible features * - * @param filteredFeatures A list of feature ids + * \param filteredFeatures A list of feature ids * */ void setFilteredFeatures( const QgsFeatureIds &filteredFeatures ); @@ -154,28 +154,28 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas /** * Returns the model which has the information about all features (not only filtered) * - * @return The master model + * \returns The master model */ QgsAttributeTableModel *masterModel() const { return mMasterModel; } /** * Set the request * - * @param request The request + * \param request The request */ void setRequest( const QgsFeatureRequest &request ); /** * Set the feature selection model * - * @param featureSelectionManager the feature selection model + * \param featureSelectionManager the feature selection model */ void setFeatureSelectionManager( QgsIFeatureSelectionManager *featureSelectionManager ); /** * Returns the table view * - * @return The table view + * \returns The table view */ QgsAttributeTableView *tableView() { return mTableView; } @@ -205,16 +205,16 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas public slots: /** - * @brief Set the current edit selection in the {@link AttributeEditor} mode. + * \brief Set the current edit selection in the AttributeEditor mode. * - * @param fids A list of edited features (Currently only one at a time is supported) + * \param fids A list of edited features (Currently only one at a time is supported) */ void setCurrentEditSelection( const QgsFeatureIds &fids ); /** - * @brief saveEditChanges + * \brief saveEditChanges * - * @return true if the saving was ok. false is possible due to connected + * \returns true if the saving was ok. false is possible due to connected * validation logic. */ bool saveEditChanges(); @@ -227,7 +227,7 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas void setMultiEditEnabled( bool enabled ); /** Toggles whether search mode should be enabled in the form. - * @param enabled set to true to switch on search mode + * \param enabled set to true to switch on search mode * \since QGIS 2.16 */ void toggleSearchMode( bool enabled ); @@ -242,7 +242,7 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas /** * Is emitted, whenever the display expression is successfully changed - * @param expression The expression that was applied + * \param expression The expression that was applied */ void displayExpressionChanged( const QString &expression ); @@ -252,14 +252,14 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas void filterChanged(); /** Is emitted when a filter expression is set using the view. - * @param expression filter expression - * @param type filter type + * \param expression filter expression + * \param type filter type * \since QGIS 2.16 */ void filterExpressionSet( const QString &expression, QgsAttributeForm::FilterType type ); /** Emitted when the form changes mode. - * @param mode new mode + * \param mode new mode */ void formModeChanged( QgsAttributeForm::Mode mode ); @@ -270,7 +270,7 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas /** * Changes the currently visible feature within the attribute editor * - * @param feat The newly visible feature + * \param feat The newly visible feature */ void on_mFeatureList_currentEditSelectionChanged( const QgsFeature &feat ); @@ -314,8 +314,8 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas /** * Will be called periodically, when loading layers from slow data providers. * - * @param i The number of features already loaded - * @param cancel Set to true to cancel + * \param i The number of features already loaded + * \param cancel Set to true to cancel */ virtual void progress( int i, bool &cancel ); diff --git a/src/gui/attributetable/qgsfeaturelistmodel.h b/src/gui/attributetable/qgsfeaturelistmodel.h index f7f94fa7b6de..a8f24cf58f71 100644 --- a/src/gui/attributetable/qgsfeaturelistmodel.h +++ b/src/gui/attributetable/qgsfeaturelistmodel.h @@ -67,15 +67,15 @@ class GUI_EXPORT QgsFeatureListModel : public QAbstractProxyModel, public QgsFea virtual Qt::ItemFlags flags( const QModelIndex &index ) const override; /** - * @brief If true is specified, a NULL value will be injected - * @param injectNull state of null value injection + * \brief If true is specified, a NULL value will be injected + * \param injectNull state of null value injection * \since QGIS 2.9 */ void setInjectNull( bool injectNull ); /** - * @brief Returns the current state of null value injection - * @return If a NULL value is added + * \brief Returns the current state of null value injection + * \returns If a NULL value is added * \since QGIS 2.9 */ bool injectNull(); @@ -83,16 +83,16 @@ class GUI_EXPORT QgsFeatureListModel : public QAbstractProxyModel, public QgsFea QgsAttributeTableModel *masterModel(); /** - * @param expression A {@link QgsExpression} compatible string. - * @return true if the expression could be set, false if there was a parse error. - * If it fails, the old expression will still be applied. Call {@link parserErrorString()} + * \param expression A QgsExpression compatible string. + * \returns true if the expression could be set, false if there was a parse error. + * If it fails, the old expression will still be applied. Call parserErrorString() * for a meaningful error message. */ bool setDisplayExpression( const QString &expression ); /** - * @brief Returns a detailed message about errors while parsing a QgsExpression. - * @return A message containing information about the parser error. + * \brief Returns a detailed message about errors while parsing a QgsExpression. + * \returns A message containing information about the parser error. */ QString parserErrorString(); diff --git a/src/gui/attributetable/qgsfeaturelistview.cpp b/src/gui/attributetable/qgsfeaturelistview.cpp index dc365f7b5087..abcc7f55265b 100644 --- a/src/gui/attributetable/qgsfeaturelistview.cpp +++ b/src/gui/attributetable/qgsfeaturelistview.cpp @@ -219,12 +219,6 @@ void QgsFeatureListView::repaintRequested() setDirtyRegion( viewport()->rect() ); } -/*! - This function is called with the given \a event when a mouse move event is - sent to the widget. If a selection is in progress and new items are moved - over the selection is extended; if a drag is in progress it is continued. -*/ - void QgsFeatureListView::mouseMoveEvent( QMouseEvent *event ) { QPoint pos = event->pos(); @@ -241,13 +235,6 @@ void QgsFeatureListView::mouseMoveEvent( QMouseEvent *event ) } } -/*! - This function is called with the given \a event when a mouse button is released, - after a mouse press event on the widget. If a user presses the mouse inside your - widget and then drags the mouse to another location before releasing the mouse button, - your widget receives the release event. The function will emit the clicked() signal if an - item was being pressed. -*/ void QgsFeatureListView::mouseReleaseEvent( QMouseEvent *event ) { Q_UNUSED( event ); diff --git a/src/gui/attributetable/qgsfeaturelistview.h b/src/gui/attributetable/qgsfeaturelistview.h index 3743686caa79..7f24eb0f19e9 100644 --- a/src/gui/attributetable/qgsfeaturelistview.h +++ b/src/gui/attributetable/qgsfeaturelistview.h @@ -35,9 +35,8 @@ class QRect; /** \ingroup gui * Shows a list of features and renders a edit button next to each feature. * - * @brief * Accepts a display expression to define the way, features are rendered. - * Uses a {@link QgsFeatureListModel} as source model. + * Uses a QgsFeatureListModel as source model. * */ class GUI_EXPORT QgsFeatureListView : public QListView @@ -49,27 +48,27 @@ class GUI_EXPORT QgsFeatureListView : public QListView /** * Creates a feature list view * - * @param parent owner + * \param parent owner */ explicit QgsFeatureListView( QWidget *parent = nullptr ); /** * Returns the layer cache - * @return the layer cache used as backend + * \returns the layer cache used as backend */ QgsVectorLayerCache *layerCache(); /** - * Set the {@link QgsFeatureListModel} which is used to retrieve information + * Set the QgsFeatureListModel which is used to retrieve information * - * @param featureListModel The model to use + * \param featureListModel The model to use */ virtual void setModel( QgsFeatureListModel *featureListModel ); /** * Get the featureListModel used by this view * - * @return The model in use + * \returns The model in use */ QgsFeatureListModel *featureListModel() { return mModel; } @@ -77,45 +76,45 @@ class GUI_EXPORT QgsFeatureListView : public QListView * The display expression is an expression used to render the fields into a single string * which is displaied. * - * @param displayExpression The expression used to render the feature + * \param displayExpression The expression used to render the feature * - * @see QgsExpression + * \see QgsExpression */ bool setDisplayExpression( const QString &displayExpression ); /** * Returns the expression which is currently used to render the features. * - * @return A string containing the currend display expression + * \returns A string containing the currend display expression * - * @see QgsExpression + * \see QgsExpression */ const QString displayExpression() const; /** * Returns a detailed message about errors while parsing a QgsExpression. * - * @return A message containing information about the parser error. + * \returns A message containing information about the parser error. */ QString parserErrorString(); /** * Get the currentEditSelection * - * @return A list of edited feature ids + * \returns A list of edited feature ids */ QgsFeatureIds currentEditSelection(); /** * Sets if the currently shown form has received any edit events so far. * - * @param state The state + * \param state The state */ void setCurrentFeatureEdited( bool state ); /** - * @brief setFeatureSelectionManager - * @param featureSelectionManager We will take ownership + * \brief setFeatureSelectionManager + * \param featureSelectionManager We will take ownership */ void setFeatureSelectionManager( QgsIFeatureSelectionManager *featureSelectionManager ); protected: @@ -130,17 +129,17 @@ class GUI_EXPORT QgsFeatureListView : public QListView /** * Is emitted, whenever the current edit selection has been changed. * - * @param feat the feature, which will be edited. + * \param feat the feature, which will be edited. */ void currentEditSelectionChanged( QgsFeature &feat ); /** * Is emitted, whenever the display expression is successfully changed - * @param expression The expression that was applied + * \param expression The expression that was applied */ void displayExpressionChanged( const QString &expression ); - //! @note not available in Python bindings + //! \note not available in Python bindings void aboutToChangeEditSelection( bool &ok ); public slots: @@ -148,15 +147,15 @@ class GUI_EXPORT QgsFeatureListView : public QListView /** * Set the feature(s) to be edited * - * @param fids A list of features to be edited + * \param fids A list of features to be edited */ void setEditSelection( const QgsFeatureIds &fids ); /** * Set the feature(s) to be edited * - * @param index The selection to set - * @param command selection update mode + * \param index The selection to set + * \param command selection update mode */ void setEditSelection( const QModelIndex &index, QItemSelectionModel::SelectionFlags command ); diff --git a/src/gui/attributetable/qgsfeatureselectionmodel.h b/src/gui/attributetable/qgsfeatureselectionmodel.h index d9db4e578988..23215909c5a0 100644 --- a/src/gui/attributetable/qgsfeatureselectionmodel.h +++ b/src/gui/attributetable/qgsfeatureselectionmodel.h @@ -34,22 +34,22 @@ class GUI_EXPORT QgsFeatureSelectionModel : public QItemSelectionModel explicit QgsFeatureSelectionModel( QAbstractItemModel *model, QgsFeatureModel *featureModel, QgsIFeatureSelectionManager *featureSelectionHandler, QObject *parent ); /** - * Enables or disables synchronisation to the {@link QgsVectorLayer} + * Enables or disables synchronisation to the QgsVectorLayer * When synchronisation is disabled, any selection change will be buffered inside this selection model. * When enabled, any buffered changes are communicated to the layer and the buffer is emptied. * Mainly to be used for performance reasons, because selection change on the layer can cost time as it * repaints the layer. * - * @param enable The synchronisation status to set. + * \param enable The synchronisation status to set. */ void enableSync( bool enable ); /** * Returns the selection status of a given feature id. * - * @param fid The featureid to determine the selection status of + * \param fid The featureid to determine the selection status of * - * @return The selection status + * \returns The selection status */ virtual bool isSelected( QgsFeatureId fid ); @@ -57,9 +57,9 @@ class GUI_EXPORT QgsFeatureSelectionModel : public QItemSelectionModel /** * Returns the selection status of a given QModelIndex. * - * @param index The index to determine the selection status of + * \param index The index to determine the selection status of * - * @return The selection status + * \returns The selection status */ virtual bool isSelected( const QModelIndex &index ); @@ -69,7 +69,7 @@ class GUI_EXPORT QgsFeatureSelectionModel : public QItemSelectionModel * Request a repaint of a list of model indexes. * Views using this model should connect to and properly process this signal. * - * @param indexes The model indexes which need to be repainted + * \param indexes The model indexes which need to be repainted */ void requestRepaint( const QModelIndexList &indexes ); @@ -84,22 +84,22 @@ class GUI_EXPORT QgsFeatureSelectionModel : public QItemSelectionModel /** * Overwritten to do NOTHING (we handle selection ourselves) * - * @see selectFeatures( const QItemSelection&, SelectionFlags ) + * \see selectFeatures( const QItemSelection&, SelectionFlags ) */ virtual void select( const QModelIndex &index, SelectionFlags command ) override { Q_UNUSED( index ); Q_UNUSED( command ); } /** * Overwritten to do NOTHING (we handle selection ourselves) * - * @see selectFeatures( const QItemSelection&, SelectionFlags ) + * \see selectFeatures( const QItemSelection&, SelectionFlags ) */ virtual void select( const QItemSelection &selection, SelectionFlags command ) override { Q_UNUSED( selection ); Q_UNUSED( command ); } /** * Select features on this table. Is to be used in favor of the stock select methods. * - * @param selection The QItemSelection which will be selected - * @param command The command to apply. Select, Deselect and ClearAndSelect are processed. + * \param selection The QItemSelection which will be selected + * \param command The command to apply. Select, Deselect and ClearAndSelect are processed. */ virtual void selectFeatures( const QItemSelection &selection, SelectionFlags command ); diff --git a/src/gui/attributetable/qgsfieldconditionalformatwidget.h b/src/gui/attributetable/qgsfieldconditionalformatwidget.h index 210bd4fc7b2f..f7cff5de3d1d 100644 --- a/src/gui/attributetable/qgsfieldconditionalformatwidget.h +++ b/src/gui/attributetable/qgsfieldconditionalformatwidget.h @@ -37,7 +37,7 @@ class GUI_EXPORT QgsFieldConditionalFormatWidget : public QWidget, private Ui::Q public: /** Constructor for QgsFieldConditionalFormatWidget. - * @param parent parent widget + * \param parent parent widget */ explicit QgsFieldConditionalFormatWidget( QWidget *parent = nullptr ); @@ -48,18 +48,18 @@ class GUI_EXPORT QgsFieldConditionalFormatWidget : public QWidget, private Ui::Q void viewRules(); /** Sets the vector layer associated with the widget. - * @param layer vector layer + * \param layer vector layer */ void setLayer( QgsVectorLayer *layer ); /** Switches the widget to the edit style mode for the specified style. - * @param index index of conditional style to edit - * @param style initial conditional styling options + * \param index index of conditional style to edit + * \param style initial conditional styling options */ void editStyle( int index, const QgsConditionalStyle &style ); /** - * @param style initial conditional styling options + * \param style initial conditional styling options */ void loadStyle( const QgsConditionalStyle &style ); @@ -68,22 +68,22 @@ class GUI_EXPORT QgsFieldConditionalFormatWidget : public QWidget, private Ui::Q void reset(); /** - * @brief Set the presets that can be used for quick pick - * @param styles A list of styles used as presets + * \brief Set the presets that can be used for quick pick + * \param styles A list of styles used as presets */ void setPresets( const QList &styles ); /** - * @brief The default presets for the widget. Normally set when the widget is + * \brief The default presets for the widget. Normally set when the widget is * created however called setPresets will override the default styles. - * @return List of default presets. + * \returns List of default presets. */ QList defaultPresets() const; signals: /** Emitted when the conditional styling rules are updated. - * @param fieldName name of field whose rules have been modified. + * \param fieldName name of field whose rules have been modified. */ void rulesUpdated( const QString &fieldName ); diff --git a/src/gui/attributetable/qgsgenericfeatureselectionmanager.h b/src/gui/attributetable/qgsgenericfeatureselectionmanager.h index 2cc1cf0a91e8..5dc23ad4be07 100644 --- a/src/gui/attributetable/qgsgenericfeatureselectionmanager.h +++ b/src/gui/attributetable/qgsgenericfeatureselectionmanager.h @@ -23,7 +23,7 @@ /** \ingroup gui * This selection manager synchronizes a local set of selected features with an attribute table. * If you want to synchronize the attribute table selection with the map canvas selection, you - * should use { @link QgsVectorLayerSelectionManager } instead. + * should use QgsVectorLayerSelectionManager instead. * \note not available in Python bindings */ class GUI_EXPORT QgsGenericFeatureSelectionManager : public QgsIFeatureSelectionManager diff --git a/src/gui/attributetable/qgsifeatureselectionmanager.h b/src/gui/attributetable/qgsifeatureselectionmanager.h index 552f6eae3b37..230151eba335 100644 --- a/src/gui/attributetable/qgsifeatureselectionmanager.h +++ b/src/gui/attributetable/qgsifeatureselectionmanager.h @@ -24,7 +24,7 @@ /** \ingroup gui * Is an interface class to abstract feature selection handling. * - * e.g. { @link QgsVectorLayer } implements this interface to manage its selections. + * e.g. QgsVectorLayer implements this interface to manage its selections. */ class GUI_EXPORT QgsIFeatureSelectionManager : public QObject @@ -38,38 +38,38 @@ class GUI_EXPORT QgsIFeatureSelectionManager : public QObject /** * The number of features that are selected in this layer * - * @return See description + * \returns See description */ virtual int selectedFeatureCount() = 0; /** * Select features * - * @param ids Feature ids to select + * \param ids Feature ids to select */ virtual void select( const QgsFeatureIds &ids ) = 0; /** * Deselect features * - * @param ids Feature ids to deselect + * \param ids Feature ids to deselect */ virtual void deselect( const QgsFeatureIds &ids ) = 0; /** * Change selection to the new set of features. Dismisses the current selection. - * Will emit the { @link selectionChanged( const QgsFeatureIds&, const QgsFeatureIds&, bool ) } signal with the + * Will emit the selectionChanged( const QgsFeatureIds&, const QgsFeatureIds&, bool ) signal with the * clearAndSelect flag set. * - * @param ids The ids which will be the new selection + * \param ids The ids which will be the new selection */ virtual void setSelectedFeatures( const QgsFeatureIds &ids ) = 0; /** * Return reference to identifiers of selected features * - * @return A list of { @link QgsFeatureId } 's - * @see selectedFeatures() + * \returns A list of QgsFeatureId's + * \see selectedFeatures() */ virtual const QgsFeatureIds &selectedFeatureIds() const = 0; @@ -78,9 +78,9 @@ class GUI_EXPORT QgsIFeatureSelectionManager : public QObject /** * This signal is emitted when selection was changed * - * @param selected Newly selected feature ids - * @param deselected Ids of all features which have previously been selected but are not any more - * @param clearAndSelect In case this is set to true, the old selection was dismissed and the new selection corresponds to selected + * \param selected Newly selected feature ids + * \param deselected Ids of all features which have previously been selected but are not any more + * \param clearAndSelect In case this is set to true, the old selection was dismissed and the new selection corresponds to selected */ void selectionChanged( const QgsFeatureIds &selected, const QgsFeatureIds &deselected, const bool clearAndSelect ); }; diff --git a/src/gui/attributetable/qgsorganizetablecolumnsdialog.h b/src/gui/attributetable/qgsorganizetablecolumnsdialog.h index 5c2de0d72300..c35e8a7db818 100644 --- a/src/gui/attributetable/qgsorganizetablecolumnsdialog.h +++ b/src/gui/attributetable/qgsorganizetablecolumnsdialog.h @@ -39,9 +39,9 @@ class GUI_EXPORT QgsOrganizeTableColumnsDialog : public QDialog, private Ui::Qgs /** * Constructor - * @param vl The concerned vector layer - * @param parent parent object - * @param flags window flags + * \param vl The concerned vector layer + * \param parent parent object + * \param flags window flags */ QgsOrganizeTableColumnsDialog( const QgsVectorLayer *vl, QWidget *parent = nullptr, Qt::WindowFlags flags = Qt::Window ); diff --git a/src/gui/attributetable/qgsvectorlayerselectionmanager.h b/src/gui/attributetable/qgsvectorlayerselectionmanager.h index 5cc660f18dad..3672aacea950 100644 --- a/src/gui/attributetable/qgsvectorlayerselectionmanager.h +++ b/src/gui/attributetable/qgsvectorlayerselectionmanager.h @@ -35,38 +35,38 @@ class GUI_EXPORT QgsVectorLayerSelectionManager : public QgsIFeatureSelectionMan /** * The number of features that are selected in this layer * - * @return See description + * \returns See description */ virtual int selectedFeatureCount() override; /** * Select features * - * @param ids Feature ids to select + * \param ids Feature ids to select */ virtual void select( const QgsFeatureIds &ids ) override; /** * Deselect features * - * @param ids Feature ids to deselect + * \param ids Feature ids to deselect */ virtual void deselect( const QgsFeatureIds &ids ) override; /** * Change selection to the new set of features. Dismisses the current selection. - * Will emit the { @link selectionChanged( const QgsFeatureIds&, const QgsFeatureIds&, bool ) } signal with the + * Will emit the selectionChanged( const QgsFeatureIds&, const QgsFeatureIds&, bool ) signal with the * clearAndSelect flag set. * - * @param ids The ids which will be the new selection + * \param ids The ids which will be the new selection */ virtual void setSelectedFeatures( const QgsFeatureIds &ids ) override; /** * Return reference to identifiers of selected features * - * @return A list of { @link QgsFeatureIds } - * @see selectedFeatures() + * \returns A list of QgsFeatureIds + * \see selectedFeatures() */ virtual const QgsFeatureIds &selectedFeatureIds() const override; diff --git a/src/gui/auth/qgsauthauthoritieseditor.h b/src/gui/auth/qgsauthauthoritieseditor.h index 5688cf4c85b3..c8c7fb6f9637 100644 --- a/src/gui/auth/qgsauthauthoritieseditor.h +++ b/src/gui/auth/qgsauthauthoritieseditor.h @@ -40,7 +40,7 @@ class GUI_EXPORT QgsAuthAuthoritiesEditor : public QWidget, private Ui::QgsAuthA /** * Widget for viewing and editing certificate authorities directly in database - * @param parent Parent widget + * \param parent Parent widget */ explicit QgsAuthAuthoritiesEditor( QWidget *parent = nullptr ); diff --git a/src/gui/auth/qgsauthcertificateinfo.h b/src/gui/auth/qgsauthcertificateinfo.h index 28003c717188..e5fb1969c5e6 100644 --- a/src/gui/auth/qgsauthcertificateinfo.h +++ b/src/gui/auth/qgsauthcertificateinfo.h @@ -145,10 +145,10 @@ class GUI_EXPORT QgsAuthCertInfoDialog : public QDialog /** * Construct a dialog displaying detailed info on a certificate and its hierarchical trust chain - * @param cert Certificate object - * @param manageCertTrust Whether to show widgets to manage the trust policy of certs in hierarchy - * @param parent Parent widget - * @param connectionCAs List of hierarchical certificates in a connection + * \param cert Certificate object + * \param manageCertTrust Whether to show widgets to manage the trust policy of certs in hierarchy + * \param parent Parent widget + * \param connectionCAs List of hierarchical certificates in a connection */ explicit QgsAuthCertInfoDialog( const QSslCertificate &cert, bool manageCertTrust, @@ -159,7 +159,7 @@ class GUI_EXPORT QgsAuthCertInfoDialog : public QDialog QgsAuthCertInfo *certInfoWidget() { return mCertInfoWdgt; } /** Whether the trust cache has been rebuilt - * @note This happens when a trust policy has been adjusted for any cert in the hierarchy + * \note This happens when a trust policy has been adjusted for any cert in the hierarchy */ bool trustCacheRebuilt() { return mCertInfoWdgt->trustCacheRebuilt(); } diff --git a/src/gui/auth/qgsauthcertificatemanager.h b/src/gui/auth/qgsauthcertificatemanager.h index 78f7ca50135c..04ae58581601 100644 --- a/src/gui/auth/qgsauthcertificatemanager.h +++ b/src/gui/auth/qgsauthcertificatemanager.h @@ -35,7 +35,7 @@ class GUI_EXPORT QgsAuthCertEditors : public QWidget, private Ui::QgsAuthCertMan /** * Construct a widget to contain various certificate editors - * @param parent Parent widget + * \param parent Parent widget */ explicit QgsAuthCertEditors( QWidget *parent = nullptr ); @@ -55,7 +55,7 @@ class GUI_EXPORT QgsAuthCertManager : public QDialog /** * Construct a dialog wrapper for widget to manage available certificate editors - * @param parent Parent widget + * \param parent Parent widget */ explicit QgsAuthCertManager( QWidget *parent = nullptr ); diff --git a/src/gui/auth/qgsauthcerttrustpolicycombobox.h b/src/gui/auth/qgsauthcerttrustpolicycombobox.h index c7984f25e678..bffc529a4f6d 100644 --- a/src/gui/auth/qgsauthcerttrustpolicycombobox.h +++ b/src/gui/auth/qgsauthcerttrustpolicycombobox.h @@ -32,9 +32,9 @@ class GUI_EXPORT QgsAuthCertTrustPolicyComboBox : public QComboBox /** * Construct a combo box for defining certificate trust policy - * @param parent Parent widget - * @param policy Defined trust policy - * @param defaultpolicy Default trust policy + * \param parent Parent widget + * \param policy Defined trust policy + * \param defaultpolicy Default trust policy */ explicit QgsAuthCertTrustPolicyComboBox( QWidget *parent = nullptr, diff --git a/src/gui/auth/qgsauthconfigedit.h b/src/gui/auth/qgsauthconfigedit.h index c54f22bf27a6..70c2a0502931 100644 --- a/src/gui/auth/qgsauthconfigedit.h +++ b/src/gui/auth/qgsauthconfigedit.h @@ -45,9 +45,9 @@ class GUI_EXPORT QgsAuthConfigEdit : public QDialog, private Ui::QgsAuthConfigEd /** * Create a dialog for editing an authentication configuration - * @param parent Parent widget - * @param authcfg Authentication config id for a existing config in auth database - * @param dataprovider The provider origin of the edit, to allow for customized code and filtering + * \param parent Parent widget + * \param authcfg Authentication config id for a existing config in auth database + * \param dataprovider The provider origin of the edit, to allow for customized code and filtering */ explicit QgsAuthConfigEdit( QWidget *parent = nullptr, const QString &authcfg = QString(), const QString &dataprovider = QString() ); diff --git a/src/gui/auth/qgsauthconfigeditor.h b/src/gui/auth/qgsauthconfigeditor.h index 11c205981e16..d9e5290f0723 100644 --- a/src/gui/auth/qgsauthconfigeditor.h +++ b/src/gui/auth/qgsauthconfigeditor.h @@ -37,9 +37,9 @@ class GUI_EXPORT QgsAuthConfigEditor : public QWidget, private Ui::QgsAuthConfig /** * Widget for editing authentication configurations directly in database - * @param parent Parent widget - * @param showUtilities Whether to show the widget's utilities button - * @param relayMessages Whether to relay auth manager messages to internal message bar + * \param parent Parent widget + * \param showUtilities Whether to show the widget's utilities button + * \param relayMessages Whether to relay auth manager messages to internal message bar */ explicit QgsAuthConfigEditor( QWidget *parent = nullptr, bool showUtilities = true, bool relayMessages = true ); diff --git a/src/gui/auth/qgsauthconfigidedit.h b/src/gui/auth/qgsauthconfigidedit.h index 8b900f14bcb4..9211ba032267 100644 --- a/src/gui/auth/qgsauthconfigidedit.h +++ b/src/gui/auth/qgsauthconfigidedit.h @@ -35,9 +35,9 @@ class GUI_EXPORT QgsAuthConfigIdEdit : public QWidget, private Ui::QgsAuthConfig /** * Widget to unlock and edit an authentication configuration ID - * @param parent Parent widget - * @param authcfg Authentication configuration ID - * @param allowEmpty Whether to allow no ID to be set, even when editing, e.g. Add config functions + * \param parent Parent widget + * \param authcfg Authentication configuration ID + * \param allowEmpty Whether to allow no ID to be set, even when editing, e.g. Add config functions */ explicit QgsAuthConfigIdEdit( QWidget *parent = nullptr, const QString &authcfg = QString(), bool allowEmpty = true ); diff --git a/src/gui/auth/qgsauthconfigselect.h b/src/gui/auth/qgsauthconfigselect.h index 5a90ba5a908a..06f19fbfb25a 100644 --- a/src/gui/auth/qgsauthconfigselect.h +++ b/src/gui/auth/qgsauthconfigselect.h @@ -36,8 +36,8 @@ class GUI_EXPORT QgsAuthConfigSelect : public QWidget, private Ui::QgsAuthConfig /** * Create a dialog for setting an associated authentication config, either * from existing configs, or creating/removing them from auth database - * @param parent Parent widget - * @param dataprovider The key of the calling layer provider, if applicable + * \param parent Parent widget + * \param dataprovider The key of the calling layer provider, if applicable */ explicit QgsAuthConfigSelect( QWidget *parent = nullptr, const QString &dataprovider = QString() ); @@ -110,9 +110,9 @@ class GUI_EXPORT QgsAuthConfigUriEdit : public QDialog, private Ui::QgsAuthConfi /** * Construct wrapper dialog for select widget to edit an authcfg in a data source URI - * @param parent Parent widget - * @param datauri URI QString with of without an authcfg=ID string - * @param dataprovider The key of the calling layer provider, if applicable + * \param parent Parent widget + * \param datauri URI QString with of without an authcfg=ID string + * \param dataprovider The key of the calling layer provider, if applicable */ explicit QgsAuthConfigUriEdit( QWidget *parent = nullptr, const QString &datauri = QString(), diff --git a/src/gui/auth/qgsautheditorwidgets.h b/src/gui/auth/qgsautheditorwidgets.h index 33405e946ab3..89f7ca6a123c 100644 --- a/src/gui/auth/qgsautheditorwidgets.h +++ b/src/gui/auth/qgsautheditorwidgets.h @@ -33,7 +33,7 @@ class GUI_EXPORT QgsAuthMethodPlugins : public QDialog, private Ui::QgsAuthMetho /** * Construct a dialog for viewing available authentication method plugins - * @param parent Parent widget + * \param parent Parent widget */ explicit QgsAuthMethodPlugins( QWidget *parent = nullptr ); @@ -59,7 +59,7 @@ class GUI_EXPORT QgsAuthEditorWidgets : public QWidget, private Ui::QgsAuthEdito /** * Construct a widget to contain various authentication editors - * @param parent Parent widget + * \param parent Parent widget */ explicit QgsAuthEditorWidgets( QWidget *parent = nullptr ); diff --git a/src/gui/auth/qgsauthidentitieseditor.h b/src/gui/auth/qgsauthidentitieseditor.h index 19f85955597b..66d96305f71a 100644 --- a/src/gui/auth/qgsauthidentitieseditor.h +++ b/src/gui/auth/qgsauthidentitieseditor.h @@ -37,7 +37,7 @@ class GUI_EXPORT QgsAuthIdentitiesEditor : public QWidget, private Ui::QgsAuthId /** * Widget for editing authentication configurations directly in database - * @param parent Parent widget + * \param parent Parent widget */ explicit QgsAuthIdentitiesEditor( QWidget *parent = nullptr ); diff --git a/src/gui/auth/qgsauthimportcertdialog.h b/src/gui/auth/qgsauthimportcertdialog.h index 4c9be80e32c1..42cd328e5703 100644 --- a/src/gui/auth/qgsauthimportcertdialog.h +++ b/src/gui/auth/qgsauthimportcertdialog.h @@ -50,9 +50,9 @@ class GUI_EXPORT QgsAuthImportCertDialog : public QDialog, private Ui::QgsAuthIm /** * Construct a dialog for importing certificates - * @param parent Parent widget - * @param filter Certificate type filter to apply to dialog - * @param input Type of input(s) for certificates + * \param parent Parent widget + * \param filter Certificate type filter to apply to dialog + * \param input Type of input(s) for certificates */ explicit QgsAuthImportCertDialog( QWidget *parent = nullptr, QgsAuthImportCertDialog::CertFilter filter = NoFilter, diff --git a/src/gui/auth/qgsauthimportidentitydialog.h b/src/gui/auth/qgsauthimportidentitydialog.h index 05a62a622e6c..aa3efb78b202 100644 --- a/src/gui/auth/qgsauthimportidentitydialog.h +++ b/src/gui/auth/qgsauthimportidentitydialog.h @@ -57,8 +57,8 @@ class GUI_EXPORT QgsAuthImportIdentityDialog : public QDialog, private Ui::QgsAu /** * Construct a dialog for importing identities - * @param identitytype Type of the identity to import - * @param parent Parent widget + * \param identitytype Type of the identity to import + * \param parent Parent widget */ explicit QgsAuthImportIdentityDialog( QgsAuthImportIdentityDialog::IdentityType identitytype, QWidget *parent = nullptr ); @@ -67,7 +67,7 @@ class GUI_EXPORT QgsAuthImportIdentityDialog : public QDialog, private Ui::QgsAu QgsAuthImportIdentityDialog::IdentityType identityType(); /** Get certificate/key bundle to be imported. - * @note not available in Python bindings + * \note not available in Python bindings */ const QPair certBundleToImport(); diff --git a/src/gui/auth/qgsauthmethodedit.h b/src/gui/auth/qgsauthmethodedit.h index 86bb5be6a340..458e1bce42c2 100644 --- a/src/gui/auth/qgsauthmethodedit.h +++ b/src/gui/auth/qgsauthmethodedit.h @@ -44,7 +44,7 @@ class GUI_EXPORT QgsAuthMethodEdit : public QWidget /** * Load an existing config map into subclassed widget - * @param configmap + * \param configmap */ virtual void loadConfig( const QgsStringMap &configmap ) = 0; @@ -58,8 +58,8 @@ class GUI_EXPORT QgsAuthMethodEdit : public QWidget /** * Construct widget to edit an authentication method configuration - * @note Non-public since this is an abstract base class - * @param parent Parent widget + * \note Non-public since this is an abstract base class + * \param parent Parent widget */ explicit QgsAuthMethodEdit( QWidget *parent = nullptr ) : QWidget( parent ) diff --git a/src/gui/auth/qgsauthserverseditor.h b/src/gui/auth/qgsauthserverseditor.h index 74ee21c828ca..f932dfee88ab 100644 --- a/src/gui/auth/qgsauthserverseditor.h +++ b/src/gui/auth/qgsauthserverseditor.h @@ -36,7 +36,7 @@ class GUI_EXPORT QgsAuthServersEditor : public QWidget, private Ui::QgsAuthServe /** * Widget for editing authentication configurations directly in database - * @param parent Parent Widget + * \param parent Parent Widget */ explicit QgsAuthServersEditor( QWidget *parent = nullptr ); diff --git a/src/gui/auth/qgsauthsslconfigwidget.h b/src/gui/auth/qgsauthsslconfigwidget.h index 32ffb5c2d219..7af08254035e 100644 --- a/src/gui/auth/qgsauthsslconfigwidget.h +++ b/src/gui/auth/qgsauthsslconfigwidget.h @@ -42,10 +42,10 @@ class GUI_EXPORT QgsAuthSslConfigWidget : public QWidget, private Ui::QgsAuthSsl /** * Construct a widget for editing an SSL server certificate configuration - * @param parent Parent widget - * @param cert SSL server certificate object - * @param hostport Unique host:port to associate with the server certificate - * @param connectionCAs List of trusted Certificate Authorities objects + * \param parent Parent widget + * \param cert SSL server certificate object + * \param hostport Unique host:port to associate with the server certificate + * \param connectionCAs List of trusted Certificate Authorities objects */ explicit QgsAuthSslConfigWidget( QWidget *parent = nullptr, const QSslCertificate &cert = QSslCertificate(), @@ -76,7 +76,7 @@ class GUI_EXPORT QgsAuthSslConfigWidget : public QWidget, private Ui::QgsAuthSsl QSslSocket::PeerVerifyMode sslPeerVerifyMode(); /** Get the client's peer verify depth for connections - * @note Value of 0 = unlimited + * \note Value of 0 = unlimited */ int sslPeerVerifyDepth(); @@ -192,9 +192,9 @@ class GUI_EXPORT QgsAuthSslConfigDialog : public QDialog /** * Construct wrapper dialog for the SSL config widget - * @param parent Parent widget - * @param cert SSL server certificate object - * @param hostport Unique host:port to associate with the server certificate + * \param parent Parent widget + * \param cert SSL server certificate object + * \param hostport Unique host:port to associate with the server certificate */ explicit QgsAuthSslConfigDialog( QWidget *parent = nullptr, const QSslCertificate &cert = QSslCertificate(), diff --git a/src/gui/auth/qgsauthsslerrorsdialog.h b/src/gui/auth/qgsauthsslerrorsdialog.h index 418eead0a034..513ec72af062 100644 --- a/src/gui/auth/qgsauthsslerrorsdialog.h +++ b/src/gui/auth/qgsauthsslerrorsdialog.h @@ -36,11 +36,11 @@ class GUI_EXPORT QgsAuthSslErrorsDialog : public QDialog, private Ui::QgsAuthSsl /** * Construct a dialog to handle SSL errors and saving SSL server certificate exceptions - * @param reply Network reply that hand error(s) - * @param sslErrors SSL errors that occurred - * @param parent Parent widget - * @param digest SHA digest of server certificate - * @param hostport Unique host:port to associate with the server certificate + * \param reply Network reply that hand error(s) + * \param sslErrors SSL errors that occurred + * \param parent Parent widget + * \param digest SHA digest of server certificate + * \param hostport Unique host:port to associate with the server certificate */ QgsAuthSslErrorsDialog( QNetworkReply *reply, const QList &sslErrors, diff --git a/src/gui/auth/qgsauthsslimportdialog.h b/src/gui/auth/qgsauthsslimportdialog.h index 4c372cb88042..9a90bb779b83 100644 --- a/src/gui/auth/qgsauthsslimportdialog.h +++ b/src/gui/auth/qgsauthsslimportdialog.h @@ -84,7 +84,7 @@ class GUI_EXPORT QgsAuthSslImportDialog : public QDialog, private Ui::QgsAuthSsl /** * Construct dialog for importing certificates - * @param parent + * \param parent */ QgsAuthSslImportDialog( QWidget *parent = nullptr ); diff --git a/src/gui/auth/qgsauthtrustedcasdialog.h b/src/gui/auth/qgsauthtrustedcasdialog.h index f8efa48bf80f..c814744dab5b 100644 --- a/src/gui/auth/qgsauthtrustedcasdialog.h +++ b/src/gui/auth/qgsauthtrustedcasdialog.h @@ -38,8 +38,8 @@ class GUI_EXPORT QgsAuthTrustedCAsDialog : public QDialog, private Ui::QgsAuthTr /** * Construct a dialog that will list the trusted Certificate Authorities - * @param parent Parent widget - * @param trustedCAs List of trusted Certificate Authorities objects + * \param parent Parent widget + * \param trustedCAs List of trusted Certificate Authorities objects */ explicit QgsAuthTrustedCAsDialog( QWidget *parent = nullptr, const QList &trustedCAs = QList() ); diff --git a/src/gui/editorwidgets/core/qgseditorconfigwidget.h b/src/gui/editorwidgets/core/qgseditorconfigwidget.h index 8c4ad0aa4a95..73efaf24e939 100644 --- a/src/gui/editorwidgets/core/qgseditorconfigwidget.h +++ b/src/gui/editorwidgets/core/qgseditorconfigwidget.h @@ -29,7 +29,7 @@ class QgsPropertyOverrideButton; * * It implements the GUI configuration widget and transforms this to/from a configuration. * - * It will only be instantiated by {@see QgsEditorWidgetFactory} + * It will only be instantiated by {\see QgsEditorWidgetFactory} */ class GUI_EXPORT QgsEditorConfigWidget : public QWidget, public QgsExpressionContextGenerator @@ -40,37 +40,37 @@ class GUI_EXPORT QgsEditorConfigWidget : public QWidget, public QgsExpressionCon /** * Create a new configuration widget * - * @param vl The layer for which the configuration dialog will be created - * @param fieldIdx The index of the field on the layer for which this dialog will be created - * @param parent A parent widget + * \param vl The layer for which the configuration dialog will be created + * \param fieldIdx The index of the field on the layer for which this dialog will be created + * \param parent A parent widget */ explicit QgsEditorConfigWidget( QgsVectorLayer *vl, int fieldIdx, QWidget *parent ); /** - * @brief Create a configuration from the current GUI state + * \brief Create a configuration from the current GUI state * - * @return A widget configuration + * \returns A widget configuration */ virtual QVariantMap config() = 0; /** - * @brief Update the configuration widget to represent the given configuration. + * \brief Update the configuration widget to represent the given configuration. * - * @param config The configuration which should be represented by this widget + * \param config The configuration which should be represented by this widget */ virtual void setConfig( const QVariantMap &config ) = 0; /** * Returns the field for which this configuration widget applies * - * @return The field index + * \returns The field index */ int field(); /** * Returns the layer for which this configuration widget applies * - * @return The layer + * \returns The layer */ QgsVectorLayer *layer(); @@ -87,8 +87,8 @@ class GUI_EXPORT QgsEditorConfigWidget : public QWidget, public QgsExpressionCon /** * Registers a property override button, setting up its initial value, connections and description. - * @param button button to register - * @param key corresponding data defined property key + * \param button button to register + * \param key corresponding data defined property key */ void initializeDataDefinedButton( QgsPropertyOverrideButton *button, QgsWidgetWrapper::Property key ); diff --git a/src/gui/editorwidgets/core/qgseditorwidgetautoconf.h b/src/gui/editorwidgets/core/qgseditorwidgetautoconf.h index c9391394c481..940c425db978 100644 --- a/src/gui/editorwidgets/core/qgseditorwidgetautoconf.h +++ b/src/gui/editorwidgets/core/qgseditorwidgetautoconf.h @@ -37,11 +37,11 @@ class GUI_EXPORT QgsEditorWidgetAutoConfPlugin * * 10: a widget has been guessed from the type of field. * * 20: a widget has been determined from an external configuration (for example a database table) * - * @param vl The vector layer for which this widget will be created - * @param fieldName The field name on the specified layer for which this widget will be created - * @param score Where the score is returned (default to 0) + * \param vl The vector layer for which this widget will be created + * \param fieldName The field name on the specified layer for which this widget will be created + * \param score Where the score is returned (default to 0) * - * @return and integer value rating how good is the setup provided by this plugin. + * \returns and integer value rating how good is the setup provided by this plugin. */ virtual QgsEditorWidgetSetup editorWidgetSetup( const QgsVectorLayer *vl, const QString &fieldName, int &score ) const = 0; @@ -56,7 +56,7 @@ class GUI_EXPORT QgsEditorWidgetAutoConfPlugin * * The plugins are instances of QgsEditorWidgetAutoConfPlugin. * \since QGIS 3.0 - * @note not available in Python bindings + * \note not available in Python bindings */ class GUI_EXPORT QgsEditorWidgetAutoConf { @@ -70,17 +70,17 @@ class GUI_EXPORT QgsEditorWidgetAutoConf /** * Iterate over the plugins and return the setup of the plugin returning the highest score. * - * @param vl The vector layer for which this widget will be created - * @param fieldName The field name on the specified layer for which this widget will be created + * \param vl The vector layer for which this widget will be created + * \param fieldName The field name on the specified layer for which this widget will be created * - * @return The best widget setup that was found + * \returns The best widget setup that was found */ QgsEditorWidgetSetup editorWidgetSetup( const QgsVectorLayer *vl, const QString &fieldName ) const; /** * Register a new plugin. * - * @param plugin The plugin (ownership is transferred) + * \param plugin The plugin (ownership is transferred) */ void registerPlugin( QgsEditorWidgetAutoConfPlugin *plugin ); diff --git a/src/gui/editorwidgets/core/qgseditorwidgetfactory.h b/src/gui/editorwidgets/core/qgseditorwidgetfactory.h index d72896174d8c..4382df86c6c1 100644 --- a/src/gui/editorwidgets/core/qgseditorwidgetfactory.h +++ b/src/gui/editorwidgets/core/qgseditorwidgetfactory.h @@ -44,7 +44,7 @@ class GUI_EXPORT QgsEditorWidgetFactory /** * Constructor * - * @param name A human readable name for this widget type + * \param name A human readable name for this widget type */ QgsEditorWidgetFactory( const QString &name ); @@ -52,15 +52,15 @@ class GUI_EXPORT QgsEditorWidgetFactory /** * Override this in your implementation. - * Create a new editor widget wrapper. Call {@link QgsEditorWidgetRegistry::create()} + * Create a new editor widget wrapper. Call QgsEditorWidgetRegistry::create() * instead of calling this method directly. * - * @param vl The vector layer on which this widget will act - * @param fieldIdx The field index on which this widget will act - * @param editor An editor widget if already existent. If NULL is provided, a new widget will be created. - * @param parent The parent for the wrapper class and any created widget. + * \param vl The vector layer on which this widget will act + * \param fieldIdx The field index on which this widget will act + * \param editor An editor widget if already existent. If NULL is provided, a new widget will be created. + * \param parent The parent for the wrapper class and any created widget. * - * @return A new widget wrapper + * \returns A new widget wrapper */ virtual QgsEditorWidgetWrapper *create( QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent ) const = 0; @@ -69,7 +69,7 @@ class GUI_EXPORT QgsEditorWidgetFactory /** * Return The human readable identifier name of this widget type * - * @return a name + * \returns a name */ QString name(); @@ -77,22 +77,22 @@ class GUI_EXPORT QgsEditorWidgetFactory * Override this in your implementation. * Create a new configuration widget for this widget type. * - * @param vl The layer for which the widget will be created - * @param fieldIdx The field index for which the widget will be created - * @param parent The parent widget of the created config widget + * \param vl The layer for which the widget will be created + * \param fieldIdx The field index for which the widget will be created + * \param parent The parent widget of the created config widget * - * @return A configuration widget + * \returns A configuration widget */ virtual QgsEditorConfigWidget *configWidget( QgsVectorLayer *vl, int fieldIdx, QWidget *parent ) const = 0; /** * Check if this editor widget type supports a certain field. * - * @param vl The layer - * @param fieldIdx The field index - * @return True if the type is supported for this field + * \param vl The layer + * \param fieldIdx The field index + * \returns True if the type is supported for this field * - * @see fieldScore( const QgsVectorLayer* vl, ind fieldIdx ) + * \see fieldScore( const QgsVectorLayer* vl, ind fieldIdx ) */ inline bool supportsField( const QgsVectorLayer *vl, int fieldIdx ) { return fieldScore( vl, fieldIdx ) > 0; } @@ -101,8 +101,8 @@ class GUI_EXPORT QgsEditorWidgetFactory * Each widget type can have a priority value attached, the factory with the highest one * will be used. * - * @return A map of widget type names and weight values - * @note not available in Python bindings + * \returns A map of widget type names and weight values + * \note not available in Python bindings */ virtual QHash supportedWidgetTypes() { return QHash(); } @@ -117,12 +117,12 @@ class GUI_EXPORT QgsEditorWidgetFactory * * 10: basic support (this is what returns TextEdit for example, since it supports everything in a crude way) * * 20: specialized support * - * @param vl - * @param fieldIdx - * @return 0 if the field is not supported or a bigger number if it can (the widget with the biggest number will be + * \param vl + * \param fieldIdx + * \returns 0 if the field is not supported or a bigger number if it can (the widget with the biggest number will be * taken by default). The default implementation returns 5.. * - * @see supportsField( QgsVectorLayer* vl, fieldIdx ) + * \see supportsField( QgsVectorLayer* vl, fieldIdx ) */ virtual unsigned int fieldScore( const QgsVectorLayer *vl, int fieldIdx ) const; diff --git a/src/gui/editorwidgets/core/qgseditorwidgetregistry.h b/src/gui/editorwidgets/core/qgseditorwidgetregistry.h index 5e8d27304889..26d500e38d17 100644 --- a/src/gui/editorwidgets/core/qgseditorwidgetregistry.h +++ b/src/gui/editorwidgets/core/qgseditorwidgetregistry.h @@ -46,7 +46,7 @@ class GUI_EXPORT QgsEditorWidgetRegistry : public QObject * This class is a singleton and has therefore to be accessed with this method instead * of a constructor. * - * @return The one and only instance of the editor widget registry + * \returns The one and only instance of the editor widget registry */ static QgsEditorWidgetRegistry *instance(); @@ -54,11 +54,11 @@ class GUI_EXPORT QgsEditorWidgetRegistry : public QObject * Registers all the default widgets. * Only call this once on startup of an application. * - * @param mapCanvas Specify a map canvas with which the widgets (relation reference) work - * @param messageBar Specify a message bar on which messages by widgets will be shown while working with the map canvas + * \param mapCanvas Specify a map canvas with which the widgets (relation reference) work + * \param messageBar Specify a message bar on which messages by widgets will be shown while working with the map canvas * * \since QGIS 2.8 - * @note Not required for plugins, the QGIS application does that already + * \note Not required for plugins, the QGIS application does that already */ static void initEditors( QgsMapCanvas *mapCanvas = nullptr, QgsMessageBar *messageBar = nullptr ); @@ -72,10 +72,10 @@ class GUI_EXPORT QgsEditorWidgetRegistry : public QObject /** * Find the best editor widget and its configuration for a given field. * - * @param vl The vector layer for which this widget will be created - * @param fieldName The field name on the specified layer for which this widget will be created + * \param vl The vector layer for which this widget will be created + * \param fieldName The field name on the specified layer for which this widget will be created * - * @return The id of the widget type to use and its config + * \returns The id of the widget type to use and its config */ QgsEditorWidgetSetup findBest( const QgsVectorLayer *vl, const QString &fieldName ) const; @@ -83,15 +83,15 @@ class GUI_EXPORT QgsEditorWidgetRegistry : public QObject * Create an attribute editor widget wrapper of a given type for a given field. * The editor may be NULL if you want the widget wrapper to create a default widget. * - * @param widgetId The id of the widget type to create an attribute editor for - * @param vl The vector layer for which this widget will be created - * @param fieldIdx The field index on the specified layer for which this widget will be created - * @param config A configuration which should be used for the widget creation - * @param editor An editor widget which will be used instead of an autocreated widget - * @param parent The parent which will be used for the created wrapper and the created widget - * @param context The editor context (not available in Python bindings) + * \param widgetId The id of the widget type to create an attribute editor for + * \param vl The vector layer for which this widget will be created + * \param fieldIdx The field index on the specified layer for which this widget will be created + * \param config A configuration which should be used for the widget creation + * \param editor An editor widget which will be used instead of an autocreated widget + * \param parent The parent which will be used for the created wrapper and the created widget + * \param context The editor context (not available in Python bindings) * - * @return A new widget wrapper + * \returns A new widget wrapper */ QgsEditorWidgetWrapper *create( const QString &widgetId, QgsVectorLayer *vl, @@ -105,13 +105,13 @@ class GUI_EXPORT QgsEditorWidgetRegistry : public QObject * Create an attribute editor widget wrapper of the best type for a given field. * The editor may be NULL if you want the widget wrapper to create a default widget. * - * @param vl The vector layer for which this widget will be created - * @param fieldIdx The field index on the specified layer for which this widget will be created - * @param editor An editor widget which will be used instead of an autocreated widget - * @param parent The parent which will be used for the created wrapper and the created widget - * @param context The editor context (not available in Python bindings) + * \param vl The vector layer for which this widget will be created + * \param fieldIdx The field index on the specified layer for which this widget will be created + * \param editor An editor widget which will be used instead of an autocreated widget + * \param parent The parent which will be used for the created wrapper and the created widget + * \param context The editor context (not available in Python bindings) * - * @return A new widget wrapper + * \returns A new widget wrapper */ QgsEditorWidgetWrapper *create( QgsVectorLayer *vl, int fieldIdx, @@ -129,52 +129,52 @@ class GUI_EXPORT QgsEditorWidgetRegistry : public QObject /** * Creates a configuration widget * - * @param widgetId The id of the widget type to create a configuration widget for - * @param vl The vector layer for which this widget will be created - * @param fieldIdx The field index on the specified layer for which this widget will be created - * @param parent The parent widget for the created widget + * \param widgetId The id of the widget type to create a configuration widget for + * \param vl The vector layer for which this widget will be created + * \param fieldIdx The field index on the specified layer for which this widget will be created + * \param parent The parent widget for the created widget * - * @return A new configuration widget + * \returns A new configuration widget */ QgsEditorConfigWidget *createConfigWidget( const QString &widgetId, QgsVectorLayer *vl, int fieldIdx, QWidget *parent ); /** * Get the human readable name for a widget type * - * @param widgetId The widget type to get the name for + * \param widgetId The widget type to get the name for * - * @return A human readable name + * \returns A human readable name */ QString name( const QString &widgetId ); /** * Get access to all registered factories * - * @return All ids and factories + * \returns All ids and factories */ QMap factories(); /** * Get a factory for the given widget type id. * - * @return A factory or Null if not existent + * \returns A factory or Null if not existent */ QgsEditorWidgetFactory *factory( const QString &widgetId ); /** * Register a new widget factory with the given id * - * @param widgetId The id which will be used later to refer to this widget type - * @param widgetFactory The factory which will create this widget type + * \param widgetId The id which will be used later to refer to this widget type + * \param widgetFactory The factory which will create this widget type * - * @return true, if successful, false, if the widgetId is already in use or widgetFactory is NULL + * \returns true, if successful, false, if the widgetId is already in use or widgetFactory is NULL */ bool registerWidget( const QString &widgetId, QgsEditorWidgetFactory *widgetFactory ); /** * Register a new auto-conf plugin. * - * @param plugin The plugin (ownership is transferred) + * \param plugin The plugin (ownership is transferred) */ void registerAutoConfPlugin( QgsEditorWidgetAutoConfPlugin *plugin ) { mAutoConf.registerPlugin( plugin ); } diff --git a/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h b/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h index 2f1dfccec9c6..c9d8bcdec6e1 100644 --- a/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h +++ b/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h @@ -56,10 +56,10 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper /** * Create a new widget wrapper * - * @param vl The layer on which the field is - * @param fieldIdx The field which will be controlled - * @param editor An editor widget. Can be NULL if one should be autogenerated. - * @param parent A parent widget for this widget wrapper and the created widget. + * \param vl The layer on which the field is + * \param fieldIdx The field which will be controlled + * \param editor An editor widget. Can be NULL if one should be autogenerated. + * \param parent A parent widget for this widget wrapper and the created widget. */ explicit QgsEditorWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor = nullptr, QWidget *parent = nullptr ); @@ -70,48 +70,48 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper * If an invalid variant is returned this will be interpreted as no change. * Be sure to return a NULL QVariant if it should be set to NULL. * - * @return The current value the widget represents + * \returns The current value the widget represents */ virtual QVariant value() const = 0; /** * Access the field index. * - * @return The index of the field you are working on + * \returns The index of the field you are working on * - * @see layer() + * \see layer() */ int fieldIdx() const; /** * Access the field. * - * @return The field you are working on + * \returns The field you are working on * - * @see layer() + * \see layer() */ QgsField field() const; /** * Access the default value of the field. * - * @return the default value of the field + * \returns the default value of the field * - * @see layer() + * \see layer() */ QVariant defaultValue() const; /** * Will return a wrapper for a given widget - * @param widget The widget which was created by a wrapper - * @return The wrapper for the widget or NULL + * \param widget The widget which was created by a wrapper + * \returns The wrapper for the widget or NULL */ static QgsEditorWidgetWrapper *fromWidget( QWidget *widget ); /** * Check if the given widget or one of its parent is a QTableView. - * @param parent the widget to check - * @return true if yes + * \param parent the widget to check + * \returns true if yes */ static bool isInTable( const QWidget *parent ); @@ -119,7 +119,7 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper * Is used to enable or disable the edit functionality of the managed widget. * By default this will enable or disable the whole widget * - * @param enabled Enable or Disable? + * \param enabled Enable or Disable? */ void setEnabled( bool enabled ) override; @@ -130,8 +130,8 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper /** * Update constraint. - * @param featureContext the feature to use to evaluate the constraint - * @param constraintOrigin optional origin for constraints to check. This can be used to limit the constraints tested + * \param featureContext the feature to use to evaluate the constraint + * \param constraintOrigin optional origin for constraints to check. This can be used to limit the constraints tested * to only provider or layer based constraints. * \since QGIS 2.16 */ @@ -139,11 +139,11 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper /** * Get the current constraint status. - * @return true if the constraint is valid or if there's no constraint, + * \returns true if the constraint is valid or if there's no constraint, * false otherwise * \since QGIS 2.16 - * @see constraintFailureReason() - * @see isBlockingCommit() + * \see constraintFailureReason() + * \see isBlockingCommit() */ bool isValidConstraint() const; @@ -151,14 +151,14 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper * Returns true if the widget is preventing the feature from being committed. This may be true as a result * of attribute values failing enforced field constraints. * \since QGIS 3.0 - * @see isValidConstraint() + * \see isValidConstraint() */ bool isBlockingCommit() const; /** * Returns the reason why a constraint check has failed (or an empty string * if constraint check was successful). - * @see isValidConstraint() + * \see isValidConstraint() * \since QGIS 3.0 */ QString constraintFailureReason() const; @@ -168,17 +168,17 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper /** * Emit this signal, whenever the value changed. * - * @param value The new value + * \param value The new value */ void valueChanged( const QVariant &value ); /** * Emit this signal when the constraint status changed. - * @brief constraintStatusChanged - * @param constraint represented as a string - * @param desc is the constraint description - * @param err the error represented as a string. Empty if none. - * @param status + * \brief constraintStatusChanged + * \param constraint represented as a string + * \param desc is the constraint description + * \param err the error represented as a string. Empty if none. + * \param status */ void constraintStatusChanged( const QString &constraint, const QString &desc, const QString &err, ConstraintResult status ); @@ -187,9 +187,9 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper /** * Will be called when the feature changes * - * Is forwarded to the slot \link setValue() \endlink + * Is forwarded to the slot setValue() * - * @param feature The new feature + * \param feature The new feature */ virtual void setFeature( const QgsFeature &feature ) override; @@ -197,7 +197,7 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper * Is called, when the value of the widget needs to be changed. Update the widget representation * to reflect the new value. * - * @param value The new value of the attribute + * \param value The new value of the attribute */ virtual void setValue( const QVariant &value ) = 0; @@ -205,7 +205,7 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper * If you emit to this slot in your implementation, an appropriate change notification * will be broadcasted. Helper for string type widgets. * - * @param value The value + * \param value The value */ void valueChanged( const QString &value ); @@ -213,8 +213,8 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper * If you emit to this slot in your implementation, an appropriate change notification * will be broadcasted. Helper for int type widgets. * - * @param value The value - * @note Python name valueChangedInt + * \param value The value + * \note Python name valueChangedInt */ void valueChanged( int value ); @@ -222,8 +222,8 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper * If you emit to this slot in your implementation, an appropriate change notification * will be broadcasted. Helper for double type widgets. * - * @param value The value - * @note Python name valueChangedDouble + * \param value The value + * \note Python name valueChangedDouble */ void valueChanged( double value ); @@ -231,8 +231,8 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper * If you emit to this slot in your implementation, an appropriate change notification * will be broadcasted. Helper for bool type widgets. * - * @param value The value - * @note Python name valueChangedBool + * \param value The value + * \note Python name valueChangedBool */ void valueChanged( bool value ); @@ -240,7 +240,7 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper * If you emit to this slot in your implementation, an appropriate change notification * will be broadcasted. Helper for longlong type widgets. * - * @param value The value + * \param value The value */ void valueChanged( qlonglong value ); @@ -261,7 +261,7 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper * This can be overwritten in subclasses to allow individual widgets to * change the visual cue. * - * @param status The current constraint status. + * \param status The current constraint status. * * \since QGIS 2.16 */ diff --git a/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h b/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h index 23c56de212e4..332b28ef732e 100644 --- a/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h +++ b/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h @@ -64,18 +64,18 @@ class GUI_EXPORT QgsSearchWidgetWrapper : public QgsWidgetWrapper /** Returns a list of exclusive filter flags, which cannot be combined with other flags (e.g., EqualTo/NotEqualTo) * \since QGIS 2.16 - * @see nonExclusiveFilterFlags() + * \see nonExclusiveFilterFlags() */ static QList< FilterFlag > exclusiveFilterFlags(); /** Returns a list of non-exclusive filter flags, which can be combined with other flags (e.g., CaseInsensitive) * \since QGIS 2.16 - * @see exclusiveFilterFlags() + * \see exclusiveFilterFlags() */ static QList< FilterFlag > nonExclusiveFilterFlags(); /** Returns a translated string representing a filter flag. - * @param flag flag to convert to string + * \param flag flag to convert to string * \since QGIS 2.16 */ static QString toString( FilterFlag flag ); @@ -83,21 +83,21 @@ class GUI_EXPORT QgsSearchWidgetWrapper : public QgsWidgetWrapper /** * Create a new widget wrapper * - * @param vl The layer on which the field is - * @param fieldIdx The field which will be controlled - * @param parent A parent widget for this widget wrapper and the created widget. + * \param vl The layer on which the field is + * \param fieldIdx The field which will be controlled + * \param parent A parent widget for this widget wrapper and the created widget. */ explicit QgsSearchWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *parent = nullptr ); /** Returns filter flags supported by the search widget. * \since QGIS 2.16 - * @see defaultFlags() + * \see defaultFlags() */ virtual FilterFlags supportedFlags() const; /** Returns the filter flags which should be set by default for the search widget. * \since QGIS 2.16 - * @see supportedFlags() + * \see supportedFlags() */ virtual FilterFlags defaultFlags() const; @@ -108,7 +108,7 @@ class GUI_EXPORT QgsSearchWidgetWrapper : public QgsWidgetWrapper * If an invalid variant is returned this will be interpreted as no change. * Be sure to return a NULL QVariant if it should be set to NULL. * - * @return The current value the widget represents + * \returns The current value the widget represents */ virtual QString expression() = 0; @@ -120,8 +120,8 @@ class GUI_EXPORT QgsSearchWidgetWrapper : public QgsWidgetWrapper /** Creates a filter expression based on the current state of the search widget * and the specified filter flags. - * @param flags filter flags - * @returns filter expression + * \param flags filter flags + * \returns filter expression * \since QGIS 2.16 */ // TODO QGIS 3.0 - make pure virtual @@ -135,7 +135,7 @@ class GUI_EXPORT QgsSearchWidgetWrapper : public QgsWidgetWrapper virtual void clearWidget() {} /** Toggles whether the search widget is enabled or disabled. - * @param enabled set to true to enable widget + * \param enabled set to true to enable widget */ virtual void setEnabled( bool enabled ) override { Q_UNUSED( enabled ); } @@ -143,7 +143,7 @@ class GUI_EXPORT QgsSearchWidgetWrapper : public QgsWidgetWrapper /** * Emitted whenever the expression changes - * @param exp The new search expression + * \param exp The new search expression */ void expressionChanged( const QString &exp ); diff --git a/src/gui/editorwidgets/core/qgswidgetwrapper.h b/src/gui/editorwidgets/core/qgswidgetwrapper.h index 236255bd3fcf..8fb81b830c26 100644 --- a/src/gui/editorwidgets/core/qgswidgetwrapper.h +++ b/src/gui/editorwidgets/core/qgswidgetwrapper.h @@ -59,24 +59,24 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject /** * Create a new widget wrapper * - * @param vl The layer on which the field is - * @param editor An editor widget. Can be NULL if one should be autogenerated. - * @param parent A parent widget for this widget wrapper and the created widget. + * \param vl The layer on which the field is + * \param editor An editor widget. Can be NULL if one should be autogenerated. + * \param parent A parent widget for this widget wrapper and the created widget. */ explicit QgsWidgetWrapper( QgsVectorLayer *vl, QWidget *editor = nullptr, QWidget *parent = nullptr ); /** - * @brief Access the widget managed by this wrapper + * \brief Access the widget managed by this wrapper * - * @return The widget + * \returns The widget */ QWidget *widget(); /** - * @brief Access the widget managed by this wrapper and cast it to a given type + * \brief Access the widget managed by this wrapper and cast it to a given type * Example: QPushButton* pb = wrapper->widget(); * - * @return The widget as template type or NULL, if it cannot be cast to this type. + * \returns The widget as template type or NULL, if it cannot be cast to this type. */ template T *widget() { return dynamic_cast( mWidget ); } @@ -84,54 +84,54 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject /** * Will set the config of this wrapper to the specified config. * - * @param config The config for this wrapper + * \param config The config for this wrapper */ void setConfig( const QVariantMap &config ); /** * Set the context in which this widget is shown * - * @param context context information + * \param context context information */ void setContext( const QgsAttributeEditorContext &context ); /** * Use this inside your overridden classes to access the configuration. * - * @param key The configuration option you want to load - * @param defaultVal Default value + * \param key The configuration option you want to load + * \param defaultVal Default value * - * @return the value assigned to this configuration option + * \returns the value assigned to this configuration option */ QVariant config( const QString &key, const QVariant &defaultVal = QVariant() ) const; /** * Returns the whole config * - * @return The configuration + * \returns The configuration */ QVariantMap config() const; /** * Returns information about the context in which this widget is shown * - * @return context information + * \returns context information */ const QgsAttributeEditorContext &context() const; /** * Access the QgsVectorLayer, you are working on * - * @return The layer + * \returns The layer * - * @see field() + * \see field() */ QgsVectorLayer *layer() const; /** * Will return a wrapper for a given widget - * @param widget The widget which was created by a wrapper - * @return The wrapper for the widget or NULL + * \param widget The widget which was created by a wrapper + * \returns The wrapper for the widget or NULL */ static QgsWidgetWrapper *fromWidget( QWidget *widget ); @@ -142,7 +142,7 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject * If it cannot be used this is a hint to the caller that he may try to find * another suitable widget type instead. * - * @return Validity status of this widget. + * \returns Validity status of this widget. * * \since QGIS 2.12 */ @@ -151,20 +151,20 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject /** Returns a reference to the editor widget's property collection, used for data defined overrides. * \since QGIS 3.0 - * @see setDataDefinedProperties() + * \see setDataDefinedProperties() */ QgsPropertyCollection &dataDefinedProperties() { return mPropertyCollection; } /** Returns a reference to the editor widget's property collection, used for data defined overrides. * \since QGIS 3.0 - * @see setDataDefinedProperties() + * \see setDataDefinedProperties() */ const QgsPropertyCollection &dataDefinedProperties() const { return mPropertyCollection; } /** Sets the editor widget's property collection, used for data defined overrides. - * @param collection property collection. Existing properties will be replaced. + * \param collection property collection. Existing properties will be replaced. * \since QGIS 3.0 - * @see dataDefinedProperties() + * \see dataDefinedProperties() */ void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mPropertyCollection = collection; } @@ -176,17 +176,17 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject * You should not do initialization stuff, which also has to be done for custom editor * widgets inside this method. Things like filling comboboxes and assigning other data which * will also be used to make widgets on forms created in the QtDesigner usable should be assigned - * in {@link initWidget(QWidget*)}. + * in initWidget(). * - * @param parent You should set this parent on the created widget. - * @return A new widget + * \param parent You should set this parent on the created widget. + * \returns A new widget */ virtual QWidget *createWidget( QWidget *parent ) = 0; /** * This method should initialize the editor widget with runtime data. Fill your comboboxes here. * - * @param editor The widget which will represent this attribute editor in a form. + * \param editor The widget which will represent this attribute editor in a form. */ virtual void initWidget( QWidget *editor ); @@ -199,7 +199,7 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject * Is called, when the value of the widget needs to be changed. Update the widget representation * to reflect the new value. * - * @param feature The new feature + * \param feature The new feature */ virtual void setFeature( const QgsFeature &feature ) = 0; @@ -207,7 +207,7 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject * Is used to enable or disable the edit functionality of the managed widget. * By default this will not change the enabled state of the widget * - * @param enabled Enable or Disable? + * \param enabled Enable or Disable? */ virtual void setEnabled( bool enabled ); diff --git a/src/gui/editorwidgets/qgscheckboxsearchwidgetwrapper.h b/src/gui/editorwidgets/qgscheckboxsearchwidgetwrapper.h index d52d113b0816..eefb53179182 100644 --- a/src/gui/editorwidgets/qgscheckboxsearchwidgetwrapper.h +++ b/src/gui/editorwidgets/qgscheckboxsearchwidgetwrapper.h @@ -39,14 +39,14 @@ class GUI_EXPORT QgsCheckboxSearchWidgetWrapper : public QgsSearchWidgetWrapper public: /** Constructor for QgsCheckboxSearchWidgetWrapper. - * @param vl associated vector layer - * @param fieldIdx index of associated field - * @param parent parent widget + * \param vl associated vector layer + * \param fieldIdx index of associated field + * \param parent parent widget */ explicit QgsCheckboxSearchWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *parent = nullptr ); /** Returns a variant representing the current state of the widget. - * @note this will not be a boolean true or false value, it will instead + * \note this will not be a boolean true or false value, it will instead * be the values configured to represent checked and unchecked states in * the editor widget configuration. */ diff --git a/src/gui/editorwidgets/qgsdatetimeedit.h b/src/gui/editorwidgets/qgsdatetimeedit.h index 6f4364dfbf92..72c0580ce3e6 100644 --- a/src/gui/editorwidgets/qgsdatetimeedit.h +++ b/src/gui/editorwidgets/qgsdatetimeedit.h @@ -23,7 +23,7 @@ class QToolButton; class QLineEdit; /** \ingroup gui - * @brief The QgsDateTimeEdit class is a QDateTimeEdit with the capability of setting/reading null date/times. + * \brief The QgsDateTimeEdit class is a QDateTimeEdit with the capability of setting/reading null date/times. */ class GUI_EXPORT QgsDateTimeEdit : public QDateTimeEdit { @@ -38,20 +38,20 @@ class GUI_EXPORT QgsDateTimeEdit : public QDateTimeEdit bool allowNull() const {return mAllowNull;} /** - * @brief setDateTime set the date time in the widget and handles null date times. - * @note since QDateTimeEdit::setDateTime() is not virtual, setDateTime must be called for QgsDateTimeEdit. + * \brief setDateTime set the date time in the widget and handles null date times. + * \note since QDateTimeEdit::setDateTime() is not virtual, setDateTime must be called for QgsDateTimeEdit. */ void setDateTime( const QDateTime &dateTime ); /** - * @brief dateTime returns the date time which can eventually be a null date/time - * @note since QDateTimeEdit::dateTime() is not virtual, dateTime must be called for QgsDateTimeEdit. + * \brief dateTime returns the date time which can eventually be a null date/time + * \note since QDateTimeEdit::dateTime() is not virtual, dateTime must be called for QgsDateTimeEdit. */ QDateTime dateTime() const; /** * Set the current date as NULL - * @note if the widget is not configured to accept NULL dates, this will have no effect + * \note if the widget is not configured to accept NULL dates, this will have no effect */ virtual void clear() override; diff --git a/src/gui/editorwidgets/qgsdatetimesearchwidgetwrapper.h b/src/gui/editorwidgets/qgsdatetimesearchwidgetwrapper.h index 58a0133e4636..f25282713095 100644 --- a/src/gui/editorwidgets/qgsdatetimesearchwidgetwrapper.h +++ b/src/gui/editorwidgets/qgsdatetimesearchwidgetwrapper.h @@ -39,9 +39,9 @@ class GUI_EXPORT QgsDateTimeSearchWidgetWrapper : public QgsSearchWidgetWrapper public: /** Constructor for QgsDateTimeSearchWidgetWrapper. - * @param vl associated vector layer - * @param fieldIdx index of associated field - * @param parent parent widget + * \param vl associated vector layer + * \param fieldIdx index of associated field + * \param parent parent widget */ explicit QgsDateTimeSearchWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *parent = nullptr ); diff --git a/src/gui/editorwidgets/qgsdefaultsearchwidgetwrapper.h b/src/gui/editorwidgets/qgsdefaultsearchwidgetwrapper.h index b08587f88e56..4462e05b233c 100644 --- a/src/gui/editorwidgets/qgsdefaultsearchwidgetwrapper.h +++ b/src/gui/editorwidgets/qgsdefaultsearchwidgetwrapper.h @@ -60,13 +60,13 @@ class GUI_EXPORT QgsDefaultSearchWidgetWrapper : public QgsSearchWidgetWrapper bool valid() const override; /** Returns a pointer to the line edit part of the widget. - * @note this method is in place for unit testing only, and is not considered + * \note this method is in place for unit testing only, and is not considered * stable API */ QgsFilterLineEdit *lineEdit(); /** Returns a pointer to the case sensitivity check box in the widget. - * @note this method is in place for unit testing only, and is not considered + * \note this method is in place for unit testing only, and is not considered * stable API */ QCheckBox *caseSensitiveCheckBox(); diff --git a/src/gui/editorwidgets/qgsdoublespinbox.h b/src/gui/editorwidgets/qgsdoublespinbox.h index ad61b6648568..26a43a9529fd 100644 --- a/src/gui/editorwidgets/qgsdoublespinbox.h +++ b/src/gui/editorwidgets/qgsdoublespinbox.h @@ -22,7 +22,7 @@ class QgsSpinBoxLineEdit; /** \ingroup gui - * @brief The QgsSpinBox is a spin box with a clear button that will set the value to the defined clear value. + * \brief The QgsSpinBox is a spin box with a clear button that will set the value to the defined clear value. * The clear value can be either the minimum or the maiximum value of the spin box or a custom value. * This value can then be handled by a special value text. */ @@ -44,32 +44,32 @@ class GUI_EXPORT QgsDoubleSpinBox : public QDoubleSpinBox }; /** Constructor for QgsDoubleSpinBox. - * @param parent parent widget + * \param parent parent widget */ explicit QgsDoubleSpinBox( QWidget *parent = nullptr ); /** Sets whether the widget will show a clear button. The clear button * allows users to reset the widget to a default or empty state. - * @param showClearButton set to true to show the clear button, or false to hide it - * @see showClearButton() + * \param showClearButton set to true to show the clear button, or false to hide it + * \see showClearButton() */ void setShowClearButton( const bool showClearButton ); /** Returns whether the widget is showing a clear button. - * @see setShowClearButton() + * \see setShowClearButton() */ bool showClearButton() const {return mShowClearButton;} /** Sets if the widget will allow entry of simple expressions, which are * evaluated and then discarded. - * @param enabled set to true to allow expression entry + * \param enabled set to true to allow expression entry * \since QGIS 2.7 */ void setExpressionsEnabled( const bool enabled ); /** Returns whether the widget will allow entry of simple expressions, which are * evaluated and then discarded. - * @returns true if spin box allows expression entry + * \returns true if spin box allows expression entry * \since QGIS 2.7 */ bool expressionsEnabled() const {return mExpressionsEnabled;} @@ -79,21 +79,21 @@ class GUI_EXPORT QgsDoubleSpinBox : public QDoubleSpinBox /** * Defines the clear value as a custom value and will automatically set the clear value mode to CustomValue. - * @param customValue defines the numerical value used as the clear value - * @param clearValueText is the text displayed when the spin box is at the clear value. If not specified, no special value text is used. - * @see setClearValue() + * \param customValue defines the numerical value used as the clear value + * \param clearValueText is the text displayed when the spin box is at the clear value. If not specified, no special value text is used. + * \see setClearValue() */ void setClearValue( double customValue, const QString &clearValueText = QString() ); /** * Defines if the clear value should be the minimum or maximum values of the widget or a custom value. - * @param mode mode to user for clear value - * @param clearValueText is the text displayed when the spin box is at the clear value. If not specified, no special value text is used. + * \param mode mode to user for clear value + * \param clearValueText is the text displayed when the spin box is at the clear value. If not specified, no special value text is used. */ void setClearValueMode( ClearValueMode mode, const QString &clearValueText = QString() ); /** Returns the value used when clear() is called. - * @see setClearValue() + * \see setClearValue() */ double clearValue() const; diff --git a/src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.h b/src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.h index 92ba8bdf8a31..6f1539147db8 100644 --- a/src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.h +++ b/src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.h @@ -32,7 +32,7 @@ class QLineEdit; */ /** - * @brief The QgsExternalResourceWidgetWrapper class wraps a external resource widget + * \brief The QgsExternalResourceWidgetWrapper class wraps a external resource widget */ class GUI_EXPORT QgsExternalResourceWidgetWrapper : public QgsEditorWidgetWrapper { diff --git a/src/gui/editorwidgets/qgskeyvaluewidgetfactory.h b/src/gui/editorwidgets/qgskeyvaluewidgetfactory.h index e83c92827ee6..c3f240000d65 100644 --- a/src/gui/editorwidgets/qgskeyvaluewidgetfactory.h +++ b/src/gui/editorwidgets/qgskeyvaluewidgetfactory.h @@ -19,10 +19,10 @@ #include "qgseditorwidgetfactory.h" #include "qgis_gui.h" -/** @ingroup gui +/** \ingroup gui * Factory for widgets for editing a QVariantMap * \since QGIS 3.0 - * @note not available in Python bindings + * \note not available in Python bindings */ class GUI_EXPORT QgsKeyValueWidgetFactory : public QgsEditorWidgetFactory { diff --git a/src/gui/editorwidgets/qgskeyvaluewidgetwrapper.h b/src/gui/editorwidgets/qgskeyvaluewidgetwrapper.h index f44007aa6d73..082cd0be00c1 100644 --- a/src/gui/editorwidgets/qgskeyvaluewidgetwrapper.h +++ b/src/gui/editorwidgets/qgskeyvaluewidgetwrapper.h @@ -21,10 +21,10 @@ class QgsKeyValueWidget; -/** @ingroup gui +/** \ingroup gui * Wraps a key/value widget. * \since QGIS 3.0 - * @note not available in Python bindings + * \note not available in Python bindings */ class GUI_EXPORT QgsKeyValueWidgetWrapper : public QgsEditorWidgetWrapper { diff --git a/src/gui/editorwidgets/qgslistwidgetfactory.h b/src/gui/editorwidgets/qgslistwidgetfactory.h index 6c4ef9448af0..869f44395c88 100644 --- a/src/gui/editorwidgets/qgslistwidgetfactory.h +++ b/src/gui/editorwidgets/qgslistwidgetfactory.h @@ -19,10 +19,10 @@ #include "qgseditorwidgetfactory.h" #include "qgis_gui.h" -/** @ingroup gui +/** \ingroup gui * Factory for widgets for editing a QVariantList or a QStringList * \since QGIS 3.0 - * @note not available in Python bindings + * \note not available in Python bindings */ class GUI_EXPORT QgsListWidgetFactory : public QgsEditorWidgetFactory { diff --git a/src/gui/editorwidgets/qgslistwidgetwrapper.h b/src/gui/editorwidgets/qgslistwidgetwrapper.h index 1b23a6f48f5c..eb155c98cef3 100644 --- a/src/gui/editorwidgets/qgslistwidgetwrapper.h +++ b/src/gui/editorwidgets/qgslistwidgetwrapper.h @@ -21,10 +21,10 @@ class QgsListWidget; -/** @ingroup gui +/** \ingroup gui * Wraps a list widget. * \since QGIS 3.0 - * @note not available in Python bindings + * \note not available in Python bindings */ class GUI_EXPORT QgsListWidgetWrapper : public QgsEditorWidgetWrapper { diff --git a/src/gui/editorwidgets/qgsmultiedittoolbutton.h b/src/gui/editorwidgets/qgsmultiedittoolbutton.h index 43c9e3672f97..8d158746ca2e 100644 --- a/src/gui/editorwidgets/qgsmultiedittoolbutton.h +++ b/src/gui/editorwidgets/qgsmultiedittoolbutton.h @@ -42,7 +42,7 @@ class GUI_EXPORT QgsMultiEditToolButton : public QToolButton }; /** Constructor for QgsMultiEditToolButton. - * @param parent parent object + * \param parent parent object */ explicit QgsMultiEditToolButton( QWidget *parent = nullptr ); @@ -52,37 +52,37 @@ class GUI_EXPORT QgsMultiEditToolButton : public QToolButton /** Sets the field associated with this button. This is used to customise the widget menu * and tooltips to match the field properties. - * @param field associated field + * \param field associated field */ void setField( const QgsField &field ) { mField = field; } public slots: /** Sets whether the associated field contains mixed values. - * @param mixed whether field values are mixed - * @see isMixed() - * @see setIsChanged() - * @see resetChanges() + * \param mixed whether field values are mixed + * \see isMixed() + * \see setIsChanged() + * \see resetChanges() */ void setIsMixed( bool mixed ) { mIsMixedValues = mixed; updateState(); } /** Sets whether the associated field has changed. - * @param changed whether field has changed - * @see isChanged() - * @see setIsMixed() - * @see resetChanges() + * \param changed whether field has changed + * \see isChanged() + * \see setIsMixed() + * \see resetChanges() */ void setIsChanged( bool changed ) { mIsChanged = changed; updateState(); } /** Resets the changed state for the field. - * @see setIsMixed() - * @see setIsChanged() - * @see changesCommitted() + * \see setIsMixed() + * \see setIsChanged() + * \see changesCommitted() */ void resetChanges() { mIsChanged = false; updateState(); } /** Called when field values have been changed and field now contains all the same values. - * @see resetChanges() + * \see resetChanges() */ void changesCommitted() { mIsMixedValues = false; mIsChanged = false; updateState(); } diff --git a/src/gui/editorwidgets/qgsrelationreferencefactory.h b/src/gui/editorwidgets/qgsrelationreferencefactory.h index 758be297b78d..1ce57d9cee86 100644 --- a/src/gui/editorwidgets/qgsrelationreferencefactory.h +++ b/src/gui/editorwidgets/qgsrelationreferencefactory.h @@ -35,15 +35,15 @@ class GUI_EXPORT QgsRelationReferenceFactory : public QgsEditorWidgetFactory /** * Override this in your implementation. - * Create a new editor widget wrapper. Call {@link QgsEditorWidgetRegistry::create()} + * Create a new editor widget wrapper. Call QgsEditorWidgetRegistry::create() * instead of calling this method directly. * - * @param vl The vector layer on which this widget will act - * @param fieldIdx The field index on which this widget will act - * @param editor An editor widget if already existent. If NULL is provided, a new widget will be created. - * @param parent The parent for the wrapper class and any created widget. + * \param vl The vector layer on which this widget will act + * \param fieldIdx The field index on which this widget will act + * \param editor An editor widget if already existent. If NULL is provided, a new widget will be created. + * \param parent The parent for the wrapper class and any created widget. * - * @return A new widget wrapper + * \returns A new widget wrapper */ virtual QgsEditorWidgetWrapper *create( QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent ) const override; @@ -53,11 +53,11 @@ class GUI_EXPORT QgsRelationReferenceFactory : public QgsEditorWidgetFactory * Override this in your implementation. * Create a new configuration widget for this widget type. * - * @param vl The layer for which the widget will be created - * @param fieldIdx The field index for which the widget will be created - * @param parent The parent widget of the created config widget + * \param vl The layer for which the widget will be created + * \param fieldIdx The field index for which the widget will be created + * \param parent The parent widget of the created config widget * - * @return A configuration widget + * \returns A configuration widget */ virtual QgsEditorConfigWidget *configWidget( QgsVectorLayer *vl, int fieldIdx, QWidget *parent ) const override; diff --git a/src/gui/editorwidgets/qgsrelationreferencesearchwidgetwrapper.h b/src/gui/editorwidgets/qgsrelationreferencesearchwidgetwrapper.h index d1edaf2dd435..7a4e4271e5ea 100644 --- a/src/gui/editorwidgets/qgsrelationreferencesearchwidgetwrapper.h +++ b/src/gui/editorwidgets/qgsrelationreferencesearchwidgetwrapper.h @@ -40,10 +40,10 @@ class GUI_EXPORT QgsRelationReferenceSearchWidgetWrapper : public QgsSearchWidge public: /** Constructor for QgsRelationReferenceSearchWidgetWrapper - * @param vl associated vector layer - * @param fieldIdx associated field index - * @param canvas optional map canvas - * @param parent parent widget + * \param vl associated vector layer + * \param fieldIdx associated field index + * \param canvas optional map canvas + * \param parent parent widget */ explicit QgsRelationReferenceSearchWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QgsMapCanvas *canvas, QWidget *parent = nullptr ); diff --git a/src/gui/editorwidgets/qgsrelationreferencewidget.h b/src/gui/editorwidgets/qgsrelationreferencewidget.h index 93e74e26181b..5d8476613079 100644 --- a/src/gui/editorwidgets/qgsrelationreferencewidget.h +++ b/src/gui/editorwidgets/qgsrelationreferencewidget.h @@ -100,7 +100,7 @@ class GUI_EXPORT QgsRelationReferenceWidget : public QWidget /** * Determines if the filters are chained * - * @return True if filters are chained + * \returns True if filters are chained */ bool chainFilters() const { return mChainFilters; } @@ -108,7 +108,7 @@ class GUI_EXPORT QgsRelationReferenceWidget : public QWidget * Set if filters are chained. * Chained filters restrict the option of subsequent filters based on the selection of a previous filter. * - * @param chainFilters If chaining should be enabled + * \param chainFilters If chaining should be enabled */ void setChainFilters( bool chainFilters ); diff --git a/src/gui/editorwidgets/qgsrelationwidgetwrapper.h b/src/gui/editorwidgets/qgsrelationwidgetwrapper.h index 5570bf93d4f6..b59ccaf4be33 100644 --- a/src/gui/editorwidgets/qgsrelationwidgetwrapper.h +++ b/src/gui/editorwidgets/qgsrelationwidgetwrapper.h @@ -86,7 +86,7 @@ class GUI_EXPORT QgsRelationWidgetWrapper : public QgsWidgetWrapper void setFeature( const QgsFeature &feature ) override; /** Sets the visibility of the wrapper's widget. - * @param visible set to true to show widget, false to hide widget + * \param visible set to true to show widget, false to hide widget * \since QGIS 2.16 */ void setVisible( bool visible ); diff --git a/src/gui/editorwidgets/qgssearchwidgettoolbutton.h b/src/gui/editorwidgets/qgssearchwidgettoolbutton.h index c03d1626b880..f41d308c89a1 100644 --- a/src/gui/editorwidgets/qgssearchwidgettoolbutton.h +++ b/src/gui/editorwidgets/qgssearchwidgettoolbutton.h @@ -34,40 +34,40 @@ class GUI_EXPORT QgsSearchWidgetToolButton : public QToolButton public: /** Constructor for QgsSearchWidgetToolButton. - * @param parent parent object + * \param parent parent object */ explicit QgsSearchWidgetToolButton( QWidget *parent = nullptr ); /** Sets the available filter flags to show in the widget. Any active flags * (see activeFlags()) which are not present in the new available filter * flags will be cleared; - * @param flags available flags to show in widget - * @see availableFlags() - * @see setActiveFlags() - * @see setDefaultFlags() + * \param flags available flags to show in widget + * \see availableFlags() + * \see setActiveFlags() + * \see setDefaultFlags() */ void setAvailableFlags( QgsSearchWidgetWrapper::FilterFlags flags ); /** Sets the default filter flags to show in the widget. - * @param flags default flags to show in widget - * @see setAvailableFlags() - * @see setActiveFlags() + * \param flags default flags to show in widget + * \see setAvailableFlags() + * \see setActiveFlags() */ void setDefaultFlags( QgsSearchWidgetWrapper::FilterFlags flags ); /** Returns the available filter flags shown in the widget. - * @see setAvailableFlags() - * @see activeFlags() + * \see setAvailableFlags() + * \see activeFlags() */ QgsSearchWidgetWrapper::FilterFlags availableFlags() const { return mAvailableFilterFlags; } /** Sets the current active filter flags for the widget. Any flags * which are not present in the available filter flags (see availableFlags()) * will not be set. - * @param flags active flags to show in widget - * @see toggleFlag() - * @see activeFlags() - * @see setAvailableFlags() + * \param flags active flags to show in widget + * \see toggleFlag() + * \see activeFlags() + * \see setAvailableFlags() */ void setActiveFlags( QgsSearchWidgetWrapper::FilterFlags flags ); @@ -75,43 +75,43 @@ class GUI_EXPORT QgsSearchWidgetToolButton : public QToolButton * which are not present in the available filter flags (see availableFlags()) * will be ignore. Other flags may be cleared if they conflict with the newly * toggled flag. - * @param flag flag to toggle - * @see setActiveFlags() - * @see activeFlags() + * \param flag flag to toggle + * \see setActiveFlags() + * \see activeFlags() */ void toggleFlag( QgsSearchWidgetWrapper::FilterFlag flag ); /** Returns the active filter flags shown in the widget. - * @see setActiveFlags() - * @see toggleFlag() - * @see availableFlags() + * \see setActiveFlags() + * \see toggleFlag() + * \see availableFlags() */ QgsSearchWidgetWrapper::FilterFlags activeFlags() const { return mFilterFlags; } /** Returns true if the widget is set to be included in the search. - * @see setInactive() - * @see setActive() + * \see setInactive() + * \see setActive() */ bool isActive() const; public slots: /** Sets the search widget as inactive, ie do not search the corresponding field. - * @see isActive() - * @see setActive() + * \see isActive() + * \see setActive() */ void setInactive(); /** Sets the search widget as active by selecting the first available search type. - * @see isActive() - * @see setInactive() + * \see isActive() + * \see setInactive() */ void setActive(); signals: /** Emitted when the active flags selected in the widget is changed - * @param flags active flags + * \param flags active flags */ void activeFlagsChanged( QgsSearchWidgetWrapper::FilterFlags flags ); diff --git a/src/gui/editorwidgets/qgsspinbox.h b/src/gui/editorwidgets/qgsspinbox.h index 07e1cdec290c..44aea63b7a50 100644 --- a/src/gui/editorwidgets/qgsspinbox.h +++ b/src/gui/editorwidgets/qgsspinbox.h @@ -22,7 +22,7 @@ class QgsSpinBoxLineEdit; /** \ingroup gui - * @brief The QgsSpinBox is a spin box with a clear button that will set the value to the defined clear value. + * \brief The QgsSpinBox is a spin box with a clear button that will set the value to the defined clear value. * The clear value can be either the minimum or the maiximum value of the spin box or a custom value. * This value can then be handled by a special value text. */ @@ -44,32 +44,32 @@ class GUI_EXPORT QgsSpinBox : public QSpinBox }; /** Constructor for QgsSpinBox. - * @param parent parent widget + * \param parent parent widget */ explicit QgsSpinBox( QWidget *parent = nullptr ); /** Sets whether the widget will show a clear button. The clear button * allows users to reset the widget to a default or empty state. - * @param showClearButton set to true to show the clear button, or false to hide it - * @see showClearButton() + * \param showClearButton set to true to show the clear button, or false to hide it + * \see showClearButton() */ void setShowClearButton( const bool showClearButton ); /** Returns whether the widget is showing a clear button. - * @see setShowClearButton() + * \see setShowClearButton() */ bool showClearButton() const {return mShowClearButton;} /** Sets if the widget will allow entry of simple expressions, which are * evaluated and then discarded. - * @param enabled set to true to allow expression entry + * \param enabled set to true to allow expression entry * \since QGIS 2.7 */ void setExpressionsEnabled( const bool enabled ); /** Returns whether the widget will allow entry of simple expressions, which are * evaluated and then discarded. - * @returns true if spin box allows expression entry + * \returns true if spin box allows expression entry * \since QGIS 2.7 */ bool expressionsEnabled() const {return mExpressionsEnabled;} @@ -79,21 +79,21 @@ class GUI_EXPORT QgsSpinBox : public QSpinBox /** * Defines the clear value as a custom value and will automatically set the clear value mode to CustomValue. - * @param customValue defines the numerical value used as the clear value - * @param clearValueText is the text displayed when the spin box is at the clear value. If not specified, no special value text is used. - * @see setClearValue() + * \param customValue defines the numerical value used as the clear value + * \param clearValueText is the text displayed when the spin box is at the clear value. If not specified, no special value text is used. + * \see setClearValue() */ void setClearValue( int customValue, const QString &clearValueText = QString() ); /** * Defines if the clear value should be the minimum or maximum values of the widget or a custom value. - * @param mode mode to user for clear value - * @param clearValueText is the text displayed when the spin box is at the clear value. If not specified, no special value text is used. + * \param mode mode to user for clear value + * \param clearValueText is the text displayed when the spin box is at the clear value. If not specified, no special value text is used. */ void setClearValueMode( ClearValueMode mode, const QString &clearValueText = QString() ); /** Returns the value used when clear() is called. - * @see setClearValue() + * \see setClearValue() */ int clearValue() const; diff --git a/src/gui/editorwidgets/qgstexteditsearchwidgetwrapper.h b/src/gui/editorwidgets/qgstexteditsearchwidgetwrapper.h index 88dfbe207d61..09a7e15c6579 100644 --- a/src/gui/editorwidgets/qgstexteditsearchwidgetwrapper.h +++ b/src/gui/editorwidgets/qgstexteditsearchwidgetwrapper.h @@ -35,9 +35,9 @@ class GUI_EXPORT QgsTextEditSearchWidgetWrapper : public QgsDefaultSearchWidgetW public: /** Constructor for QgsTextEditSearchWidgetWrapper. - * @param vl associated vector layer - * @param fieldIdx index of associated field - * @param parent parent widget + * \param vl associated vector layer + * \param fieldIdx index of associated field + * \param parent parent widget */ explicit QgsTextEditSearchWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *parent = nullptr ); diff --git a/src/gui/effects/qgseffectdrawmodecombobox.h b/src/gui/effects/qgseffectdrawmodecombobox.h index 1fa52e60554f..32dad5b7ca49 100644 --- a/src/gui/effects/qgseffectdrawmodecombobox.h +++ b/src/gui/effects/qgseffectdrawmodecombobox.h @@ -36,12 +36,12 @@ class GUI_EXPORT QgsEffectDrawModeComboBox : public QComboBox QgsEffectDrawModeComboBox( QWidget *parent = nullptr ); /** Returns the currently selected draw mode for the combo box - * @returns current draw mode + * \returns current draw mode */ QgsPaintEffect::DrawMode drawMode() const; /** Sets the currently selected draw mode for the combo box - * @param drawMode selected draw mode + * \param drawMode selected draw mode */ void setDrawMode( QgsPaintEffect::DrawMode drawMode ); diff --git a/src/gui/effects/qgseffectstackpropertieswidget.h b/src/gui/effects/qgseffectstackpropertieswidget.h index 08814da76626..52d83ad0d55f 100644 --- a/src/gui/effects/qgseffectstackpropertieswidget.h +++ b/src/gui/effects/qgseffectstackpropertieswidget.h @@ -50,20 +50,20 @@ class GUI_EXPORT QgsEffectStackPropertiesWidget : public QgsPanelWidget, private public: /** QgsEffectStackPropertiesWidget constructor - * @param stack QgsEffectStack to modify in the widget - * @param parent parent widget + * \param stack QgsEffectStack to modify in the widget + * \param parent parent widget */ QgsEffectStackPropertiesWidget( QgsEffectStack *stack, QWidget *parent = nullptr ); ~QgsEffectStackPropertiesWidget(); /** Returns effect stack attached to the widget - * @returns QgsEffectStack modified by the widget + * \returns QgsEffectStack modified by the widget */ QgsEffectStack *stack() { return mStack; } /** Sets the picture to use for effect previews for the dialog - * @param picture preview picture + * \param picture preview picture */ void setPreviewPicture( const QPicture &picture ); @@ -94,7 +94,7 @@ class GUI_EXPORT QgsEffectStackPropertiesWidget : public QgsPanelWidget, private void updatePreview(); /** Updates the effect stack when the currently selected effect changes properties. - * @param newEffect new effect to replace existing effect at selected position within the stack. + * \param newEffect new effect to replace existing effect at selected position within the stack. */ void changeEffect( QgsPaintEffect *newEffect ); @@ -110,7 +110,7 @@ class GUI_EXPORT QgsEffectStackPropertiesWidget : public QgsPanelWidget, private void loadStack(); /** Refreshes the widget to reflect the current state of a specified stack. - * @param stack QgsEffectStack for widget + * \param stack QgsEffectStack for widget */ void loadStack( QgsEffectStack *stack ); @@ -119,7 +119,7 @@ class GUI_EXPORT QgsEffectStackPropertiesWidget : public QgsPanelWidget, private void updateUi(); /** Returns the currently selected effect within the stack. - * @note not available in Python bindings + * \note not available in Python bindings */ EffectItem *currentEffectItem(); @@ -152,19 +152,19 @@ class GUI_EXPORT QgsEffectStackPropertiesDialog: public QgsDialog public: /** QgsEffectStackPropertiesDialog constructor - * @param stack QgsEffectStack to modify in the dialog - * @param parent parent widget - * @param f window flags + * \param stack QgsEffectStack to modify in the dialog + * \param parent parent widget + * \param f window flags */ QgsEffectStackPropertiesDialog( QgsEffectStack *stack, QWidget *parent = nullptr, Qt::WindowFlags f = 0 ); /** Returns effect stack attached to the dialog - * @returns QgsEffectStack modified by the dialog + * \returns QgsEffectStack modified by the dialog */ QgsEffectStack *stack(); /** Sets the picture to use for effect previews for the dialog - * @param picture preview picture + * \param picture preview picture */ void setPreviewPicture( const QPicture &picture ); @@ -193,8 +193,8 @@ class GUI_EXPORT QgsEffectStackCompactWidget: public QgsPanelWidget public: /** QgsEffectStackCompactWidget constructor - * @param parent parent widget - * @param effect QgsPaintEffect for modification by the widget. If the effect + * \param parent parent widget + * \param effect QgsPaintEffect for modification by the widget. If the effect * is not a QgsEffectStack, it will be automatically converted to an effect * stack consisting of the original effect */ @@ -202,21 +202,21 @@ class GUI_EXPORT QgsEffectStackCompactWidget: public QgsPanelWidget ~QgsEffectStackCompactWidget(); /** Sets paint effect attached to the widget, - * @param effect QgsPaintEffect for modification by the widget. If the effect + * \param effect QgsPaintEffect for modification by the widget. If the effect * is not a QgsEffectStack, it will be automatically converted to an effect * stack consisting of the original effect - * @see paintEffect + * \see paintEffect */ void setPaintEffect( QgsPaintEffect *effect ); /** Returns paint effect attached to the widget - * @returns QgsPaintEffect modified by the widget - * @see setPaintEffect + * \returns QgsPaintEffect modified by the widget + * \see setPaintEffect */ QgsPaintEffect *paintEffect() const; /** Sets the picture to use for effect previews for the dialog - * @param picture preview picture + * \param picture preview picture */ void setPreviewPicture( const QPicture &picture ); diff --git a/src/gui/effects/qgspainteffectpropertieswidget.h b/src/gui/effects/qgspainteffectpropertieswidget.h index cac4ce467731..616bae7b5038 100644 --- a/src/gui/effects/qgspainteffectpropertieswidget.h +++ b/src/gui/effects/qgspainteffectpropertieswidget.h @@ -36,8 +36,8 @@ class GUI_EXPORT QgsPaintEffectPropertiesWidget : public QWidget, private Ui::Ef public: /** QgsPaintEffectPropertiesWidget constructor - * @param effect QgsPaintEffect to modify in the widget - * @param parent parent widget + * \param effect QgsPaintEffect to modify in the widget + * \param parent parent widget */ QgsPaintEffectPropertiesWidget( QgsPaintEffect *effect, QWidget *parent = nullptr ); diff --git a/src/gui/effects/qgspainteffectwidget.h b/src/gui/effects/qgspainteffectwidget.h index bdaf49721c9b..f55bb74d6f70 100644 --- a/src/gui/effects/qgspainteffectwidget.h +++ b/src/gui/effects/qgspainteffectwidget.h @@ -44,7 +44,7 @@ class GUI_EXPORT QgsPaintEffectWidget : public QWidget /** * Sets the paint effect to modify with the widget - * @param effect paint effect + * \param effect paint effect */ virtual void setPaintEffect( QgsPaintEffect *effect ) = 0; diff --git a/src/gui/layertree/qgscustomlayerorderwidget.h b/src/gui/layertree/qgscustomlayerorderwidget.h index 7fd95ae9a3f7..d444b298fb91 100644 --- a/src/gui/layertree/qgscustomlayerorderwidget.h +++ b/src/gui/layertree/qgscustomlayerorderwidget.h @@ -36,7 +36,7 @@ class QListView; * propagated to the assigned QgsLayerTreeMapCanvasBridge. Also, any updates * to the layer tree cause refresh of the list. * - * @see QgsLayerTreeMapCanvasBridge + * \see QgsLayerTreeMapCanvasBridge * \since QGIS 2.4 */ class GUI_EXPORT QgsCustomLayerOrderWidget : public QWidget diff --git a/src/gui/layertree/qgslayertreeembeddedconfigwidget.h b/src/gui/layertree/qgslayertreeembeddedconfigwidget.h index 1008a53f054e..8afb7dcc3520 100644 --- a/src/gui/layertree/qgslayertreeembeddedconfigwidget.h +++ b/src/gui/layertree/qgslayertreeembeddedconfigwidget.h @@ -24,7 +24,7 @@ class QgsMapLayer; /** \ingroup gui * \class QgsLayerTreeEmbeddedConfigWidget * A widget to configure layer tree embedded widgets for a particular map layer. - * @note introduced in QGIS 2.16 + * \since QGIS 2.16 */ class GUI_EXPORT QgsLayerTreeEmbeddedConfigWidget : public QWidget, protected Ui::QgsLayerTreeEmbeddedConfigWidget { @@ -33,7 +33,7 @@ class GUI_EXPORT QgsLayerTreeEmbeddedConfigWidget : public QWidget, protected Ui /** * A widget to configure layer tree embedded widgets for a particular map layer. - * @param parent The parent of the widget. + * \param parent The parent of the widget. */ QgsLayerTreeEmbeddedConfigWidget( QWidget *parent = nullptr ); diff --git a/src/gui/layertree/qgslayertreeembeddedwidgetregistry.h b/src/gui/layertree/qgslayertreeembeddedwidgetregistry.h index 08aaacbb15a2..a28d6a7f3bfc 100644 --- a/src/gui/layertree/qgslayertreeembeddedwidgetregistry.h +++ b/src/gui/layertree/qgslayertreeembeddedwidgetregistry.h @@ -27,8 +27,8 @@ class QgsMapLayer; * \class QgsLayerTreeEmbeddedWidgetProvider * Provider interface to be implemented in order to introduce new kinds of embedded widgets for use in layer tree. * Embedded widgets are assigned per individual map layers and they are shown before any legend entries. - * @see QgsLayerTreeEmbeddedWidgetRegistry - * @note introduced in QGIS 2.16 + * \see QgsLayerTreeEmbeddedWidgetRegistry + * \since QGIS 2.16 */ class GUI_EXPORT QgsLayerTreeEmbeddedWidgetProvider { @@ -56,8 +56,8 @@ class GUI_EXPORT QgsLayerTreeEmbeddedWidgetProvider * Embedded widgets are assigned per individual map layers and they are shown before any legend entries. * Layer tree must have UseEmbeddedWidgets flag enabled in order to show assigned widgets. * - * @see QgsLayerTreeEmbeddedWidgetRegistry - * @note introduced in QGIS 2.16 + * \see QgsLayerTreeEmbeddedWidgetRegistry + * \since QGIS 2.16 */ class GUI_EXPORT QgsLayerTreeEmbeddedWidgetRegistry { diff --git a/src/gui/layertree/qgslayertreeembeddedwidgetsimpl.h b/src/gui/layertree/qgslayertreeembeddedwidgetsimpl.h index 66d427ca25e5..c09575d7fb1e 100644 --- a/src/gui/layertree/qgslayertreeembeddedwidgetsimpl.h +++ b/src/gui/layertree/qgslayertreeembeddedwidgetsimpl.h @@ -27,9 +27,9 @@ class QgsMapLayer; ///@cond PRIVATE /** - * @brief Implementation of simple transparency widget to be used in layer tree view + * \brief Implementation of simple transparency widget to be used in layer tree view * - * @note private class - not in QGIS API + * \note private class - not in QGIS API */ class QgsLayerTreeTransparencyWidget : public QWidget { diff --git a/src/gui/layertree/qgslayertreeview.h b/src/gui/layertree/qgslayertreeview.h index 3daa62f0aa3c..1e17ee28cbdb 100644 --- a/src/gui/layertree/qgslayertreeview.h +++ b/src/gui/layertree/qgslayertreeview.h @@ -41,7 +41,7 @@ class QgsMapLayer; * Allows the client to specify a context menu provider with custom actions. Also it comes * with a set of default actions that can be used when building context menu. * - * @see QgsLayerTreeModel + * \see QgsLayerTreeModel * \since QGIS 2.4 */ class GUI_EXPORT QgsLayerTreeView : public QTreeView @@ -140,7 +140,7 @@ class GUI_EXPORT QgsLayerTreeView : public QTreeView * Implementation of this interface can be implemented to allow QgsLayerTreeView * instance to provide custom context menus (opened upon right-click). * - * @see QgsLayerTreeView + * \see QgsLayerTreeView * \since QGIS 2.4 */ class GUI_EXPORT QgsLayerTreeViewMenuProvider diff --git a/src/gui/layertree/qgslayertreeviewdefaultactions.h b/src/gui/layertree/qgslayertreeviewdefaultactions.h index 6e4be949bcf8..acfc3374d120 100644 --- a/src/gui/layertree/qgslayertreeviewdefaultactions.h +++ b/src/gui/layertree/qgslayertreeviewdefaultactions.h @@ -32,7 +32,7 @@ class QgsMapLayer; * The QgsLayerTreeViewDefaultActions class serves as a factory of actions * that can be used together with a layer tree view. * - * @see QgsLayerTreeView + * \see QgsLayerTreeView * \since QGIS 2.4 */ class GUI_EXPORT QgsLayerTreeViewDefaultActions : public QObject diff --git a/src/gui/qgisgui.h b/src/gui/qgisgui.h index 50314cc927d6..bbcebdfe9a2c 100644 --- a/src/gui/qgisgui.h +++ b/src/gui/qgisgui.h @@ -31,7 +31,7 @@ class QFont; namespace QgisGui { - /*! + /** * /var ModalDialogFlags * /brief Flags used to create a modal dialog (adapted from QMessageBox). * @@ -52,14 +52,14 @@ namespace QgisGui /** * Minimum magnification level allowed in map canvases. - * @see CANVAS_MAGNIFICATION_MAX + * \see CANVAS_MAGNIFICATION_MAX * \since QGIS 3.0 */ constexpr double CANVAS_MAGNIFICATION_MIN = 0.1; /** * Maximum magnification level allowed in map canvases. - * @see CANVAS_MAGNIFICATION_MAX + * \see CANVAS_MAGNIFICATION_MAX * \since QGIS 3.0 */ // Must be a factor of 2, so zooming in to max from 100% then zooming back out will result in 100% mag @@ -70,13 +70,13 @@ namespace QgisGui last one used, if any; also, prefer to start in the last directory associated with filterName. - @param filterName the name of the filter; used for persistent store key - @param filters the file filters used for QFileDialog - @param selectedFiles string list of selected files; will be empty if none selected - @param enc encoding? - @param title the title for the dialog - @param cancelAll add button to cancel further requests - @note + \param filterName the name of the filter; used for persistent store key + \param filters the file filters used for QFileDialog + \param selectedFiles string list of selected files; will be empty if none selected + \param enc encoding? + \param title the title for the dialog + \param cancelAll add button to cancel further requests + \note Stores persistent settings under /UI/. The sub-keys will be filterName and filterName + "Dir". @@ -94,10 +94,10 @@ namespace QgisGui /** A helper function to get an image name from the user. It will nicely * provide filters with all available writable image formats. - * @param parent widget that should act as the parent for the file dialog - * @param message the message to display to the user - * @param defaultFilename default file name (empty by default) - * @return QPair where first is the file name and second is + * \param parent widget that should act as the parent for the file dialog + * \param message the message to display to the user + * \param defaultFilename default file name (empty by default) + * \returns QPair where first is the file name and second is * the file type */ QPair GUI_EXPORT getSaveAsImageName( QWidget *parent, const QString &message, const QString &defaultFilename = QString::null ); @@ -115,17 +115,17 @@ namespace QgisGui /** * Create file filters suitable for use with QFileDialog * - * @param format extension e.g. "png" - * @return QString e.g. "PNG format (*.png, *.PNG)" + * \param format extension e.g. "png" + * \returns QString e.g. "PNG format (*.png, *.PNG)" */ QString GUI_EXPORT createFileFilter_( QString const &format ); /** * Show font selection dialog - * @param ok true on ok, false on cancel - * @param initial initial font - * @param title optional dialog title - * @return QFont the selected fon + * \param ok true on ok, false on cancel + * \param initial initial font + * \param title optional dialog title + * \returns QFont the selected fon */ QFont GUI_EXPORT getFont( bool &ok, const QFont &initial, const QString &title = QString() ); } diff --git a/src/gui/qgisinterface.h b/src/gui/qgisinterface.h index a99db0e816fa..12562bb98f36 100644 --- a/src/gui/qgisinterface.h +++ b/src/gui/qgisinterface.h @@ -86,8 +86,8 @@ class GUI_EXPORT QgisInterface : public QObject * If menu argument is not empty, the action will be also added to a menu within the main window, * creating menu with the given name if it does not exist yet. * - * @see removeCustomActionForLayerType() - * @see addCustomActionForLayer() + * \see removeCustomActionForLayerType() + * \see addCustomActionForLayer() */ virtual void addCustomActionForLayerType( QAction *action, QString menu, QgsMapLayer::LayerType type, bool allLayers ) = 0; @@ -95,12 +95,12 @@ class GUI_EXPORT QgisInterface : public QObject /** Add action to context menu for a specific layer in the layer tree. * It is necessary to first call addCustomActionForLayerType() with allLayers=false * in order for this method to have any effect. - * @see addCustomActionForLayerType() + * \see addCustomActionForLayerType() */ virtual void addCustomActionForLayer( QAction *action, QgsMapLayer *layer ) = 0; /** Remove action for layers in the layer tree previously added with addCustomActionForLayerType() - * @see addCustomActionForLayerType() + * \see addCustomActionForLayerType() */ virtual bool removeCustomActionForLayerType( QAction *action ) = 0; @@ -113,14 +113,14 @@ class GUI_EXPORT QgisInterface : public QObject /** * Create a new map canvas with the specified unique \a name. * \since QGIS 3.0 - * @see closeMapCanvas() + * \see closeMapCanvas() */ virtual QgsMapCanvas *createNewMapCanvas( const QString &name ) = 0; /** * Closes the additional map canvas with matching \a name. * \since QGIS 3.0 - * @see createNewMapCanvas() + * \see createNewMapCanvas() */ virtual void closeMapCanvas( const QString &name ) = 0; @@ -166,11 +166,11 @@ class GUI_EXPORT QgisInterface : public QObject /** * Add a widget to the plugins toolbar. - * To remove this widget again, call {@link removeToolBarIcon} + * To remove this widget again, call removeToolBarIcon() * with the returned QAction. * - * @param widget widget to add. The toolbar will take ownership of this widget - * @return the QAction you can use to remove this widget from the toolbar + * \param widget widget to add. The toolbar will take ownership of this widget + * \returns the QAction you can use to remove this widget from the toolbar */ virtual QAction *addToolBarWidget( QWidget *widget ) = 0; @@ -179,11 +179,11 @@ class GUI_EXPORT QgisInterface : public QObject /** * Add a widget to the raster toolbar. - * To remove this widget again, call {@link removeRasterToolBarIcon} + * To remove this widget again, call removeRasterToolBarIcon() * with the returned QAction. * - * @param widget widget to add. The toolbar will take ownership of this widget - * @return the QAction you can use to remove this widget from the toolbar + * \param widget widget to add. The toolbar will take ownership of this widget + * \returns the QAction you can use to remove this widget from the toolbar */ virtual QAction *addRasterToolBarWidget( QWidget *widget ) = 0; @@ -198,11 +198,11 @@ class GUI_EXPORT QgisInterface : public QObject /** * Add a widget to the vector toolbar. - * To remove this widget again, call {@link removeVectorToolBarIcon} + * To remove this widget again, call removeVectorToolBarIcon() * with the returned QAction. * - * @param widget widget to add. The toolbar will take ownership of this widget - * @return the QAction you can use to remove this widget from the toolbar + * \param widget widget to add. The toolbar will take ownership of this widget + * \returns the QAction you can use to remove this widget from the toolbar */ virtual QAction *addVectorToolBarWidget( QWidget *widget ) = 0; @@ -214,11 +214,11 @@ class GUI_EXPORT QgisInterface : public QObject /** * Add a widget to the database toolbar. - * To remove this widget again, call {@link removeDatabaseToolBarIcon} + * To remove this widget again, call removeDatabaseToolBarIcon() * with the returned QAction. * - * @param widget widget to add. The toolbar will take ownership of this widget - * @return the QAction you can use to remove this widget from the toolbar + * \param widget widget to add. The toolbar will take ownership of this widget + * \returns the QAction you can use to remove this widget from the toolbar */ virtual QAction *addDatabaseToolBarWidget( QWidget *widget ) = 0; @@ -230,11 +230,11 @@ class GUI_EXPORT QgisInterface : public QObject /** * Add a widget to the web toolbar. - * To remove this widget again, call {@link removeWebToolBarIcon} + * To remove this widget again, call removeWebToolBarIcon() * with the returned QAction. * - * @param widget widget to add. The toolbar will take ownership of this widget - * @return the QAction you can use to remove this widget from the toolbar + * \param widget widget to add. The toolbar will take ownership of this widget + * \returns the QAction you can use to remove this widget from the toolbar */ virtual QAction *addWebToolBarWidget( QWidget *widget ) = 0; @@ -281,7 +281,7 @@ class GUI_EXPORT QgisInterface : public QObject * brings an already open composer window to the foreground if one * is already created for the composition. * \since QGIS 3.0 - * @see closeComposer() + * \see closeComposer() */ virtual QgsComposerInterface *openComposer( QgsComposition *composition ) = 0; @@ -289,7 +289,7 @@ class GUI_EXPORT QgisInterface : public QObject * Closes an open composer window showing the specified \a composition. * The composition remains unaffected. * \since QGIS 3.0 - * @see openComposer() + * \see openComposer() */ virtual void closeComposer( QgsComposition *composition ) = 0; @@ -304,7 +304,7 @@ class GUI_EXPORT QgisInterface : public QObject virtual QMap defaultStyleSheetOptions() = 0; /** Generate stylesheet - * @param opts generated default option values, or a changed copy of them + * \param opts generated default option values, or a changed copy of them */ virtual void buildStyleSheet( const QMap &opts ) = 0; @@ -383,40 +383,40 @@ class GUI_EXPORT QgisInterface : public QObject /** Register a new tab in the vector layer properties dialog. * \since QGIS 2.16 - * @note Ownership of the factory is not transferred, and the factory must + * \note Ownership of the factory is not transferred, and the factory must * be unregistered when plugin is unloaded. - * @see unregisterMapLayerPropertiesFactory() */ + * \see unregisterMapLayerPropertiesFactory() */ virtual void registerMapLayerConfigWidgetFactory( QgsMapLayerConfigWidgetFactory *factory ) = 0; /** Unregister a previously registered tab in the vector layer properties dialog. * \since QGIS 2.16 - * @see registerMapLayerPropertiesFactory() + * \see registerMapLayerPropertiesFactory() */ virtual void unregisterMapLayerConfigWidgetFactory( QgsMapLayerConfigWidgetFactory *factory ) = 0; /** Register a new tab in the options dialog. * \since QGIS 3.0 - * @note Ownership of the factory is not transferred, and the factory must + * \note Ownership of the factory is not transferred, and the factory must * be unregistered when plugin is unloaded. - * @see unregisterOptionsWidgetFactory() */ + * \see unregisterOptionsWidgetFactory() */ virtual void registerOptionsWidgetFactory( QgsOptionsWidgetFactory *factory ) = 0; /** Unregister a previously registered tab in the options dialog. * \since QGIS 3.0 - * @see registerOptionsWidgetFactory() + * \see registerOptionsWidgetFactory() */ virtual void unregisterOptionsWidgetFactory( QgsOptionsWidgetFactory *factory ) = 0; /** Register a new custom drop handler. * \since QGIS 3.0 - * @note Ownership of the factory is not transferred, and the factory must + * \note Ownership of the factory is not transferred, and the factory must * be unregistered when plugin is unloaded. - * @see unregisterCustomDropHandler() */ + * \see unregisterCustomDropHandler() */ virtual void registerCustomDropHandler( QgsCustomDropHandler *handler ) = 0; /** Unregister a previously registered custom drop handler. * \since QGIS 3.0 - * @see registerCustomDropHandler() */ + * \see registerCustomDropHandler() */ virtual void unregisterCustomDropHandler( QgsCustomDropHandler *handler ) = 0; // @todo is this deprecated in favour of QgsContextHelp? @@ -424,10 +424,10 @@ class GUI_EXPORT QgisInterface : public QObject /** Open a url in the users browser. By default the QGIS doc directory is used * as the base for the URL. To open a URL that is not relative to the installed * QGIS documentation, set useQgisDocDirectory to false. - * @param url URL to open - * @param useQgisDocDirectory If true, the URL will be formed by concatenating + * \param url URL to open + * \param useQgisDocDirectory If true, the URL will be formed by concatenating * url to the QGIS documentation directory path (prefix/share/doc) - * @deprecated + * \deprecated */ #ifndef Q_MOC_RUN Q_DECL_DEPRECATED @@ -604,20 +604,20 @@ class GUI_EXPORT QgisInterface : public QObject /** * Open feature form - * @param l vector layer - * @param f feature to show/modify - * @param updateFeatureOnly only update the feature update (don't change any attributes of the layer) [UNUSED] - * @param showModal if true, will wait for the dialog to be executed (only shown otherwise) + * \param l vector layer + * \param f feature to show/modify + * \param updateFeatureOnly only update the feature update (don't change any attributes of the layer) [UNUSED] + * \param showModal if true, will wait for the dialog to be executed (only shown otherwise) */ virtual bool openFeatureForm( QgsVectorLayer *l, QgsFeature &f, bool updateFeatureOnly = false, bool showModal = true ) = 0; /** * Returns a feature form for a given feature * - * @param l The layer for which the dialog will be created - * @param f The feature for which the dialog will be created + * \param l The layer for which the dialog will be created + * \param f The feature for which the dialog will be created * - * @return A feature form + * \returns A feature form */ virtual QgsAttributeDialog *getFeatureForm( QgsVectorLayer *l, QgsFeature &f ) = 0; @@ -626,7 +626,7 @@ class GUI_EXPORT QgisInterface : public QObject * With the help of this you can access methods like addFeature, startEditing * or stopEditing while giving the user the appropriate dialogs. * - * @return An instance of the vector layer tools + * \returns An instance of the vector layer tools */ virtual QgsVectorLayerTools *vectorLayerTools() = 0; @@ -644,8 +644,8 @@ class GUI_EXPORT QgisInterface : public QObject virtual void preloadForm( const QString &uifile ) = 0; /** Return vector layers in edit mode - * @param modified whether to return only layers that have been modified - * @returns list of layers in legend order, or empty list */ + * \param modified whether to return only layers that have been modified + * \returns list of layers in legend order, or empty list */ virtual QList editableLayers( bool modified = false ) const = 0; //! Get timeout for timed messages: default of 5 seconds @@ -661,7 +661,7 @@ class GUI_EXPORT QgisInterface : public QObject /** * This signal is emitted when a new composer window has been opened. * \since QGIS 3.0 - * @see composerWillBeClosed() + * \see composerWillBeClosed() */ void composerOpened( QgsComposerInterface *composer ); @@ -669,16 +669,16 @@ class GUI_EXPORT QgisInterface : public QObject * This signal is emitted before a composer window is going to be closed * and deleted. * \since QGIS 3.0 - * @see composerClosed() - * @see composerOpened() + * \see composerClosed() + * \see composerOpened() */ void composerWillBeClosed( QgsComposerInterface *composer ); /** * This signal is emitted after a composer window is closed. * \since QGIS 3.0 - * @see composerWillBeClosed() - * @see composerOpened() + * \see composerWillBeClosed() + * \see composerOpened() */ void composerClosed( QgsComposerInterface *composer ); @@ -688,7 +688,7 @@ class GUI_EXPORT QgisInterface : public QObject void initializationCompleted(); /** Emitted when a project file is successfully read - * @note + * \note * This is useful for plug-ins that store properties with project files. A * plug-in can connect to this signal. When it is emitted, the plug-in * knows to then check the project properties for any relevant state. @@ -696,7 +696,7 @@ class GUI_EXPORT QgisInterface : public QObject void projectRead(); /** Emitted when starting an entirely new project - * @note + * \note * This is similar to projectRead(); plug-ins might want to be notified * that they're in a new project. Yes, projectRead() could have been * overloaded to be used in the case of new projects instead. However, @@ -706,7 +706,7 @@ class GUI_EXPORT QgisInterface : public QObject void newProjectCreated(); /** This signal is emitted when a layer has been saved using save as - * @note + * \note * added in version 2.7 */ void layerSavedAs( QgsMapLayer *l, const QString &path ); diff --git a/src/gui/qgsactionmenu.h b/src/gui/qgsactionmenu.h index e7d6fcf03da7..8365a17600bd 100644 --- a/src/gui/qgsactionmenu.h +++ b/src/gui/qgsactionmenu.h @@ -59,28 +59,28 @@ class GUI_EXPORT QgsActionMenu : public QMenu /** * Constructs a new QgsActionMenu * - * @param layer The layer that this action will be run upon. - * @param feature The feature that this action will be run upon. Make sure that this feature is available + * \param layer The layer that this action will be run upon. + * \param feature The feature that this action will be run upon. Make sure that this feature is available * for the lifetime of this object. - * @param parent The usual QWidget parent. - * @param actionScope The action scope this menu will run in + * \param parent The usual QWidget parent. + * \param actionScope The action scope this menu will run in */ explicit QgsActionMenu( QgsVectorLayer *layer, const QgsFeature &feature, const QString &actionScope, QWidget *parent = nullptr ); /** * Constructs a new QgsActionMenu * - * @param layer The layer that this action will be run upon. - * @param fid The feature id of the feature for which this action will be run. - * @param parent The usual QWidget parent. - * @param actionScope The action scope this menu will run in + * \param layer The layer that this action will be run upon. + * \param fid The feature id of the feature for which this action will be run. + * \param parent The usual QWidget parent. + * \param actionScope The action scope this menu will run in */ explicit QgsActionMenu( QgsVectorLayer *layer, const QgsFeatureId fid, const QString &actionScope, QWidget *parent = nullptr ); /** * Change the feature on which actions are performed * - * @param feature A feature. Will not take ownership. It's the callers responsibility to keep the feature + * \param feature A feature. Will not take ownership. It's the callers responsibility to keep the feature * as long as the menu is displayed and the action is running. */ void setFeature( const QgsFeature &feature ); diff --git a/src/gui/qgsadvanceddigitizingcanvasitem.h b/src/gui/qgsadvanceddigitizingcanvasitem.h index 5d7565d2f289..1edb4eb2b8b5 100644 --- a/src/gui/qgsadvanceddigitizingcanvasitem.h +++ b/src/gui/qgsadvanceddigitizingcanvasitem.h @@ -24,7 +24,7 @@ class QgsAdvancedDigitizingDockWidget; /** \ingroup gui - * @brief The QgsAdvancedDigitizingCanvasItem class draws the graphical elements of the CAD tools (@see QgsAdvancedDigitizingDockWidget) on the map canvas. + * \brief The QgsAdvancedDigitizingCanvasItem class draws the graphical elements of the CAD tools (\see QgsAdvancedDigitizingDockWidget) on the map canvas. */ class GUI_EXPORT QgsAdvancedDigitizingCanvasItem : public QgsMapCanvasItem { diff --git a/src/gui/qgsadvanceddigitizingdockwidget.h b/src/gui/qgsadvanceddigitizingdockwidget.h index 4e55a355a69d..3b93a7e35216 100644 --- a/src/gui/qgsadvanceddigitizingdockwidget.h +++ b/src/gui/qgsadvanceddigitizingdockwidget.h @@ -36,7 +36,7 @@ static const double SOFT_CONSTRAINT_TOLERANCE_PIXEL = 15; static const double SOFT_CONSTRAINT_TOLERANCE_DEGREES = 10; /** \ingroup gui - * @brief The QgsAdvancedDigitizingDockWidget class is a dockable widget + * \brief The QgsAdvancedDigitizingDockWidget class is a dockable widget * used to handle the CAD tools on top of a selection of map tools. * It handles both the UI and the constraints. Constraints are applied * by implementing filters called from QgsMapToolAdvancedDigitizing. @@ -82,9 +82,9 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private }; /** \ingroup gui - * @brief The CadConstraint is an abstract class for all basic constraints (angle/distance/x/y). + * \brief The CadConstraint is an abstract class for all basic constraints (angle/distance/x/y). * It contains all values (locked, value, relative) and pointers to corresponding widgets. - * @note Relative is not mandatory since it is not used for distance. + * \note Relative is not mandatory since it is not used for distance. */ class GUI_EXPORT CadConstraint { @@ -101,10 +101,10 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private }; /** Constructor for CadConstraint. - * @param lineEdit associated line edit for constraint value - * @param lockerButton associated button for locking constraint - * @param relativeButton optional button for toggling relative constraint mode - * @param repeatingLockButton optional button for toggling repeating lock mode + * \param lineEdit associated line edit for constraint value + * \param lockerButton associated button for locking constraint + * \param relativeButton optional button for toggling relative constraint mode + * \param repeatingLockButton optional button for toggling repeating lock mode */ CadConstraint( QLineEdit *lineEdit, QToolButton *lockerButton, QToolButton *relativeButton = nullptr, QToolButton *repeatingLockButton = nullptr ) : mLineEdit( lineEdit ) @@ -119,7 +119,7 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private /** * The current lock mode of this constraint - * @return Lock mode + * \returns Lock mode */ LockMode lockMode() const { return mLockMode; } @@ -131,7 +131,7 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private /** Returns true if a repeating lock is set for the constraint. Repeating locks are not * automatically cleared after a new point is added. * \since QGIS 2.16 - * @see setRepeatingLock() + * \see setRepeatingLock() */ bool isRepeatingLock() const { return mRepeatingLock; } @@ -157,9 +157,9 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private /** Sets whether a repeating lock is set for the constraint. Repeating locks are not * automatically cleared after a new point is added. - * @param repeating set to true to set the lock to repeat automatically + * \param repeating set to true to set the lock to repeat automatically * \since QGIS 2.16 - * @see isRepeatingLock() + * \see isRepeatingLock() */ void setRepeatingLock( bool repeating ); @@ -170,8 +170,8 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private /** * Set the value of the constraint - * @param value new value for constraint - * @param updateWidget set to false to prevent automatically updating the associated widget's value + * \param value new value for constraint + * \param updateWidget set to false to prevent automatically updating the associated widget's value */ void setValue( double value, bool updateWidget = true ); @@ -197,13 +197,13 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private }; //! performs the intersection of a circle and a line - //! @note from the two solutions, the intersection will be set to the closest point + //! \note from the two solutions, the intersection will be set to the closest point static bool lineCircleIntersection( const QgsPoint ¢er, const double radius, const QList &segment, QgsPoint &intersection ); /** * Create an advanced digitizing dock widget - * @param canvas The map canvas on which the widget operates - * @param parent The parent + * \param canvas The map canvas on which the widget operates + * \param parent The parent */ explicit QgsAdvancedDigitizingDockWidget( QgsMapCanvas *canvas, QWidget *parent = nullptr ); @@ -215,38 +215,38 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private /** * Will react on a canvas press event * - * @param e A mouse event (may be modified) - * @return If the event is hidden (construction mode hides events from the maptool) + * \param e A mouse event (may be modified) + * \returns If the event is hidden (construction mode hides events from the maptool) */ bool canvasPressEvent( QgsMapMouseEvent *e ); /** * Will react on a canvas release event * - * @param e A mouse event (may be modified) - * @param mode determines if the dock has to record one, two or many points. - * @return If the event is hidden (construction mode hides events from the maptool) + * \param e A mouse event (may be modified) + * \param mode determines if the dock has to record one, two or many points. + * \returns If the event is hidden (construction mode hides events from the maptool) */ bool canvasReleaseEvent( QgsMapMouseEvent *e, AdvancedDigitizingMode mode ); /** * Will react on a canvas move event * - * @param e A mouse event (may be modified) - * @return If the event is hidden (construction mode hides events from the maptool) + * \param e A mouse event (may be modified) + * \returns If the event is hidden (construction mode hides events from the maptool) */ bool canvasMoveEvent( QgsMapMouseEvent *e ); /** * Filter key events to e.g. toggle construction mode or adapt constraints * - * @param e A mouse event (may be modified) - * @return If the event is hidden (construction mode hides events from the maptool) + * \param e A mouse event (may be modified) + * \returns If the event is hidden (construction mode hides events from the maptool) */ bool canvasKeyPressEventFilter( QKeyEvent *e ); //! apply the CAD constraints. The will modify the position of the map event in map coordinates by applying the CAD constraints. - //! @return false if no solution was found (invalid constraints) + //! \returns false if no solution was found (invalid constraints) virtual bool applyConstraints( QgsMapMouseEvent *e ); /** @@ -256,7 +256,7 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private /** * The snapping mode - * @return Snapping mode + * \returns Snapping mode */ QgsMapMouseEvent::SnappingMode snappingMode() { return mSnappingMode; } @@ -338,7 +338,7 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private /** * Push a warning * - * @param message An informative message + * \param message An informative message */ void pushWarning( const QString &message ); @@ -351,7 +351,7 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private * Sometimes a constraint may change the current point out of a mouse event. This happens normally * when a constraint is toggled. * - * @param point The last known digitizing point. Can be used to emulate a mouse event. + * \param point The last known digitizing point. Can be used to emulate a mouse event. */ void pointChanged( const QgsPoint &point ); @@ -371,7 +371,7 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private void constraintFocusOut(); //! unlock all constraints - //! @param releaseRepeatingLocks set to false to preserve the lock for any constraints set to repeating lock mode + //! \param releaseRepeatingLocks set to false to preserve the lock for any constraints set to repeating lock mode void releaseLocks( bool releaseRepeatingLocks = true ); //! set the relative properties of constraints @@ -395,8 +395,8 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private void setCadEnabled( bool enabled ); /** - * @brief updateCapacity updates the cad capacities depending on the point list and update the UI according to the capabilities. - * @param updateUIwithoutChange if true, it will update the UI even if new capacities are not different from previous ones. + * \brief updateCapacity updates the cad capacities depending on the point list and update the UI according to the capabilities. + * \param updateUIwithoutChange if true, it will update the UI even if new capacities are not different from previous ones. */ void updateCapacity( bool updateUIwithoutChange = false ); @@ -419,7 +419,7 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private void clearPoints(); //! filters key press - //! @note called by eventFilter (filter on line edits), canvasKeyPressEvent (filter on map tool) and keyPressEvent (filter on dock) + //! \note called by eventFilter (filter on line edits), canvasKeyPressEvent (filter on map tool) and keyPressEvent (filter on dock) bool filterKeyPress( QKeyEvent *e ); //! event filter for line edits in the dock UI (angle/distance/x/y line edits) @@ -435,9 +435,9 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private double parseUserInput( const QString &inputValue, bool &ok ) const; /** Updates a constraint value based on a text input. - * @param constraint constraint to update - * @param textValue user entered text value, may be an expression - * @param convertExpression set to true to update widget contents to calculated expression value + * \param constraint constraint to update + * \param textValue user entered text value, may be an expression + * \param convertExpression set to true to update widget contents to calculated expression value */ void updateConstraintValue( CadConstraint *constraint, const QString &textValue, bool convertExpression = false ); diff --git a/src/gui/qgsattributedialog.h b/src/gui/qgsattributedialog.h index c5e8b2641fa0..8f2489426a6f 100644 --- a/src/gui/qgsattributedialog.h +++ b/src/gui/qgsattributedialog.h @@ -41,12 +41,12 @@ class GUI_EXPORT QgsAttributeDialog : public QDialog /** * Create an attribute dialog for a given layer and feature * - * @param vl The layer for which the dialog will be generated - * @param thepFeature A feature for which the dialog will be generated - * @param featureOwner Set to true, if the dialog should take ownership of the feature - * @param parent A parent widget for the dialog - * @param showDialogButtons True: Show the dialog buttons accept/cancel - * @param context The context in which this dialog is created + * \param vl The layer for which the dialog will be generated + * \param thepFeature A feature for which the dialog will be generated + * \param featureOwner Set to true, if the dialog should take ownership of the feature + * \param parent A parent widget for the dialog + * \param showDialogButtons True: Show the dialog buttons accept/cancel + * \param context The context in which this dialog is created * */ QgsAttributeDialog( QgsVectorLayer *vl, QgsFeature *thepFeature, bool featureOwner, QWidget *parent = nullptr, bool showDialogButtons = true, const QgsAttributeEditorContext &context = QgsAttributeEditorContext() ); @@ -64,8 +64,8 @@ class GUI_EXPORT QgsAttributeDialog : public QDialog void restoreGeometry(); /** - * @brief setHighlight - * @param h The highlight. Ownership is taken. + * \brief setHighlight + * \param h The highlight. Ownership is taken. */ void setHighlight( QgsHighlight *h ); @@ -76,13 +76,13 @@ class GUI_EXPORT QgsAttributeDialog : public QDialog /** * Is this dialog editable? * - * @return returns true, if this dialog was created in an editable manner. + * \returns returns true, if this dialog was created in an editable manner. */ bool editable() { return mAttributeForm->editable(); } /** * Toggles the form mode. - * @param mode form mode. For example, if set to QgsAttributeForm::AddFeatureMode, the dialog will be editable even with an invalid feature and + * \param mode form mode. For example, if set to QgsAttributeForm::AddFeatureMode, the dialog will be editable even with an invalid feature and * will add a new feature when the form is accepted. */ void setMode( QgsAttributeForm::Mode mode ) { mAttributeForm->setMode( mode ); } @@ -90,16 +90,16 @@ class GUI_EXPORT QgsAttributeDialog : public QDialog /** * Sets the edit command message (Undo) that will be used when the dialog is accepted * - * @param message The message + * \param message The message */ void setEditCommandMessage( const QString &message ) { mAttributeForm->setEditCommandMessage( message ); } /** * Intercept window activate/deactive events to show/hide the highlighted feature. * - * @param e The event + * \param e The event * - * @return The same as the parent QDialog + * \returns The same as the parent QDialog */ virtual bool event( QEvent *e ) override; diff --git a/src/gui/qgsattributeeditorcontext.h b/src/gui/qgsattributeeditorcontext.h index 03a4e45b0520..8a3d31e8f3df 100644 --- a/src/gui/qgsattributeeditorcontext.h +++ b/src/gui/qgsattributeeditorcontext.h @@ -105,27 +105,27 @@ class GUI_EXPORT QgsAttributeEditorContext inline RelationMode relationMode() const { return mRelationMode; } /** Returns the form mode. - * @see setFormMode() + * \see setFormMode() */ inline FormMode formMode() const { return mFormMode; } /** Sets the form mode. - * @param mode form mode - * @see formMode() + * \param mode form mode + * \see formMode() * \since QGIS 2.16 */ inline void setFormMode( FormMode mode ) { mFormMode = mode; } /** Returns true if the attribute editor should permit use of custom UI forms. - * @see setAllowCustomUi() + * \see setAllowCustomUi() * \since QGIS 2.16 */ bool allowCustomUi() const { return mAllowCustomUi; } /** Sets whether the attribute editor should permit use of custom UI forms. - * @param allow set to true to allow custom UI forms, or false to disable them and use default generated + * \param allow set to true to allow custom UI forms, or false to disable them and use default generated * QGIS forms - * @see allowCustomUi() + * \see allowCustomUi() * \since QGIS 2.16 */ void setAllowCustomUi( bool allow ) { mAllowCustomUi = allow; } diff --git a/src/gui/qgsattributeform.h b/src/gui/qgsattributeform.h index c26c646d15f6..c699de7a6ac2 100644 --- a/src/gui/qgsattributeform.h +++ b/src/gui/qgsattributeform.h @@ -68,14 +68,14 @@ class GUI_EXPORT QgsAttributeForm : public QWidget /** * Hides the button box (Ok/Cancel) and enables auto-commit - * @note set Embed in QgsAttributeEditorContext in constructor instead + * \note set Embed in QgsAttributeEditorContext in constructor instead */ // TODO QGIS 3.0 - make private void hideButtonBox(); /** * Shows the button box (Ok/Cancel) and disables auto-commit - * @note set Embed in QgsAttributeEditorContext in constructor instead + * \note set Embed in QgsAttributeEditorContext in constructor instead */ // TODO QGIS 3.0 - make private void showButtonBox(); @@ -89,63 +89,63 @@ class GUI_EXPORT QgsAttributeForm : public QWidget /** * Takes ownership - * @param iface + * \param iface */ void addInterface( QgsAttributeFormInterface *iface ); /** * Returns the layer for which this form is shown * - * @return Layer + * \returns Layer */ QgsVectorLayer *layer() { return mLayer; } /** * Returns if the form is currently in editable mode. * - * @return Editable mode of this form + * \returns Editable mode of this form */ bool editable(); /** Returns the current mode of the form. * \since QGIS 2.16 - * @see setMode() + * \see setMode() */ Mode mode() const { return mMode; } /** Sets the current mode of the form. - * @param mode form mode + * \param mode form mode * \since QGIS 2.16 - * @see mode() + * \see mode() */ void setMode( Mode mode ); /** * Sets the edit command message (Undo) that will be used when the dialog is accepted * - * @param message The message + * \param message The message */ void setEditCommandMessage( const QString &message ) { mEditCommandMessage = message; } /** * Intercepts keypress on custom form (escape should not close it) * - * @param object The object for which the event has been sent - * @param event The event which is being filtered + * \param object The object for which the event has been sent + * \param event The event which is being filtered * - * @return true if the event has been handled (key was ESC) + * \returns true if the event has been handled (key was ESC) */ bool eventFilter( QObject *object, QEvent *event ) override; /** Sets all feature IDs which are to be edited if the form is in multiedit mode - * @param fids feature ID list + * \param fids feature ID list * \since QGIS 2.16 */ void setMultiEditFeatureIds( const QgsFeatureIds &fids ); /** Sets the message bar to display feedback from the form in. This is used in the search/filter * mode to display the count of selected features. - * @param messageBar target message bar + * \param messageBar target message bar * \since QGIS 2.16 */ void setMessageBar( QgsMessageBar *messageBar ); @@ -155,8 +155,8 @@ class GUI_EXPORT QgsAttributeForm : public QWidget /** * Notifies about changes of attributes * - * @param attribute The name of the attribute that changed. - * @param value The new value of the attribute. + * \param attribute The name of the attribute that changed. + * \param value The new value of the attribute. */ void attributeChanged( const QString &attribute, const QVariant &value ); @@ -165,8 +165,8 @@ class GUI_EXPORT QgsAttributeForm : public QWidget * You can set the parameter ok to false to notify the form that you don't want it to be saved. * If you want the form to be saved, leave the parameter untouched. * - * @param ok Set this parameter to false if you don't want the form to be saved - * @note not available in Python bindings + * \param ok Set this parameter to false if you don't want the form to be saved + * \note not available in Python bindings */ void beforeSave( bool &ok ); @@ -176,14 +176,14 @@ class GUI_EXPORT QgsAttributeForm : public QWidget void featureSaved( const QgsFeature &feature ); /** Is emitted when a filter expression is set using the form. - * @param expression filter expression - * @param type filter type + * \param expression filter expression + * \param type filter type * \since QGIS 2.16 */ void filterExpressionSet( const QString &expression, QgsAttributeForm::FilterType type ); /** Emitted when the form changes mode. - * @param mode new mode + * \param mode new mode */ void modeChanged( QgsAttributeForm::Mode mode ); @@ -203,22 +203,22 @@ class GUI_EXPORT QgsAttributeForm : public QWidget /** * Call this to change the content of a given attribute. Will update the editor(s) related to this field. * - * @param field The field to change - * @param value The new value + * \param field The field to change + * \param value The new value */ void changeAttribute( const QString &field, const QVariant &value ); /** * Update all editors to correspond to a different feature. * - * @param feature The feature which will be represented by the form + * \param feature The feature which will be represented by the form */ void setFeature( const QgsFeature &feature ); /** * Save all the values from the editors to the layer. * - * @return True if successful + * \returns True if successful */ bool save(); diff --git a/src/gui/qgsattributeformeditorwidget.h b/src/gui/qgsattributeformeditorwidget.h index 9b2dc7f4b2f4..8cb785fc0f6a 100644 --- a/src/gui/qgsattributeformeditorwidget.h +++ b/src/gui/qgsattributeformeditorwidget.h @@ -53,8 +53,8 @@ class GUI_EXPORT QgsAttributeFormEditorWidget : public QWidget }; /** Constructor for QgsAttributeFormEditorWidget. - * @param editorWidget associated editor widget wrapper (for default/edit modes) - * @param form parent attribute form + * \param editorWidget associated editor widget wrapper (for default/edit modes) + * \param form parent attribute form */ explicit QgsAttributeFormEditorWidget( QgsEditorWidgetWrapper *editorWidget, QgsAttributeForm *form ); @@ -63,10 +63,10 @@ class GUI_EXPORT QgsAttributeFormEditorWidget : public QWidget /** Creates the search widget wrappers for the widget used when the form is in * search mode. - * @param widgetId id of the widget type to create a search wrapper for - * @param fieldIdx index of field associated with widget - * @param config configuration which should be used for the widget creation - * @param context editor context (not available in Python bindings) + * \param widgetId id of the widget type to create a search wrapper for + * \param fieldIdx index of field associated with widget + * \param config configuration which should be used for the widget creation + * \param context editor context (not available in Python bindings) */ void createSearchWidgetWrappers( const QString &widgetId, int fieldIdx, const QVariantMap &config, @@ -74,24 +74,24 @@ class GUI_EXPORT QgsAttributeFormEditorWidget : public QWidget /** Sets the current mode for the widget. The widget will adapt its state and visible widgets to * reflect the updated mode. For example, showing multi edit tool buttons if the mode is set to MultiEditMode. - * @param mode widget mode - * @see mode() + * \param mode widget mode + * \see mode() */ void setMode( Mode mode ); /** Returns the current mode for the widget. - * @see setMode() + * \see setMode() */ Mode mode() const { return mMode; } /** Resets the widget to an initial value. - * @param initialValue initial value to show in widget - * @param mixedValues set to true to initially show the mixed values state + * \param initialValue initial value to show in widget + * \param mixedValues set to true to initially show the mixed values state */ void initialize( const QVariant &initialValue, bool mixedValues = false ); /** Returns true if the widget's value has been changed since it was initialized. - * @see initialize() + * \see initialize() */ bool hasChanged() const { return mIsChanged; } @@ -108,7 +108,7 @@ class GUI_EXPORT QgsAttributeFormEditorWidget : public QWidget public slots: /** Sets whether the widget should be displayed in a "mixed values" mode. - * @param mixed set to true to show in a mixed values state + * \param mixed set to true to show in a mixed values state */ void setIsMixed( bool mixed ); @@ -123,7 +123,7 @@ class GUI_EXPORT QgsAttributeFormEditorWidget : public QWidget signals: //! Emitted when the widget's value changes - //! @param value new widget value + //! \param value new widget value void valueChanged( const QVariant &value ); private slots: @@ -143,31 +143,31 @@ class GUI_EXPORT QgsAttributeFormEditorWidget : public QWidget protected: /** Returns a pointer to the search widget tool button in the widget. - * @note this method is in place for unit testing only, and is not considered + * \note this method is in place for unit testing only, and is not considered * stable API */ QgsSearchWidgetToolButton *searchWidgetToolButton(); /** Sets the search widget wrapper for the widget used when the form is in * search mode. - * @param wrapper search widget wrapper. - * @note the search widget wrapper should be created using searchWidgetFrame() + * \param wrapper search widget wrapper. + * \note the search widget wrapper should be created using searchWidgetFrame() * as its parent - * @note this method is in place for unit testing only, and is not considered + * \note this method is in place for unit testing only, and is not considered * stable AP */ void setSearchWidgetWrapper( QgsSearchWidgetWrapper *wrapper ); /** Returns the widget which should be used as a parent during construction * of the search widget wrapper. - * @note this method is in place for unit testing only, and is not considered + * \note this method is in place for unit testing only, and is not considered * stable AP */ QWidget *searchWidgetFrame(); /** Returns the search widget wrapper used in this widget. The wrapper must * first be created using createSearchWidgetWrapper() - * @note this method is in place for unit testing only, and is not considered + * \note this method is in place for unit testing only, and is not considered * stable AP */ QList< QgsSearchWidgetWrapper * > searchWidgetWrappers(); diff --git a/src/gui/qgsattributeformlegacyinterface.h b/src/gui/qgsattributeformlegacyinterface.h index b08796dc2225..3ffe17caea4e 100644 --- a/src/gui/qgsattributeformlegacyinterface.h +++ b/src/gui/qgsattributeformlegacyinterface.h @@ -24,7 +24,7 @@ /** \ingroup gui * This class helps to support legacy open form scripts to be compatible with the new * QgsAttributeForm style interface. - * @note not available in Python bindings + * \note not available in Python bindings */ class GUI_EXPORT QgsAttributeFormLegacyInterface : public QgsAttributeFormInterface { diff --git a/src/gui/qgsattributetypeloaddialog.h b/src/gui/qgsattributetypeloaddialog.h index 716266041264..2a7e4c5eeb0e 100644 --- a/src/gui/qgsattributetypeloaddialog.h +++ b/src/gui/qgsattributetypeloaddialog.h @@ -46,20 +46,20 @@ class GUI_EXPORT QgsAttributeTypeLoadDialog: public QDialog, private Ui::QgsAttr /** * Sets predefined vector layer for selection of data - * @param layer Vector layer which is to be set as predefined one + * \param layer Vector layer which is to be set as predefined one */ void setVectorLayer( QgsVectorLayer *layer ); /** * Getter to value map which is currently active - * @return value map of vlues selected from layer + * \returns value map of vlues selected from layer */ QMap &valueMap(); /** * Returns true if the "Add NULL value" checkbox has been checked. * - * @return true if the "Add NULL value" checkbox has been checked. + * \returns true if the "Add NULL value" checkbox has been checked. */ bool insertNull(); @@ -67,14 +67,14 @@ class GUI_EXPORT QgsAttributeTypeLoadDialog: public QDialog, private Ui::QgsAttr /** * Slot which reacts to change of selected layer to fill other two comboboxes with correct data - * @param layerIndex index of layer which was selected + * \param layerIndex index of layer which was selected */ void fillComboBoxes( int layerIndex ); /** * Slot to react to button push or change of selected column for display of preview - * @param fieldIndex indexOfChangedField - * @param full flag if all values should be displayed or just preview of first 10 + * \param fieldIndex indexOfChangedField + * \param full flag if all values should be displayed or just preview of first 10 */ void createPreview( int fieldIndex, bool full = false ); diff --git a/src/gui/qgsblendmodecombobox.cpp b/src/gui/qgsblendmodecombobox.cpp index a0015bf12b79..b9c7c41b7be1 100644 --- a/src/gui/qgsblendmodecombobox.cpp +++ b/src/gui/qgsblendmodecombobox.cpp @@ -30,11 +30,6 @@ QgsBlendModeComboBox::QgsBlendModeComboBox( QWidget *parent ) : QComboBox( paren updateModes(); } -/* Returns a QStringList of the translated blend modes -* "-" is used to indicate the position of a separator in the list -* This list is designed to emulate GIMP's layer modes, where -* blending modes are grouped by their effect (lightening, darkening, etc) -*/ QStringList QgsBlendModeComboBox::blendModesList() const { return QStringList() << tr( "Normal" ) @@ -56,9 +51,6 @@ QStringList QgsBlendModeComboBox::blendModesList() const << tr( "Subtract" ); } -/* Populates the blend mode combo box, and sets up mapping for -* blend modes to combo box indexes -*/ void QgsBlendModeComboBox::updateModes() { blockSignals( true ); @@ -95,13 +87,11 @@ void QgsBlendModeComboBox::updateModes() blockSignals( false ); } -//! Function to read the selected blend mode QPainter::CompositionMode QgsBlendModeComboBox::blendMode() { return QgsPainting::getCompositionMode( ( QgsPainting::BlendMode ) mListIndexToBlendMode[ currentIndex()] ); } -//! Function to set the selected blend mode void QgsBlendModeComboBox::setBlendMode( QPainter::CompositionMode blendMode ) { setCurrentIndex( mBlendModeToListIndex[( int ) QgsPainting::getBlendModeEnum( blendMode )] ); diff --git a/src/gui/qgsblendmodecombobox.h b/src/gui/qgsblendmodecombobox.h index 287fbbc737b4..753929deb4f9 100644 --- a/src/gui/qgsblendmodecombobox.h +++ b/src/gui/qgsblendmodecombobox.h @@ -36,7 +36,12 @@ class GUI_EXPORT QgsBlendModeComboBox : public QComboBox //! Function to set the selected blend mode from QPainter::CompositionMode void setBlendMode( QPainter::CompositionMode blendMode ); private: - //! Returns a list of grouped blend modes (with separators) + + /** Returns a QStringList of the translated blend modes + * "-" is used to indicate the position of a separator in the list + * This list is designed to emulate GIMP's layer modes, where + * blending modes are grouped by their effect (lightening, darkening, etc) + */ QStringList blendModesList() const; //! Used to map blend modes across to their corresponding @@ -45,6 +50,10 @@ class GUI_EXPORT QgsBlendModeComboBox : public QComboBox std::vector mListIndexToBlendMode; public slots: + + /** Populates the blend mode combo box, and sets up mapping for + * blend modes to combo box indexes + */ void updateModes(); }; diff --git a/src/gui/qgsbrowsertreeview.h b/src/gui/qgsbrowsertreeview.h index 4eb4a9bcd2da..91974b282bc9 100644 --- a/src/gui/qgsbrowsertreeview.h +++ b/src/gui/qgsbrowsertreeview.h @@ -24,7 +24,7 @@ /** \ingroup gui * The QgsBrowserTreeView class extends QTreeView with save/restore tree state functionality. * - * @see QgsBrowserModel + * \see QgsBrowserModel * \since QGIS 2.8 */ class GUI_EXPORT QgsBrowserTreeView : public QTreeView diff --git a/src/gui/qgsbusyindicatordialog.h b/src/gui/qgsbusyindicatordialog.h index 16d4e9c1d6c2..f9c302d4712f 100644 --- a/src/gui/qgsbusyindicatordialog.h +++ b/src/gui/qgsbusyindicatordialog.h @@ -36,9 +36,9 @@ class GUI_EXPORT QgsBusyIndicatorDialog : public QDialog /** Constructor * Modal busy indicator dialog with no buttons. - * @param message Text to show above busy progress indicator. - * @param parent parent object (owner) - * @param fl widget flags + * \param message Text to show above busy progress indicator. + * \param parent parent object (owner) + * \param fl widget flags */ QgsBusyIndicatorDialog( const QString &message = "", QWidget *parent = nullptr, Qt::WindowFlags fl = QgisGui::ModalDialogFlags ); diff --git a/src/gui/qgscharacterselectdialog.cpp b/src/gui/qgscharacterselectdialog.cpp index c181585366e8..4963421f6542 100644 --- a/src/gui/qgscharacterselectdialog.cpp +++ b/src/gui/qgscharacterselectdialog.cpp @@ -31,9 +31,9 @@ QgsCharacterSelectorDialog::QgsCharacterSelectorDialog( QWidget *parent, Qt::Win const QChar &QgsCharacterSelectorDialog::selectCharacter( bool *gotChar, const QFont &font, const QString &style ) { mCharSelectLabelFont->setText( QStringLiteral( "%1 %2" ).arg( font.family(), style ) ); - mCharWidget->updateFont( font ); - mCharWidget->updateStyle( style ); - mCharWidget->updateSize( 22.0 ); + mCharWidget->setFont( font ); + mCharWidget->setFontStyle( style ); + mCharWidget->setFontSize( 22.0 ); mCharSelectScrollArea->viewport()->update(); QApplication::setOverrideCursor( Qt::ArrowCursor ); diff --git a/src/gui/qgscodeeditor.h b/src/gui/qgscodeeditor.h index 4692e3c6c80c..a79429006c3e 100644 --- a/src/gui/qgscodeeditor.h +++ b/src/gui/qgscodeeditor.h @@ -39,34 +39,34 @@ class GUI_EXPORT QgsCodeEditor : public QsciScintilla /** * Construct a new code editor. * - * @param parent The parent QWidget - * @param title The title to show in the code editor dialog - * @param folding false: Enable folding for code editor - * @param margin false: Enable margin for code editor + * \param parent The parent QWidget + * \param title The title to show in the code editor dialog + * \param folding false: Enable folding for code editor + * \param margin false: Enable margin for code editor * \since QGIS 2.6 */ QgsCodeEditor( QWidget *parent = nullptr, const QString &title = "", bool folding = false, bool margin = false ); /** Set the widget title - * @param title widget title + * \param title widget title */ void setTitle( const QString &title ); /** Set margin visible state - * @param margin Set margin in the editor + * \param margin Set margin in the editor */ void setMarginVisible( bool margin ); bool marginVisible() { return mMargin; } /** Set folding visible state - * @param folding Set folding in the editor + * \param folding Set folding in the editor */ void setFoldingVisible( bool folding ); bool foldingVisible() { return mFolding; } /** Insert text at cursor position, or replace any selected text if user has * made a selection. - * @param text The text to be inserted + * \param text The text to be inserted */ void insertText( const QString &text ); diff --git a/src/gui/qgscodeeditorpython.h b/src/gui/qgscodeeditorpython.h index 0f294ab49bbc..2b5ecc2aaa4a 100644 --- a/src/gui/qgscodeeditorpython.h +++ b/src/gui/qgscodeeditorpython.h @@ -35,19 +35,19 @@ class GUI_EXPORT QgsCodeEditorPython : public QgsCodeEditor /** * Construct a new Python editor. * - * @param parent The parent QWidget - * @param filenames The list of apis files to load for the Python lexer + * \param parent The parent QWidget + * \param filenames The list of apis files to load for the Python lexer * \since QGIS 2.6 */ QgsCodeEditorPython( QWidget *parent = nullptr, const QList &filenames = QList() ); /** Load APIs from one or more files - * @param filenames The list of apis files to load for the Python lexer + * \param filenames The list of apis files to load for the Python lexer */ void loadAPIs( QList const &filenames ); /** Load a script file - * @param script The script file to load + * \param script The script file to load */ bool loadScript( const QString &script ); diff --git a/src/gui/qgscollapsiblegroupbox.h b/src/gui/qgscollapsiblegroupbox.h index 76de8b2922b2..36c641323635 100644 --- a/src/gui/qgscollapsiblegroupbox.h +++ b/src/gui/qgscollapsiblegroupbox.h @@ -68,7 +68,7 @@ class GUI_EXPORT QgsGroupBoxCollapseButton : public QToolButton * Basic class QgsCollapsibleGroupBoxBasic does not auto-save collapsed or checked state * Holding Alt modifier key when toggling collapsed state will synchronize the toggling across other collapsible group boxes with the same syncGroup QString value * Holding Shift modifier key when attempting to toggle collapsed state will expand current group box, then collapse any others with the same syncGroup QString value - * @note To add Collapsible properties in promoted QtDesigner widgets, you can add the following "Dynamic properties" by clicking on the green + in the propreties palette: + * \note To add Collapsible properties in promoted QtDesigner widgets, you can add the following "Dynamic properties" by clicking on the green + in the propreties palette: * bool collapsed, QString syncGroup, bool scrollOnExpand */ @@ -106,7 +106,7 @@ class GUI_EXPORT QgsCollapsibleGroupBoxBasic : public QGroupBox /** * Collapse or uncollapse this groupbox * - * @param collapse Will collapse on true and uncollapse on false + * \param collapse Will collapse on true and uncollapse on false */ void setCollapsed( bool collapse ); @@ -173,8 +173,8 @@ class GUI_EXPORT QgsCollapsibleGroupBoxBasic : public QGroupBox * By default, it auto-saves only its collapsed state to the global settings based on the widget and it's parent names. * Holding Alt modifier key when toggling collapsed state will synchronize the toggling across other collapsible group boxes with the same syncGroup QString value * Holding Shift modifier key when attempting to toggle collapsed state will expand current group box, then collapse any others with the same syncGroup QString value - * @see basic class QgsCollapsibleGroupBoxBasic which does not auto-save states - * @note To add Collapsible properties in promoted QtDesigner widgets, you can add the following "Dynamic properties" by clicking on the green + in the propreties palette: + * \see basic class QgsCollapsibleGroupBoxBasic which does not auto-save states + * \note To add Collapsible properties in promoted QtDesigner widgets, you can add the following "Dynamic properties" by clicking on the green + in the propreties palette: * bool collapsed, bool saveCollapsedState, bool saveCheckedState, QString syncGroup */ @@ -204,7 +204,7 @@ class GUI_EXPORT QgsCollapsibleGroupBox : public QgsCollapsibleGroupBoxBasic void setSaveCollapsedState( bool save ) { mSaveCollapsedState = save; } /** Set this to true to save/restore checked state - * @note only turn on mSaveCheckedState for groupboxes NOT used + * \note only turn on mSaveCheckedState for groupboxes NOT used * in multiple places or used as options for different parent objects */ void setSaveCheckedState( bool save ) { mSaveCheckedState = save; } bool saveCollapsedState() { return mSaveCollapsedState; } diff --git a/src/gui/qgscolorbrewercolorrampdialog.h b/src/gui/qgscolorbrewercolorrampdialog.h index f955fe6f3446..06e0afaacee6 100644 --- a/src/gui/qgscolorbrewercolorrampdialog.h +++ b/src/gui/qgscolorbrewercolorrampdialog.h @@ -37,19 +37,19 @@ class GUI_EXPORT QgsColorBrewerColorRampWidget : public QgsPanelWidget, private public: /** Constructor for QgsColorBrewerColorRampWidget. - * @param ramp initial ramp to show in dialog - * @param parent parent widget + * \param ramp initial ramp to show in dialog + * \param parent parent widget */ QgsColorBrewerColorRampWidget( const QgsColorBrewerColorRamp &ramp, QWidget *parent = nullptr ); /** Returns a color ramp representing the current settings from the dialog. - * @see setRamp() + * \see setRamp() */ QgsColorBrewerColorRamp ramp() const { return mRamp; } /** Sets the color ramp to show in the dialog. - * @param ramp color ramp - * @see ramp() + * \param ramp color ramp + * \see ramp() */ void setRamp( const QgsColorBrewerColorRamp &ramp ); @@ -84,19 +84,19 @@ class GUI_EXPORT QgsColorBrewerColorRampDialog : public QDialog public: /** Constructor for QgsColorBrewerColorRampDialog. - * @param ramp initial ramp to show in dialog - * @param parent parent widget + * \param ramp initial ramp to show in dialog + * \param parent parent widget */ QgsColorBrewerColorRampDialog( const QgsColorBrewerColorRamp &ramp, QWidget *parent = nullptr ); /** Returns a color ramp representing the current settings from the dialog. - * @see setRamp() + * \see setRamp() */ QgsColorBrewerColorRamp ramp() const { return mWidget->ramp(); } /** Sets the color ramp to show in the dialog. - * @param ramp color ramp - * @see ramp() + * \param ramp color ramp + * \see ramp() */ void setRamp( const QgsColorBrewerColorRamp &ramp ) { mWidget->setRamp( ramp ); } diff --git a/src/gui/qgscolorbutton.h b/src/gui/qgscolorbutton.h index b6c8a22c6b0e..3677107a7bfe 100644 --- a/src/gui/qgscolorbutton.h +++ b/src/gui/qgscolorbutton.h @@ -58,9 +58,9 @@ class GUI_EXPORT QgsColorButton : public QToolButton }; /** Construct a new color button. - * @param parent The parent QWidget for the dialog - * @param cdt The title to show in the color chooser dialog - * @param registry a color scheme registry for color swatch grids to show in the drop down menu. If not + * \param parent The parent QWidget for the dialog + * \param cdt The title to show in the color chooser dialog + * \param registry a color scheme registry for color swatch grids to show in the drop down menu. If not * specified, the button will use the global color scheme registry */ QgsColorButton( QWidget *parent = nullptr, const QString &cdt = "", QgsColorSchemeRegistry *registry = nullptr ); @@ -68,148 +68,148 @@ class GUI_EXPORT QgsColorButton : public QToolButton virtual QSize sizeHint() const override; /** Return the currently selected color. - * @returns currently selected color - * @see setColor + * \returns currently selected color + * \see setColor */ QColor color() const; /** Sets whether alpha modification (transparency) is permitted * for the color. Defaults to false. - * @param allowAlpha set to true to allow alpha modification - * @see allowAlpha + * \param allowAlpha set to true to allow alpha modification + * \see allowAlpha */ void setAllowAlpha( const bool allowAlpha ); /** Returns whether alpha modification (transparency) is permitted * for the color. - * @returns true if alpha modification is allowed - * @see setAllowAlpha + * \returns true if alpha modification is allowed + * \see setAllowAlpha */ bool allowAlpha() const { return mAllowAlpha; } /** Set the title for the color chooser dialog window. - * @param title Title for the color chooser dialog - * @see colorDialogTitle + * \param title Title for the color chooser dialog + * \see colorDialogTitle */ void setColorDialogTitle( const QString &title ); /** Returns the title for the color chooser dialog window. - * @returns title for the color chooser dialog - * @see setColorDialogTitle + * \returns title for the color chooser dialog + * \see setColorDialogTitle */ QString colorDialogTitle() const; /** Returns whether the button accepts live updates from QColorDialog. - * @returns true if the button will be accepted immediately when the dialog's color changes - * @see setAcceptLiveUpdates + * \returns true if the button will be accepted immediately when the dialog's color changes + * \see setAcceptLiveUpdates */ bool acceptLiveUpdates() const { return mAcceptLiveUpdates; } /** Sets whether the button accepts live updates from QColorDialog. Live updates may cause changes * that are not undoable on QColorDialog cancel. - * @param accept set to true to enable live updates - * @see acceptLiveUpdates + * \param accept set to true to enable live updates + * \see acceptLiveUpdates */ void setAcceptLiveUpdates( const bool accept ) { mAcceptLiveUpdates = accept; } /** Sets whether the drop down menu should be shown for the button. The default behavior is to * show the menu. - * @param showMenu set to false to hide the drop down menu - * @see showMenu + * \param showMenu set to false to hide the drop down menu + * \see showMenu */ void setShowMenu( const bool showMenu ); /** Returns whether the drop down menu is shown for the button. - * @returns true if drop down menu is shown - * @see setShowMenu + * \returns true if drop down menu is shown + * \see setShowMenu */ bool showMenu() const { return menu() ? true : false; } /** Sets the behavior for when the button is clicked. The default behavior is to show * a color picker dialog. - * @param behavior behavior when button is clicked - * @see behavior + * \param behavior behavior when button is clicked + * \see behavior */ void setBehavior( const Behavior behavior ); /** Returns the behavior for when the button is clicked. - * @returns behavior when button is clicked - * @see setBehavior + * \returns behavior when button is clicked + * \see setBehavior */ Behavior behavior() const { return mBehavior; } /** Sets the default color for the button, which is shown in the button's drop down menu for the * "default color" option. - * @param color default color for the button. Set to an invalid QColor to disable the default color + * \param color default color for the button. Set to an invalid QColor to disable the default color * option. - * @see defaultColor + * \see defaultColor */ void setDefaultColor( const QColor &color ); /** Returns the default color for the button, which is shown in the button's drop down menu for the * "default color" option. - * @returns default color for the button. Returns an invalid QColor if the default color + * \returns default color for the button. Returns an invalid QColor if the default color * option is disabled. - * @see setDefaultColor + * \see setDefaultColor */ QColor defaultColor() const { return mDefaultColor; } /** Sets whether the "no color" option should be shown in the button's drop down menu. If selected, * the "no color" option sets the color button's color to a totally transparent color. - * @param showNoColorOption set to true to show the no color option. This is disabled by default. - * @see showNoColor - * @see setNoColorString - * @note The "no color" option is only shown if the color button is set to show an alpha channel in the color + * \param showNoColorOption set to true to show the no color option. This is disabled by default. + * \see showNoColor + * \see setNoColorString + * \note The "no color" option is only shown if the color button is set to show an alpha channel in the color * dialog (see setColorDialogOptions) */ void setShowNoColor( const bool showNoColorOption ) { mShowNoColorOption = showNoColorOption; } /** Returns whether the "no color" option is shown in the button's drop down menu. If selected, * the "no color" option sets the color button's color to a totally transparent color. - * @returns true if the no color option is shown. - * @see setShowNoColor - * @see noColorString - * @note The "no color" option is only shown if the color button is set to show an alpha channel in the color + * \returns true if the no color option is shown. + * \see setShowNoColor + * \see noColorString + * \note The "no color" option is only shown if the color button is set to show an alpha channel in the color * dialog (see setColorDialogOptions) */ bool showNoColor() const { return mShowNoColorOption; } /** Sets the string to use for the "no color" option in the button's drop down menu. - * @param noColorString string to use for the "no color" menu option - * @see noColorString - * @see setShowNoColor - * @note The "no color" option is only shown if the color button is set to show an alpha channel in the color + * \param noColorString string to use for the "no color" menu option + * \see noColorString + * \see setShowNoColor + * \note The "no color" option is only shown if the color button is set to show an alpha channel in the color * dialog (see setColorDialogOptions) */ void setNoColorString( const QString &noColorString ) { mNoColorString = noColorString; } /** Sets whether a set to null (clear) option is shown in the button's drop down menu. - * @param showNull set to true to show a null option + * \param showNull set to true to show a null option * \since QGIS 2.16 - * @see showNull() - * @see isNull() + * \see showNull() + * \see isNull() */ void setShowNull( bool showNull ); /** Returns whether the set to null (clear) option is shown in the button's drop down menu. * \since QGIS 2.16 - * @see setShowNull() - * @see isNull() + * \see setShowNull() + * \see isNull() */ bool showNull() const; /** Returns true if the current color is null. * \since QGIS 2.16 - * @see setShowNull() - * @see showNull() + * \see setShowNull() + * \see showNull() */ bool isNull() const; /** Returns the string used for the "no color" option in the button's drop down menu. - * @returns string used for the "no color" menu option - * @see setNoColorString - * @see showNoColor - * @note The "no color" option is only shown if the color button is set to show an alpha channel in the color + * \returns string used for the "no color" menu option + * \see setNoColorString + * \see showNoColor + * \note The "no color" option is only shown if the color button is set to show an alpha channel in the color * dialog (see setColorDialogOptions) */ QString noColorString() const { return mNoColorString; } @@ -217,32 +217,32 @@ class GUI_EXPORT QgsColorButton : public QToolButton /** Sets the context string for the color button. The context string is passed to all color swatch * grids shown in the button's drop down menu, to allow them to customise their display colors * based on the context. - * @param context context string for the color button's color swatch grids - * @see context + * \param context context string for the color button's color swatch grids + * \see context */ void setContext( const QString &context ) { mContext = context; } /** Returns the context string for the color button. The context string is passed to all color swatch * grids shown in the button's drop down menu, to allow them to customise their display colors * based on the context. - * @returns context string for the color button's color swatch grids - * @see setContext + * \returns context string for the color button's color swatch grids + * \see setContext */ QString context() const { return mContext; } /** Sets the color scheme registry for the button, which controls the color swatch grids * that are shown in the button's drop down menu. - * @param registry color scheme registry for the button. Set to 0 to hide all color + * \param registry color scheme registry for the button. Set to 0 to hide all color * swatch grids from the button's drop down menu. - * @see colorSchemeRegistry + * \see colorSchemeRegistry */ void setColorSchemeRegistry( QgsColorSchemeRegistry *registry ) { mColorSchemeRegistry = registry; } /** Returns the color scheme registry for the button, which controls the color swatch grids * that are shown in the button's drop down menu. - * @returns color scheme registry for the button. If returned value is 0 then all color + * \returns color scheme registry for the button. If returned value is 0 then all color * swatch grids are hidden from the button's drop down menu. - * @see setColorSchemeRegistry + * \see setColorSchemeRegistry */ QgsColorSchemeRegistry *colorSchemeRegistry() { return mColorSchemeRegistry; } @@ -250,8 +250,8 @@ class GUI_EXPORT QgsColorButton : public QToolButton /** Sets the current color for the button. Will emit a colorChanged signal if the color is different * to the previous color. - * @param color new color for the button - * @see color + * \param color new color for the button + * \see color */ void setColor( const QColor &color ); @@ -259,19 +259,19 @@ class GUI_EXPORT QgsColorButton : public QToolButton * Call directly to update background after adding/removing QColorDialog::ShowAlphaChannel option * but the color has not changed, i.e. setColor() wouldn't update button and * you want the button to retain the set color's alpha component regardless - * @param color Color for button background. If no color is specified, the button's current + * \param color Color for button background. If no color is specified, the button's current * color will be used */ void setButtonBackground( const QColor &color = QColor() ); /** Copies the current color to the clipboard - * @see pasteColor + * \see pasteColor */ void copyColor(); /** Pastes a color from the clipboard to the color button. If clipboard does not contain a valid * color or string representation of a color, then no change is applied. - * @see copyColor + * \see copyColor */ void pasteColor(); @@ -280,22 +280,22 @@ class GUI_EXPORT QgsColorButton : public QToolButton void activatePicker(); /** Sets color to a totally transparent color. - * @note If the color button is not set to show an alpha channel in the color + * \note If the color button is not set to show an alpha channel in the color * dialog (see setColorDialogOptions) then the color will not be changed. - * @see setToNull() + * \see setToNull() */ void setToNoColor(); /** Sets color to the button's default color, if set. - * @see setDefaultColor - * @see defaultColor - * @see setToNull() + * \see setDefaultColor + * \see defaultColor + * \see setToNull() */ void setToDefaultColor(); /** Sets color to null. - * @see setToDefaultColor() - * @see setToNoColor() + * \see setToDefaultColor() + * \see setToNoColor() * \since QGIS 2.16 */ void setToNull(); @@ -304,14 +304,14 @@ class GUI_EXPORT QgsColorButton : public QToolButton /** Is emitted whenever a new color is set for the button. The color is always valid. * In case the new color is the same no signal is emitted, to avoid infinite loops. - * @param color New color + * \param color New color */ void colorChanged( const QColor &color ); /** Emitted when the button is clicked, if the button's behavior is set to SignalOnly - * @param color button color - * @see setBehavior - * @see behavior + * \param color button color + * \see setBehavior + * \see behavior */ void colorClicked( const QColor &color ); @@ -388,23 +388,23 @@ class GUI_EXPORT QgsColorButton : public QToolButton /** Attempts to parse mimeData as a color, either via the mime data's color data or by * parsing a textual representation of a color. - * @returns true if mime data could be intrepreted as a color - * @param mimeData mime data - * @param resultColor QColor to store evaluated color - * @see createColorMimeData + * \returns true if mime data could be intrepreted as a color + * \param mimeData mime data + * \param resultColor QColor to store evaluated color + * \see createColorMimeData */ bool colorFromMimeData( const QMimeData *mimeData, QColor &resultColor ); /** Ends a color picking operation - * @param eventPos global position of pixel to sample color from - * @param sampleColor set to true to actually sample the color, false to just cancel + * \param eventPos global position of pixel to sample color from + * \param sampleColor set to true to actually sample the color, false to just cancel * the color picking operation */ void stopPicking( QPointF eventPos, bool sampleColor = true ); /** Create a color icon for display in the drop down menu - * @param color for icon - * @param showChecks set to true to display a checkboard pattern behind + * \param color for icon + * \param showChecks set to true to display a checkboard pattern behind * transparent colors */ QPixmap createMenuIcon( const QColor &color, const bool showChecks = true ); @@ -425,7 +425,7 @@ class GUI_EXPORT QgsColorButton : public QToolButton void setValidTemporaryColor( const QColor &newColor ); /** Adds a color to the recent colors list - * @param color to add to recent colors list + * \param color to add to recent colors list */ void addRecentColor( const QColor &color ); diff --git a/src/gui/qgscolordialog.h b/src/gui/qgscolordialog.h index edb806facba1..ea2b25de34c9 100644 --- a/src/gui/qgscolordialog.h +++ b/src/gui/qgscolordialog.h @@ -38,38 +38,38 @@ class GUI_EXPORT QgsColorDialog : public QDialog, private Ui::QgsColorDialogBase public: /** Create a new color picker dialog - * @param parent parent widget - * @param fl window flags - * @param color initial color for dialog + * \param parent parent widget + * \param fl window flags + * \param color initial color for dialog */ QgsColorDialog( QWidget *parent = nullptr, Qt::WindowFlags fl = QgisGui::ModalDialogFlags, const QColor &color = QColor() ); /** Returns the current color for the dialog - * @returns dialog color + * \returns dialog color */ QColor color() const; /** Sets the title for the color dialog - * @param title title for dialog box + * \param title title for dialog box */ void setTitle( const QString &title ); /** Sets whether alpha modification (transparency) is permitted * for the color dialog. Defaults to true. - * @param allowAlpha set to false to disable alpha modification + * \param allowAlpha set to false to disable alpha modification */ void setAllowAlpha( const bool allowAlpha ); /** Return a color selection from a color dialog, with live updating of interim selections. - * @param initialColor the initial color of the selection dialog. - * @param updateObject the receiver object of the live updating. - * @param updateSlot the receiver object's slot for live updating (e.g. SLOT( setValidColor( const QColor& ) ) ). - * @param parent parent widget - * @param title the title of the dialog. - * @param allowAlpha set to true to allow modification of color alpha value (transparency) - * @return Selected color on accepted() or initialColor on rejected(). - * @see getColor + * \param initialColor the initial color of the selection dialog. + * \param updateObject the receiver object of the live updating. + * \param updateSlot the receiver object's slot for live updating (e.g. SLOT( setValidColor( const QColor& ) ) ). + * \param parent parent widget + * \param title the title of the dialog. + * \param allowAlpha set to true to allow modification of color alpha value (transparency) + * \returns Selected color on accepted() or initialColor on rejected(). + * \see getColor */ static QColor getLiveColor( const QColor &initialColor, QObject *updateObject, const char *updateSlot, QWidget *parent = nullptr, @@ -77,12 +77,12 @@ class GUI_EXPORT QgsColorDialog : public QDialog, private Ui::QgsColorDialogBase const bool allowAlpha = true ); /** Return a color selection from a color dialog. - * @param initialColor the initial color of the selection dialog. - * @param parent parent widget - * @param title the title of the dialog. - * @param allowAlpha set to true to allow modification of color alpha value (transparency) - * @return Selected color on accepted() or initialColor on rejected(). - * @see getLiveColor + * \param initialColor the initial color of the selection dialog. + * \param parent parent widget + * \param title the title of the dialog. + * \param allowAlpha set to true to allow modification of color alpha value (transparency) + * \returns Selected color on accepted() or initialColor on rejected(). + * \see getLiveColor */ static QColor getColor( const QColor &initialColor, QWidget *parent, const QString &title = QString(), const bool allowAlpha = false ); @@ -90,14 +90,14 @@ class GUI_EXPORT QgsColorDialog : public QDialog, private Ui::QgsColorDialogBase signals: /** Emitted when the dialog's color changes - * @param color current color + * \param color current color */ void currentColorChanged( const QColor &color ); public slots: /** Sets the current color for the dialog - * @param color desired color + * \param color desired color */ void setColor( const QColor &color ); diff --git a/src/gui/qgscolorrampbutton.h b/src/gui/qgscolorrampbutton.h index 3a14a112df2b..0cb283c1cdab 100644 --- a/src/gui/qgscolorrampbutton.h +++ b/src/gui/qgscolorrampbutton.h @@ -45,8 +45,8 @@ class GUI_EXPORT QgsColorRampButton : public QToolButton public: /** Construct a new color ramp button. - * @param parent The parent QWidget for the dialog - * @param dialogTitle The title to show in the color ramp dialog + * \param parent The parent QWidget for the dialog + * \param dialogTitle The title to show in the color ramp dialog */ QgsColorRampButton( QWidget *parent = nullptr, const QString &dialogTitle = QString() ); @@ -55,135 +55,135 @@ class GUI_EXPORT QgsColorRampButton : public QToolButton virtual QSize sizeHint() const override; /** Return a copy of the current color ramp. - * @see setColorRamp() + * \see setColorRamp() */ QgsColorRamp *colorRamp() const; /** Set the title for the color ramp dialog window. - * @param title Title for the color ramp dialog - * @see colorRampDialogTitle + * \param title Title for the color ramp dialog + * \see colorRampDialogTitle */ void setColorRampDialogTitle( const QString &title ); /** Returns the title for the color ramp dialog window. - * @returns title for the color ramp dialog - * @see setColorRampDialogTitle + * \returns title for the color ramp dialog + * \see setColorRampDialogTitle */ QString colorRampDialogTitle() const; /** Returns whether the button accepts live updates from QgsColorRampDialog. - * @returns true if the button will be accepted immediately when the dialog's color ramp changes - * @see setAcceptLiveUpdates + * \returns true if the button will be accepted immediately when the dialog's color ramp changes + * \see setAcceptLiveUpdates */ bool acceptLiveUpdates() const { return mAcceptLiveUpdates; } /** Sets whether the button accepts live updates from QgsColorRampDialog. Live updates may cause changes * that are not undoable on QColorRampDialog cancel. - * @param accept set to true to enable live updates - * @see acceptLiveUpdates + * \param accept set to true to enable live updates + * \see acceptLiveUpdates */ void setAcceptLiveUpdates( const bool accept ) { mAcceptLiveUpdates = accept; } /** Sets whether the drop down menu should be shown for the button. The default behavior is to * show the menu. - * @param showMenu set to false to hide the drop down menu - * @see showMenu + * \param showMenu set to false to hide the drop down menu + * \see showMenu */ void setShowMenu( const bool showMenu ); /** Returns whether the drop down menu is shown for the button. - * @returns true if drop down menu is shown - * @see setShowMenu + * \returns true if drop down menu is shown + * \see setShowMenu */ bool showMenu() const { return menu() ? true : false; } /** Sets the default color ramp for the button, which is shown in the button's drop down menu for the * "default color ramp" option. - * @param colorramp default color ramp for the button. Set to a null pointer to disable the default color + * \param colorramp default color ramp for the button. Set to a null pointer to disable the default color * ramp option. The ramp will be cloned and ownership is not transferred. - * @see defaultColorRamp + * \see defaultColorRamp */ void setDefaultColorRamp( QgsColorRamp *colorramp ); /** Returns a copy of the default color ramp for the button, which is shown in the button's drop down menu for the * "default color ramp" option. - * @returns default color ramp for the button. Returns a null pointer if the default color ramp + * \returns default color ramp for the button. Returns a null pointer if the default color ramp * option is disabled. - * @see setDefaultColorRamp + * \see setDefaultColorRamp */ QgsColorRamp *defaultColorRamp() const { return mDefaultColorRamp ? mDefaultColorRamp->clone() : nullptr ; } /** Sets whether a random colors option is shown in the button's drop down menu. - * @param showRandom set to true to show a random colors option - * @see showRandom() + * \param showRandom set to true to show a random colors option + * \see showRandom() */ void setShowRandomColorRamp( bool showRandom ) { mShowRandomColorRamp = showRandom; } /** Returns whether random colors option is shown in the button's drop down menu. - * @see setShowRandom() + * \see setShowRandom() */ bool showRandomColorRamp() const { return mShowRandomColorRamp; } /** Returns true if the current color is null. - * @see setShowNull() - * @see showNull() + * \see setShowNull() + * \see showNull() */ bool isRandomColorRamp() const; /** Sets whether a set to null (clear) option is shown in the button's drop down menu. - * @param showNull set to true to show a null option - * @see showNull() - * @see isNull() + * \param showNull set to true to show a null option + * \see showNull() + * \see isNull() */ void setShowNull( bool showNull ); /** Returns whether the set to null (clear) option is shown in the button's drop down menu. - * @see setShowNull() - * @see isNull() + * \see setShowNull() + * \see isNull() */ bool showNull() const; /** Returns true if the current color is null. - * @see setShowNull() - * @see showNull() + * \see setShowNull() + * \see showNull() */ bool isNull() const; /** Sets the context string for the color ramp button. The context string is passed to all color ramp * preview icons shown in the button's drop down menu, to (eventually) allow them to customise their display colors * based on the context. - * @param context context string for the color dialog button's color ramp preview icons - * @see context + * \param context context string for the color dialog button's color ramp preview icons + * \see context */ void setContext( const QString &context ) { mContext = context; } /** Returns the context string for the color ramp button. The context string is passed to all color ramp * preview icons shown in the button's drop down menu, to (eventually) allow them to customise their display colors * based on the context. - * @returns context context string for the color dialog button's color ramp preview icons - * @see setContext + * \returns context context string for the color dialog button's color ramp preview icons + * \see setContext */ QString context() const { return mContext; } /** Sets whether the color ramp button only shows gradient type ramps - * @param gradientonly set to true to show only gradient type ramps - * @see showGradientOnly + * \param gradientonly set to true to show only gradient type ramps + * \see showGradientOnly */ void setShowGradientOnly( bool gradientonly ) { mShowGradientOnly = gradientonly; } /** Returns true if the color ramp button only shows gradient type ramps - * @see setShowGradientOnly + * \see setShowGradientOnly */ bool showGradientOnly() const { return mShowGradientOnly; } /** Sets the name of the current color ramp when it's available in the style manager - * @param name Name of the saved color ramp - * @see colorRampName + * \param name Name of the saved color ramp + * \see colorRampName */ void setColorRampName( const QString &name ) { mColorRampName = name; } /** Returns the name of the current color ramp when it's available in the style manager - * @see setColorRampName + * \see setColorRampName */ QString colorRampName() const { return mColorRampName; } @@ -191,39 +191,39 @@ class GUI_EXPORT QgsColorRampButton : public QToolButton /** Sets the current color ramp for the button. Will emit a colorRampChanged() signal if the color ramp is different * to the previous color ramp. - * @param colorramp New color ramp for the button. The ramp will be cloned and ownership is not transferred. - * @see setRandomColorRamp, setColorRampFromName, colorRamp + * \param colorramp New color ramp for the button. The ramp will be cloned and ownership is not transferred. + * \see setRandomColorRamp, setColorRampFromName, colorRamp */ void setColorRamp( QgsColorRamp *colorramp ); /** Sets the current color ramp for the button to random colors. Will emit a colorRampChanged() signal * if the color ramp is different to the previous color ramp. - * @see setColorRamp, setColorRampFromName, colorRamp + * \see setColorRamp, setColorRampFromName, colorRamp */ void setRandomColorRamp(); /** Sets the current color ramp for the button using a saved color ramp name. Will emit a colorRampChanged() signal * if the color ramp is different to the previous color ramp. - * @param name Name of saved color ramp - * @see setColorRamp, setRandomColorRamp, colorRamp + * \param name Name of saved color ramp + * \see setColorRamp, setRandomColorRamp, colorRamp */ void setColorRampFromName( const QString &name = QString() ); /** Sets the background pixmap for the button based upon current color ramp. - * @param colorramp Color ramp for button background. If no color ramp is specified, the button's current + * \param colorramp Color ramp for button background. If no color ramp is specified, the button's current * color ramp will be used */ void setButtonBackground( QgsColorRamp *colorramp = nullptr ); /** Sets color ramp to the button's default color ramp, if set. - * @see setDefaultColorRamp - * @see defaultColorRamp - * @see setToNull() + * \see setDefaultColorRamp + * \see defaultColorRamp + * \see setToNull() */ void setToDefaultColorRamp(); /** Sets color ramp to null. - * @see setToDefaultColorRamp() + * \see setToDefaultColorRamp() */ void setToNull(); @@ -271,7 +271,7 @@ class GUI_EXPORT QgsColorRampButton : public QToolButton QSize mIconSize; /** Create a color ramp icon for display in the drop down menu - * @param colorramp Color ramp to create an icon from + * \param colorramp Color ramp to create an icon from */ QPixmap createMenuIcon( QgsColorRamp *colorramp ); diff --git a/src/gui/qgscolorschemelist.h b/src/gui/qgscolorschemelist.h index d1460f676dcd..836f968d6cec 100644 --- a/src/gui/qgscolorschemelist.h +++ b/src/gui/qgscolorschemelist.h @@ -28,8 +28,8 @@ class QgsPanelWidget; /** \ingroup gui * \class QgsColorSwatchDelegate * A delegate for showing a color swatch in a list - * @see QgsColorSchemeList - * @note introduced in QGIS 2.5 + * \see QgsColorSchemeList + * \since QGIS 2.5 */ class GUI_EXPORT QgsColorSwatchDelegate : public QAbstractItemDelegate { @@ -49,7 +49,7 @@ class GUI_EXPORT QgsColorSwatchDelegate : public QAbstractItemDelegate QWidget *mParent = nullptr; /** Generates a checkboard pattern for transparent color backgrounds - * @returns checkboard pixmap + * \returns checkboard pixmap */ QPixmap transparentBackground() const; }; @@ -58,8 +58,8 @@ class GUI_EXPORT QgsColorSwatchDelegate : public QAbstractItemDelegate /** \ingroup gui * \class QgsColorSchemeModel * A model for colors in a color scheme - * @see QgsColorSchemeList - * @note introduced in QGIS 2.5 + * \see QgsColorSchemeList + * \since QGIS 2.5 */ class GUI_EXPORT QgsColorSchemeModel: public QAbstractItemModel { @@ -68,10 +68,10 @@ class GUI_EXPORT QgsColorSchemeModel: public QAbstractItemModel public: /** Constructor - * @param scheme color scheme for list - * @param context context string for color scheme - * @param baseColor base color for color scheme - * @param parent parent object + * \param scheme color scheme for list + * \param context context string for color scheme + * \param baseColor base color for color scheme + * \param parent parent object */ explicit QgsColorSchemeModel( QgsColorScheme *scheme, const QString &context = QString(), const QColor &baseColor = QColor(), QObject *parent = nullptr ); @@ -92,38 +92,38 @@ class GUI_EXPORT QgsColorSchemeModel: public QAbstractItemModel bool dropMimeData( const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent ) override; /** Returns a list of colors shown in the widget - * @returns colors shown in the widget + * \returns colors shown in the widget */ QgsNamedColorList colors() const { return mColors; } /** Sets the color scheme to show in the widget - * @param scheme color scheme - * @param context context for color scheme - * @param baseColor base color for color scheme + * \param scheme color scheme + * \param context context for color scheme + * \param baseColor base color for color scheme */ void setScheme( QgsColorScheme *scheme, const QString &context = QString(), const QColor &baseColor = QColor() ); /** Get the current color scheme context for the model - * @returns context string which is passed to scheme for color generation - * @see baseColor + * \returns context string which is passed to scheme for color generation + * \see baseColor */ QString context() const { return mContext; } /** Get the base color for the color scheme used by the model - * @returns base color which is passed to scheme for color generation - * @see context + * \returns base color which is passed to scheme for color generation + * \see context */ QColor baseColor() const { return mBaseColor; } /** Add a color to the list - * @param color color to add - * @param label label for color - * @param allowDuplicate set to true to allow duplicate colors to be added (colors which are already present in the list) + * \param color color to add + * \param label label for color + * \param allowDuplicate set to true to allow duplicate colors to be added (colors which are already present in the list) */ void addColor( const QColor &color, const QString &label = QString(), bool allowDuplicate = false ); /** Returns whether the color scheme model has been modified - * @returns true if colors have been modified + * \returns true if colors have been modified */ bool isDirty() const { return mIsDirty; } @@ -145,8 +145,8 @@ class GUI_EXPORT QgsColorSchemeModel: public QAbstractItemModel /** \ingroup gui * \class QgsColorSchemeList * An editable list of color swatches, taken from an associated QgsColorScheme. - * @see QgsColorSchemeList - * @note introduced in QGIS 2.5 + * \see QgsColorSchemeList + * \since QGIS 2.5 */ class GUI_EXPORT QgsColorSchemeList: public QTreeView { @@ -155,49 +155,49 @@ class GUI_EXPORT QgsColorSchemeList: public QTreeView public: /** Construct a new color swatch grid. - * @param parent parent widget - * @param scheme QgsColorScheme for colors to show in the list - * @param context context string provided to color scheme - * @param baseColor base color for color scheme + * \param parent parent widget + * \param scheme QgsColorScheme for colors to show in the list + * \param context context string provided to color scheme + * \param baseColor base color for color scheme */ QgsColorSchemeList( QWidget *parent = nullptr, QgsColorScheme *scheme = nullptr, const QString &context = QString(), const QColor &baseColor = QColor() ); /** Saves the current colors shown in the list back to a color scheme, if supported * by the color scheme. - * @note this method is only effective if the color scheme is editable + * \note this method is only effective if the color scheme is editable */ bool saveColorsToScheme(); /** Import colors from a GPL palette file to the list - * @param file file to import - * @see exportColorsToGpl + * \param file file to import + * \see exportColorsToGpl */ bool importColorsFromGpl( QFile &file ); /** Export colors to a GPL palette file from the list - * @param file destination file - * @see importColorsFromGpl + * \param file destination file + * \see importColorsFromGpl */ bool exportColorsToGpl( QFile &file ); /** Returns whether the color scheme list has been modified - * @returns true if colors have been modified + * \returns true if colors have been modified */ bool isDirty() const; /** Returns the scheme currently selected in the list. * \since QGIS 3.0 - * @see setScheme() + * \see setScheme() */ QgsColorScheme *scheme(); public slots: /** Sets the color scheme to show in the list - * @param scheme QgsColorScheme for colors to show in the list - * @param context context string provided to color scheme - * @param baseColor base color for color scheme - * @see scheme() + * \param scheme QgsColorScheme for colors to show in the list + * \param context context string provided to color scheme + * \param baseColor base color for color scheme + * \see scheme() */ void setScheme( QgsColorScheme *scheme, const QString &context = QString(), const QColor &baseColor = QColor() ); @@ -206,38 +206,38 @@ class GUI_EXPORT QgsColorSchemeList: public QTreeView void removeSelection(); /** Adds a color to the list - * @param color color to add - * @param label optional label for color - * @param allowDuplicate set to true to allow duplicate colors to be added, ie colors which already exist in the list + * \param color color to add + * \param label optional label for color + * \param allowDuplicate set to true to allow duplicate colors to be added, ie colors which already exist in the list */ void addColor( const QColor &color, const QString &label = QString(), bool allowDuplicate = false ); /** Pastes colors from clipboard to the list - * @see copyColors + * \see copyColors */ void pasteColors(); /** Copies colors from the list to the clipboard - * @see pasteColors + * \see pasteColors */ void copyColors(); /** Displays a file picker dialog allowing users to import colors into the list from a file. * \since QGIS 3.0 - * @see showExportColorsDialog() + * \see showExportColorsDialog() */ void showImportColorsDialog(); /** Displays a file picker dialog allowing users to export colors from the list into a file. * \since QGIS 3.0 - * @see showImportColorsDialog() + * \see showImportColorsDialog() */ void showExportColorsDialog(); signals: /** Emitted when a color is selected from the list - * @param color color selected + * \param color color selected */ void colorSelected( const QColor &color ); diff --git a/src/gui/qgscolorswatchgrid.h b/src/gui/qgscolorswatchgrid.h index c4db27d12e63..34a9e0374d12 100644 --- a/src/gui/qgscolorswatchgrid.h +++ b/src/gui/qgscolorswatchgrid.h @@ -24,8 +24,8 @@ * \class QgsColorSwatchGrid * A grid of color swatches, which allows for user selection. Colors are taken from an * associated QgsColorScheme. - * @see QgsColorGridAction - * @note introduced in QGIS 2.5 + * \see QgsColorGridAction + * \since QGIS 2.5 */ class GUI_EXPORT QgsColorSwatchGrid : public QWidget { @@ -34,9 +34,9 @@ class GUI_EXPORT QgsColorSwatchGrid : public QWidget public: /** Construct a new color swatch grid. - * @param scheme QgsColorScheme for colors to show in grid - * @param context context string provided to color scheme - * @param parent parent widget + * \param scheme QgsColorScheme for colors to show in grid + * \param context context string provided to color scheme + * \param parent parent widget */ QgsColorSwatchGrid( QgsColorScheme *scheme, const QString &context = QString(), QWidget *parent = nullptr ); @@ -47,31 +47,31 @@ class GUI_EXPORT QgsColorSwatchGrid : public QWidget virtual QSize sizeHint() const override; /** Get the current context for the grid - * @returns context string which is passed to scheme for color generation - * @see setContext + * \returns context string which is passed to scheme for color generation + * \see setContext */ QString context() const { return mContext; } /** Sets the current context for the grid - * @param context string which is passed to scheme for color generation - * @see context + * \param context string which is passed to scheme for color generation + * \see context */ void setContext( const QString &context ); /** Get the base color for the widget - * @returns base color which is passed to scheme for color generation - * @see setBaseColor + * \returns base color which is passed to scheme for color generation + * \see setBaseColor */ QColor baseColor() const { return mBaseColor; } /** Sets the base color for the widget - * @param baseColor base color to pass to scheme for color generation - * @see baseColor + * \param baseColor base color to pass to scheme for color generation + * \see baseColor */ void setBaseColor( const QColor &baseColor ); /** Gets the list of colors shown in the grid - * @returns list of colors currently shown in the grid + * \returns list of colors currently shown in the grid */ QgsNamedColorList *colors() { return &mColors; } @@ -84,7 +84,7 @@ class GUI_EXPORT QgsColorSwatchGrid : public QWidget signals: /** Emitted when a color has been selected from the widget - * @param color selected color + * \param color selected color */ void colorChanged( const QColor &color ); @@ -120,28 +120,28 @@ class GUI_EXPORT QgsColorSwatchGrid : public QWidget bool mPressedOnWidget; /** Calculate height of widget based on number of colors - * @returns required height of widget in pixels + * \returns required height of widget in pixels */ int calculateHeight() const; /** Draws widget - * @param painter destination painter + * \param painter destination painter */ void draw( QPainter &painter ); /** Calculate swatch corresponding to a position within the widget - * @param position position - * @returns swatch number (starting at 0), or -1 if position is outside a swatch + * \param position position + * \returns swatch number (starting at 0), or -1 if position is outside a swatch */ int swatchForPosition( QPoint position ) const; /** Updates the widget's tooltip for a given color index - * @param colorIdx color index to use for calculating tooltip + * \param colorIdx color index to use for calculating tooltip */ void updateTooltip( const int colorIdx ); /** Generates a checkboard pattern for transparent color backgrounds - * @returns checkboard pixmap + * \returns checkboard pixmap */ QPixmap transparentBackground(); }; @@ -150,8 +150,8 @@ class GUI_EXPORT QgsColorSwatchGrid : public QWidget /** \ingroup gui * \class QgsColorSwatchGridAction * A color swatch grid which can be embedded into a menu. - * @see QgsColorSwatchGrid - * @note introduced in QGIS 2.5 + * \see QgsColorSwatchGrid + * \since QGIS 2.5 */ class GUI_EXPORT QgsColorSwatchGridAction: public QWidgetAction @@ -161,50 +161,50 @@ class GUI_EXPORT QgsColorSwatchGridAction: public QWidgetAction public: /** Construct a new color swatch grid action. - * @param scheme QgsColorScheme for colors to show in grid - * @param menu parent menu - * @param context context string provided to color scheme - * @param parent parent widget + * \param scheme QgsColorScheme for colors to show in grid + * \param menu parent menu + * \param context context string provided to color scheme + * \param parent parent widget */ QgsColorSwatchGridAction( QgsColorScheme *scheme, QMenu *menu = nullptr, const QString &context = QString(), QWidget *parent = nullptr ); /** Sets the base color for the color grid - * @param baseColor base color to pass to scheme for color generation - * @see baseColor + * \param baseColor base color to pass to scheme for color generation + * \see baseColor */ void setBaseColor( const QColor &baseColor ); /** Get the base color for the color grid - * @returns base color which is passed to scheme for color generation - * @see setBaseColor + * \returns base color which is passed to scheme for color generation + * \see setBaseColor */ QColor baseColor() const; /** Get the current context for the color grid - * @returns context string which is passed to scheme for color generation - * @see setContext + * \returns context string which is passed to scheme for color generation + * \see setContext */ QString context() const; /** Sets the current context for the color grid - * @param context string which is passed to scheme for color generation - * @see context + * \param context string which is passed to scheme for color generation + * \see context */ void setContext( const QString &context ); /** Sets whether the parent menu should be dismissed and closed when a color is selected * from the action's color widget. - * @param dismiss set to true (default) to immediately close the menu when a color is selected + * \param dismiss set to true (default) to immediately close the menu when a color is selected * from the widget. If set to false, the colorChanged signal will be emitted but the menu will * stay open. - * @see dismissOnColorSelection() + * \see dismissOnColorSelection() * \since QGIS 2.14 */ void setDismissOnColorSelection( bool dismiss ) { mDismissOnColorSelection = dismiss; } /** Returns whether the parent menu will be dismissed after a color is selected from the * action's color widget. - * @see setDismissOnColorSelection + * \see setDismissOnColorSelection * \since QGIS 2.14 */ bool dismissOnColorSelection() const { return mDismissOnColorSelection; } @@ -218,7 +218,7 @@ class GUI_EXPORT QgsColorSwatchGridAction: public QWidgetAction signals: /** Emitted when a color has been selected from the widget - * @param color selected color + * \param color selected color */ void colorChanged( const QColor &color ); diff --git a/src/gui/qgscolorwidgets.h b/src/gui/qgscolorwidgets.h index fb8b7d5866f7..ddde6e41d0fc 100644 --- a/src/gui/qgscolorwidgets.h +++ b/src/gui/qgscolorwidgets.h @@ -55,57 +55,57 @@ class GUI_EXPORT QgsColorWidget : public QWidget }; /** Construct a new color widget. - * @param parent parent QWidget for the widget - * @param component color component the widget alters + * \param parent parent QWidget for the widget + * \param component color component the widget alters */ QgsColorWidget( QWidget *parent = nullptr, const ColorComponent component = Multiple ); /** Returns the current color for the widget - * @returns current widget color - * @see setColor + * \returns current widget color + * \see setColor */ QColor color() const; /** Returns the color component which the widget controls - * @returns color component for widget - * @see setComponent + * \returns color component for widget + * \see setComponent */ ColorComponent component() const { return mComponent; } /** Returns the current value of the widget's color component - * @returns value of color component, or -1 if widget has multiple components or an invalid color + * \returns value of color component, or -1 if widget has multiple components or an invalid color * set - * @see setComponentValue - * @see component + * \see setComponentValue + * \see component */ int componentValue() const; /** Create an icon for dragging colors - * @param color for icon + * \param color for icon */ static QPixmap createDragIcon( const QColor &color ); public slots: /** Sets the color for the widget - * @param color widget color - * @param emitSignals set to true to emit the colorChanged signal after setting color - * @see color + * \param color widget color + * \param emitSignals set to true to emit the colorChanged signal after setting color + * \see color */ virtual void setColor( const QColor &color, const bool emitSignals = false ); /** Sets the color component which the widget controls - * @param component color component for widget - * @see component + * \param component color component for widget + * \see component */ virtual void setComponent( const ColorComponent component ); /** Alters the widget's color by setting the value for the widget's color component - * @param value value for widget's color component. This value is automatically + * \param value value for widget's color component. This value is automatically * clipped to the range of valid values for the color component. - * @see componentValue - * @see setComponent - * @note this method has no effect if the widget is set to the QgsColorWidget::Multiple + * \see componentValue + * \see setComponent + * \note this method has no effect if the widget is set to the QgsColorWidget::Multiple * component */ virtual void setComponentValue( const int value ); @@ -113,7 +113,7 @@ class GUI_EXPORT QgsColorWidget : public QWidget signals: /** Emitted when the widget's color changes - * @param color new widget color + * \param color new widget color */ void colorChanged( const QColor &color ); @@ -134,39 +134,39 @@ class GUI_EXPORT QgsColorWidget : public QWidget int mExplicitHue; /** Returns the range of valid values for the color widget's component - * @returns maximum value allowed for color component, or -1 if widget has multiple components + * \returns maximum value allowed for color component, or -1 if widget has multiple components */ int componentRange() const; /** Returns the range of valid values a color component - * @returns maximum value allowed for color component + * \returns maximum value allowed for color component */ int componentRange( const ColorComponent component ) const; /** Returns the value of a component of the widget's current color. This method correctly * handles hue values when the color has an ambiguous hue (e.g., black or white shades) - * @param component color component to return - * @returns value of color component, or -1 if widget has an invalid color set - * @see hue + * \param component color component to return + * \returns value of color component, or -1 if widget has an invalid color set + * \see hue */ int componentValue( const ColorComponent component ) const; /** Returns the hue for the widget. This may differ from the hue for the QColor returned by color(), * as QColor returns a hue of -1 if the color's hue is ambiguous (e.g., if the saturation is zero). - * @returns explicitly set hue for widget + * \returns explicitly set hue for widget */ int hue() const; /** Alters a color by modifiying the value of a specific color component - * @param color color to alter - * @param component color component to alter - * @param newValue new value of color component. Values are automatically clipped to a + * \param color color to alter + * \param component color component to alter + * \param newValue new value of color component. Values are automatically clipped to a * valid range for the color component. */ void alterColor( QColor &color, const QgsColorWidget::ColorComponent component, const int newValue ) const; /** Generates a checkboard pattern pixmap for use as a background to transparent colors - * @returns checkerboard pixmap + * \returns checkerboard pixmap */ static const QPixmap &transparentBackground(); @@ -185,8 +185,8 @@ class GUI_EXPORT QgsColorWidget : public QWidget /** \ingroup gui * \class QgsColorWidgetAction * An action containing a color widget, which can be embedded into a menu. - * @see QgsColorWidget - * @note introduced in QGIS 2.14 + * \see QgsColorWidget + * \since QGIS 2.14 */ class GUI_EXPORT QgsColorWidgetAction: public QWidgetAction @@ -196,9 +196,9 @@ class GUI_EXPORT QgsColorWidgetAction: public QWidgetAction public: /** Construct a new color widget action. - * @param colorWidget QgsColorWidget to show in action - * @param menu parent menu - * @param parent parent widget + * \param colorWidget QgsColorWidget to show in action + * \param menu parent menu + * \param parent parent widget */ QgsColorWidgetAction( QgsColorWidget *colorWidget, QMenu *menu = nullptr, QWidget *parent = nullptr ); @@ -208,23 +208,23 @@ class GUI_EXPORT QgsColorWidgetAction: public QWidgetAction /** Sets whether the parent menu should be dismissed and closed when a color is selected * from the action's color widget. - * @param dismiss set to true (default) to immediately close the menu when a color is selected + * \param dismiss set to true (default) to immediately close the menu when a color is selected * from the widget. If set to false, the colorChanged signal will be emitted but the menu will * stay open. - * @see dismissOnColorSelection() + * \see dismissOnColorSelection() */ void setDismissOnColorSelection( bool dismiss ) { mDismissOnColorSelection = dismiss; } /** Returns whether the parent menu will be dismissed after a color is selected from the * action's color widget. - * @see setDismissOnColorSelection + * \see setDismissOnColorSelection */ bool dismissOnColorSelection() const { return mDismissOnColorSelection; } signals: /** Emitted when a color has been selected from the widget - * @param color selected color + * \param color selected color */ void colorChanged( const QColor &color ); @@ -264,7 +264,7 @@ class GUI_EXPORT QgsColorWheel : public QgsColorWidget public: /** Constructs a new color wheel widget. - * @param parent parent QWidget for the widget + * \param parent parent QWidget for the widget */ QgsColorWheel( QWidget *parent = nullptr ); @@ -321,7 +321,7 @@ class GUI_EXPORT QgsColorWheel : public QgsColorWidget QBrush mWheelBrush; /** Creates cache images for specified widget size - * @param size widget size for images + * \param size widget size for images */ void createImages( const QSizeF size ); @@ -332,7 +332,7 @@ class GUI_EXPORT QgsColorWheel : public QgsColorWidget void createTriangle(); /** Sets the widget color based on a point in the widget - * @param pos position for color + * \param pos position for color */ void setColorFromPos( const QPointF pos ); @@ -354,8 +354,8 @@ class GUI_EXPORT QgsColorBox : public QgsColorWidget public: /** Construct a new color box widget. - * @param parent parent QWidget for the widget - * @param component constant color component for the widget. The color components + * \param parent parent QWidget for the widget + * \param component constant color component for the widget. The color components * which vary along the horizontal and vertical axis are automatically assigned * based on this constant color component. */ @@ -393,12 +393,12 @@ class GUI_EXPORT QgsColorBox : public QgsColorWidget void createBox(); /** Returns the range of permissible values along the x axis - * @returns maximum color component value for x axis + * \returns maximum color component value for x axis */ int valueRangeX() const; /** Returns the range of permissible values along the y axis - * @returns maximum color component value for y axis + * \returns maximum color component value for y axis */ int valueRangeY() const; @@ -419,7 +419,7 @@ class GUI_EXPORT QgsColorBox : public QgsColorWidget int xComponentValue() const; /** Updates the widget's color based on a point within the widget - * @param point point within the widget + * \param point point within the widget */ void setColorFromPoint( QPoint point ); @@ -448,9 +448,9 @@ class GUI_EXPORT QgsColorRampWidget : public QgsColorWidget }; /** Construct a new color ramp widget. - * @param parent parent QWidget for the widget - * @param component color component which varies along the ramp - * @param orientation orientation for widget + * \param parent parent QWidget for the widget + * \param component color component which varies along the ramp + * \param orientation orientation for widget */ QgsColorRampWidget( QWidget *parent = nullptr, const ColorComponent component = QgsColorWidget::Red, @@ -460,50 +460,50 @@ class GUI_EXPORT QgsColorRampWidget : public QgsColorWidget void paintEvent( QPaintEvent *event ) override; /** Sets the orientation for the color ramp - * @param orientation new orientation for the ramp - * @see orientation + * \param orientation new orientation for the ramp + * \see orientation */ void setOrientation( const Orientation orientation ); /** Fetches the orientation for the color ramp - * @returns orientation for the ramp - * @see setOrientation + * \returns orientation for the ramp + * \see setOrientation */ Orientation orientation() const { return mOrientation; } /** Sets the margin between the edge of the widget and the ramp - * @param margin margin around the ramp - * @see interiorMargin + * \param margin margin around the ramp + * \see interiorMargin */ void setInteriorMargin( const int margin ); /** Fetches the margin between the edge of the widget and the ramp - * @returns margin around the ramp - * @see setInteriorMargin + * \returns margin around the ramp + * \see setInteriorMargin */ int interiorMargin() const { return mMargin; } /** Sets whether the ramp should be drawn within a frame - * @param showFrame set to true to draw a frame around the ramp - * @see showFrame + * \param showFrame set to true to draw a frame around the ramp + * \see showFrame */ void setShowFrame( const bool showFrame ); /** Fetches whether the ramp is drawn within a frame - * @returns true if a frame is drawn around the ramp - * @see setShowFrame + * \returns true if a frame is drawn around the ramp + * \see setShowFrame */ bool showFrame() const { return mShowFrame; } /** Sets the size for drawing the triangular markers on the ramp - * @param markerSize marker size in pixels + * \param markerSize marker size in pixels */ void setMarkerSize( const int markerSize ); signals: /** Emitted when the widget's color component value changes - * @param value new value of color component + * \param value new value of color component */ void valueChanged( const int value ); @@ -532,7 +532,7 @@ class GUI_EXPORT QgsColorRampWidget : public QgsColorWidget QPolygonF mBottomTriangle; /** Updates the widget's color based on a point within the widget - * @param point point within the widget + * \param point point within the widget */ void setColorFromPoint( QPointF point ); @@ -552,8 +552,8 @@ class GUI_EXPORT QgsColorSliderWidget : public QgsColorWidget public: /** Construct a new color slider widget. - * @param parent parent QWidget for the widget - * @param component color component which is controlled by the slider + * \param parent parent QWidget for the widget + * \param component color component which is controlled by the slider */ QgsColorSliderWidget( QWidget *parent = nullptr, const ColorComponent component = QgsColorWidget::Red ); @@ -571,16 +571,16 @@ class GUI_EXPORT QgsColorSliderWidget : public QgsColorWidget /** Converts the real value of a color component to a friendly display value. For instance, * alpha values from 0-255 have little meaning to users, so we translate them to 0-100% - * @param realValue actual value of the color component - * @returns display value of color component - * @see convertDisplayToReal + * \param realValue actual value of the color component + * \returns display value of color component + * \see convertDisplayToReal */ int convertRealToDisplay( const int realValue ) const; /** Converts the display value of a color component to a real value. - * @param displayValue friendly display value of the color component - * @returns real value of color component - * @see convertRealToDisplay + * \param displayValue friendly display value of the color component + * \returns real value of color component + * \see convertRealToDisplay */ int convertDisplayToReal( const int displayValue ) const; @@ -615,7 +615,7 @@ class GUI_EXPORT QgsColorTextWidget : public QgsColorWidget public: /** Construct a new color line edit widget. - * @param parent parent QWidget for the widget + * \param parent parent QWidget for the widget */ QgsColorTextWidget( QWidget *parent = nullptr ); @@ -673,7 +673,7 @@ class GUI_EXPORT QgsColorPreviewWidget : public QgsColorWidget public: /** Construct a new color preview widget. - * @param parent parent QWidget for the widget + * \param parent parent QWidget for the widget */ QgsColorPreviewWidget( QWidget *parent = nullptr ); @@ -681,20 +681,20 @@ class GUI_EXPORT QgsColorPreviewWidget : public QgsColorWidget virtual QSize sizeHint() const override; /** Returns the secondary color for the widget - * @returns secondary widget color, or an invalid color if the widget + * \returns secondary widget color, or an invalid color if the widget * has no secondary color - * @see color - * @see setColor2 + * \see color + * \see setColor2 */ QColor color2() const { return mColor2; } public slots: /** Sets the second color for the widget - * @param color secondary widget color. Set to an invalid color to prevent + * \param color secondary widget color. Set to an invalid color to prevent * drawing of a secondary color - * @see setColor - * @see color2 + * \see setColor + * \see color2 */ virtual void setColor2( const QColor &color ); @@ -717,9 +717,9 @@ class GUI_EXPORT QgsColorPreviewWidget : public QgsColorWidget QPoint mDragStartPosition; /*Draws a color preview within the specified rect. - * @param color color to draw - * @param rect rect to draw color in - * @param painter destination painter + * \param color color to draw + * \param rect rect to draw color in + * \param painter destination painter */ void drawColor( const QColor &color, QRect rect, QPainter &painter ); }; diff --git a/src/gui/qgscomposeritemcombobox.h b/src/gui/qgscomposeritemcombobox.h index 9d82b62e3eab..89ffbd2df0e9 100644 --- a/src/gui/qgscomposeritemcombobox.h +++ b/src/gui/qgscomposeritemcombobox.h @@ -38,8 +38,8 @@ class GUI_EXPORT QgsComposerItemComboBox : public QComboBox /** * QgsComposerItemComboBox creates a combo box to display a list of items in a * composition. The items can optionally be filtered by type. - * @param parent parent widget - * @param composition composition to show items from. If not set, no items will be shown + * \param parent parent widget + * \param composition composition to show items from. If not set, no items will be shown * until setComposition() is called */ explicit QgsComposerItemComboBox( QWidget *parent = nullptr, QgsComposition *composition = nullptr ); @@ -49,31 +49,31 @@ class GUI_EXPORT QgsComposerItemComboBox : public QComboBox void setComposition( QgsComposition *composition ); /** Sets a filter for the item type to show in the combo box. - * @param itemType type of items to show. Set to QgsComposerItem::ComposerItem to + * \param itemType type of items to show. Set to QgsComposerItem::ComposerItem to * show all items. - * @see itemType() + * \see itemType() */ void setItemType( QgsComposerItem::ItemType itemType ); /** Returns the filter for the item types to show in the combo box. - * @see setItemType() + * \see setItemType() */ QgsComposerItem::ItemType itemType() const; /** Sets a list of specific items to exclude from the combo box. - * @param exceptList list of items to exclude - * @see exceptedItemList() + * \param exceptList list of items to exclude + * \see exceptedItemList() */ void setExceptedItemList( const QList< QgsComposerItem * > &exceptList ); /** Returns the list of specific items excluded from the combo box. - * @see setExceptedItemList() + * \see setExceptedItemList() */ QList< QgsComposerItem * > exceptedItemList() const; /** Return the item currently shown at the specified index within the combo box. - * @param index position of item to return - * @see currentItem() + * \param index position of item to return + * \see currentItem() */ QgsComposerItem *item( int index ) const; @@ -84,7 +84,7 @@ class GUI_EXPORT QgsComposerItemComboBox : public QComboBox public slots: /** Sets the currently selected item in the combo box. - * @param item selected item + * \param item selected item */ void setItem( const QgsComposerItem *item ); diff --git a/src/gui/qgscomposerview.h b/src/gui/qgscomposerview.h index c966a890e077..36ca0acfe633 100644 --- a/src/gui/qgscomposerview.h +++ b/src/gui/qgscomposerview.h @@ -152,36 +152,36 @@ class GUI_EXPORT QgsComposerView: public QGraphicsView /** Scales the view in a safe way, by limiting the acceptable range * of the scale applied. - * @param scale factor to scale view by + * \param scale factor to scale view by * \since QGIS 2.16 */ void scaleSafe( double scale ); /** Sets whether a preview effect should be used to alter the view's appearance - * @param enabled Set to true to enable the preview effect on the view + * \param enabled Set to true to enable the preview effect on the view * \since QGIS 2.3 - * @see setPreviewMode + * \see setPreviewMode */ void setPreviewModeEnabled( bool enabled ); /** Sets the preview mode which should be used to modify the view's appearance. Preview modes are only used * if setPreviewMode is set to true. - * @param mode PreviewMode to be used to draw the view + * \param mode PreviewMode to be used to draw the view * \since QGIS 2.3 - * @see setPreviewModeEnabled + * \see setPreviewModeEnabled */ void setPreviewMode( QgsPreviewEffect::PreviewMode mode ); /** Sets the map canvas associated with the view. This allows the * view to retrieve map settings from the canvas. * \since QGIS 3.0 - * @see mapCanvas() + * \see mapCanvas() */ void setMapCanvas( QgsMapCanvas *canvas ); /** * Returns the map canvas associated with the view. - * @see setMapCanvas() + * \see setMapCanvas() * \since QGIS 3.0 */ QgsMapCanvas *mapCanvas() const; diff --git a/src/gui/qgscompoundcolorwidget.h b/src/gui/qgscompoundcolorwidget.h index 6e282612c74e..f277a287f813 100644 --- a/src/gui/qgscompoundcolorwidget.h +++ b/src/gui/qgscompoundcolorwidget.h @@ -43,28 +43,28 @@ class GUI_EXPORT QgsCompoundColorWidget : public QgsPanelWidget, private Ui::Qgs }; /** Constructor for QgsCompoundColorWidget - * @param parent parent widget - * @param color initial color for dialog - * @param layout widget layout to use + * \param parent parent widget + * \param color initial color for dialog + * \param layout widget layout to use */ QgsCompoundColorWidget( QWidget *parent = nullptr, const QColor &color = QColor(), Layout layout = LayoutDefault ); ~QgsCompoundColorWidget(); /** Returns the current color for the dialog - * @returns dialog color + * \returns dialog color */ QColor color() const; /** Sets whether alpha modification (transparency) is permitted * for the color dialog. Defaults to true. - * @param allowAlpha set to false to disable alpha modification + * \param allowAlpha set to false to disable alpha modification */ void setAllowAlpha( const bool allowAlpha ); /** Sets whether the widget's color has been "discarded" and the selected color should not * be stored in the recent color list. - * @param discarded set to true to avoid adding color to recent color list on widget destruction. + * \param discarded set to true to avoid adding color to recent color list on widget destruction. * \since QGIS 3.0 */ void setDiscarded( bool discarded ) { mDiscarded = discarded; } @@ -72,19 +72,19 @@ class GUI_EXPORT QgsCompoundColorWidget : public QgsPanelWidget, private Ui::Qgs signals: /** Emitted when the dialog's color changes - * @param color current color + * \param color current color */ void currentColorChanged( const QColor &color ); public slots: /** Sets the current color for the dialog - * @param color desired color + * \param color desired color */ void setColor( const QColor &color ); /** Sets the color to show in an optional "previous color" section - * @param color previous color + * \param color previous color */ void setPreviousColor( const QColor &color ); @@ -140,21 +140,21 @@ class GUI_EXPORT QgsCompoundColorWidget : public QgsPanelWidget, private Ui::Qgs void saveSettings(); /** Ends a color picking operation - * @param eventPos global position of pixel to sample color from - * @param takeSample set to true to actually sample the color, false to just cancel + * \param eventPos global position of pixel to sample color from + * \param takeSample set to true to actually sample the color, false to just cancel * the color picking operation */ void stopPicking( QPoint eventPos, const bool takeSample = true ); /** Returns the average color from the pixels in an image - * @param image image to sample - * @returns average color from image + * \param image image to sample + * \returns average color from image */ QColor averageColor( const QImage &image ) const; /** Samples a color from the desktop - * @param point position of color to sample - * @returns average color from sampled position + * \param point position of color to sample + * \returns average color from sampled position */ QColor sampleColor( QPoint point ) const; diff --git a/src/gui/qgsconfigureshortcutsdialog.cpp b/src/gui/qgsconfigureshortcutsdialog.cpp index 637f76f3dc4f..7aa124029994 100644 --- a/src/gui/qgsconfigureshortcutsdialog.cpp +++ b/src/gui/qgsconfigureshortcutsdialog.cpp @@ -59,18 +59,12 @@ QgsConfigureShortcutsDialog::~QgsConfigureShortcutsDialog() saveState(); } -/*! - * Function to save dialog window state - */ void QgsConfigureShortcutsDialog::saveState() { QgsSettings settings; settings.setValue( QStringLiteral( "Windows/ShortcutsDialog/geometry" ), saveGeometry() ); } -/*! - * Function to restore dialog window state - */ void QgsConfigureShortcutsDialog::restoreState() { QgsSettings settings; diff --git a/src/gui/qgsconfigureshortcutsdialog.h b/src/gui/qgsconfigureshortcutsdialog.h index 07c65a6c6233..d1096c26a09f 100644 --- a/src/gui/qgsconfigureshortcutsdialog.h +++ b/src/gui/qgsconfigureshortcutsdialog.h @@ -37,8 +37,8 @@ class GUI_EXPORT QgsConfigureShortcutsDialog : public QDialog, private Ui::QgsCo public: /** Constructor for QgsConfigureShortcutsDialog. - * @param parent parent widget - * @param manager associated QgsShortcutsManager, or leave as null to use the default + * \param parent parent widget + * \param manager associated QgsShortcutsManager, or leave as null to use the default * singleton QgsShortcutsManager instance. */ QgsConfigureShortcutsDialog( QWidget *parent = nullptr, QgsShortcutsManager *manager = nullptr ); diff --git a/src/gui/qgscredentialdialog.h b/src/gui/qgscredentialdialog.h index 01b86c3452b5..4a5f1af8e7cc 100644 --- a/src/gui/qgscredentialdialog.h +++ b/src/gui/qgscredentialdialog.h @@ -37,10 +37,10 @@ class GUI_EXPORT QgsCredentialDialog : public QDialog, public QgsCredentials, pr signals: - //! @note not available in Python bindings + //! \note not available in Python bindings void credentialsRequested( const QString &, QString *, QString *, const QString &, bool * ); - //! @note not available in Python bindings + //! \note not available in Python bindings void credentialsRequestedMasterPassword( QString *, bool, bool * ); private slots: diff --git a/src/gui/qgscurveeditorwidget.h b/src/gui/qgscurveeditorwidget.h index 022c25c75207..b4a73dfc5d53 100644 --- a/src/gui/qgscurveeditorwidget.h +++ b/src/gui/qgscurveeditorwidget.h @@ -149,13 +149,13 @@ class GUI_EXPORT QgsCurveEditorWidget : public QWidget /** * Returns a curve representing the current curve from the widget. - * @see setCurve() + * \see setCurve() */ QgsCurveTransform curve() const { return mCurve; } /** * Sets the \a curve to show in the widget. - * @see curve() + * \see curve() */ void setCurve( const QgsCurveTransform &curve ); @@ -163,22 +163,22 @@ class GUI_EXPORT QgsCurveEditorWidget : public QWidget * Sets a \a layer and \a expression source for values to show in a histogram * behind the curve. The histogram is generated in a background thread to keep * the widget responsive. - * @see minHistogramValueRange() - * @see maxHistogramValueRange() + * \see minHistogramValueRange() + * \see maxHistogramValueRange() */ void setHistogramSource( const QgsVectorLayer *layer, const QString &expression ); /** * Returns the minimum expected value for the range of values shown in the histogram. - * @see maxHistogramValueRange() - * @see setMinHistogramValueRange() + * \see maxHistogramValueRange() + * \see setMinHistogramValueRange() */ double minHistogramValueRange() const { return mMinValueRange; } /** * Returns the maximum expected value for the range of values shown in the histogram. - * @see minHistogramValueRange() - * @see setMaxHistogramValueRange() + * \see minHistogramValueRange() + * \see setMaxHistogramValueRange() */ double maxHistogramValueRange() const { return mMaxValueRange; } @@ -186,15 +186,15 @@ class GUI_EXPORT QgsCurveEditorWidget : public QWidget /** * Sets the minimum expected value for the range of values shown in the histogram. - * @see setMaxHistogramValueRange() - * @see minHistogramValueRange() + * \see setMaxHistogramValueRange() + * \see minHistogramValueRange() */ void setMinHistogramValueRange( double minValueRange ); /** * Sets the maximum expected value for the range of values shown in the histogram. - * @see setMinHistogramValueRange() - * @see maxHistogramValueRange() + * \see setMinHistogramValueRange() + * \see maxHistogramValueRange() */ void setMaxHistogramValueRange( double maxValueRange ); diff --git a/src/gui/qgsdetaileditemdata.h b/src/gui/qgsdetaileditemdata.h index 1bb2ea0cc6a4..99cce92d4c5a 100644 --- a/src/gui/qgsdetaileditemdata.h +++ b/src/gui/qgsdetaileditemdata.h @@ -42,7 +42,7 @@ class GUI_EXPORT QgsDetailedItemData /** This is a hint to the delegate to render using * a widget rather than manually painting every * part of the list item. - * @note the delegate may completely ignore this + * \note the delegate may completely ignore this * depending on the delegate implementation. */ void setRenderAsWidget( bool flag ); diff --git a/src/gui/qgsdetaileditemdelegate.h b/src/gui/qgsdetaileditemdelegate.h index 5cca7065f881..a0ea8ecbd64d 100644 --- a/src/gui/qgsdetaileditemdelegate.h +++ b/src/gui/qgsdetaileditemdelegate.h @@ -30,7 +30,7 @@ class QFont; /** \ingroup gui * A custom model/view delegate that can display an icon, heading * and detail sections. - * @see also QgsDetailedItemData + * \see also QgsDetailedItemData */ class GUI_EXPORT QgsDetailedItemDelegate : public QAbstractItemDelegate { diff --git a/src/gui/qgsdetaileditemwidget.h b/src/gui/qgsdetaileditemwidget.h index 833024d23193..497cf254b60d 100644 --- a/src/gui/qgsdetaileditemwidget.h +++ b/src/gui/qgsdetaileditemwidget.h @@ -23,7 +23,7 @@ /** \ingroup gui * A widget renderer for detailed item views. - * @see also QgsDetailedItem and QgsDetailedItemData. + * \see also QgsDetailedItem and QgsDetailedItemData. */ class GUI_EXPORT QgsDetailedItemWidget : public QWidget, private Ui::QgsDetailedItemWidgetBase diff --git a/src/gui/qgsdockwidget.h b/src/gui/qgsdockwidget.h index 3093a25fff77..de47ea3c6ae5 100644 --- a/src/gui/qgsdockwidget.h +++ b/src/gui/qgsdockwidget.h @@ -33,22 +33,22 @@ class GUI_EXPORT QgsDockWidget : public QDockWidget public: /** Constructor for QgsDockWidget. - * @param parent parent widget - * @param flags window flags + * \param parent parent widget + * \param flags window flags */ explicit QgsDockWidget( QWidget *parent = nullptr, Qt::WindowFlags flags = 0 ); /** Constructor for QgsDockWidget. - * @param title dock title - * @param parent parent widget - * @param flags window flags + * \param title dock title + * \param parent parent widget + * \param flags window flags */ explicit QgsDockWidget( const QString &title, QWidget *parent = nullptr, Qt::WindowFlags flags = 0 ); public slots: /** Sets the dock widget as visible to a user, ie both shown and raised to the front. - * @param visible set to true to show the dock to the user, or false to hide the dock. + * \param visible set to true to show the dock to the user, or false to hide the dock. * When setting a dock as user visible, the dock will be opened (if it is not already * opened) and raised to the front. * When setting as hidden, the following logic is used: @@ -57,13 +57,13 @@ class GUI_EXPORT QgsDockWidget : public QDockWidget * - hiding a dock which is open and raised (ie, user visible) will cause the dock to * be closed * - hiding a dock which is closed has no effect and raises no signals - * @see isUserVisible() + * \see isUserVisible() */ void setUserVisible( bool visible ); /** Returns true if the dock is both opened and raised to the front (ie not hidden by * any other tabs. - * @see setUserVisible() + * \see setUserVisible() */ bool isUserVisible() const; @@ -75,28 +75,28 @@ class GUI_EXPORT QgsDockWidget : public QDockWidget signals: /** Emitted when dock widget is closed. - * @see closedStateChanged() - * @see opened() + * \see closedStateChanged() + * \see opened() */ void closed(); /** Emitted when dock widget is closed (or opened). - * @param wasClosed will be true if dock widget was closed, or false if dock widget was opened - * @see closed() - * @see openedStateChanged() + * \param wasClosed will be true if dock widget was closed, or false if dock widget was opened + * \see closed() + * \see openedStateChanged() */ void closedStateChanged( bool wasClosed ); /** Emitted when dock widget is opened. - * @see openedStateChanged() - * @see closed() + * \see openedStateChanged() + * \see closed() */ void opened(); /** Emitted when dock widget is opened (or closed). - * @param wasOpened will be true if dock widget was opened, or false if dock widget was closed - * @see closedStateChanged() - * @see opened() + * \param wasOpened will be true if dock widget was opened, or false if dock widget was closed + * \see closedStateChanged() + * \see opened() */ void openedStateChanged( bool wasOpened ); diff --git a/src/gui/qgserrordialog.h b/src/gui/qgserrordialog.h index 802ccc0e450c..9c448f27d537 100644 --- a/src/gui/qgserrordialog.h +++ b/src/gui/qgserrordialog.h @@ -34,10 +34,10 @@ class GUI_EXPORT QgsErrorDialog: public QDialog, private Ui::QgsErrorDialogBase QgsErrorDialog( const QgsError &error, const QString &title, QWidget *parent = nullptr, Qt::WindowFlags fl = QgisGui::ModalDialogFlags ); /** Show dialog with error - * @param error error - * @param title title - * @param parent parent object - * @param fl widget flags + * \param error error + * \param title title + * \param parent parent object + * \param fl widget flags */ static void show( const QgsError &error, const QString &title, QWidget *parent = nullptr, Qt::WindowFlags fl = QgisGui::ModalDialogFlags ); diff --git a/src/gui/qgsexpressionbuilderdialog.h b/src/gui/qgsexpressionbuilderdialog.h index fd906a64efd5..d27cc32ff7aa 100644 --- a/src/gui/qgsexpressionbuilderdialog.h +++ b/src/gui/qgsexpressionbuilderdialog.h @@ -41,15 +41,15 @@ class GUI_EXPORT QgsExpressionBuilderDialog : public QDialog, private Ui::QgsExp /** Returns the expression context for the dialog. The context is used for the expression * preview result and for populating the list of available functions and variables. - * @see setExpressionContext + * \see setExpressionContext * \since QGIS 2.12 */ QgsExpressionContext expressionContext() const; /** Sets the expression context for the dialog. The context is used for the expression * preview result and for populating the list of available functions and variables. - * @param context expression context - * @see expressionContext + * \param context expression context + * \see expressionContext * \since QGIS 2.12 */ void setExpressionContext( const QgsExpressionContext &context ); @@ -63,7 +63,7 @@ class GUI_EXPORT QgsExpressionBuilderDialog : public QDialog, private Ui::QgsExp * Is called when the dialog get accepted or rejected * Used to save geometry * - * @param r result value (unused) + * \param r result value (unused) */ virtual void done( int r ) override; diff --git a/src/gui/qgsexpressionbuilderwidget.h b/src/gui/qgsexpressionbuilderwidget.h index d73baf81fe00..3b546aa25f00 100644 --- a/src/gui/qgsexpressionbuilderwidget.h +++ b/src/gui/qgsexpressionbuilderwidget.h @@ -70,19 +70,19 @@ class QgsExpressionItem : public QStandardItem /** Get the help text that is associated with this expression item. * - * @return The help text. + * \returns The help text. */ QString getHelpText() const { return mHelpText; } /** Set the help text for the current item * - * @note The help text can be set as a html string. + * \note The help text can be set as a html string. */ void setHelpText( const QString &helpText ) { mHelpText = helpText; } /** Get the type of expression item, e.g., header, field, ExpressionNode. * - * @return The QgsExpressionItem::ItemType + * \returns The QgsExpressionItem::ItemType */ QgsExpressionItem::ItemType getItemType() const { return mType; } @@ -134,7 +134,7 @@ class GUI_EXPORT QgsExpressionBuilderWidget : public QWidget, private Ui::QgsExp ~QgsExpressionBuilderWidget(); /** Sets layer in order to get the fields and values - * @note this needs to be called before calling loadFieldNames(). + * \note this needs to be called before calling loadFieldNames(). */ void setLayer( QgsVectorLayer *layer ); @@ -146,7 +146,7 @@ class GUI_EXPORT QgsExpressionBuilderWidget : public QWidget, private Ui::QgsExp void loadFieldNames( const QgsFields &fields ); /** Loads field names and values from the specified map. - * @note The field values must be quoted appropriately if they are strings. + * \note The field values must be quoted appropriately if they are strings. * \since QGIS 2.12 */ void loadFieldsAndValues( const QMap &fieldValues ); @@ -155,7 +155,7 @@ class GUI_EXPORT QgsExpressionBuilderWidget : public QWidget, private Ui::QgsExp void setGeomCalculator( const QgsDistanceArea &da ); /** Gets the expression string that has been set in the expression area. - * @returns The expression as a string. */ + * \returns The expression as a string. */ QString expressionText(); //! Sets the expression string for the widget @@ -163,27 +163,27 @@ class GUI_EXPORT QgsExpressionBuilderWidget : public QWidget, private Ui::QgsExp /** Returns the expression context for the widget. The context is used for the expression * preview result and for populating the list of available functions and variables. - * @see setExpressionContext + * \see setExpressionContext * \since QGIS 2.12 */ QgsExpressionContext expressionContext() const { return mExpressionContext; } /** Sets the expression context for the widget. The context is used for the expression * preview result and for populating the list of available functions and variables. - * @param context expression context - * @see expressionContext + * \param context expression context + * \see expressionContext * \since QGIS 2.12 */ void setExpressionContext( const QgsExpressionContext &context ); /** Registers a node item for the expression builder. - * @param group The group the item will be show in the tree view. If the group doesn't exsit it will be created. - * @param label The label that is show to the user for the item in the tree. - * @param expressionText The text that is inserted into the expression area when the user double clicks on the item. - * @param helpText The help text that the user will see when item is selected. - * @param type The type of the expression item. - * @param highlightedItem set to true to make the item highlighted, which inserts a bold copy of the item at the top level - * @param sortOrder sort ranking for item + * \param group The group the item will be show in the tree view. If the group doesn't exsit it will be created. + * \param label The label that is show to the user for the item in the tree. + * \param expressionText The text that is inserted into the expression area when the user double clicks on the item. + * \param helpText The help text that the user will see when item is selected. + * \param type The type of the expression item. + * \param highlightedItem set to true to make the item highlighted, which inserts a bold copy of the item at the top level + * \param sortOrder sort ranking for item */ void registerItem( const QString &group, const QString &label, const QString &expressionText, const QString &helpText = "", @@ -244,7 +244,7 @@ class GUI_EXPORT QgsExpressionBuilderWidget : public QWidget, private Ui::QgsExp /** * Enabled or disable auto saving. When enabled Python scripts will be auto saved * when text changes. - * @param enabled True to enable auto saving. + * \param enabled True to enable auto saving. */ void setAutoSave( bool enabled ) { mAutoSave = enabled; } @@ -269,7 +269,7 @@ class GUI_EXPORT QgsExpressionBuilderWidget : public QWidget, private Ui::QgsExp /** Emitted when the user changes the expression in the widget. * Users of this widget should connect to this signal to decide if to let the user * continue. - * @param isValid Is true if the expression the user has typed is valid. + * \param isValid Is true if the expression the user has typed is valid. */ void expressionParsed( bool isValid ); @@ -286,13 +286,13 @@ class GUI_EXPORT QgsExpressionBuilderWidget : public QWidget, private Ui::QgsExp void loadExpressionContext(); /** Registers a node item for the expression builder, adding multiple items when the function exists in multiple groups - * @param groups The groups the item will be show in the tree view. If a group doesn't exist it will be created. - * @param label The label that is show to the user for the item in the tree. - * @param expressionText The text that is inserted into the expression area when the user double clicks on the item. - * @param helpText The help text that the user will see when item is selected. - * @param type The type of the expression item. - * @param highlightedItem set to true to make the item highlighted, which inserts a bold copy of the item at the top level - * @param sortOrder sort ranking for item + * \param groups The groups the item will be show in the tree view. If a group doesn't exist it will be created. + * \param label The label that is show to the user for the item in the tree. + * \param expressionText The text that is inserted into the expression area when the user double clicks on the item. + * \param helpText The help text that the user will see when item is selected. + * \param type The type of the expression item. + * \param highlightedItem set to true to make the item highlighted, which inserts a bold copy of the item at the top level + * \param sortOrder sort ranking for item */ void registerItemForAllGroups( const QStringList &groups, const QString &label, const QString &expressionText, const QString &helpText = "", diff --git a/src/gui/qgsexpressionlineedit.h b/src/gui/qgsexpressionlineedit.h index 271a75d2a7e8..9a03d20d2767 100644 --- a/src/gui/qgsexpressionlineedit.h +++ b/src/gui/qgsexpressionlineedit.h @@ -29,8 +29,8 @@ class QgsExpressionContextGenerator; class QgsCodeEditorSQL; /** \ingroup gui - * @class QgsExpressionLineEdit - * @brief The QgsExpressionLineEdit widget includes a line edit for entering expressions + * \class QgsExpressionLineEdit + * \brief The QgsExpressionLineEdit widget includes a line edit for entering expressions * together with a button to open the expression creation dialog. * * This widget is designed for use in contexts where no layer fields are available for @@ -52,33 +52,33 @@ class GUI_EXPORT QgsExpressionLineEdit : public QWidget /** * Constructor for QgsExpressionLineEdit. - * @param parent parent widget + * \param parent parent widget */ explicit QgsExpressionLineEdit( QWidget *parent = nullptr ); /** * Sets the title used in the expression builder dialog - * @param title dialog title - * @see expressionDialogTitle() + * \param title dialog title + * \see expressionDialogTitle() */ void setExpressionDialogTitle( const QString &title ); /** * Returns the title used for the expression dialog. - * @see setExpressionDialogTitle() + * \see setExpressionDialogTitle() */ QString expressionDialogTitle() const { return mExpressionDialogTitle; } /** * Sets whether the widget should show a multiline text editor. - * @param multiLine set to true to show multiline editor, or false + * \param multiLine set to true to show multiline editor, or false * to show single line editor (the default). */ void setMultiLine( bool multiLine ); /** * Set the geometry calculator used in the expression dialog. - * @param distanceArea calculator + * \param distanceArea calculator */ void setGeomCalculator( const QgsDistanceArea &distanceArea ); @@ -88,26 +88,26 @@ class GUI_EXPORT QgsExpressionLineEdit : public QWidget * This will also automatically register the layer as expression context generator if * no generator has been set before or the previous layer has been used as generator. * - * @see registerExpressionContextGenerator + * \see registerExpressionContextGenerator */ void setLayer( QgsVectorLayer *layer ); /** * Returns the current expression shown in the widget. - * @see setExpression() + * \see setExpression() */ QString expression() const; /** * Returns true if the current expression is valid. - * @param expressionError will be set to any generated error message if specified + * \param expressionError will be set to any generated error message if specified */ bool isValidExpression( QString *expressionError = nullptr ) const; /** * Register an expression context generator class that will be used to retrieve * an expression context for the widget. - * @param generator A QgsExpressionContextGenerator class that will be used to + * \param generator A QgsExpressionContextGenerator class that will be used to * create an expression context when required. */ void registerExpressionContextGenerator( const QgsExpressionContextGenerator *generator ); @@ -115,7 +115,7 @@ class GUI_EXPORT QgsExpressionLineEdit : public QWidget signals: /** Emitted when the expression is changed. - * @param expression new expression + * \param expression new expression */ void expressionChanged( const QString &expression ); @@ -123,8 +123,8 @@ class GUI_EXPORT QgsExpressionLineEdit : public QWidget /** * Sets the current expression to show in the widget. - * @param expression expression string - * @see expression() + * \param expression expression string + * \see expression() */ void setExpression( const QString &expression ); @@ -142,8 +142,8 @@ class GUI_EXPORT QgsExpressionLineEdit : public QWidget void editExpression(); /** - * @brief updateLineEditStyle will re-style (color/font) the line edit depending on content and status - * @param expression if expression is given it will be evaluated for the given string, otherwise it takes + * \brief updateLineEditStyle will re-style (color/font) the line edit depending on content and status + * \param expression if expression is given it will be evaluated for the given string, otherwise it takes * current expression from the model */ void updateLineEditStyle( const QString &expression = QString() ); diff --git a/src/gui/qgsexpressionselectiondialog.h b/src/gui/qgsexpressionselectiondialog.h index a303759d34e7..ee3a8e6e3285 100644 --- a/src/gui/qgsexpressionselectiondialog.h +++ b/src/gui/qgsexpressionselectiondialog.h @@ -38,27 +38,27 @@ class GUI_EXPORT QgsExpressionSelectionDialog : public QDialog, private Ui::QgsE /** * Creates a new selection dialog. - * @param layer The layer on which the selection is to be performed. - * @param startText A default expression text to be applied (Defaults to empty) - * @param parent parent object (owner) + * \param layer The layer on which the selection is to be performed. + * \param startText A default expression text to be applied (Defaults to empty) + * \param parent parent object (owner) */ QgsExpressionSelectionDialog( QgsVectorLayer *layer, const QString &startText = QString(), QWidget *parent = nullptr ); /** * The builder widget that is used by the dialog - * @return The builder widget that is used by the dialog + * \returns The builder widget that is used by the dialog */ QgsExpressionBuilderWidget *expressionBuilder(); /** * Sets the current expression text - * @param text the expression text to set + * \param text the expression text to set */ void setExpressionText( const QString &text ); /** * Returns the current expression text - * @return The expression text + * \returns The expression text */ QString expressionText(); @@ -69,7 +69,7 @@ class GUI_EXPORT QgsExpressionSelectionDialog : public QDialog, private Ui::QgsE /** Sets the message bar to display feedback from the dialog. This is used when zooming to * features to display the count of selected features. - * @param messageBar target message bar + * \param messageBar target message bar * \since QGIS 3.0 */ void setMessageBar( QgsMessageBar *messageBar ); @@ -93,14 +93,14 @@ class GUI_EXPORT QgsExpressionSelectionDialog : public QDialog, private Ui::QgsE /** * Implementation for closeEvent * Saves the window geometry - * @param closeEvent Event object. Unused. + * \param closeEvent Event object. Unused. */ virtual void closeEvent( QCloseEvent *closeEvent ) override; /** * Implementation for done (default behavior when pressing esc) * Calls close, so the window geometry gets saved and the object deleted. - * @param r Result value. Unused. + * \param r Result value. Unused. */ virtual void done( int r ) override; diff --git a/src/gui/qgsexternalresourcewidget.h b/src/gui/qgsexternalresourcewidget.h index b37a1c7e89a5..a5c5441f9c34 100644 --- a/src/gui/qgsexternalresourcewidget.h +++ b/src/gui/qgsexternalresourcewidget.h @@ -53,15 +53,15 @@ class GUI_EXPORT QgsExternalResourceWidget : public QWidget }; /** - * @brief QgsExternalResourceWidget creates a widget with a file widget and a document viewer + * \brief QgsExternalResourceWidget creates a widget with a file widget and a document viewer * Both part of the widget are optional. - * @see QgsFileWidget + * \see QgsFileWidget */ explicit QgsExternalResourceWidget( QWidget *parent = 0 ); /** - * @brief documentPath returns the path of the current document in the widget - * @param type determines the type of the returned null variant if the document is not defined yet + * \brief documentPath returns the path of the current document in the widget + * \param type determines the type of the returned null variant if the document is not defined yet */ QVariant documentPath( QVariant::Type type = QVariant::String ) const; void setDocumentPath( const QVariant &documentPath ); @@ -83,16 +83,16 @@ class GUI_EXPORT QgsExternalResourceWidget : public QWidget int documentViewerHeight() const; /** - * @brief setDocumentViewerWidth set the height of the document viewer. - * @param height the height. Use 0 for automatic best display. + * \brief setDocumentViewerWidth set the height of the document viewer. + * \param height the height. Use 0 for automatic best display. */ void setDocumentViewerHeight( int height ); //! returns the width of the document viewer int documentViewerWidth() const ; /** - * @brief setDocumentViewerWidth set the width of the document viewer. - * @param width the width. Use 0 for automatic best display. + * \brief setDocumentViewerWidth set the width of the document viewer. + * \param width the width. Use 0 for automatic best display. */ void setDocumentViewerWidth( int width ); diff --git a/src/gui/qgsfeatureselectiondlg.h b/src/gui/qgsfeatureselectiondlg.h index a53f5184522f..22f02e1872d2 100644 --- a/src/gui/qgsfeatureselectiondlg.h +++ b/src/gui/qgsfeatureselectiondlg.h @@ -34,13 +34,13 @@ class GUI_EXPORT QgsFeatureSelectionDlg : public QDialog, private Ui::QgsFeature /** * Get the selected features * - * @return The selected feature ids + * \returns The selected feature ids */ const QgsFeatureIds &selectedFeatures(); /** * Set the selected features - * @param ids The feature ids to select + * \param ids The feature ids to select */ void setSelectedFeatures( const QgsFeatureIds &ids ); diff --git a/src/gui/qgsfieldcombobox.h b/src/gui/qgsfieldcombobox.h index 621a66cc2387..981a16132947 100644 --- a/src/gui/qgsfieldcombobox.h +++ b/src/gui/qgsfieldcombobox.h @@ -25,10 +25,10 @@ class QgsMapLayer; class QgsVectorLayer; /** \ingroup gui - * @brief The QgsFieldComboBox is a combo box which displays the list of fields of a given layer. + * \brief The QgsFieldComboBox is a combo box which displays the list of fields of a given layer. * It might be combined with a QgsMapLayerComboBox to automatically update fields according to a chosen layer. * If expression must be used, QgsFieldExpressionWidget shall be used instead. - * @see QgsMapLayerComboBox + * \see QgsMapLayerComboBox * \since QGIS 2.3 */ class GUI_EXPORT QgsFieldComboBox : public QComboBox @@ -41,7 +41,7 @@ class GUI_EXPORT QgsFieldComboBox : public QComboBox public: /** - * @brief QgsFieldComboBox creates a combo box to display the fields of a layer. + * \brief QgsFieldComboBox creates a combo box to display the fields of a layer. * The layer can be either manually given or dynamically set by connecting the signal QgsMapLayerComboBox::layerChanged to the slot setLayer. */ explicit QgsFieldComboBox( QWidget *parent = nullptr ); @@ -54,14 +54,14 @@ class GUI_EXPORT QgsFieldComboBox : public QComboBox /** * Sets whether an optional empty field ("not set") option is shown in the combo box. - * @see allowEmptyFieldName() + * \see allowEmptyFieldName() * \since QGIS 3.0 */ void setAllowEmptyFieldName( bool allowEmpty ); /** * Returns true if the combo box allows the empty field ("not set") choice. - * @see setAllowEmptyFieldName() + * \see setAllowEmptyFieldName() * \since QGIS 3.0 */ bool allowEmptyFieldName() const; @@ -71,7 +71,7 @@ class GUI_EXPORT QgsFieldComboBox : public QComboBox /** * Returns the layer currently associated with the combobox. - * @see setLayer() + * \see setLayer() */ QgsVectorLayer *layer() const; @@ -84,7 +84,7 @@ class GUI_EXPORT QgsFieldComboBox : public QComboBox /** * Sets the layer for which fields are listed in the combobox. If no layer is set * or a non-vector layer is set then the combobox will be empty. - * @see layer() + * \see layer() */ void setLayer( QgsMapLayer *layer ); diff --git a/src/gui/qgsfieldexpressionwidget.h b/src/gui/qgsfieldexpressionwidget.h index bd88512bce38..16672d999c4e 100644 --- a/src/gui/qgsfieldexpressionwidget.h +++ b/src/gui/qgsfieldexpressionwidget.h @@ -33,7 +33,7 @@ class QgsVectorLayer; /** \ingroup gui - * @brief The QgsFieldExpressionWidget class reates a widget to choose fields and edit expressions + * \brief The QgsFieldExpressionWidget class reates a widget to choose fields and edit expressions * It contains a combo boxto display the fields and expression and a button to open the expression dialog. * The combo box is editable, allowing expressions to be edited inline. * The validity of the expression is checked live on key press, invalid expressions are displayed in red. @@ -50,7 +50,7 @@ class GUI_EXPORT QgsFieldExpressionWidget : public QWidget public: /** - * @brief QgsFieldExpressionWidget creates a widget with a combo box to display the fields and expression and a button to open the expression dialog + * \brief QgsFieldExpressionWidget creates a widget with a combo box to display the fields and expression and a button to open the expression dialog */ explicit QgsFieldExpressionWidget( QWidget *parent = nullptr ); @@ -72,9 +72,9 @@ class GUI_EXPORT QgsFieldExpressionWidget : public QWidget void setGeomCalculator( const QgsDistanceArea &da ); /** - * @brief currentField returns the currently selected field or expression if allowed - * @param isExpression determines if the string returned is the name of a field or an expression - * @param isValid determines if the expression (or field) returned is valid + * \brief currentField returns the currently selected field or expression if allowed + * \param isExpression determines if the string returned is the name of a field or an expression + * \param isValid determines if the expression (or field) returned is valid */ QString currentField( bool *isExpression = nullptr, bool *isValid = nullptr ) const; @@ -114,14 +114,14 @@ class GUI_EXPORT QgsFieldExpressionWidget : public QWidget /** * Returns the layer currently associated with the widget. - * @see setLayer() + * \see setLayer() */ QgsVectorLayer *layer() const; /** * Register an expression context generator class that will be used to retrieve * an expression context for the widget. - * @param generator A QgsExpressionContextGenerator class that will be used to + * \param generator A QgsExpressionContextGenerator class that will be used to * create an expression context when required. * \since QGIS 3.0 */ @@ -140,7 +140,7 @@ class GUI_EXPORT QgsFieldExpressionWidget : public QWidget /** * Sets the layer used to display the fields and expression. - * @see layer() + * \see layer() */ void setLayer( QgsMapLayer *layer ); @@ -171,8 +171,8 @@ class GUI_EXPORT QgsFieldExpressionWidget : public QWidget void currentFieldChanged(); /** - * @brief updateLineEditStyle will re-style (color/font) the line edit depending on content and status - * @param expression if expression is given it will be evaluated for the given string, otherwise it takes + * \brief updateLineEditStyle will re-style (color/font) the line edit depending on content and status + * \param expression if expression is given it will be evaluated for the given string, otherwise it takes * current expression from the model */ void updateLineEditStyle( const QString &expression = QString() ); diff --git a/src/gui/qgsfieldmodel.h b/src/gui/qgsfieldmodel.h index d45b9ebcf2b6..89295d9a2361 100644 --- a/src/gui/qgsfieldmodel.h +++ b/src/gui/qgsfieldmodel.h @@ -26,7 +26,7 @@ class QgsVectorLayer; /** * \ingroup gui - * @brief The QgsFieldModel class is a model to display the list of fields of a layer in widgets. + * \brief The QgsFieldModel class is a model to display the list of fields of a layer in widgets. * If allowed, expressions might be added to the end of the model. * It can be associated with a QgsMapLayerModel to dynamically display a layer and its fields. * \since QGIS 2.3 @@ -66,27 +66,27 @@ class GUI_EXPORT QgsFieldModel : public QAbstractItemModel /** * Sets whether custom expressions are accepted and displayed in the model. - * @see allowExpression() - * @see setExpression() + * \see allowExpression() + * \see setExpression() */ void setAllowExpression( bool allowExpression ); /** * Returns true if the model allows custom expressions to be created and displayed. - * @see setAllowExpression() + * \see setAllowExpression() */ bool allowExpression() { return mAllowExpression; } /** * Sets whether an optional empty field ("not set") option is present in the model. - * @see allowEmptyFieldName() + * \see allowEmptyFieldName() * \since QGIS 3.0 */ void setAllowEmptyFieldName( bool allowEmpty ); /** * Returns true if the model allows the empty field ("not set") choice. - * @see setAllowEmptyFieldName() + * \see setAllowEmptyFieldName() * \since QGIS 3.0 */ bool allowEmptyFieldName() const { return mAllowEmpty; } @@ -99,22 +99,22 @@ class GUI_EXPORT QgsFieldModel : public QAbstractItemModel /** * Sets a single expression to be added after the fields at the end of the model. - * @see setAllowExpression() - * @see allowExpression() - * @see removeExpression() + * \see setAllowExpression() + * \see allowExpression() + * \see removeExpression() */ void setExpression( const QString &expression ); /** * Removes any custom expression from the model. - * @see setExpression() - * @see allowExpression() + * \see setExpression() + * \see allowExpression() */ void removeExpression(); /** * Returns the layer associated with the model. - * @see setLayer() + * \see setLayer() */ QgsVectorLayer *layer() { return mLayer; } @@ -129,7 +129,7 @@ class GUI_EXPORT QgsFieldModel : public QAbstractItemModel /** * Set the layer from which fields are displayed. - * @see layer() + * \see layer() */ void setLayer( QgsVectorLayer *layer ); diff --git a/src/gui/qgsfieldproxymodel.h b/src/gui/qgsfieldproxymodel.h index e6a31da58b0e..0dce5ec63348 100644 --- a/src/gui/qgsfieldproxymodel.h +++ b/src/gui/qgsfieldproxymodel.h @@ -22,7 +22,7 @@ class QgsFieldModel; /** \ingroup gui - * @brief The QgsFieldProxyModel class provides an easy to use model to display the list of fields of a layer. + * \brief The QgsFieldProxyModel class provides an easy to use model to display the list of fields of a layer. * \since QGIS 2.3 */ class GUI_EXPORT QgsFieldProxyModel : public QSortFilterProxyModel @@ -48,7 +48,7 @@ class GUI_EXPORT QgsFieldProxyModel : public QSortFilterProxyModel Q_DECLARE_FLAGS( Filters, Filter ) /** - * @brief QgsFieldProxModel creates a proxy model with a QgsFieldModel as source model. + * \brief QgsFieldProxModel creates a proxy model with a QgsFieldModel as source model. * It can be used to filter the fields based on their types. */ explicit QgsFieldProxyModel( QObject *parent = nullptr ); @@ -58,13 +58,13 @@ class GUI_EXPORT QgsFieldProxyModel : public QSortFilterProxyModel /** * Set flags that affect how fields are filtered in the model. - * @param filters are Filter flags - * @see filters() + * \param filters are Filter flags + * \see filters() */ QgsFieldProxyModel *setFilters( QgsFieldProxyModel::Filters filters ); /** Returns the filters controlling displayed fields. - * @see setFilters() + * \see setFilters() */ const Filters &filters() const { return mFilters; } diff --git a/src/gui/qgsfieldvalueslineedit.h b/src/gui/qgsfieldvalueslineedit.h index 89c064d86ec8..a6ffd09393d5 100644 --- a/src/gui/qgsfieldvalueslineedit.h +++ b/src/gui/qgsfieldvalueslineedit.h @@ -91,7 +91,7 @@ class QgsFieldValuesLineEditValuesGatherer: public QThread signals: /** Emitted when values have been collected - * @param values list of unique matching string values + * \param values list of unique matching string values */ void collectedValues( const QStringList &values ); @@ -125,47 +125,47 @@ class GUI_EXPORT QgsFieldValuesLineEdit: public QgsFilterLineEdit public: /** Constructor for QgsFieldValuesLineEdit - * @param parent parent widget + * \param parent parent widget */ QgsFieldValuesLineEdit( QWidget *parent = nullptr ); virtual ~QgsFieldValuesLineEdit(); /** Sets the layer containing the field that values will be shown from. - * @param layer vector layer - * @see layer() - * @see setAttributeIndex() + * \param layer vector layer + * \see layer() + * \see setAttributeIndex() */ void setLayer( QgsVectorLayer *layer ); /** Returns the layer containing the field that values will be shown from. - * @see setLayer() - * @see attributeIndex() + * \see setLayer() + * \see attributeIndex() */ QgsVectorLayer *layer() const { return mLayer; } /** Sets the attribute index for the field containing values to show in the widget. - * @param index index of attribute - * @see attributeIndex() - * @see setLayer() + * \param index index of attribute + * \see attributeIndex() + * \see setLayer() */ void setAttributeIndex( int index ); /** Returns the attribute index for the field containing values shown in the widget. - * @see setAttributeIndex() - * @see layer() + * \see setAttributeIndex() + * \see layer() */ int attributeIndex() const { return mAttributeIndex; } signals: /** Emitted when the layer associated with the widget changes. - * @param layer vector layer + * \param layer vector layer */ void layerChanged( QgsVectorLayer *layer ); /** Emitted when the field associated with the widget changes. - * @param index new attribute index for field + * \param index new attribute index for field */ void attributeIndexChanged( int index ); @@ -182,7 +182,7 @@ class GUI_EXPORT QgsFieldValuesLineEdit: public QgsFilterLineEdit void triggerCompleterUpdate(); /** Updates the values shown in the completer list. - * @param values list of string values to show + * \param values list of string values to show */ void updateCompleter( const QStringList &values ); diff --git a/src/gui/qgsfiledownloader.h b/src/gui/qgsfiledownloader.h index 3ce8978a57d0..ebd34487c8fc 100644 --- a/src/gui/qgsfiledownloader.h +++ b/src/gui/qgsfiledownloader.h @@ -46,9 +46,9 @@ class GUI_EXPORT QgsFileDownloader : public QObject /** * QgsFileDownloader - * @param url the download url - * @param outputFileName file name where the downloaded content will be stored - * @param guiNotificationsEnabled if false, the downloader will not display any progress bar or error message + * \param url the download url + * \param outputFileName file name where the downloaded content will be stored + * \param guiNotificationsEnabled if false, the downloader will not display any progress bar or error message */ QgsFileDownloader( const QUrl &url, const QString &outputFileName, bool guiNotificationsEnabled = true ); @@ -90,8 +90,8 @@ class GUI_EXPORT QgsFileDownloader : public QObject /** * Called on SSL network Errors - * @param reply - * @param errors + * \param reply + * \param errors */ void onSslErrors( QNetworkReply *reply, const QList &errors ); #endif diff --git a/src/gui/qgsfiledropedit.cpp b/src/gui/qgsfiledropedit.cpp index 27e4aae481a6..2d36b8c7a9f7 100644 --- a/src/gui/qgsfiledropedit.cpp +++ b/src/gui/qgsfiledropedit.cpp @@ -20,16 +20,6 @@ #include #include -/*! - \class QgsFileDropEdit - - \brief The QgsDropNameEdit class provides a line edit widget which - accepts file drops. - - Dropping can be limited to files only, files with a specific extension - or directories only. By default, dropping is limited to files only. -*/ - QgsFileDropEdit::QgsFileDropEdit( QWidget *parent ) : QLineEdit( parent ) { @@ -39,9 +29,6 @@ QgsFileDropEdit::QgsFileDropEdit( QWidget *parent ) setAcceptDrops( true ); } -/*! - Limit drops to directories. -*/ void QgsFileDropEdit::setDirOnly( bool isDirOnly ) { mDirOnly = isDirOnly; @@ -51,9 +38,6 @@ void QgsFileDropEdit::setDirOnly( bool isDirOnly ) } } -/*! - Limit drops to files. -*/ void QgsFileDropEdit::setFileOnly( bool isFileOnly ) { mFileOnly = isFileOnly; @@ -63,17 +47,11 @@ void QgsFileDropEdit::setFileOnly( bool isFileOnly ) } } -/*! - Limit drops to files with specified extension. -*/ void QgsFileDropEdit::setSuffixFilter( const QString &suffix ) { mSuffix = suffix; } -/*! - Return file name if object meets drop criteria. -*/ QString QgsFileDropEdit::acceptableFilePath( QDropEvent *event ) const { QString path; @@ -88,10 +66,6 @@ QString QgsFileDropEdit::acceptableFilePath( QDropEvent *event ) const return path; } -/*! - Check if dragged object is acceptable. Called when a drag is in progress - and the mouse enters this widget. -*/ void QgsFileDropEdit::dragEnterEvent( QDragEnterEvent *event ) { QString filePath = acceptableFilePath( event ); @@ -107,9 +81,6 @@ void QgsFileDropEdit::dragEnterEvent( QDragEnterEvent *event ) } } -/*! - Called when a drag is in progress and the mouse leaves this widget. -*/ void QgsFileDropEdit::dragLeaveEvent( QDragLeaveEvent *event ) { QLineEdit::dragLeaveEvent( event ); @@ -118,9 +89,6 @@ void QgsFileDropEdit::dragLeaveEvent( QDragLeaveEvent *event ) update(); } -/*! - Receive the dragged object. Called when the drag is dropped on this widget. -*/ void QgsFileDropEdit::dropEvent( QDropEvent *event ) { QString filePath = acceptableFilePath( event ); @@ -139,9 +107,6 @@ void QgsFileDropEdit::dropEvent( QDropEvent *event ) } } -/*! - Paints line edit with drag highlight in response to a paint event. -*/ void QgsFileDropEdit::paintEvent( QPaintEvent *e ) { QLineEdit::paintEvent( e ); diff --git a/src/gui/qgsfiledropedit.h b/src/gui/qgsfiledropedit.h index e6a2dac2c616..d6f6ea02d52d 100644 --- a/src/gui/qgsfiledropedit.h +++ b/src/gui/qgsfiledropedit.h @@ -21,6 +21,9 @@ /** \ingroup gui * A line edit for capturing file names that can have files dropped onto * it via drag & drop. + * + * Dropping can be limited to files only, files with a specific extension + or directories only. By default, dropping is limited to files only. */ class GUI_EXPORT QgsFileDropEdit: public QLineEdit { @@ -30,12 +33,24 @@ class GUI_EXPORT QgsFileDropEdit: public QLineEdit QgsFileDropEdit( QWidget *parent = nullptr ); bool isDirOnly() const { return mDirOnly; } + + /** + Limit drops to directories. + */ void setDirOnly( bool isDirOnly ); bool isFileOnly() const { return mFileOnly; } + + /** + Limit drops to files. + */ void setFileOnly( bool isFileOnly ); QString suffixFilter() const { return mSuffix; } + + /** + Limit drops to files with specified extension. + */ void setSuffixFilter( const QString &suffix ); protected: @@ -46,6 +61,10 @@ class GUI_EXPORT QgsFileDropEdit: public QLineEdit virtual void paintEvent( QPaintEvent *e ) override; private: + + /** + Return file name if object meets drop criteria. + */ QString acceptableFilePath( QDropEvent *event ) const; QString mSuffix; diff --git a/src/gui/qgsfilewidget.h b/src/gui/qgsfilewidget.h index e34e1108bbd7..ca7bfbddac16 100644 --- a/src/gui/qgsfilewidget.h +++ b/src/gui/qgsfilewidget.h @@ -27,7 +27,7 @@ class QgsFilterLineEdit; #include "qgis_gui.h" /** \ingroup gui - * @brief The QgsFileWidget class creates a widget for selecting a file or a folder. + * \brief The QgsFileWidget class creates a widget for selecting a file or a folder. */ class GUI_EXPORT QgsFileWidget : public QWidget { @@ -44,7 +44,7 @@ class GUI_EXPORT QgsFileWidget : public QWidget public: /** - * @brief The StorageMode enum determines if the file picker should pick files or directories + * \brief The StorageMode enum determines if the file picker should pick files or directories */ enum StorageMode { @@ -53,7 +53,7 @@ class GUI_EXPORT QgsFileWidget : public QWidget }; /** - * @brief The RelativeStorage enum determines if path is absolute, relative to the current project path or relative to a defined default path. + * \brief The RelativeStorage enum determines if path is absolute, relative to the current project path or relative to a defined default path. */ enum RelativeStorage { @@ -63,7 +63,7 @@ class GUI_EXPORT QgsFileWidget : public QWidget }; /** - * @brief QgsFileWidget creates a widget for selecting a file or a folder. + * \brief QgsFileWidget creates a widget for selecting a file or a folder. */ explicit QgsFileWidget( QWidget *parent = 0 ); @@ -80,8 +80,8 @@ class GUI_EXPORT QgsFileWidget : public QWidget QString dialogTitle() const; /** - * @brief setDialogTitle defines the open file dialog title - * @note if not defined, the title is "Select a file" or "Select a directory" depending on the configuration. + * \brief setDialogTitle defines the open file dialog title + * \note if not defined, the title is "Select a file" or "Select a directory" depending on the configuration. */ void setDialogTitle( const QString &title ); @@ -89,8 +89,8 @@ class GUI_EXPORT QgsFileWidget : public QWidget QString filter() const; /** - * @brief setFilter sets the filter used by the model to filters. The filter is used to specify the kind of files that should be shown. - * @param filter Only files that match the given filter are shown, it may be an empty string. If you want multiple filters, separate them with ';;', + * \brief setFilter sets the filter used by the model to filters. The filter is used to specify the kind of files that should be shown. + * \param filter Only files that match the given filter are shown, it may be an empty string. If you want multiple filters, separate them with ';;', */ void setFilter( const QString &filter ); diff --git a/src/gui/qgsfilterlineedit.h b/src/gui/qgsfilterlineedit.h index 226d5e3d9cbd..4fd17722c4f3 100644 --- a/src/gui/qgsfilterlineedit.h +++ b/src/gui/qgsfilterlineedit.h @@ -53,34 +53,34 @@ class GUI_EXPORT QgsFilterLineEdit : public QLineEdit }; /** Constructor for QgsFilterLineEdit. - * @param parent parent widget - * @param nullValue string for representing null values + * \param parent parent widget + * \param nullValue string for representing null values */ QgsFilterLineEdit( QWidget *parent = nullptr, const QString &nullValue = QString::null ); /** Returns true if the widget's clear button is visible. - * @see setShowClearButton() + * \see setShowClearButton() * \since QGIS 3.0 */ bool showClearButton() const { return mClearButtonVisible; } /** Sets whether the widget's clear button is visible. - * @param visible set to false to hide the clear button - * @see showClearButton() + * \param visible set to false to hide the clear button + * \see showClearButton() * \since QGIS 3.0 */ void setShowClearButton( bool visible ); /** Returns the clear mode for the widget. The clear mode defines the behavior of the * widget when its value is cleared. This defaults to ClearToNull. - * @see setClearMode() + * \see setClearMode() * \since QGIS 3.0 */ ClearMode clearMode() const { return mClearMode; } /** Sets the clear mode for the widget. The clear mode defines the behavior of the * widget when its value is cleared. This defaults to ClearToNull. - * @see clearMode() + * \see clearMode() * \since QGIS 3.0 */ void setClearMode( ClearMode mode ) { mClearMode = mode; } @@ -88,20 +88,20 @@ class GUI_EXPORT QgsFilterLineEdit : public QLineEdit /** Sets the string representation for null values in the widget. This does not * affect the values returned for null values by value(), rather it only affects * the text that is shown to users when the widget's value is null. - * @param nullValue string to show when widget's value is null - * @see nullValue() + * \param nullValue string to show when widget's value is null + * \see nullValue() */ void setNullValue( const QString &nullValue ) { mNullValue = nullValue; } /** Returns the string used for representating null values in the widget. - * @see setNullValue() - * @see isNull() + * \see setNullValue() + * \see isNull() */ QString nullValue() const { return mNullValue; } /** Define if a search icon shall be shown on the left of the image * when no text is entered - * @param visible set to false to hide the search icon + * \param visible set to false to hide the search icon * \since QGIS 3.0 */ void setShowSearchIcon( bool visible ); @@ -115,9 +115,9 @@ class GUI_EXPORT QgsFilterLineEdit : public QLineEdit /** Sets the default value for the widget. The default value is a value * which the widget will be reset to if it is cleared and the clearMode() * is equal to ClearToDefault. - * @param defaultValue default value - * @see defaultValue() - * @see clearMode() + * \param defaultValue default value + * \see defaultValue() + * \see clearMode() * \since QGIS 3.0 */ void setDefaultValue( const QString &defaultValue ) { mDefaultValue = defaultValue; } @@ -125,8 +125,8 @@ class GUI_EXPORT QgsFilterLineEdit : public QLineEdit /** Returns the default value for the widget. The default value is a value * which the widget will be reset to if it is cleared and the clearMode() * is equal to ClearToDefault. - * @see setDefaultValue() - * @see clearMode() + * \see setDefaultValue() + * \see clearMode() * \since QGIS 3.0 */ QString defaultValue() const { return mDefaultValue; } @@ -134,9 +134,9 @@ class GUI_EXPORT QgsFilterLineEdit : public QLineEdit /** * Sets the current text for the widget with support for handling null values. * - * @param value The text to set. If a null string is provided, the text shown in the + * \param value The text to set. If a null string is provided, the text shown in the * widget will be set to the current nullValue(). - * @see value() + * \see value() */ void setValue( const QString &value ) { setText( value.isNull() ? mNullValue : value ); } @@ -145,23 +145,23 @@ class GUI_EXPORT QgsFilterLineEdit : public QLineEdit * in the widget matches the current nullValue() then the returned value will be * a null string. * - * @return Current text (or null string if it matches the nullValue() property ) - * @see setValue() + * \returns Current text (or null string if it matches the nullValue() property ) + * \see setValue() */ QString value() const { return isNull() ? QString::null : text(); } /** * Determine if the current text represents null. * - * @return True if the widget's value is null. - * @see nullValue() + * \returns True if the widget's value is null. + * \see nullValue() */ inline bool isNull() const { return text() == mNullValue; } public slots: /** Clears the widget and resets it to the null value. - * @see nullValue() + * \see nullValue() * \since QGIS 3.0 */ virtual void clearValue(); @@ -169,14 +169,14 @@ class GUI_EXPORT QgsFilterLineEdit : public QLineEdit signals: /** Emitted when the widget is cleared - * @see clearValue() + * \see clearValue() */ void cleared(); /** * Same as textChanged() but with support for null values. * - * @param value The current text or null string if it matches the nullValue() property. + * \param value The current text or null string if it matches the nullValue() property. */ void valueChanged( const QString &value ); diff --git a/src/gui/qgsfloatingwidget.h b/src/gui/qgsfloatingwidget.h index 10e7793c5400..610295999ad4 100644 --- a/src/gui/qgsfloatingwidget.h +++ b/src/gui/qgsfloatingwidget.h @@ -53,47 +53,47 @@ class GUI_EXPORT QgsFloatingWidget: public QWidget }; /** Constructor for QgsFloatingWidget. - * @param parent parent widget + * \param parent parent widget */ QgsFloatingWidget( QWidget *parent = nullptr ); /** Sets the widget to "anchor" the floating widget to. The floating widget will be repositioned whenever the * anchor widget moves or is resized so that it maintains the same relative position to the anchor widget. - * @param widget anchor widget. Both the floating widget and the anchor widget must share some common parent. - * @see anchorWidget() + * \param widget anchor widget. Both the floating widget and the anchor widget must share some common parent. + * \see anchorWidget() */ void setAnchorWidget( QWidget *widget ); /** Returns the widget that the floating widget is "anchored" tto. The floating widget will be repositioned whenever the * anchor widget moves or is resized so that it maintains the same relative position to the anchor widget. - * @see setAnchorWidget() + * \see setAnchorWidget() */ QWidget *anchorWidget(); /** Returns the floating widget's anchor point, which corresponds to the point on the widget which should remain * fixed in the same relative position whenever the widget's parent is resized or moved. - * @see setAnchorPoint() + * \see setAnchorPoint() */ AnchorPoint anchorPoint() const { return mFloatAnchorPoint; } /** Sets the floating widget's anchor point, which corresponds to the point on the widget which should remain * fixed in the same relative position whenever the widget's parent is resized or moved. - * @param point anchor point - * @see anchorPoint() + * \param point anchor point + * \see anchorPoint() */ void setAnchorPoint( AnchorPoint point ); /** Returns the anchor widget's anchor point, which corresponds to the point on the anchor widget which * the floating widget should "attach" to. The floating widget should remain fixed in the same relative position * to this anchor widget whenever the widget's parent is resized or moved. - * @see setAnchorWidgetPoint() + * \see setAnchorWidgetPoint() */ AnchorPoint anchorWidgetPoint() const { return mAnchorWidgetAnchorPoint; } /** Returns the anchor widget's anchor point, which corresponds to the point on the anchor widget which * the floating widget should "attach" to. The floating widget should remain fixed in the same relative position * to this anchor widget whenever the widget's parent is resized or moved. - * @see setAnchorWidgetPoint() + * \see setAnchorWidgetPoint() */ void setAnchorWidgetPoint( AnchorPoint point ); diff --git a/src/gui/qgsfocuswatcher.h b/src/gui/qgsfocuswatcher.h index 06945128e2ce..55e9341da311 100644 --- a/src/gui/qgsfocuswatcher.h +++ b/src/gui/qgsfocuswatcher.h @@ -35,7 +35,7 @@ class GUI_EXPORT QgsFocusWatcher : public QObject public: /** Constructor for QgsFocusWatcher. - * @param parent parent widget to catch focus events for. This class will automatically be + * \param parent parent widget to catch focus events for. This class will automatically be * installed as an event filter for parent. */ explicit QgsFocusWatcher( QObject *parent ); @@ -45,7 +45,7 @@ class GUI_EXPORT QgsFocusWatcher : public QObject signals: /** Emitted when parent object's focus changes. - * @param focused true if object gained focus, false if object lost focus + * \param focused true if object gained focus, false if object lost focus */ void focusChanged( bool focused ); diff --git a/src/gui/qgsformannotation.h b/src/gui/qgsformannotation.h index dc5942e2355f..8727cd8df080 100644 --- a/src/gui/qgsformannotation.h +++ b/src/gui/qgsformannotation.h @@ -45,13 +45,13 @@ class GUI_EXPORT QgsFormAnnotation: public QgsAnnotation /** * Sets the path to the Qt Designer UI file to show in the annotation. - * @see designerForm() + * \see designerForm() */ void setDesignerForm( const QString &uiFile ); /** * Returns the path to the Qt Designer UI file to show in the annotation. - * @see setDesignerForm() + * \see setDesignerForm() */ QString designerForm() const { return mDesignerForm; } diff --git a/src/gui/qgsgradientcolorrampdialog.h b/src/gui/qgsgradientcolorrampdialog.h index 9a8dabfcb864..5a0c1a1ae555 100644 --- a/src/gui/qgsgradientcolorrampdialog.h +++ b/src/gui/qgsgradientcolorrampdialog.h @@ -40,20 +40,20 @@ class GUI_EXPORT QgsGradientColorRampDialog : public QDialog, private Ui::QgsGra public: /** Constructor for QgsGradientColorRampDialog. - * @param ramp initial ramp to show in dialog - * @param parent parent widget + * \param ramp initial ramp to show in dialog + * \param parent parent widget */ QgsGradientColorRampDialog( const QgsGradientColorRamp &ramp, QWidget *parent = nullptr ); ~QgsGradientColorRampDialog(); /** Returns a color ramp representing the current settings from the dialog. - * @see setRamp() + * \see setRamp() */ QgsGradientColorRamp ramp() const { return mRamp; } /** Sets the color ramp to show in the dialog. - * @param ramp color ramp - * @see ramp() + * \param ramp color ramp + * \see ramp() */ void setRamp( const QgsGradientColorRamp &ramp ); @@ -65,12 +65,12 @@ class GUI_EXPORT QgsGradientColorRampDialog : public QDialog, private Ui::QgsGra public slots: /** Sets the start color for the gradient ramp. - * @see setColor2() + * \see setColor2() */ void setColor1( const QColor &color ); /** Sets the end color for the gradient ramp. - * @see setColor1() + * \see setColor1() */ void setColor2( const QColor &color ); diff --git a/src/gui/qgsgradientstopeditor.h b/src/gui/qgsgradientstopeditor.h index 750c973140c2..8761b96cbae2 100644 --- a/src/gui/qgsgradientstopeditor.h +++ b/src/gui/qgsgradientstopeditor.h @@ -35,30 +35,30 @@ class GUI_EXPORT QgsGradientStopEditor : public QWidget public: /** Constructor for QgsGradientStopEditor. - * @param parent parent widget - * @param ramp optional initial gradient ramp + * \param parent parent widget + * \param ramp optional initial gradient ramp */ QgsGradientStopEditor( QWidget *parent = nullptr, QgsGradientColorRamp *ramp = nullptr ); /** Sets the current ramp shown in the editor. - * @param ramp color ramp - * @see gradientRamp() + * \param ramp color ramp + * \see gradientRamp() */ void setGradientRamp( const QgsGradientColorRamp &ramp ); /** Returns the current ramp created by the editor. - * @see setGradientRamp() + * \see setGradientRamp() */ QgsGradientColorRamp gradientRamp() const { return mGradient; } /** Sets the currently selected stop. - * @param index index of stop, where 0 corresponds to the first stop - * @see selectedStop() + * \param index index of stop, where 0 corresponds to the first stop + * \see selectedStop() */ void selectStop( int index ); /** Returns details about the currently selected stop. - * @see selectStop() + * \see selectStop() */ QgsGradientStop selectedStop() const; @@ -68,27 +68,27 @@ class GUI_EXPORT QgsGradientStopEditor : public QWidget public slots: /** Sets the color for the current selected stop. - * @param color new stop color - * @see setSelectedStopOffset() - * @see setSelectedStopDetails() - * @see setColor1() - * @see setColor2() + * \param color new stop color + * \see setSelectedStopOffset() + * \see setSelectedStopDetails() + * \see setColor1() + * \see setColor2() */ void setSelectedStopColor( const QColor &color ); /** Sets the offset for the current selected stop. This slot has no effect if either the * first or last stop is selected, as they cannot be repositioned. - * @param offset new stop offset - * @see setSelectedStopColor() - * @see setSelectedStopDetails() + * \param offset new stop offset + * \see setSelectedStopColor() + * \see setSelectedStopDetails() */ void setSelectedStopOffset( double offset ); /** Sets the color and offset for the current selected stop. - * @param color new stop color - * @param offset new stop offset - * @see setSelectedStopColor() - * @see setSelectedStopOffset() + * \param color new stop color + * \param offset new stop offset + * \see setSelectedStopColor() + * \see setSelectedStopOffset() */ void setSelectedStopDetails( const QColor &color, double offset ); @@ -98,16 +98,16 @@ class GUI_EXPORT QgsGradientStopEditor : public QWidget void deleteSelectedStop(); /** Sets the color for the first stop. - * @param color new stop color - * @see setColor2() - * @see setSelectedStopColor() + * \param color new stop color + * \see setColor2() + * \see setSelectedStopColor() */ void setColor1( const QColor &color ); /** Sets the color for the last stop. - * @param color new stop color - * @see setColor1() - * @see setSelectedStopColor() + * \param color new stop color + * \see setColor1() + * \see setSelectedStopColor() */ void setColor2( const QColor &color ); @@ -117,7 +117,7 @@ class GUI_EXPORT QgsGradientStopEditor : public QWidget void changed(); /** Emitted when the current selected stop changes. - * @param stop details about newly selected stop + * \param stop details about newly selected stop */ void selectedStopChanged( const QgsGradientStop &stop ); @@ -137,15 +137,15 @@ class GUI_EXPORT QgsGradientStopEditor : public QWidget private: /** Generates a checkboard pattern pixmap for use as a background to transparent colors - * @returns checkerboard pixmap + * \returns checkerboard pixmap */ QPixmap transparentBackground(); /** Draws a stop marker on the specified painter. - * @param painter destination painter - * @param topMiddle coordinate corresponding to top middle point of desired marker - * @param color color of marker - * @param selected set to true to draw the marker in a selected state + * \param painter destination painter + * \param topMiddle coordinate corresponding to top middle point of desired marker + * \param color color of marker + * \param selected set to true to draw the marker in a selected state */ void drawStopMarker( QPainter &painter, QPoint topMiddle, const QColor &color, bool selected = false ); diff --git a/src/gui/qgshelp.h b/src/gui/qgshelp.h index baa1f63df1b7..5cc24d9b3201 100644 --- a/src/gui/qgshelp.h +++ b/src/gui/qgshelp.h @@ -22,7 +22,7 @@ /** \ingroup gui * \class QgsHelp - * @brief Helper class for showing help topic URI for the given key. + * \brief Helper class for showing help topic URI for the given key. * * Help can be stored online, on the local directory or on the intranet * server. Location of the QGIS help can be configured in QGIS options. @@ -44,14 +44,14 @@ class GUI_EXPORT QgsHelp /** Opens help topic for the given help key using default system * web browser. If help topic not found, builtin error page shown. - * @param key key which identified help topic + * \param key key which identified help topic * \since QGIS 3.0 */ static void openHelp( const QString &key ); /** Returns URI of the help topic for the given key. If help topic * not found, URI of the builtin error page returned. - * @param key key which identified help topic + * \param key key which identified help topic * \since QGIS 3.0 */ static QUrl helpUrl( const QString &key ); @@ -60,7 +60,7 @@ class GUI_EXPORT QgsHelp /** Check if given URL accessible by issuing HTTP HEAD request. * Returns true if URL accessible, false otherwise. - * @param url URL to check + * \param url URL to check * \since QGIS 3.0 */ static bool urlExists( const QString &url ); diff --git a/src/gui/qgshighlight.cpp b/src/gui/qgshighlight.cpp index 5aaad0d08f09..ab2db0ed3706 100644 --- a/src/gui/qgshighlight.cpp +++ b/src/gui/qgshighlight.cpp @@ -45,11 +45,7 @@ - fill with highlight or contrast color but opaque and using pattern (e.g. Qt::Dense7Pattern): again no highlight impression */ -/*! - \class QgsHighlight - \brief The QgsHighlight class provides a transparent overlay widget - for highlighting features on the map. -*/ + QgsHighlight::QgsHighlight( QgsMapCanvas *mapCanvas, const QgsGeometry &geom, QgsMapLayer *layer ) : QgsMapCanvasItem( mapCanvas ) , mLayer( layer ) @@ -108,9 +104,6 @@ QgsHighlight::~QgsHighlight() delete mGeometry; } -/*! - Set the stroke and fill color. - */ void QgsHighlight::setColor( const QColor &color ) { mPen.setColor( color ); @@ -198,9 +191,6 @@ double QgsHighlight::getSymbolWidth( const QgsRenderContext &context, double wid return width; } -/*! - Set the stroke width. - */ void QgsHighlight::setWidth( int width ) { mPen.setWidth( width ); @@ -270,9 +260,6 @@ void QgsHighlight::updatePosition() // nothing to do here... } -/*! - Draw the shape in response to an update event. - */ void QgsHighlight::paint( QPainter *p ) { if ( mGeometry ) diff --git a/src/gui/qgshighlight.h b/src/gui/qgshighlight.h index ea525e2660b3..808dc9302eb4 100644 --- a/src/gui/qgshighlight.h +++ b/src/gui/qgshighlight.h @@ -32,30 +32,33 @@ class QgsSymbol; /** \ingroup gui * A class for highlight features on the map. + * + * The QgsHighlight class provides a transparent overlay widget + for highlighting features on the map. */ class GUI_EXPORT QgsHighlight: public QgsMapCanvasItem { public: /** Constructor for QgsHighlight - * @param mapCanvas associated map canvas - * @param geom initial geometry of highlight - * @param layer associated map layer + * \param mapCanvas associated map canvas + * \param geom initial geometry of highlight + * \param layer associated map layer */ QgsHighlight( QgsMapCanvas *mapCanvas, const QgsGeometry &geom, QgsMapLayer *layer ); /** Constructor for QgsHighlight - * @param mapCanvas associated map canvas - * @param geom initial geometry of highlight - * @param layer associated vector layer + * \param mapCanvas associated map canvas + * \param geom initial geometry of highlight + * \param layer associated vector layer */ QgsHighlight( QgsMapCanvas *mapCanvas, const QgsGeometry &geom, QgsVectorLayer *layer ); /** Constructor for highlighting true feature shape using feature attributes * and renderer. - * @param mapCanvas map canvas - * @param feature - * @param layer vector layer + * \param mapCanvas map canvas + * \param feature + * \param layer vector layer */ QgsHighlight( QgsMapCanvas *mapCanvas, const QgsFeature &feature, QgsVectorLayer *layer ); ~QgsHighlight(); @@ -68,7 +71,7 @@ class GUI_EXPORT QgsHighlight: public QgsMapCanvasItem * \since QGIS 2.3 */ void setFillColor( const QColor &fillColor ); - //! Set width. Ignored in feature mode. + //! Set stroke width. Ignored in feature mode. void setWidth( int width ); /** Set line / stroke buffer in millimeters. diff --git a/src/gui/qgshistogramwidget.h b/src/gui/qgshistogramwidget.h index be1cb33a1a68..fe771ce06440 100644 --- a/src/gui/qgshistogramwidget.h +++ b/src/gui/qgshistogramwidget.h @@ -55,93 +55,93 @@ class GUI_EXPORT QgsHistogramWidget : public QWidget, private Ui::QgsHistogramWi /** QgsHistogramWidget constructor. If layer and fieldOrExp are specified then the histogram * will be initially populated with the corresponding values. - * @param parent parent widget - * @param layer source vector layer - * @param fieldOrExp field name or expression string + * \param parent parent widget + * \param layer source vector layer + * \param fieldOrExp field name or expression string */ QgsHistogramWidget( QWidget *parent = nullptr, QgsVectorLayer *layer = nullptr, const QString &fieldOrExp = QString() ); ~QgsHistogramWidget(); /** Returns the layer currently associated with the widget. - * @see setLayer - * @see sourceFieldExp + * \see setLayer + * \see sourceFieldExp */ QgsVectorLayer *layer() { return mVectorLayer; } /** Returns the source field name or expression used to calculate values displayed * in the histogram. - * @see setSourceFieldExp - * @see layer + * \see setSourceFieldExp + * \see layer */ QString sourceFieldExp() const { return mSourceFieldExp; } /** Sets the pen to use when drawing histogram bars. If set to Qt::NoPen then the - * pen will be automatically calculated. If ranges have been set using @link setGraduatedRanges @endlink + * pen will be automatically calculated. If ranges have been set using setGraduatedRanges() * then the pen and brush will have no effect. - * @param pen histogram pen - * @see pen - * @see setBrush + * \param pen histogram pen + * \see pen + * \see setBrush */ void setPen( const QPen &pen ) { mPen = pen; } /** Returns the pen used when drawing histogram bars. - * @see setPen - * @see brush + * \see setPen + * \see brush */ QPen pen() const { return mPen; } - /** Sets the brush used for drawing histogram bars. If ranges have been set using @link setGraduatedRanges @endlink + /** Sets the brush used for drawing histogram bars. If ranges have been set using setGraduatedRanges() * then the pen and brush will have no effect. - * @param brush histogram brush - * @see brush - * @see setPen + * \param brush histogram brush + * \see brush + * \see setPen */ void setBrush( const QBrush &brush ) { mBrush = brush; } /** Returns the brush used when drawing histogram bars. - * @see setBrush - * @see pen + * \see setBrush + * \see pen */ QBrush brush() const { return mBrush; } /** Sets the graduated ranges associated with the histogram. If set, the ranges will be used to color the histogram * bars and for showing vertical dividers at the histogram breaks. - * @param ranges graduated range list - * @see graduatedRanges + * \param ranges graduated range list + * \see graduatedRanges */ void setGraduatedRanges( const QgsRangeList &ranges ); /** Returns the graduated ranges associated with the histogram. If set, the ranges will be used to color the histogram * bars and for showing vertical dividers at the histogram breaks. - * @returns graduated range list - * @see setGraduatedRanges + * \returns graduated range list + * \see setGraduatedRanges */ QgsRangeList graduatedRanges() const { return mRanges; } /** Returns the title for the histogram's x-axis. - * @see setXAxisTitle - * @see yAxisTitle + * \see setXAxisTitle + * \see yAxisTitle */ QString xAxisTitle() const { return mXAxisTitle; } /** Sets the title for the histogram's x-axis. - * @param title x-axis title, or empty string to remove title - * @see xAxisTitle - * @see setYAxisTitle + * \param title x-axis title, or empty string to remove title + * \see xAxisTitle + * \see setYAxisTitle */ void setXAxisTitle( const QString &title ) { mXAxisTitle = title; } /** Returns the title for the histogram's y-axis. - * @see setYAxisTitle - * @see xAxisTitle + * \see setYAxisTitle + * \see xAxisTitle */ QString yAxisTitle() const { return mYAxisTitle; } /** Sets the title for the histogram's y-axis. - * @param title y-axis title, or empty string to remove title - * @see yAxisTitle - * @see setXAxisTitle + * \param title y-axis title, or empty string to remove title + * \see yAxisTitle + * \see setXAxisTitle */ void setYAxisTitle( const QString &title ) { mYAxisTitle = title; } @@ -152,19 +152,19 @@ class GUI_EXPORT QgsHistogramWidget : public QWidget, private Ui::QgsHistogramWi void refreshValues(); /** Redraws the histogram. Calling this slot does not update the values - * for the histogram, use @link refreshValues @endlink to do this. + * for the histogram, use refreshValues() to do this. */ void refresh(); /** Sets the vector layer associated with the histogram. - * @param layer source vector layer - * @see setSourceFieldExp + * \param layer source vector layer + * \see setSourceFieldExp */ void setLayer( QgsVectorLayer *layer ); /** Sets the source field or expression to use for values in the histogram. - * @param fieldOrExp field name or expression string - * @see setLayer + * \param fieldOrExp field name or expression string + * \see setLayer */ void setSourceFieldExp( const QString &fieldOrExp ); diff --git a/src/gui/qgsidentifymenu.h b/src/gui/qgsidentifymenu.h index 7533957906d3..f7c708c2e641 100644 --- a/src/gui/qgsidentifymenu.h +++ b/src/gui/qgsidentifymenu.h @@ -35,8 +35,8 @@ class CustomActionRegistry : public QgsMapLayerActionRegistry ///@endcond /** \ingroup gui - * @brief The QgsIdentifyMenu class builds a menu to be used with identify results (@see QgsMapToolIdentify). - * It is customizable and can display attribute actions (@see QgsAction) as well as map layer actions (@see QgsMapLayerAction). + * \brief The QgsIdentifyMenu class builds a menu to be used with identify results (\see QgsMapToolIdentify). + * It is customizable and can display attribute actions (\see QgsAction) as well as map layer actions (\see QgsMapLayerAction). * It can also embed custom map layer actions, defined for this menu exclusively. * If used in a QgsMapToolIdentify, it is accessible via QgsMapToolIdentify::identifyMenu() and can be customized in the map tool sub-class. */ @@ -94,7 +94,7 @@ class GUI_EXPORT QgsIdentifyMenu : public QMenu }; /** - * @brief QgsIdentifyMenu is a menu to be used to choose within a list of QgsMapTool::IdentifyReults + * \brief QgsIdentifyMenu is a menu to be used to choose within a list of QgsMapTool::IdentifyReults */ explicit QgsIdentifyMenu( QgsMapCanvas *canvas ); @@ -109,28 +109,28 @@ class GUI_EXPORT QgsIdentifyMenu : public QMenu bool execWithSingleResult() { return mExecWithSingleResult;} /** - * @brief define if attribute actions(1) and map layer actions(2) can be listed and run from the menu - * @note custom actions will be shown in any case if they exist. - * @note (1) attribute actions are defined by the user in the layer properties @see QgsAction - * @note (2) map layer actions are built-in c++ actions or actions which are defined by a Python plugin @see QgsMapLayerActionRegistry + * \brief define if attribute actions(1) and map layer actions(2) can be listed and run from the menu + * \note custom actions will be shown in any case if they exist. + * \note (1) attribute actions are defined by the user in the layer properties \see QgsAction + * \note (2) map layer actions are built-in c++ actions or actions which are defined by a Python plugin \see QgsMapLayerActionRegistry */ void setShowFeatureActions( bool showFeatureActions ) { mShowFeatureActions = showFeatureActions; } bool showFeatureActions() { return mShowFeatureActions;} /** - * @brief setResultsIfExternalAction if set to false (default) the menu will not return any results if an external action has been triggered - * @note external action can be either custom actions or feature / map layer actions (@see setShowFeatureActions) + * \brief setResultsIfExternalAction if set to false (default) the menu will not return any results if an external action has been triggered + * \note external action can be either custom actions or feature / map layer actions (\see setShowFeatureActions) */ void setResultsIfExternalAction( bool resultsIfExternalAction ) {mResultsIfExternalAction = resultsIfExternalAction;} bool resultsIfExternalAction() {return mResultsIfExternalAction;} //! Defines the maximum number of layers displayed in the menu (default is 10). - //! @note 0 is unlimited. + //! \note 0 is unlimited. void setMaxLayerDisplay( int maxLayerDisplay ); int maxLayerDisplay() {return mMaxLayerDisplay;} //! Defines the maximum number of features displayed in the menu for vector layers (default is 10). - //! @note 0 is unlimited. + //! \note 0 is unlimited. void setMaxFeatureDisplay( int maxFeatureDisplay ); int maxFeatureDisplay() {return mMaxFeatureDisplay;} @@ -141,9 +141,9 @@ class GUI_EXPORT QgsIdentifyMenu : public QMenu void removeCustomActions(); /** - * @brief exec - * @param idResults the list of identify results to choose within - * @param pos the position where the menu will be executed + * \brief exec + * \param idResults the list of identify results to choose within + * \param pos the position where the menu will be executed */ QList exec( const QList &idResults, QPoint pos ); diff --git a/src/gui/qgskeyvaluewidget.h b/src/gui/qgskeyvaluewidget.h index cafdbe12ddcb..881f4a3693a0 100644 --- a/src/gui/qgskeyvaluewidget.h +++ b/src/gui/qgskeyvaluewidget.h @@ -23,10 +23,10 @@ ///@cond PRIVATE -/** @ingroup gui +/** \ingroup gui * Table model to edit a QVariantMap. * \since QGIS 3.0 - * @note not available in Python bindings + * \note not available in Python bindings */ class GUI_EXPORT QgsKeyValueModel : public QAbstractTableModel { @@ -76,7 +76,7 @@ class GUI_EXPORT QgsKeyValueWidget: public QgsTableWidgetBase /** * Get the edit value. - * @return the QVariantMap + * \returns the QVariantMap */ QVariantMap map() const { return mModel.map(); } diff --git a/src/gui/qgslegendfilterbutton.h b/src/gui/qgslegendfilterbutton.h index 6eca9ed2080c..4ee820da5206 100644 --- a/src/gui/qgslegendfilterbutton.h +++ b/src/gui/qgslegendfilterbutton.h @@ -36,7 +36,7 @@ class GUI_EXPORT QgsLegendFilterButton: public QToolButton /** * Construct a new filter legend button * - * @param parent The parent QWidget + * \param parent The parent QWidget */ QgsLegendFilterButton( QWidget *parent = nullptr ); diff --git a/src/gui/qgslimitedrandomcolorrampdialog.h b/src/gui/qgslimitedrandomcolorrampdialog.h index 58b959f35ca3..aabde4667baf 100644 --- a/src/gui/qgslimitedrandomcolorrampdialog.h +++ b/src/gui/qgslimitedrandomcolorrampdialog.h @@ -35,19 +35,19 @@ class GUI_EXPORT QgsLimitedRandomColorRampWidget : public QgsPanelWidget, privat public: /** Constructor for QgsLimitedRandomColorRampWidget. - * @param ramp initial ramp to show in dialog - * @param parent parent widget + * \param ramp initial ramp to show in dialog + * \param parent parent widget */ QgsLimitedRandomColorRampWidget( const QgsLimitedRandomColorRamp &ramp, QWidget *parent = nullptr ); /** Returns a color ramp representing the current settings from the dialog. - * @see setRamp() + * \see setRamp() */ QgsLimitedRandomColorRamp ramp() const { return mRamp; } /** Sets the color ramp to show in the dialog. - * @param ramp color ramp - * @see ramp() + * \param ramp color ramp + * \see ramp() */ void setRamp( const QgsLimitedRandomColorRamp &ramp ); @@ -95,19 +95,19 @@ class GUI_EXPORT QgsLimitedRandomColorRampDialog : public QDialog public: /** Constructor for QgsLimitedRandomColorRampDialog. - * @param ramp initial ramp to show in dialog - * @param parent parent widget + * \param ramp initial ramp to show in dialog + * \param parent parent widget */ QgsLimitedRandomColorRampDialog( const QgsLimitedRandomColorRamp &ramp, QWidget *parent = nullptr ); /** Returns a color ramp representing the current settings from the dialog. - * @see setRamp() + * \see setRamp() */ QgsLimitedRandomColorRamp ramp() const { return mWidget->ramp(); } /** Sets the color ramp to show in the dialog. - * @param ramp color ramp - * @see ramp() + * \param ramp color ramp + * \see ramp() */ void setRamp( const QgsLimitedRandomColorRamp &ramp ) { mWidget->setRamp( ramp ); } diff --git a/src/gui/qgslistwidget.h b/src/gui/qgslistwidget.h index ff151b7d9f37..6fd98cc1cf56 100644 --- a/src/gui/qgslistwidget.h +++ b/src/gui/qgslistwidget.h @@ -23,10 +23,10 @@ ///@cond PRIVATE -/** @ingroup gui +/** \ingroup gui * Table model to edit a QVariantList. * \since QGIS 3.0 - * @note not available in Python bindings + * \note not available in Python bindings */ class GUI_EXPORT QgsListModel : public QAbstractTableModel { @@ -76,13 +76,13 @@ class GUI_EXPORT QgsListWidget: public QgsTableWidgetBase /** * Get the edit value. - * @return the QVariantList + * \returns the QVariantList */ QVariantList list() const { return mModel.list(); } /** * Check the content is valid - * @return true if valid + * \returns true if valid */ bool valid() const { return mModel.valid(); } diff --git a/src/gui/qgsmapcanvas.cpp b/src/gui/qgsmapcanvas.cpp index 79d31c402bab..5571220b7ce3 100644 --- a/src/gui/qgsmapcanvas.cpp +++ b/src/gui/qgsmapcanvas.cpp @@ -1,10 +1,10 @@ /*************************************************************************** - qgsmapcanvas.cpp - description - ------------------- +qgsmapcanvas.cpp - description +------------------ - begin : Sun Jun 30 2002 -copyright : (C) 2002 by Gary E.Sherman +copyright : ( C ) 2002 by Gary E.Sherman email : sherman at mrcc.com - ***************************************************************************/ +***************************************************************************/ /*************************************************************************** * * @@ -1506,11 +1506,8 @@ void QgsMapCanvas::mouseMoveEvent( QMouseEvent *e ) QPoint xy = e->pos(); QgsPoint coord = getCoordinateTransform()->toMapCoordinates( xy ); emit xyCoordinates( coord ); -} // mouseMoveEvent - - +} -//! Sets the map tool currently being used on the canvas void QgsMapCanvas::setMapTool( QgsMapTool *tool ) { if ( !tool ) @@ -1945,7 +1942,6 @@ void QgsMapCanvas::writeProject( QDomDocument &doc ) // TODO: store only units, extent, projections, dest CRS } -//! Ask user which datum transform to use void QgsMapCanvas::getDatumTransformInfo( const QgsMapLayer *ml, const QString &srcAuthId, const QString &destAuthId ) { if ( !ml ) diff --git a/src/gui/qgsmapcanvas.h b/src/gui/qgsmapcanvas.h index 7d5bfe5e2230..df7b3a868063 100644 --- a/src/gui/qgsmapcanvas.h +++ b/src/gui/qgsmapcanvas.h @@ -94,7 +94,7 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView * empty string before setLayers() calls can be made. * * \since QGIS 3.0 - * @see layers() + * \see layers() */ void setLayers( const QList &layers ); @@ -204,18 +204,18 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView void clearExtentHistory(); /** Zoom to the extent of the selected features of current (vector) layer. - * @param layer optionally specify different than current layer + * \param layer optionally specify different than current layer */ void zoomToSelected( QgsVectorLayer *layer = nullptr ); /** Set canvas extent to the bounding box of a set of features - @param layer the vector layer - @param ids the feature ids*/ + \param layer the vector layer + \param ids the feature ids*/ void zoomToFeatureIds( QgsVectorLayer *layer, const QgsFeatureIds &ids ); /** Centers canvas extent to feature ids - @param layer the vector layer - @param ids the feature ids*/ + \param layer the vector layer + \param ids the feature ids*/ void panToFeatureIds( QgsVectorLayer *layer, const QgsFeatureIds &ids ); //! Pan to the selected features of current (vector) layer keeping same extent. @@ -255,35 +255,35 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView /** * Return the list of layers shown within the map canvas. - * @see setLayers() + * \see setLayers() */ QList layers() const; /** * Freeze/thaw the map canvas. This is used to prevent the canvas from * responding to events while layers are being added/removed etc. - * @param frozen Boolean specifying if the canvas should be frozen (true) or + * \param frozen Boolean specifying if the canvas should be frozen (true) or * thawed (false). Default is true. - * @see isFrozen() - * @see setRenderFlag(). freeze() should be used to programmatically halt map updates, + * \see isFrozen() + * \see setRenderFlag(). freeze() should be used to programmatically halt map updates, * while setRenderFlag() should only be used when users disable rendering via GUI. */ void freeze( bool frozen = true ); /** * Returns true if canvas is frozen. - * @see renderFlag(). isFrozen() should be used to determine whether map updates + * \see renderFlag(). isFrozen() should be used to determine whether map updates * have been halted programmatically, while renderFlag() should be used to * determine whether a user has disabled rendering via GUI. - * @see freeze() + * \see freeze() */ bool isFrozen() const; /** * Returns true if canvas render is disabled as a result of user disabling * renders via the GUI. - * @see setRenderFlag() - * @see isFrozen(). isFrozen() should be used to determine whether map updates + * \see setRenderFlag() + * \see isFrozen(). isFrozen() should be used to determine whether map updates * have been halted programmatically, while renderFlag() should be used to * determine whether a user has disabled rendering via GUI. */ @@ -298,7 +298,7 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView /** * Returns the stored overrides of styles for layers. * \since QGIS 2.12 - * @see setLayerStyleOverrides(). + * \see setLayerStyleOverrides(). */ QMap layerStyleOverrides() const; @@ -311,7 +311,7 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView * empty string before setLayerStyleOverrides() calls can be made. * * \since QGIS 2.12 - * @see layerStyleOverrides() + * \see layerStyleOverrides() */ void setLayerStyleOverrides( const QMap &overrides ); @@ -331,14 +331,14 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView * If an empty string is passed then the current theme association will be * cleared. * \since QGIS 3.0 - * @see theme() + * \see theme() */ void setTheme( const QString &theme ); /** * Returns the map's theme shown in the canvas, if set. * \since QGIS 3.0 - * @see setTheme() + * \see setTheme() */ QString theme() const { return mTheme; } @@ -370,7 +370,7 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView //! Returns whether the scale is locked, so zooming can be performed using magnication. //! \since QGIS 2.16 - //! @see setScaleLocked() + //! \see setScaleLocked() bool scaleLocked() const { return mScaleLocked;} //! used to determine if anti-aliasing is enabled or not @@ -394,32 +394,32 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView QPoint mouseLastXY(); /** Enables a preview mode for the map canvas - * @param previewEnabled set to true to enable a preview mode - * @see setPreviewMode + * \param previewEnabled set to true to enable a preview mode + * \see setPreviewMode * \since QGIS 2.3 */ void setPreviewModeEnabled( bool previewEnabled ); /** Returns whether a preview mode is enabled for the map canvas - * @returns true if a preview mode is currently enabled - * @see setPreviewModeEnabled - * @see previewMode + * \returns true if a preview mode is currently enabled + * \see setPreviewModeEnabled + * \see previewMode * \since QGIS 2.3 */ bool previewModeEnabled() const; /** Sets a preview mode for the map canvas. This setting only has an effect if * previewModeEnabled is true. - * @param mode preview mode for the canvas - * @see previewMode - * @see setPreviewModeEnabled - * @see previewModeEnabled + * \param mode preview mode for the canvas + * \see previewMode + * \see setPreviewModeEnabled + * \see previewModeEnabled * \since QGIS 2.3 */ void setPreviewMode( QgsPreviewEffect::PreviewMode mode ); /** Returns the current preview mode for the map canvas. This setting only has an effect if * previewModeEnabled is true. - * @returns preview mode for map canvas - * @see setPreviewMode - * @see previewModeEnabled + * \returns preview mode for map canvas + * \see setPreviewMode + * \see previewModeEnabled * \since QGIS 2.3 */ QgsPreviewEffect::PreviewMode previewMode() const; @@ -445,9 +445,9 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView * context used for rendering the map, and can be used to apply specific variable overrides for * expression evaluation for the map canvas render. This method will overwrite the existing expression * context scope for the canvas. - * @param scope new expression context scope + * \param scope new expression context scope * \since QGIS 2.12 - * @see expressionContextScope() + * \see expressionContextScope() */ void setExpressionContextScope( const QgsExpressionContextScope &scope ) { mExpressionContextScope = scope; } @@ -455,23 +455,23 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView * into the expression context used for rendering the map, and can be used to apply specific variable * overrides for expression evaluation for the map canvas render. * \since QGIS 2.12 - * @see setExpressionContextScope() + * \see setExpressionContextScope() */ QgsExpressionContextScope &expressionContextScope() { return mExpressionContextScope; } /** Returns a const reference to the expression context scope for the map canvas. * \since QGIS 2.12 - * @see setExpressionContextScope() - * @note not available in Python bindings + * \see setExpressionContextScope() + * \note not available in Python bindings */ const QgsExpressionContextScope &expressionContextScope() const { return mExpressionContextScope; } /** Sets the segmentation tolerance applied when rendering curved geometries - @param tolerance the segmentation tolerance*/ + \param tolerance the segmentation tolerance*/ void setSegmentationTolerance( double tolerance ); /** Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) - @param type the segmentation tolerance typename*/ + \param type the segmentation tolerance typename*/ void setSegmentationToleranceType( QgsAbstractGeometry::SegmentationToleranceType type ); /** @@ -483,14 +483,14 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView /** * Returns true if annotations are visible within the map canvas. * \since QGIS 3.0 - * @see setAnnotationsVisible() + * \see setAnnotationsVisible() */ bool annotationsVisible() const { return mAnnotationsVisible; } /** * Sets whether annotations are \a visible in the canvas. * \since QGIS 3.0 - * @see annotationsVisible() + * \see annotationsVisible() */ void setAnnotationsVisible( bool visible ); @@ -513,9 +513,9 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView /** * Sets whether a user has disabled canvas renders via the GUI. - * @param flag set to false to indicate that user has disabled renders - * @see renderFlag() - * @see freeze(). freeze() should be used to programmatically halt map updates, + * \param flag set to false to indicate that user has disabled renders + * \see renderFlag() + * \see freeze(). freeze() should be used to programmatically halt map updates, * while setRenderFlag() should only be used when users disable rendering via GUI. */ void setRenderFlag( bool flag ); @@ -541,7 +541,7 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView //! Lock the scale, so zooming can be performed using magnication //! \since QGIS 2.16 - //! @see scaleLocked() + //! \see scaleLocked() void setScaleLocked( bool isLocked ); //! Zoom in with fixed factor @@ -641,7 +641,7 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView /** * Emitted when the canvas has been assigned a different map theme. - * @see setTheme() + * \see setTheme() * \since QGIS 3.0 */ void themeChanged( const QString &theme ); @@ -720,7 +720,7 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView /// this class is non-copyable /** - @note + \note Otherwise QScopedPointer would pass the object responsibility on to the copy like a hot potato leaving the copyer in a weird state. @@ -817,23 +817,23 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView void updateMapSize(); /** Starts zooming via rectangle - * @param pos start position for rectangle + * \param pos start position for rectangle * \since QGIS 2.16 */ void beginZoomRect( QPoint pos ); /** Ends zooming via rectangle - * @param pos end position for rectangle + * \param pos end position for rectangle * \since QGIS 2.16 */ void endZoomRect( QPoint pos ); /** Returns bounding box of feature list (in canvas coordinates) - @param ids feature id list - @param layer the layer - @param bbox out: bounding box - @param errorMsg error message in case of error - @return true in case of success*/ + \param ids feature id list + \param layer the layer + \param bbox out: bounding box + \param errorMsg error message in case of error + \returns true in case of success*/ bool boundingBoxOfFeatureIds( const QgsFeatureIds &ids, QgsVectorLayer *layer, QgsRectangle &bbox, QString &errorMsg ) const; void setLayersPrivate( const QList &layers ); diff --git a/src/gui/qgsmapcanvasitem.h b/src/gui/qgsmapcanvasitem.h index 08f1f3c32811..82093b2eac3b 100644 --- a/src/gui/qgsmapcanvasitem.h +++ b/src/gui/qgsmapcanvasitem.h @@ -48,9 +48,9 @@ class GUI_EXPORT QgsMapCanvasItem : public QGraphicsItem void updateCanvas(); /** Sets render context parameters - @param p painter for rendering - @param context out: configured context - @return true in case of success */ + \param p painter for rendering + \param context out: configured context + \returns true in case of success */ bool setRenderContextVariables( QPainter *p, QgsRenderContext &context ) const; public: diff --git a/src/gui/qgsmapcanvasmap.h b/src/gui/qgsmapcanvasmap.h index 0352f411f336..ee15005574b2 100644 --- a/src/gui/qgsmapcanvasmap.h +++ b/src/gui/qgsmapcanvasmap.h @@ -26,7 +26,7 @@ class QgsMapCanvas; /** \ingroup gui * A rectangular graphics item representing the map on the canvas. * - * @note This class is not a part of public API + * \note This class is not a part of public API */ class QgsMapCanvasMap : public QgsMapCanvasItem { diff --git a/src/gui/qgsmapcanvassnapper.h b/src/gui/qgsmapcanvassnapper.h index 2987647ae532..a7d08cb42417 100644 --- a/src/gui/qgsmapcanvassnapper.h +++ b/src/gui/qgsmapcanvassnapper.h @@ -36,7 +36,7 @@ class GUI_EXPORT QgsMapCanvasSnapper public: /** Constructor - @param canvas the map canvas to snap to*/ + \param canvas the map canvas to snap to*/ QgsMapCanvasSnapper( QgsMapCanvas *canvas ); QgsMapCanvasSnapper(); @@ -53,12 +53,12 @@ class GUI_EXPORT QgsMapCanvasSnapper * and QgsSnapper::SnapWithOneResult_BY_SEGMENT if not. As this method is usually used to * find vertices/segments for editing operations, it uses the search radius for vertex * editing from the qgis options. - * @param p start point of the snap (in pixel coordinates) - * @param results list to which the results are appended - * @param snap_to snap to vertex or to segment - * @param snappingTol snapping tolerance. -1 means that the search radius for vertex edits is taken - * @param excludePoints a list with (map coordinate) points that should be excluded in the snapping result. Useful e.g. for vertex moves where a vertex should not be snapped to its original position - * @param allResutInTolerance return all thew results in the tolerance + * \param p start point of the snap (in pixel coordinates) + * \param results list to which the results are appended + * \param snap_to snap to vertex or to segment + * \param snappingTol snapping tolerance. -1 means that the search radius for vertex edits is taken + * \param excludePoints a list with (map coordinate) points that should be excluded in the snapping result. Useful e.g. for vertex moves where a vertex should not be snapped to its original position + * \param allResutInTolerance return all thew results in the tolerance */ int snapToCurrentLayer( QPoint p, QList &results, QgsSnapper::SnappingType snap_to, double snappingTol = -1, const QList &excludePoints = QList(), bool allResutInTolerance = false ); @@ -66,14 +66,14 @@ class GUI_EXPORT QgsMapCanvasSnapper * edited layers to those of other layers (as described in the project properties). * Uses snap mode QgsSnapper::SnapWithOneResult. Therefore, only the * closest result is returned. - * @param p start point of the snap (in pixel coordinates) - * @param results snapped points - * @param excludePoints a list with (map coordinate) points that should be excluded in the snapping result. Useful e.g. for vertex moves where a vertex should not be snapped to its original position - * @return 0 in case of success + * \param p start point of the snap (in pixel coordinates) + * \param results snapped points + * \param excludePoints a list with (map coordinate) points that should be excluded in the snapping result. Useful e.g. for vertex moves where a vertex should not be snapped to its original position + * \returns 0 in case of success */ int snapToBackgroundLayers( QPoint p, QList &results, const QList &excludePoints = QList() ); - // @note not available in Python bindings + // \note not available in Python bindings int snapToBackgroundLayers( const QgsPoint &point, QList &results, const QList &excludePoints = QList() ); void setMapCanvas( QgsMapCanvas *canvas ); diff --git a/src/gui/qgsmaplayeractionregistry.cpp b/src/gui/qgsmaplayeractionregistry.cpp index a3a883192f4e..5c168e94685c 100644 --- a/src/gui/qgsmaplayeractionregistry.cpp +++ b/src/gui/qgsmaplayeractionregistry.cpp @@ -26,7 +26,6 @@ QgsMapLayerAction::QgsMapLayerAction( const QString &name, QObject *parent, Targ { } -//! Creates a map layer action which can run only on a specific layer QgsMapLayerAction::QgsMapLayerAction( const QString &name, QObject *parent, QgsMapLayer *layer, Targets targets, const QIcon &icon ) : QAction( icon, name, parent ) , mSingleLayer( true ) @@ -37,7 +36,6 @@ QgsMapLayerAction::QgsMapLayerAction( const QString &name, QObject *parent, QgsM { } -//! Creates a map layer action which can run on a specific type of layer QgsMapLayerAction::QgsMapLayerAction( const QString &name, QObject *parent, QgsMapLayer::LayerType layerType, Targets targets, const QIcon &icon ) : QAction( icon, name, parent ) , mSingleLayer( false ) diff --git a/src/gui/qgsmaplayeractionregistry.h b/src/gui/qgsmaplayeractionregistry.h index d1c99ad0fc2a..2873e9587fab 100644 --- a/src/gui/qgsmaplayeractionregistry.h +++ b/src/gui/qgsmaplayeractionregistry.h @@ -45,7 +45,7 @@ class GUI_EXPORT QgsMapLayerAction : public QAction Q_DECLARE_FLAGS( Targets, Target ) //! Creates a map layer action which can run on any layer - //! @note using AllActions as a target probably does not make a lot of sense. This default action was settled for API compatibility reasons. + //! \note using AllActions as a target probably does not make a lot of sense. This default action was settled for API compatibility reasons. QgsMapLayerAction( const QString &name, QObject *parent, Targets targets = AllActions, const QIcon &icon = QIcon() ); //! Creates a map layer action which can run only on a specific layer diff --git a/src/gui/qgsmaplayercombobox.h b/src/gui/qgsmaplayercombobox.h index 5b61de9e6a38..7784da5d7387 100644 --- a/src/gui/qgsmaplayercombobox.h +++ b/src/gui/qgsmaplayercombobox.h @@ -25,7 +25,7 @@ class QgsMapLayer; class QgsVectorLayer; /** \ingroup gui - * @brief The QgsMapLayerComboBox class is a combo box which displays the list of layers + * \brief The QgsMapLayerComboBox class is a combo box which displays the list of layers * \since QGIS 2.3 */ class GUI_EXPORT QgsMapLayerComboBox : public QComboBox @@ -40,7 +40,7 @@ class GUI_EXPORT QgsMapLayerComboBox : public QComboBox public: /** - * @brief QgsMapLayerComboBox creates a combo box to dislpay the list of layers (currently in the registry). + * \brief QgsMapLayerComboBox creates a combo box to dislpay the list of layers (currently in the registry). * The layers can be filtered and/or ordered. */ explicit QgsMapLayerComboBox( QWidget *parent = nullptr ); @@ -60,41 +60,41 @@ class GUI_EXPORT QgsMapLayerComboBox : public QComboBox /** * Sets a list of data providers which should be excluded from the combobox. * \since QGIS 3.0 - * @see excludedProviders() + * \see excludedProviders() */ void setExcludedProviders( const QStringList &providers ); /** * Returns the list of data providers which are excluded from the combobox. - * @see setExcludedProviders() + * \see setExcludedProviders() * \since QGIS 3.0 */ QStringList excludedProviders() const; /** * Sets whether an optional empty layer ("not set") option is shown in the combo box. - * @see allowEmptyLayer() + * \see allowEmptyLayer() * \since QGIS 3.0 */ void setAllowEmptyLayer( bool allowEmpty ); /** * Returns true if the combo box allows the empty layer ("not set") choice. - * @see setAllowEmptyLayer() + * \see setAllowEmptyLayer() * \since QGIS 3.0 */ bool allowEmptyLayer() const; /** * Sets whether the CRS of layers is also included in the combo box text. - * @see showCrs() + * \see showCrs() * \since QGIS 3.0 */ void setShowCrs( bool showCrs ); /** * Returns true if the combo box shows the layer's CRS. - * @see setShowCrs() + * \see setShowCrs() * \since QGIS 3.0 */ bool showCrs() const; @@ -103,27 +103,27 @@ class GUI_EXPORT QgsMapLayerComboBox : public QComboBox * Sets a list of additional (non map layer) items to include at the end of the combobox. * These may represent additional layers such as layers which are not included in the map * layer registry, or paths to layers which have not yet been loaded into QGIS. - * @see additionalItems() + * \see additionalItems() * \since QGIS 3.0 */ void setAdditionalItems( const QStringList &items ); /** * Return the list of additional (non map layer) items included at the end of the combo box. - * @see setAdditionalItems() + * \see setAdditionalItems() * \since QGIS 3.0 */ QStringList additionalItems() const; /** Returns the current layer selected in the combo box. - * @see layer + * \see layer */ QgsMapLayer *currentLayer() const; /** Return the layer currently shown at the specified index within the combo box. - * @param layerIndex position of layer to return + * \param layerIndex position of layer to return * \since QGIS 2.10 - * @see currentLayer + * \see currentLayer */ QgsMapLayer *layer( int layerIndex ) const; diff --git a/src/gui/qgsmaplayerconfigwidget.h b/src/gui/qgsmaplayerconfigwidget.h index 6f0fc17f8fd5..01cb0b881e63 100644 --- a/src/gui/qgsmaplayerconfigwidget.h +++ b/src/gui/qgsmaplayerconfigwidget.h @@ -35,11 +35,11 @@ class GUI_EXPORT QgsMapLayerConfigWidget : public QgsPanelWidget public: /** - * @brief A panel widget that can be shown in the map style dock - * @param layer The layer active in the dock. - * @param canvas The canvas object. - * @param parent The parent of the widget. - * @note The widget is created each time the panel is selected in the dock. + * \brief A panel widget that can be shown in the map style dock + * \param layer The layer active in the dock. + * \param canvas The canvas object. + * \param parent The parent of the widget. + * \note The widget is created each time the panel is selected in the dock. * Keep the loading light as possible for speed in the UI. */ QgsMapLayerConfigWidget( QgsMapLayer *layer, QgsMapCanvas *canvas, QWidget *parent = 0 ); @@ -47,7 +47,7 @@ class GUI_EXPORT QgsMapLayerConfigWidget : public QgsPanelWidget public slots: /** - * @brief Called when changes to the layer need to be made. + * \brief Called when changes to the layer need to be made. * Will be called when live update is enabled. */ virtual void apply() = 0; diff --git a/src/gui/qgsmaplayerconfigwidgetfactory.h b/src/gui/qgsmaplayerconfigwidgetfactory.h index 5cbfef657abe..4ade58698a7d 100644 --- a/src/gui/qgsmaplayerconfigwidgetfactory.h +++ b/src/gui/qgsmaplayerconfigwidgetfactory.h @@ -41,70 +41,70 @@ class GUI_EXPORT QgsMapLayerConfigWidgetFactory virtual ~QgsMapLayerConfigWidgetFactory() = default; /** - * @brief The icon that will be shown in the UI for the panel. - * @return A QIcon for the panel icon. + * \brief The icon that will be shown in the UI for the panel. + * \returns A QIcon for the panel icon. */ virtual QIcon icon() const { return mIcon; } /** * Set the icon for the factory object. - * @param icon The icon to show in the interface. + * \param icon The icon to show in the interface. */ void setIcon( const QIcon &icon ) { mIcon = icon; } /** - * @brief The title of the panel. - * @note This may or may not be shown to the user. - * @return Title of the panel + * \brief The title of the panel. + * \note This may or may not be shown to the user. + * \returns Title of the panel */ virtual QString title() const { return mTitle; } /** * Set the title for the interface - * @note Not all users may show this as a label + * \note Not all users may show this as a label * e.g style dock uses this as a tooltip. - * @param title The title to set. + * \param title The title to set. */ void setTitle( const QString &title ) { mTitle = title; } /** * Flag if widget is supported for use in style dock. - * @return True if supported + * \returns True if supported */ virtual bool supportsStyleDock() const { return false; } /** * Set support flag for style dock - * @param supports True if this widget is supported in the style dock. + * \param supports True if this widget is supported in the style dock. */ void setSupportsStyleDock( bool supports ) { mSupportsDock = supports; } /** * Flag if widget is supported for use in layer properties dialog. - * @return True if supported + * \returns True if supported */ virtual bool supportLayerPropertiesDialog() const { return false; } /** * Set support flag for style dock - * @param supports True if this widget is supported in the style dock. + * \param supports True if this widget is supported in the style dock. */ void setSupportLayerPropertiesDialog( bool supports ) { mSupportsProperties = supports; } /** - * @brief Check if the layer is supported for this widget. - * @return True if this layer is supported for this widget + * \brief Check if the layer is supported for this widget. + * \returns True if this layer is supported for this widget */ virtual bool supportsLayer( QgsMapLayer *layer ) const; /** - * @brief Factory function to create the widget on demand as needed by the dock. - * @note This function is called each time the panel is selected. Keep it light for better UX. - * @param layer The active layer in the dock. - * @param canvas The map canvas. - * @param dockWidget True of the widget will be shown a dock style widget. - * @param parent The parent of the widget. - * @return A new QgsMapStylePanel which is shown in the map style dock. + * \brief Factory function to create the widget on demand as needed by the dock. + * \note This function is called each time the panel is selected. Keep it light for better UX. + * \param layer The active layer in the dock. + * \param canvas The map canvas. + * \param dockWidget True of the widget will be shown a dock style widget. + * \param parent The parent of the widget. + * \returns A new QgsMapStylePanel which is shown in the map style dock. */ virtual QgsMapLayerConfigWidget *createWidget( QgsMapLayer *layer, QgsMapCanvas *canvas, bool dockWidget = true, QWidget *parent = 0 ) const = 0; diff --git a/src/gui/qgsmaplayerstylemanagerwidget.h b/src/gui/qgsmaplayerstylemanagerwidget.h index edafd010e191..26e890ad5a74 100644 --- a/src/gui/qgsmaplayerstylemanagerwidget.h +++ b/src/gui/qgsmaplayerstylemanagerwidget.h @@ -27,7 +27,7 @@ class QgsMapCanvas; /** \ingroup gui - * @brief The QgsMapLayerStyleManagerWidget class which is used to visually manage + * \brief The QgsMapLayerStyleManagerWidget class which is used to visually manage * the layer styles. */ class GUI_EXPORT QgsMapLayerStyleManagerWidget : public QgsMapLayerConfigWidget @@ -36,10 +36,10 @@ class GUI_EXPORT QgsMapLayerStyleManagerWidget : public QgsMapLayerConfigWidget public: /** - * @brief Style manager widget to manage the layers styles. - * @param layer The layer for the widget - * @param canvas The canvas object. - * @param parent The parent. + * \brief Style manager widget to manage the layers styles. + * \param layer The layer for the widget + * \param canvas The canvas object. + * \param parent The parent. */ QgsMapLayerStyleManagerWidget( QgsMapLayer *layer, QgsMapCanvas *canvas, QWidget *parent = 0 ); diff --git a/src/gui/qgsmapmouseevent.h b/src/gui/qgsmapmouseevent.h index e07138cc313f..61384a9d3f6d 100644 --- a/src/gui/qgsmapmouseevent.h +++ b/src/gui/qgsmapmouseevent.h @@ -45,27 +45,27 @@ class GUI_EXPORT QgsMapMouseEvent : public QMouseEvent /** * Creates a new QgsMapMouseEvent. Should only be required to be called from the QgsMapCanvas. * - * @param mapCanvas The map canvas on which the event occurred - * @param event The original mouse event + * \param mapCanvas The map canvas on which the event occurred + * \param event The original mouse event */ QgsMapMouseEvent( QgsMapCanvas *mapCanvas, QMouseEvent *event ); /** * Creates a new QgsMapMouseEvent. Should only be required to be called from the QgsMapCanvas. * - * @param mapCanvas The map canvas on which the event occurred - * @param type The type of the event - * @param pos The pixel position of the mouse - * @param button The pressed button - * @param buttons Further buttons that are pressed - * @param modifiers Keyboard modifiers + * \param mapCanvas The map canvas on which the event occurred + * \param type The type of the event + * \param pos The pixel position of the mouse + * \param button The pressed button + * \param buttons Further buttons that are pressed + * \param modifiers Keyboard modifiers */ QgsMapMouseEvent( QgsMapCanvas *mapCanvas, QEvent::Type type, QPoint pos, Qt::MouseButton button = Qt::NoButton, Qt::MouseButtons buttons = Qt::NoButton, Qt::KeyboardModifiers modifiers = Qt::NoModifier ); /** - * @brief snapPoint will snap the points using the map canvas snapping utils configuration - * @note if snapping did not succeeded, the map point will be reset to its original position + * \brief snapPoint will snap the points using the map canvas snapping utils configuration + * \note if snapping did not succeeded, the map point will be reset to its original position */ QgsPoint snapPoint( SnappingMode snappingMode ); @@ -73,9 +73,9 @@ class GUI_EXPORT QgsMapMouseEvent : public QMouseEvent * Returns the first snapped segment. If the cached snapped match is a segment, it will simply return it. * Otherwise it will try to snap a segment according to the event's snapping mode. In this case the cache * will not be overwritten. - * @param snappingMode Specify if the default project settings or all layers should be used for snapping - * @param snapped if given, determines if a segment has been snapped - * @param allLayers if true, override snapping mode + * \param snappingMode Specify if the default project settings or all layers should be used for snapping + * \param snapped if given, determines if a segment has been snapped + * \param allLayers if true, override snapping mode */ QList snapSegment( SnappingMode snappingMode, bool *snapped = nullptr, bool allLayers = false ) const; @@ -83,19 +83,19 @@ class GUI_EXPORT QgsMapMouseEvent : public QMouseEvent * Returns true if there is a snapped point cached. * Will only be useful after snapPoint has previously been called. * - * @return True if there is a snapped point cached. + * \returns True if there is a snapped point cached. */ bool isSnapped() const { return mSnapMatch.isValid(); } /** - * @brief mapPoint returns the point in coordinates - * @return the point in map coordinates, after snapping if requested in the event. + * \brief mapPoint returns the point in coordinates + * \returns the point in map coordinates, after snapping if requested in the event. */ inline QgsPoint mapPoint() const { return mMapPoint; } /** * Returns the matching data from the most recently snapped point. - * @return the snapping data structure + * \returns the snapping data structure * \since QGIS 2.14 */ QgsPointLocator::Match mapPointMatch() const { return mSnapMatch; } @@ -104,21 +104,21 @@ class GUI_EXPORT QgsMapMouseEvent : public QMouseEvent * Set the (snapped) point this event points to in map coordinates. * The point in pixel coordinates will be calculated accordingly. * - * @param point The point in map coordinates + * \param point The point in map coordinates */ void setMapPoint( const QgsPoint &point ); /** * Returns the original, unmodified map point of the mouse cursor. * - * @return The cursor position in map coordinates. + * \returns The cursor position in map coordinates. */ QgsPoint originalMapPoint() const { return mMapPoint; } /** * The snapped mouse cursor in pixel coordinates. * - * @return The snapped mouse cursor position in pixel coordinates. + * \returns The snapped mouse cursor position in pixel coordinates. */ QPoint pixelPoint() const { return mPixelPoint; } @@ -126,7 +126,7 @@ class GUI_EXPORT QgsMapMouseEvent : public QMouseEvent * The unsnapped, real mouse cursor position in pixel coordinates. * Alias to pos() * - * @return Mouse position in pixel coordinates + * \returns Mouse position in pixel coordinates */ QPoint originalPixelPoint() const { return pos(); } diff --git a/src/gui/qgsmaptip.h b/src/gui/qgsmaptip.h index 50b9760d1763..0f93e5e2d5ee 100644 --- a/src/gui/qgsmaptip.h +++ b/src/gui/qgsmaptip.h @@ -57,13 +57,13 @@ class GUI_EXPORT QgsMapTip : public QWidget QgsMapTip(); /** Show a maptip at a given point on the map canvas - * @param thepLayer a qgis vector map layer pointer that will + * \param thepLayer a qgis vector map layer pointer that will * be used to provide the attribute data for the map tip. - * @param mapPosition a reference to the position of the cursor + * \param mapPosition a reference to the position of the cursor * in map coordinatess. - * @param pixelPosition a reference to the position of the cursor + * \param pixelPosition a reference to the position of the cursor * in pixel coordinates. - * @param mpMapCanvas a map canvas on which the tip is drawn + * \param mpMapCanvas a map canvas on which the tip is drawn */ void showMapTip( QgsMapLayer *thepLayer, QgsPoint &mapPosition, @@ -71,7 +71,7 @@ class GUI_EXPORT QgsMapTip : public QWidget QgsMapCanvas *mpMapCanvas ); /** Clear the current maptip if it exists - * @param mpMapCanvas the canvas from which the tip should be cleared. + * \param mpMapCanvas the canvas from which the tip should be cleared. */ void clear( QgsMapCanvas *mpMapCanvas = nullptr ); private: diff --git a/src/gui/qgsmaptool.h b/src/gui/qgsmaptool.h index 9320bd12f248..eeba1c6f0767 100644 --- a/src/gui/qgsmaptool.h +++ b/src/gui/qgsmaptool.h @@ -179,7 +179,7 @@ class GUI_EXPORT QgsMapTool : public QObject QgsPoint toMapCoordinates( const QgsMapLayer *layer, const QgsPoint &point ); //!transformation from layer's coordinates to map coordinates (which is different in case reprojection is used) - //! @note available in Python bindings as toMapCoordinatesV2 + //! \note available in Python bindings as toMapCoordinatesV2 QgsPointV2 toMapCoordinates( const QgsMapLayer *layer, const QgsPointV2 &point ); //! trnasformation of the rect from map coordinates to layer's coordinates diff --git a/src/gui/qgsmaptooladvanceddigitizing.h b/src/gui/qgsmaptooladvanceddigitizing.h index 4357ce34dfc6..de50b19af0c5 100644 --- a/src/gui/qgsmaptooladvanceddigitizing.h +++ b/src/gui/qgsmaptooladvanceddigitizing.h @@ -24,12 +24,12 @@ class QgsMapMouseEvent; class QgsAdvancedDigitizingDockWidget; /** \ingroup gui - * @brief The QgsMapToolAdvancedDigitizing class is a QgsMapTool which gives event directly in map coordinates and allows filtering its events. + * \brief The QgsMapToolAdvancedDigitizing class is a QgsMapTool which gives event directly in map coordinates and allows filtering its events. * Events from QgsMapTool are caught and their QMouseEvent are transformed into QgsMapMouseEvent (with map coordinates). * Events are then forwarded to corresponding virtual methods which can be reimplemented in subclasses. - * An event filter can be set on the map tool to filter and modify the events in map coordinates (@see QgsMapToolMapEventFilter). - * @note at the moment, the event filter is used by the CAD tools (@see QgsCadDocWidget). - * @note the event filter definition is not exposed in Python API to avoid any unexpected behavior. + * An event filter can be set on the map tool to filter and modify the events in map coordinates (\see QgsMapToolMapEventFilter). + * \note at the moment, the event filter is used by the CAD tools (\see QgsCadDocWidget). + * \note the event filter definition is not exposed in Python API to avoid any unexpected behavior. */ class GUI_EXPORT QgsMapToolAdvancedDigitizing : public QgsMapToolEdit { @@ -47,8 +47,8 @@ class GUI_EXPORT QgsMapToolAdvancedDigitizing : public QgsMapToolEdit /** * Creates an advanced digitizing maptool - * @param canvas The map canvas on which the tool works - * @param cadDockWidget The cad dock widget which will be used to adjust mouse events + * \param canvas The map canvas on which the tool works + * \param cadDockWidget The cad dock widget which will be used to adjust mouse events */ explicit QgsMapToolAdvancedDigitizing( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget ); @@ -62,7 +62,7 @@ class GUI_EXPORT QgsMapToolAdvancedDigitizing : public QgsMapToolEdit /** * The capture mode * - * @return Capture mode + * \returns Capture mode */ CaptureMode mode() const { return mCaptureMode; } @@ -70,7 +70,7 @@ class GUI_EXPORT QgsMapToolAdvancedDigitizing : public QgsMapToolEdit * Set capture mode. This should correspond to the layer on which the digitizing * happens. * - * @param mode Capture Mode + * \param mode Capture Mode */ void setMode( CaptureMode mode ) { mCaptureMode = mode; } @@ -95,7 +95,7 @@ class GUI_EXPORT QgsMapToolAdvancedDigitizing : public QgsMapToolEdit * canvasPressEvent is triggered and it's not hidden by the cad's * construction mode. * - * @param e Mouse events prepared by the cad system + * \param e Mouse events prepared by the cad system */ virtual void cadCanvasPressEvent( QgsMapMouseEvent *e ) { Q_UNUSED( e ) } @@ -106,7 +106,7 @@ class GUI_EXPORT QgsMapToolAdvancedDigitizing : public QgsMapToolEdit * canvasReleaseEvent is triggered and it's not hidden by the cad's * construction mode. * - * @param e Mouse events prepared by the cad system + * \param e Mouse events prepared by the cad system */ virtual void cadCanvasReleaseEvent( QgsMapMouseEvent *e ) { Q_UNUSED( e ) } @@ -117,7 +117,7 @@ class GUI_EXPORT QgsMapToolAdvancedDigitizing : public QgsMapToolEdit * canvasMoveEvent is triggered and it's not hidden by the cad's * construction mode. * - * @param e Mouse events prepared by the cad system + * \param e Mouse events prepared by the cad system */ virtual void cadCanvasMoveEvent( QgsMapMouseEvent *e ) { Q_UNUSED( e ) } @@ -137,7 +137,7 @@ class GUI_EXPORT QgsMapToolAdvancedDigitizing : public QgsMapToolEdit * The specified point will be used to generate a fake mouse event which will * be sent as move event to cadCanvasMoveEvent. * - * @param point The last point known to the cad system. + * \param point The last point known to the cad system. */ void cadPointChanged( const QgsPoint &point ); diff --git a/src/gui/qgsmaptoolcapture.h b/src/gui/qgsmaptoolcapture.h index 66297c9bbb7e..b2f1a8f11085 100644 --- a/src/gui/qgsmaptoolcapture.h +++ b/src/gui/qgsmaptoolcapture.h @@ -52,7 +52,7 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing /** * Get the capture curve * - * @return Capture curve + * \returns Capture curve */ const QgsCompoundCurve *captureCurve() const { return &mCaptureCurve; } @@ -60,7 +60,7 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing /** * Intercept key events like Esc or Del to delete the last point - * @param e key event + * \param e key event */ virtual void keyPressEvent( QKeyEvent *e ) override; @@ -82,9 +82,9 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing protected: /** Converts a map point to layer coordinates - * @param mapPoint the point in map coordinates - * @param[in,out] layerPoint the point in layer coordinates - * @return + * \param mapPoint the point in map coordinates + * \param[in,out] layerPoint the point in layer coordinates + * \returns * 0 in case of success * 1 if the current layer is null or not a vector layer * 2 if the transformation failed @@ -93,10 +93,10 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing int nextPoint( const QgsPointV2 &mapPoint, QgsPointV2 &layerPoint ); /** Converts a point to map coordinates and layer coordinates - * @param p the input point - * @param[in,out] layerPoint the point in layer coordinates - * @param[in,out] mapPoint the point in map coordinates - * @return + * \param p the input point + * \param[in,out] layerPoint the point in layer coordinates + * \param[in,out] mapPoint the point in map coordinates + * \returns * 0 in case of success * 1 if the current layer is null or not a vector layer * 2 if the transformation failed @@ -106,21 +106,21 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing /** Fetches the original point from the source layer if it has the same * CRS as the current layer. - * @return 0 in case of success, 1 if not applicable (CRS mismatch), 2 in case of failure + * \returns 0 in case of success, 1 if not applicable (CRS mismatch), 2 in case of failure * \since QGIS 2.14 */ // TODO QGIS 3.0 returns an enum instead of a magic constant int fetchLayerPoint( const QgsPointLocator::Match &match, QgsPointV2 &layerPoint ); /** Adds a point to the rubber band (in map coordinates) and to the capture list (in layer coordinates) - * @return 0 in case of success, 1 if current layer is not a vector layer, 2 if coordinate transformation failed + * \returns 0 in case of success, 1 if current layer is not a vector layer, 2 if coordinate transformation failed */ // TODO QGIS 3.0 returns an enum instead of a magic constant int addVertex( const QgsPoint &point ); /** Variant to supply more information in the case of snapping - * @param mapPoint The vertex to add in map coordinates - * @param match Data about the snapping match. Can be an invalid match, if point not snapped. + * \param mapPoint The vertex to add in map coordinates + * \param match Data about the snapping match. Can be an invalid match, if point not snapped. * \since QGIS 2.14 */ int addVertex( const QgsPoint &mapPoint, const QgsPointLocator::Match &match ); @@ -136,7 +136,7 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing /** * Are we currently capturing? * - * @return Is the tool in capture mode? + * \returns Is the tool in capture mode? */ bool isCapturing() const; @@ -148,20 +148,20 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing /** * Number of points digitized * - * @return Number of points + * \returns Number of points */ int size(); /** * List of digitized points - * @return List of points + * \returns List of points */ QList points(); /** * Set the points on which to work * - * @param pointList A list of points + * \param pointList A list of points */ void setPoints( const QList &pointList ); diff --git a/src/gui/qgsmaptooledit.h b/src/gui/qgsmaptooledit.h index 3b6c85716fd1..72204d536e1c 100644 --- a/src/gui/qgsmaptooledit.h +++ b/src/gui/qgsmaptooledit.h @@ -55,8 +55,8 @@ class GUI_EXPORT QgsMapToolEdit: public QgsMapTool /** Creates a rubber band with the color/line width from * the QGIS settings. The caller takes ownership of the * returned object - * @param geometryType - * @param alternativeBand if true, rubber band will be set with more transparency and a dash pattern. defaut is false. + * \param geometryType + * \param alternativeBand if true, rubber band will be set with more transparency and a dash pattern. defaut is false. */ QgsRubberBand *createRubberBand( QgsWkbTypes::GeometryType geometryType = QgsWkbTypes::LineGeometry, bool alternativeBand = false ); @@ -66,8 +66,8 @@ class GUI_EXPORT QgsMapToolEdit: public QgsMapTool QgsVectorLayer *currentVectorLayer(); /** Adds vertices to other features to keep topology up to date, e.g. to neighbouring polygons. - * @param geom list of points (in layer coordinate system) - * @return 0 in case of success + * \param geom list of points (in layer coordinate system) + * \returns 0 in case of success */ int addTopologicalPoints( const QList &geom ); diff --git a/src/gui/qgsmaptoolidentify.h b/src/gui/qgsmaptoolidentify.h index 0a0ceede51e7..e67390a8a6ff 100644 --- a/src/gui/qgsmaptoolidentify.h +++ b/src/gui/qgsmaptoolidentify.h @@ -101,21 +101,21 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool virtual void deactivate() override; /** Performs the identification. - @param x x coordinates of mouseEvent - @param y y coordinates of mouseEvent - @param layerList Performs the identification within the given list of layers. Default value is an empty list, i.e. uses all the layers. - @param mode Identification mode. Can use Qgis default settings or a defined mode. Default mode is DefaultQgsSetting. - @return a list of IdentifyResult*/ + \param x x coordinates of mouseEvent + \param y y coordinates of mouseEvent + \param layerList Performs the identification within the given list of layers. Default value is an empty list, i.e. uses all the layers. + \param mode Identification mode. Can use Qgis default settings or a defined mode. Default mode is DefaultQgsSetting. + \returns a list of IdentifyResult*/ QList identify( int x, int y, const QList &layerList = QList(), IdentifyMode mode = DefaultQgsSetting ); /** Performs the identification. To avoid being forced to specify IdentifyMode with a list of layers this has been made private and two publics methods are offered - @param x x coordinates of mouseEvent - @param y y coordinates of mouseEvent - @param mode Identification mode. Can use Qgis default settings or a defined mode. - @param layerType Only performs identification in a certain type of layers (raster, vector). Default value is AllLayers. - @return a list of IdentifyResult*/ + \param x x coordinates of mouseEvent + \param y y coordinates of mouseEvent + \param mode Identification mode. Can use Qgis default settings or a defined mode. + \param layerType Only performs identification in a certain type of layers (raster, vector). Default value is AllLayers. + \returns a list of IdentifyResult*/ QList identify( int x, int y, IdentifyMode mode, LayerType layerType = AllLayers ); //! return a pointer to the identify menu which will be used in layer selection mode @@ -135,12 +135,12 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool /** Performs the identification. To avoid being forced to specify IdentifyMode with a list of layers this has been made private and two publics methods are offered - @param x x coordinates of mouseEvent - @param y y coordinates of mouseEvent - @param mode Identification mode. Can use Qgis default settings or a defined mode. - @param layerList Performs the identification within the given list of layers. - @param layerType Only performs identification in a certain type of layers (raster, vector). - @return a list of IdentifyResult*/ + \param x x coordinates of mouseEvent + \param y y coordinates of mouseEvent + \param mode Identification mode. Can use Qgis default settings or a defined mode. + \param layerList Performs the identification within the given list of layers. + \param layerType Only performs identification in a certain type of layers (raster, vector). + \returns a list of IdentifyResult*/ QList identify( int x, int y, IdentifyMode mode, const QList &layerList, LayerType layerType = AllLayers ); QgsIdentifyMenu *mIdentifyMenu = nullptr; @@ -155,25 +155,25 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool /** Desired units for distance display. * \since QGIS 2.14 - * @see displayAreaUnits() + * \see displayAreaUnits() */ virtual QgsUnitTypes::DistanceUnit displayDistanceUnits() const; /** Desired units for area display. * \since QGIS 2.14 - * @see displayDistanceUnits() + * \see displayDistanceUnits() */ virtual QgsUnitTypes::AreaUnit displayAreaUnits() const; /** Format a distance into a suitable string for display to the user * \since QGIS 2.14 - * @see formatArea() + * \see formatArea() */ QString formatDistance( double distance ) const; /** Format a distance into a suitable string for display to the user * \since QGIS 2.14 - * @see formatDistance() + * \see formatDistance() */ QString formatArea( double area ) const; diff --git a/src/gui/qgsmaptoolidentifyfeature.h b/src/gui/qgsmaptoolidentifyfeature.h index 494148aba848..2771107fe6a8 100644 --- a/src/gui/qgsmaptoolidentifyfeature.h +++ b/src/gui/qgsmaptoolidentifyfeature.h @@ -20,7 +20,7 @@ #include "qgis_gui.h" /** \ingroup gui - * @brief The QgsMapToolIdentifyFeature class is a map tool to identify a feature on a chosen layer. + * \brief The QgsMapToolIdentifyFeature class is a map tool to identify a feature on a chosen layer. * Once the map tool is enable, user can click on the map canvas to identify a feature. * A signal will then be emitted. */ @@ -31,9 +31,9 @@ class GUI_EXPORT QgsMapToolIdentifyFeature : public QgsMapToolIdentify public: /** - * @brief QgsMapToolIdentifyFeature is a map tool to identify a feature on a chosen layer - * @param canvas the map canvas - * @param vl the vector layer. The map tool can be initialized without any layer and can be set afterward. + * \brief QgsMapToolIdentifyFeature is a map tool to identify a feature on a chosen layer + * \param canvas the map canvas + * \param vl the vector layer. The map tool can be initialized without any layer and can be set afterward. */ QgsMapToolIdentifyFeature( QgsMapCanvas *canvas, QgsVectorLayer *vl = nullptr ); diff --git a/src/gui/qgsmaptoolpan.h b/src/gui/qgsmaptoolpan.h index 0700e661b86e..daec08d5c6d8 100644 --- a/src/gui/qgsmaptoolpan.h +++ b/src/gui/qgsmaptoolpan.h @@ -23,7 +23,7 @@ class QgsMapCanvas; /** \ingroup gui * A map tool for panning the map. - * @see QgsMapTool + * \see QgsMapTool */ class GUI_EXPORT QgsMapToolPan : public QgsMapTool { diff --git a/src/gui/qgsmaptoolzoom.h b/src/gui/qgsmaptoolzoom.h index c5ed2cadc22e..5ebf1d22a6fa 100644 --- a/src/gui/qgsmaptoolzoom.h +++ b/src/gui/qgsmaptoolzoom.h @@ -24,7 +24,7 @@ class QgsRubberBand; /** \ingroup gui * A map tool for zooming into the map. - * @see QgsMapTool + * \see QgsMapTool */ class GUI_EXPORT QgsMapToolZoom : public QgsMapTool { diff --git a/src/gui/qgsmessagebar.h b/src/gui/qgsmessagebar.h index e7ed16b14939..cd0a51a1bad4 100644 --- a/src/gui/qgsmessagebar.h +++ b/src/gui/qgsmessagebar.h @@ -60,22 +60,22 @@ class GUI_EXPORT QgsMessageBar: public QFrame * and putting it in a stack. * The message bar will take ownership of the item. * - * @param item Item to display + * \param item Item to display */ void pushItem( QgsMessageBarItem *item ); /** Display a widget as a message on the bar after hiding the currently visible one * and putting it in a stack. - * @param widget message widget to display - * @param level is QgsMessageBar::INFO, WARNING, CRITICAL or SUCCESS - * @param duration timeout duration of message in seconds, 0 value indicates no timeout + * \param widget message widget to display + * \param level is QgsMessageBar::INFO, WARNING, CRITICAL or SUCCESS + * \param duration timeout duration of message in seconds, 0 value indicates no timeout */ QgsMessageBarItem *pushWidget( QWidget *widget, MessageLevel level = INFO, int duration = 0 ); /** Remove the passed widget from the bar (if previously added), * then display the next one in the stack if any or hide the bar - * @param item item to remove - * @return true if the widget was removed, false otherwise + * \param item item to remove + * \returns true if the widget was removed, false otherwise */ bool popWidget( QgsMessageBarItem *item ); @@ -104,43 +104,43 @@ class GUI_EXPORT QgsMessageBar: public QFrame /** Remove the currently displayed widget from the bar and * display the next in the stack if any or hide the bar. - * @return true if the widget was removed, false otherwise + * \returns true if the widget was removed, false otherwise */ bool popWidget(); /** Remove all items from the bar's widget list - * @return true if all items were removed, false otherwise + * \returns true if all items were removed, false otherwise */ bool clearWidgets(); /** * Pushes a success message with default timeout to the message bar - * @param title title string for message - * @param message The message to be displayed + * \param title title string for message + * \param message The message to be displayed * \since QGIS 2.8 */ void pushSuccess( const QString &title, const QString &message ); /** * Pushes a information message with default timeout to the message bar - * @param title title string for message - * @param message The message to be displayed + * \param title title string for message + * \param message The message to be displayed * \since QGIS 2.8 */ void pushInfo( const QString &title, const QString &message ); /** * Pushes a warning with default timeout to the message bar - * @param title title string for message - * @param message The message to be displayed + * \param title title string for message + * \param message The message to be displayed * \since QGIS 2.8 */ void pushWarning( const QString &title, const QString &message ); /** * Pushes a critical warning with default timeout to the message bar - * @param title title string for message - * @param message The message to be displayed + * \param title title string for message + * \param message The message to be displayed * \since QGIS 2.8 */ void pushCritical( const QString &title, const QString &message ); diff --git a/src/gui/qgsnewmemorylayerdialog.h b/src/gui/qgsnewmemorylayerdialog.h index 9a56bf9850b9..da78e4e8d71b 100644 --- a/src/gui/qgsnewmemorylayerdialog.h +++ b/src/gui/qgsnewmemorylayerdialog.h @@ -34,9 +34,9 @@ class GUI_EXPORT QgsNewMemoryLayerDialog: public QDialog, private Ui::QgsNewMemo public: /** Runs the dialoag and creates a new memory layer - * @param parent parent widget - * @param defaultCrs default layer CRS to show in dialog - * @returns new memory layer + * \param parent parent widget + * \param defaultCrs default layer CRS to show in dialog + * \returns new memory layer */ static QgsVectorLayer *runAndCreateLayer( QWidget *parent = nullptr, const QgsCoordinateReferenceSystem &defaultCrs = QgsCoordinateReferenceSystem() ); @@ -49,13 +49,13 @@ class GUI_EXPORT QgsNewMemoryLayerDialog: public QDialog, private Ui::QgsNewMemo /** * Sets the \a crs value for the new layer in the dialog. * \since QGIS 3.0 - * @see crs() + * \see crs() */ void setCrs( const QgsCoordinateReferenceSystem &crs ); /** * Returns the selected CRS for the new layer. - * @see setCrs() + * \see setCrs() */ QgsCoordinateReferenceSystem crs() const; diff --git a/src/gui/qgsnewnamedialog.h b/src/gui/qgsnewnamedialog.h index d1f9c55177c6..4ecadc3613b0 100644 --- a/src/gui/qgsnewnamedialog.h +++ b/src/gui/qgsnewnamedialog.h @@ -34,14 +34,14 @@ class GUI_EXPORT QgsNewNameDialog : public QgsDialog public: /** New dialog constructor. - * @param source original data source name, e.g. original layer name of the layer to be copied - * @param initial initial name - * @param extensions base name extensions, e.g. raster base name band extensions or vector layer type extensions - * @param existing existing names - * @param regexp regular expression to be used as validator, for example db tables should have "[A-Za-z_][A-Za-z0-9_]+" - * @param cs case sensitivity for new name to existing names comparison - * @param parent - * @param flags + * \param source original data source name, e.g. original layer name of the layer to be copied + * \param initial initial name + * \param extensions base name extensions, e.g. raster base name band extensions or vector layer type extensions + * \param existing existing names + * \param regexp regular expression to be used as validator, for example db tables should have "[A-Za-z_][A-Za-z0-9_]+" + * \param cs case sensitivity for new name to existing names comparison + * \param parent + * \param flags */ QgsNewNameDialog( const QString &source = QString::null, const QString &initial = QString::null, const QStringList &extensions = QStringList(), const QStringList &existing = QStringList(), @@ -50,15 +50,15 @@ class GUI_EXPORT QgsNewNameDialog : public QgsDialog /** Sets the hint string for the dialog (the text shown above the name * input box). - * @param hintString hint text - * @see hintString() + * \param hintString hint text + * \see hintString() * \since QGIS 2.12 */ void setHintString( const QString &hintString ); /** Returns the hint string for the dialog (the text shown above the name * input box). - * @see setHintString() + * \see setHintString() * \since QGIS 2.12 */ QString hintString() const; @@ -67,40 +67,40 @@ class GUI_EXPORT QgsNewNameDialog : public QgsDialog * the dialog will reflect that the new name will overwrite an existing name. If false, * then the dialog will not accept names which already exist. * \since QGIS 2.12 - * @see overwriteEnabled() + * \see overwriteEnabled() */ void setOverwriteEnabled( bool enabled ); /** Returns whether users are permitted to overwrite existing names. * \since QGIS 2.12 - * @see setOverwriteEnabled() + * \see setOverwriteEnabled() */ bool overwriteEnabled() const { return mOverwriteEnabled; } /** Sets the string used for warning users if a conflicting name exists. - * @param string warning string. If empty a default warning string will be used. + * \param string warning string. If empty a default warning string will be used. * \since QGIS 2.12 - * @see conflictingNameWarning() + * \see conflictingNameWarning() */ void setConflictingNameWarning( const QString &string ); /** Returns the string used for warning users if a conflicting name exists. * \since QGIS 2.12 - * @see setConflictingNameWarning() + * \see setConflictingNameWarning() */ QString conflictingNameWarning() const { return mConflictingNameWarning; } /** Name entered by user. - * @return new name + * \returns new name */ QString name() const; /** Test if name or name with at least one extension exists. - * @param name name or base name - * @param extensions base name extensions - * @param existing existing names - * @param cs case sensitivity for new name to existing names comparison - * @return true if name exists + * \param name name or base name + * \param extensions base name extensions + * \param existing existing names + * \param cs case sensitivity for new name to existing names comparison + * \returns true if name exists */ static bool exists( const QString &name, const QStringList &extensions, const QStringList &existing, Qt::CaseSensitivity cs = Qt::CaseSensitive ); diff --git a/src/gui/qgsnewvectorlayerdialog.h b/src/gui/qgsnewvectorlayerdialog.h index 000e7003fc0c..3ef8647354df 100644 --- a/src/gui/qgsnewvectorlayerdialog.h +++ b/src/gui/qgsnewvectorlayerdialog.h @@ -35,7 +35,7 @@ class GUI_EXPORT QgsNewVectorLayerDialog: public QDialog, private Ui::QgsNewVect /** * Runs the dialog and creates a layer matching the dialog parameters. - * @returns fileName on success, empty string use aborted, QString::null if creation failed + * \returns fileName on success, empty string use aborted, QString::null if creation failed */ static QString runAndCreateLayer( QWidget *parent = nullptr, QString *enc = nullptr, const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() ); @@ -52,14 +52,14 @@ class GUI_EXPORT QgsNewVectorLayerDialog: public QDialog, private Ui::QgsNewVect /** * Returns the selected CRS for the new layer. - * @see setCrs() + * \see setCrs() */ QgsCoordinateReferenceSystem crs() const; /** * Sets the \a crs value for the new layer in the dialog. * \since QGIS 3.0 - * @see crs() + * \see crs() */ void setCrs( const QgsCoordinateReferenceSystem &crs ); diff --git a/src/gui/qgsoptionsdialogbase.h b/src/gui/qgsoptionsdialogbase.h index 8a9d416aa28b..09da6723251a 100644 --- a/src/gui/qgsoptionsdialogbase.h +++ b/src/gui/qgsoptionsdialogbase.h @@ -53,7 +53,7 @@ class GUI_EXPORT QgsSearchHighlightOptionWidget : public QObject public: /** Constructor - * @param widget the widget used to search text into + * \param widget the widget used to search text into */ explicit QgsSearchHighlightOptionWidget( QWidget *widget = 0 ); @@ -64,7 +64,7 @@ class GUI_EXPORT QgsSearchHighlightOptionWidget : public QObject /** * search for a text pattern and highlight the widget if the text is found - * @return true if the text pattern is found + * \returns true if the text pattern is found */ bool searchHighlight( const QString &searchText ); @@ -114,17 +114,17 @@ class GUI_EXPORT QgsOptionsDialogBase : public QDialog public: /** Constructor - * @param settingsKey QgsSettings subgroup key for saving/restore ui states, e.g. "ProjectProperties". - * @param parent parent object (owner) - * @param fl widget flags - * @param settings custom QgsSettings pointer + * \param settingsKey QgsSettings subgroup key for saving/restore ui states, e.g. "ProjectProperties". + * \param parent parent object (owner) + * \param fl widget flags + * \param settings custom QgsSettings pointer */ QgsOptionsDialogBase( const QString &settingsKey, QWidget *parent = nullptr, Qt::WindowFlags fl = 0, QgsSettings *settings = nullptr ); ~QgsOptionsDialogBase(); /** Set up the base ui connections for vertical tabs. - * @param restoreUi Whether to restore the base ui at this time. - * @param title the window title + * \param restoreUi Whether to restore the base ui at this time. + * \param title the window title */ void initOptionsBase( bool restoreUi = true, const QString &title = QString() ); @@ -133,7 +133,7 @@ class GUI_EXPORT QgsOptionsDialogBase : public QDialog /** Restore the base ui. * Sometimes useful to do at end of subclass's constructor. - * @param title the window title (it does not need to be defined if previously given to initOptionsBase(); + * \param title the window title (it does not need to be defined if previously given to initOptionsBase(); */ void restoreOptionsBaseUi( const QString &title = QString() ); @@ -145,7 +145,7 @@ class GUI_EXPORT QgsOptionsDialogBase : public QDialog /** * searchText searches for a text in all the pages of the stacked widget and highlight the results - * @param text the text to search + * \param text the text to search * \since QGIS 3.0 */ void searchText( const QString &text ); diff --git a/src/gui/qgsoptionswidgetfactory.h b/src/gui/qgsoptionswidgetfactory.h index 49b87a606859..12742b5aa122 100644 --- a/src/gui/qgsoptionswidgetfactory.h +++ b/src/gui/qgsoptionswidgetfactory.h @@ -68,34 +68,34 @@ class GUI_EXPORT QgsOptionsWidgetFactory virtual ~QgsOptionsWidgetFactory() = default; /** - * @brief The icon that will be shown in the UI for the panel. - * @return A QIcon for the panel icon. - * @see setIcon() + * \brief The icon that will be shown in the UI for the panel. + * \returns A QIcon for the panel icon. + * \see setIcon() */ virtual QIcon icon() const { return mIcon; } /** * Set the \a icon to show in the interface for the factory object. - * @see icon() + * \see icon() */ void setIcon( const QIcon &icon ) { mIcon = icon; } /** * The title of the panel. - * @see setTitle() + * \see setTitle() */ virtual QString title() const { return mTitle; } /** * Set the \a title for the interface. - * @see title() + * \see title() */ void setTitle( const QString &title ) { mTitle = title; } /** - * @brief Factory function to create the widget on demand as needed by the options dialog. - * @param parent The parent of the widget. - * @return A new widget to show as a page in the options dialog. + * \brief Factory function to create the widget on demand as needed by the options dialog. + * \param parent The parent of the widget. + * \returns A new widget to show as a page in the options dialog. */ virtual QgsOptionsPageWidget *createWidget( QWidget *parent = nullptr ) const = 0; diff --git a/src/gui/qgsorderbydialog.h b/src/gui/qgsorderbydialog.h index 6850ed2194dc..51e510bb8733 100644 --- a/src/gui/qgsorderbydialog.h +++ b/src/gui/qgsorderbydialog.h @@ -40,8 +40,8 @@ class GUI_EXPORT QgsOrderByDialog : public QDialog, private Ui::OrderByDialogBas /** * Create a new order by dialog. This helps building order by structures. * - * @param layer The vector layer for which the order by should be produced - * @param parent The parent widget, optional + * \param layer The vector layer for which the order by should be produced + * \param parent The parent widget, optional */ QgsOrderByDialog( QgsVectorLayer *layer, QWidget *parent = nullptr ); diff --git a/src/gui/qgsowssourceselect.h b/src/gui/qgsowssourceselect.h index 8f5b2c40c917..0c2818e4dc1b 100644 --- a/src/gui/qgsowssourceselect.h +++ b/src/gui/qgsowssourceselect.h @@ -115,7 +115,7 @@ class GUI_EXPORT QgsOWSSourceSelect : public QDialog, public Ui::QgsOWSSourceSel /** * List of image formats (encodings) supported by provider - * @return list of format/label pairs + * \returns list of format/label pairs */ virtual QList providerFormats(); @@ -181,7 +181,7 @@ class GUI_EXPORT QgsOWSSourceSelect : public QDialog, public Ui::QgsOWSSourceSel virtual void populateLayerList(); //! create an item including possible parents - //! @note not available in Python bindings + //! \note not available in Python bindings QgsTreeWidgetItem *createItem( int id, const QStringList &names, QMap &items, diff --git a/src/gui/qgspanelwidget.h b/src/gui/qgspanelwidget.h index d7f5c408a917..f42a4ad6cbfd 100644 --- a/src/gui/qgspanelwidget.h +++ b/src/gui/qgspanelwidget.h @@ -21,7 +21,7 @@ #include "qgis_gui.h" /** \ingroup gui - * @brief Base class for any widget that can be shown as a inline panel + * \brief Base class for any widget that can be shown as a inline panel */ class GUI_EXPORT QgsPanelWidget : public QWidget { @@ -29,20 +29,20 @@ class GUI_EXPORT QgsPanelWidget : public QWidget public: /** - * @brief Base class for any widget that can be shown as a inline panel - * @param parent Parent widget. + * \brief Base class for any widget that can be shown as a inline panel + * \param parent Parent widget. */ QgsPanelWidget( QWidget *parent = 0 ); /** * Set the title of the panel when shown in the interface. - * @param panelTitle The panel title. + * \param panelTitle The panel title. */ void setPanelTitle( const QString &panelTitle ) { mPanelTitle = panelTitle; } /** * The title of the panel. - * @return The title pf the panel. + * \returns The title pf the panel. */ QString panelTitle() { return mPanelTitle; } @@ -51,7 +51,7 @@ class GUI_EXPORT QgsPanelWidget : public QWidget * main showPanel event to bubble up to the user. * * Use this method if you have children widgets that need to show a panel to the user. - * @param panels A list of panel widgets to connect. + * \param panels A list of panel widgets to connect. */ void connectChildPanels( const QList &panels ); @@ -60,20 +60,20 @@ class GUI_EXPORT QgsPanelWidget : public QWidget * main showPanel event to bubble up to the user. * * Use this method if you have children widgets that need to show a panel to the user. - * @param panel The panel to connect. + * \param panel The panel to connect. */ void connectChildPanel( QgsPanelWidget *panel ); /** * Set the widget in dock mode which tells the widget to emit panel * widgets and not open dialogs - * @param dockMode True to enable dock mode. + * \param dockMode True to enable dock mode. */ virtual void setDockMode( bool dockMode ); /** * Return the dock mode state. - * @return True if in dock mode. If in dock mode the widget + * \returns True if in dock mode. If in dock mode the widget * will emit the showPanel signal to handle panel opening * If false it will open dialogs when openPanel is called. */ @@ -83,7 +83,7 @@ class GUI_EXPORT QgsPanelWidget : public QWidget * The the auto delete property on the widget. True by default. * When auto delete is enabled when a panel is removed from the stack * it will be deleted. - * @param autoDelete Enable or disable auto delete on the panel. + * \param autoDelete Enable or disable auto delete on the panel. */ void setAutoDelete( bool autoDelete ) { mAutoDelete = autoDelete; } @@ -91,14 +91,14 @@ class GUI_EXPORT QgsPanelWidget : public QWidget * The the auto delete property on the widget. True by default. * When auto delete is enabled when a panel is removed from the stack * it will be deleted. - * @returns The auto delete value for the widget. + * \returns The auto delete value for the widget. */ bool autoDelete() { return mAutoDelete; } /** Traces through the parents of a widget to find if it is contained within a QgsPanelWidget * widget. - * @param widget widget which may be contained within a panel widget - * @returns parent panel widget if found, otherwise nullptr + * \param widget widget which may be contained within a panel widget + * \returns parent panel widget if found, otherwise nullptr * \since QGIS 3.0 */ static QgsPanelWidget *findParentPanel( QWidget *widget ); @@ -107,10 +107,10 @@ class GUI_EXPORT QgsPanelWidget : public QWidget /** * Emitted when the panel is accepted by the user. - * @param panel The panel widget that was accepted. - * @note This argument is normally raised with emit panelAccepted(this) + * \param panel The panel widget that was accepted. + * \note This argument is normally raised with emit panelAccepted(this) * so that callers can retrieve the widget easier in calling code. - * @note this is emitted only when this panel is accepted, and is not emitted for + * \note this is emitted only when this panel is accepted, and is not emitted for * child panels. For example, if this panel opens a second stacked panel, then this panel * will not emit panelAccepted when the second panel is accepted. */ @@ -118,8 +118,8 @@ class GUI_EXPORT QgsPanelWidget : public QWidget /** * Emit when you require a panel to be show in the interface. - * @param panel The panel widget to show. - * @note If you are connected to this signal you should also connect + * \param panel The panel widget to show. + * \note If you are connected to this signal you should also connect * given panels showPanel signal as they can be nested. */ void showPanel( QgsPanelWidget *panel ); @@ -142,7 +142,7 @@ class GUI_EXPORT QgsPanelWidget : public QWidget * If dock mode is false this method will open a dialog * and block the user. * - * @param panel The panel widget to open. + * \param panel The panel widget to open. */ void openPanel( QgsPanelWidget *panel ); @@ -155,8 +155,8 @@ class GUI_EXPORT QgsPanelWidget : public QWidget protected: /** - * @brief Overridden key press event to handle the esc event on the widget. - * @param event The key event + * \brief Overridden key press event to handle the esc event on the widget. + * \param event The key event */ void keyPressEvent( QKeyEvent *event ); @@ -169,10 +169,10 @@ class GUI_EXPORT QgsPanelWidget : public QWidget /** \ingroup gui - * @brief Wrapper widget for existing widgets which can't have + * \brief Wrapper widget for existing widgets which can't have * the inheritance tree changed, e.g dialogs. * - * @note Generally you should use the QgsPanelWidget class if you can + * \note Generally you should use the QgsPanelWidget class if you can * and only use this wrapper if you can't update your code. */ class GUI_EXPORT QgsPanelWidgetWrapper: public QgsPanelWidget @@ -181,16 +181,16 @@ class GUI_EXPORT QgsPanelWidgetWrapper: public QgsPanelWidget public: /** - * @brief Wrapper widget for existing widgets which can't have + * \brief Wrapper widget for existing widgets which can't have * the inheritance tree changed, e.g dialogs. - * @param widget The widget to wrap. - * @param parent The parent widget. + * \param widget The widget to wrap. + * \param parent The parent widget. */ QgsPanelWidgetWrapper( QWidget *widget, QWidget *parent = nullptr ); /** * Returns the internal widget that is wrapped in this panel. - * @return The internal widget. Can be nullptr. + * \returns The internal widget. Can be nullptr. */ QWidget *widget() { return mWidget; } diff --git a/src/gui/qgspanelwidgetstack.h b/src/gui/qgspanelwidgetstack.h index 7f0534a3f420..e0a98a46c06c 100644 --- a/src/gui/qgspanelwidgetstack.h +++ b/src/gui/qgspanelwidgetstack.h @@ -39,7 +39,7 @@ class GUI_EXPORT QgsPanelWidgetStack : public QWidget, private Ui::QgsRendererWi /** * A stack widget to manage panels in the interface. Handles the open and close events * for added panels. - * @param parent + * \param parent */ QgsPanelWidgetStack( QWidget *parent = nullptr ); @@ -47,30 +47,30 @@ class GUI_EXPORT QgsPanelWidgetStack : public QWidget, private Ui::QgsRendererWi * Adds the main panel widget to the stack and selects it for the user * The main widget can not be closed and only the showPanel signal is attached * to handle children widget opening panels. - * @param panel The panel to set as the first widget in the stack. - * @note a stack can have only one main panel. Any existing main panel + * \param panel The panel to set as the first widget in the stack. + * \note a stack can have only one main panel. Any existing main panel * should be removed by first calling takeMainPanel(). - * @see mainPanel() - * @see takeMainPanel() + * \see mainPanel() + * \see takeMainPanel() */ void setMainPanel( QgsPanelWidget *panel ); /** * The main panel widget that is set in the stack. The main widget can not be closed * and doesn't display a back button. - * @return The main QgsPanelWidget that is active in the stack. - * @see setMainPanel() + * \returns The main QgsPanelWidget that is active in the stack. + * \see setMainPanel() */ QgsPanelWidget *mainPanel(); /** * Removes the main panel widget from the stack and transfers ownsership to the * caller. - * @return The main widget that is set in the stack. - * @note Calling this will clear out any current stacked panels by accepting + * \returns The main widget that is set in the stack. + * \note Calling this will clear out any current stacked panels by accepting * each panel in turn. - * @see mainPanel() - * @see setMainPanel() + * \see mainPanel() + * \see setMainPanel() */ QgsPanelWidget *takeMainPanel(); @@ -92,14 +92,14 @@ class GUI_EXPORT QgsPanelWidgetStack : public QWidget, private Ui::QgsRendererWi * Accept the current active widget in the stack. * * Calls the panelAccepeted signal on the active widget. - * @see acceptAllPanels() + * \see acceptAllPanels() */ void acceptCurrentPanel(); /** * Accepts all panel widgets open in the stack in turn until until only the mainPanel() * remains. - * @see acceptCurrentPanel(); + * \see acceptCurrentPanel(); * \since QGIS 3.0 */ void acceptAllPanels(); @@ -107,14 +107,14 @@ class GUI_EXPORT QgsPanelWidgetStack : public QWidget, private Ui::QgsRendererWi /** * Show a panel in the stack widget. Will connect to the panels showPanel event to handle * nested panels. Auto switches the the given panel for the user. - * @param panel The panel to show. + * \param panel The panel to show. */ void showPanel( QgsPanelWidget *panel ); /** * Closes the panel in the widget. Will also delete the widget. * This slot is normally auto connected to panelAccepted when a panel is shown. - * @param panel The panel to close. + * \param panel The panel to close. */ void closePanel( QgsPanelWidget *panel ); diff --git a/src/gui/qgspasswordlineedit.h b/src/gui/qgspasswordlineedit.h index 865225177ed3..0c001763a938 100644 --- a/src/gui/qgspasswordlineedit.h +++ b/src/gui/qgspasswordlineedit.h @@ -37,13 +37,13 @@ class GUI_EXPORT QgsPasswordLineEdit : public QLineEdit public: /** Constructor for QgsPasswordLineEdit. - * @param parent parent widget - * @param passwordVisible Initial state of the password's visibility + * \param parent parent widget + * \param passwordVisible Initial state of the password's visibility */ QgsPasswordLineEdit( QWidget *parent = nullptr, bool passwordVisible = false ); /** Define if a lock icon shall be shown on the left of the widget - * @param visible set to false to hide the lock icon + * \param visible set to false to hide the lock icon */ void setShowLockIcon( bool visible ); diff --git a/src/gui/qgspixmaplabel.h b/src/gui/qgspixmaplabel.h index 26c05c8fdfa2..260866c79b40 100644 --- a/src/gui/qgspixmaplabel.h +++ b/src/gui/qgspixmaplabel.h @@ -20,7 +20,7 @@ #include "qgis_gui.h" /** \ingroup gui - * @brief The QgsPixmapLabel class shows a pixmap and adjusts its size to the space given + * \brief The QgsPixmapLabel class shows a pixmap and adjusts its size to the space given * to the widget by the layout and keeping its aspect ratio. */ class GUI_EXPORT QgsPixmapLabel : public QLabel @@ -33,15 +33,15 @@ class GUI_EXPORT QgsPixmapLabel : public QLabel /** * Calculates the height for the given width. * - * @param width The width for the widget - * @return An appropriate height + * \param width The width for the widget + * \returns An appropriate height */ virtual int heightForWidth( int width ) const override; /** * An optimal size for the widget. Effectively using the height * determined from the width with the given aspect ratio. - * @return A size hint + * \returns A size hint */ virtual QSize sizeHint() const override; diff --git a/src/gui/qgspresetcolorrampdialog.h b/src/gui/qgspresetcolorrampdialog.h index 3f812918f3d0..b6f7407b999e 100644 --- a/src/gui/qgspresetcolorrampdialog.h +++ b/src/gui/qgspresetcolorrampdialog.h @@ -35,19 +35,19 @@ class GUI_EXPORT QgsPresetColorRampWidget : public QgsPanelWidget, private Ui::Q public: /** Constructor for QgsPresetColorRampWidget. - * @param ramp initial ramp to show in dialog - * @param parent parent widget + * \param ramp initial ramp to show in dialog + * \param parent parent widget */ QgsPresetColorRampWidget( const QgsPresetSchemeColorRamp &ramp, QWidget *parent = nullptr ); /** Returns a color ramp representing the current settings from the dialog. - * @see setRamp() + * \see setRamp() */ QgsPresetSchemeColorRamp ramp() const; /** Sets the color ramp to show in the dialog. - * @param ramp color ramp - * @see ramp() + * \param ramp color ramp + * \see ramp() */ void setRamp( const QgsPresetSchemeColorRamp &ramp ); @@ -83,19 +83,19 @@ class GUI_EXPORT QgsPresetColorRampDialog : public QDialog public: /** Constructor for QgsPresetColorRampDialog. - * @param ramp initial ramp to show in dialog - * @param parent parent widget + * \param ramp initial ramp to show in dialog + * \param parent parent widget */ QgsPresetColorRampDialog( const QgsPresetSchemeColorRamp &ramp, QWidget *parent = nullptr ); /** Returns a color ramp representing the current settings from the dialog. - * @see setRamp() + * \see setRamp() */ QgsPresetSchemeColorRamp ramp() const { return mWidget->ramp(); } /** Sets the color ramp to show in the dialog. - * @param ramp color ramp - * @see ramp() + * \param ramp color ramp + * \see ramp() */ void setRamp( const QgsPresetSchemeColorRamp &ramp ) { mWidget->setRamp( ramp ); } diff --git a/src/gui/qgsprevieweffect.h b/src/gui/qgsprevieweffect.h index adfafb6ceb67..c3940f60a4f6 100644 --- a/src/gui/qgsprevieweffect.h +++ b/src/gui/qgsprevieweffect.h @@ -42,16 +42,16 @@ class GUI_EXPORT QgsPreviewEffect: public QGraphicsEffect QgsPreviewEffect( QObject *parent ); /** Sets the mode for the preview effect, which controls how the effect modifies a widgets appearance. - * @param mode PreviewMode to use to draw the widget + * \param mode PreviewMode to use to draw the widget * \since QGIS 2.3 - * @see mode + * \see mode */ void setMode( PreviewMode mode ); /** Returns the mode used for the preview effect. - * @returns PreviewMode currently used by the effect + * \returns PreviewMode currently used by the effect * \since QGIS 2.3 - * @see setMode + * \see setMode */ PreviewMode mode() const { return mMode; } diff --git a/src/gui/qgsprojectionselectiondialog.h b/src/gui/qgsprojectionselectiondialog.h index 405164b7a0d7..e8a76cfb5858 100644 --- a/src/gui/qgsprojectionselectiondialog.h +++ b/src/gui/qgsprojectionselectiondialog.h @@ -65,7 +65,7 @@ class GUI_EXPORT QgsProjectionSelectionDialog : public QDialog, private Ui::QgsG /** * Returns the CRS currently selected in the widget. * \since QGIS 3.0 - * @see setCrs() + * \see setCrs() */ QgsCoordinateReferenceSystem crs() const; @@ -79,7 +79,7 @@ class GUI_EXPORT QgsProjectionSelectionDialog : public QDialog, private Ui::QgsG /** * Sets whether a "no/invalid" projection option should be shown. If this * option is selected, calling crs() will return an invalid QgsCoordinateReferenceSystem. - * @see showNoProjection() + * \see showNoProjection() * \since QGIS 3.0 */ void setShowNoProjection( bool show ); @@ -88,7 +88,7 @@ class GUI_EXPORT QgsProjectionSelectionDialog : public QDialog, private Ui::QgsG * Returns whether the "no/invalid" projection option is shown. If this * option is selected, calling crs() will return an invalid QgsCoordinateReferenceSystem. * \since QGIS 3.0 - * @see setShowNoProjection() + * \see setShowNoProjection() */ bool showNoProjection() const; @@ -97,7 +97,7 @@ class GUI_EXPORT QgsProjectionSelectionDialog : public QDialog, private Ui::QgsG /** * Sets the initial \a crs to show within the dialog. * \since QGIS 3.0 - * @see crs() + * \see crs() */ void setCrs( const QgsCoordinateReferenceSystem &crs ); diff --git a/src/gui/qgsprojectionselectiontreewidget.cpp b/src/gui/qgsprojectionselectiontreewidget.cpp index 45ae76e9be3f..2b6c35ca0beb 100644 --- a/src/gui/qgsprojectionselectiontreewidget.cpp +++ b/src/gui/qgsprojectionselectiontreewidget.cpp @@ -993,15 +993,6 @@ QStringList QgsProjectionSelectionTreeWidget::authorities() return authorities; } -/** Linfinity qtcreator qgis -* \brief Make the string safe for use in SQL statements. -* This involves escaping single quotes, double quotes, backslashes, -* and optionally, percentage symbols. Percentage symbols are used -* as wildcards sometimes and so when using the string as part of the -* LIKE phrase of a select statement, should be escaped. -* \arg const QString in The input string to make safe. -* \return The string made safe for SQL statements. -*/ const QString QgsProjectionSelectionTreeWidget::sqlSafeString( const QString &theSQL ) { QString retval = theSQL; diff --git a/src/gui/qgsprojectionselectiontreewidget.h b/src/gui/qgsprojectionselectiontreewidget.h index 42891f19fd34..69de99f15589 100644 --- a/src/gui/qgsprojectionselectiontreewidget.h +++ b/src/gui/qgsprojectionselectiontreewidget.h @@ -52,14 +52,14 @@ class GUI_EXPORT QgsProjectionSelectionTreeWidget : public QWidget, private Ui:: /** * Returns the CRS currently selected in the widget. * \since QGIS 3.0 - * @see setCrs() + * \see setCrs() */ QgsCoordinateReferenceSystem crs() const; /** * Sets whether a "no/invalid" projection option should be shown. If this * option is selected, calling crs() will return an invalid QgsCoordinateReferenceSystem. - * @see showNoProjection() + * \see showNoProjection() * \since QGIS 3.0 */ void setShowNoProjection( bool show ); @@ -68,7 +68,7 @@ class GUI_EXPORT QgsProjectionSelectionTreeWidget : public QWidget, private Ui:: * Returns whether the "no/invalid" projection option is shown. If this * option is selected, calling crs() will return an invalid QgsCoordinateReferenceSystem. * \since QGIS 3.0 - * @see setShowNoProjection() + * \see setShowNoProjection() */ bool showNoProjection() const; @@ -85,7 +85,7 @@ class GUI_EXPORT QgsProjectionSelectionTreeWidget : public QWidget, private Ui:: /** * Sets the initial \a crs to show within the dialog. * \since QGIS 3.0 - * @see crs() + * \see crs() */ void setCrs( const QgsCoordinateReferenceSystem &crs ); @@ -154,14 +154,14 @@ class GUI_EXPORT QgsProjectionSelectionTreeWidget : public QWidget, private Ui:: */ void loadCrsList( QSet *crsFilter = nullptr ); - /*! + /** * \brief Make the string safe for use in SQL statements. * This involves escaping single quotes, double quotes, backslashes, * and optionally, percentage symbols. Percentage symbols are used * as wildcards sometimes and so when using the string as part of the * LIKE phrase of a select statement, should be escaped. * \arg const QString in The input string to make safe. - * \return The string made safe for SQL statements. + * \returns The string made safe for SQL statements. */ const QString sqlSafeString( const QString &theSQL ); diff --git a/src/gui/qgsprojectionselectionwidget.h b/src/gui/qgsprojectionselectionwidget.h index bc1e610f35c5..93fb1934bfdd 100644 --- a/src/gui/qgsprojectionselectionwidget.h +++ b/src/gui/qgsprojectionselectionwidget.h @@ -54,26 +54,26 @@ class GUI_EXPORT QgsProjectionSelectionWidget : public QWidget /** Returns a pointer to the projection selector dialog used by the widget. * Can be used to modify how the projection selector dialog behaves. - * @returns projection selector dialog + * \returns projection selector dialog */ QgsProjectionSelectionDialog *dialog() { return mDialog; } /** Returns the currently selected CRS for the widget - * @returns current CRS + * \returns current CRS */ QgsCoordinateReferenceSystem crs() const; /** Sets whether a predefined CRS option should be shown in the widget. - * @param option CRS option to show/hide - * @param visible whether the option should be shown - * @see optionVisible() + * \param option CRS option to show/hide + * \param visible whether the option should be shown + * \see optionVisible() */ void setOptionVisible( const CrsOption option, const bool visible ); /** * Returns whether the specified CRS option is visible in the widget. * \since QGIS 3.0 - * @see setOptionVisible() + * \see setOptionVisible() */ bool optionVisible( CrsOption option ) const; @@ -99,13 +99,13 @@ class GUI_EXPORT QgsProjectionSelectionWidget : public QWidget public slots: /** Sets the current CRS for the widget - * @param crs new CRS + * \param crs new CRS */ void setCrs( const QgsCoordinateReferenceSystem &crs ); /** Sets the layer CRS for the widget. If set, this will be added as an option * to the preset CRSes shown in the widget. - * @param crs layer CRS + * \param crs layer CRS */ void setLayerCrs( const QgsCoordinateReferenceSystem &crs ); diff --git a/src/gui/qgspropertyassistantwidget.h b/src/gui/qgspropertyassistantwidget.h index a437c90345a0..4ef87261ba5f 100644 --- a/src/gui/qgspropertyassistantwidget.h +++ b/src/gui/qgspropertyassistantwidget.h @@ -140,7 +140,7 @@ class GUI_EXPORT QgsPropertyAssistantWidget : public QgsPanelWidget, private Ui: /** * Sets a symbol which can be used for previews inside the widget. If not specified, default * created symbols will be used instead. - * @note not available in Python bindings + * \note not available in Python bindings */ void setSymbol( std::shared_ptr< QgsSymbol > symbol ) { mSymbol = symbol; updatePreview(); } diff --git a/src/gui/qgspropertyoverridebutton.h b/src/gui/qgspropertyoverridebutton.h index 24b96571fb56..b753f2f48932 100644 --- a/src/gui/qgspropertyoverridebutton.h +++ b/src/gui/qgspropertyoverridebutton.h @@ -54,18 +54,18 @@ class GUI_EXPORT QgsPropertyOverrideButton: public QToolButton /** * Constructor for QgsPropertyOverrideButton. - * @param parent parent widget - * @param layer associated vector layer + * \param parent parent widget + * \param layer associated vector layer */ QgsPropertyOverrideButton( QWidget *parent = nullptr, const QgsVectorLayer *layer = nullptr ); /** * Initialize a newly constructed property button (useful if button was included in a UI layout). - * @param propertyKey key for corresponding property - * @param property initial value of associated property to show in widget - * @param definitions properties definitions for corresponding collection - * @param layer associated vector layer + * \param propertyKey key for corresponding property + * \param property initial value of associated property to show in widget + * \param definitions properties definitions for corresponding collection + * \param layer associated vector layer */ void init( int propertyKey, const QgsProperty &property, @@ -74,10 +74,10 @@ class GUI_EXPORT QgsPropertyOverrideButton: public QToolButton /** * Initialize a newly constructed property button (useful if button was included in a UI layout). - * @param propertyKey key for corresponding property - * @param collection associated property collection - * @param definitions properties definitions for collection - * @param layer associated vector layer + * \param propertyKey key for corresponding property + * \param collection associated property collection + * \param definitions properties definitions for collection + * \param layer associated vector layer */ void init( int propertyKey, const QgsAbstractPropertyCollection &collection, @@ -87,7 +87,7 @@ class GUI_EXPORT QgsPropertyOverrideButton: public QToolButton /** * Returns a QgsProperty object encapsulating the current state of the * widget. - * @see setToProperty() + * \see setToProperty() */ QgsProperty toProperty() const; @@ -121,27 +121,27 @@ class GUI_EXPORT QgsPropertyOverrideButton: public QToolButton /** * Returns usage information for the property. - * @see setUsageInfo() + * \see setUsageInfo() */ QString usageInfo() const { return mUsageInfo; } /** * Set the usage information for the property. - * @see usageInfo() + * \see usageInfo() */ void setUsageInfo( const QString &info ) { mUsageInfo = info; updateGui(); } /** * Sets the vector layer associated with the button. This controls which fields are * displayed within the widget's pop up menu. - * @see vectorLayer() + * \see vectorLayer() */ void setVectorLayer( const QgsVectorLayer *layer ); /** * Returns the vector layer associated with the button. This controls which fields are * displayed within the widget's pop up menu. - * @see setVectorLayer() + * \see setVectorLayer() */ const QgsVectorLayer *vectorLayer() const { return mVectorLayer; } @@ -159,7 +159,7 @@ class GUI_EXPORT QgsPropertyOverrideButton: public QToolButton /** * Sets a symbol which can be used for previews inside the widget or in any dialog created * by the widget. If not specified, a default created symbol will be used instead. - * @note not available in Python bindings + * \note not available in Python bindings */ void setSymbol( std::shared_ptr< QgsSymbol > symbol ) { mSymbol = symbol; } diff --git a/src/gui/qgsquerybuilder.h b/src/gui/qgsquerybuilder.h index 92f2d7f12621..3e03290eadd9 100644 --- a/src/gui/qgsquerybuilder.h +++ b/src/gui/qgsquerybuilder.h @@ -44,9 +44,9 @@ class GUI_EXPORT QgsQueryBuilder : public QDialog, private Ui::QgsQueryBuilderBa /** This constructor is used when the query builder is called from the * vector layer properties dialog - * @param layer existing vector layer - * @param parent Parent widget - * @param fl dialog flags + * \param layer existing vector layer + * \param parent Parent widget + * \param fl dialog flags */ QgsQueryBuilder( QgsVectorLayer *layer, QWidget *parent = nullptr, Qt::WindowFlags fl = QgisGui::ModalDialogFlags ); @@ -87,12 +87,14 @@ class GUI_EXPORT QgsQueryBuilder : public QDialog, private Ui::QgsQueryBuilderBa * statement. */ void test(); - /*! + + /** * Get all distinct values for the field. Values are inserted * into the value list box */ void on_btnGetAllValues_clicked(); - /*! + + /** * Get sample distinct values for the selected field. The sample size is * limited to an arbitrary value (currently set to 25). The values * are inserted into the values list box. @@ -102,12 +104,13 @@ class GUI_EXPORT QgsQueryBuilder : public QDialog, private Ui::QgsQueryBuilderBa void setDatasourceDescription( const QString &uri ); private: - /*! + + /** * Populate the field list for the selected table */ void populateFields(); - /*! + /** * Setup models for listviews */ void setupGuiViews(); diff --git a/src/gui/qgsrasterformatsaveoptionswidget.h b/src/gui/qgsrasterformatsaveoptionswidget.h index 2b13c334c384..d3947121fc2a 100644 --- a/src/gui/qgsrasterformatsaveoptionswidget.h +++ b/src/gui/qgsrasterformatsaveoptionswidget.h @@ -71,14 +71,14 @@ class GUI_EXPORT QgsRasterFormatSaveOptionsWidget: public QWidget, /** * Returns list of selected options - * @see setOptions() + * \see setOptions() */ QStringList options() const; /** * Populate widget with user-defined options. String should contain * key=value pairs separated by spaces, e.g. "TILED=YES TFW=YES" - * @see options() + * \see options() * \since QGIS 3.0 */ void setOptions( const QString &options ); diff --git a/src/gui/qgsrelationeditorwidget.h b/src/gui/qgsrelationeditorwidget.h index b920ac815ba1..855439f0d954 100644 --- a/src/gui/qgsrelationeditorwidget.h +++ b/src/gui/qgsrelationeditorwidget.h @@ -44,7 +44,7 @@ class GUI_EXPORT QgsRelationEditorWidget : public QgsCollapsibleGroupBox public: /** - * @param parent parent widget + * \param parent parent widget */ QgsRelationEditorWidget( QWidget *parent = nullptr ); @@ -62,8 +62,8 @@ class GUI_EXPORT QgsRelationEditorWidget : public QgsCollapsibleGroupBox * If both relations are set, it will act as an N:M relation widget * inserting and deleting entries on the intermediate table as required. * - * @param relation Relation referencing the edited table - * @param nmrelation Optional reference from the referencing table to a 3rd N:M table + * \param relation Relation referencing the edited table + * \param nmrelation Optional reference from the referencing table to a 3rd N:M table */ void setRelations( const QgsRelation &relation, const QgsRelation &nmrelation ); diff --git a/src/gui/qgsrubberband.cpp b/src/gui/qgsrubberband.cpp index c4ebc476c4d7..999c85579679 100644 --- a/src/gui/qgsrubberband.cpp +++ b/src/gui/qgsrubberband.cpp @@ -21,11 +21,6 @@ #include "qgsvectorlayer.h" #include -/*! - \class QgsRubberBand - \brief The QgsRubberBand class provides a transparent overlay widget - for tracking the mouse while drawing polylines or polygons. -*/ QgsRubberBand::QgsRubberBand( QgsMapCanvas *mapCanvas, QgsWkbTypes::GeometryType geometryType ) : QgsMapCanvasItem( mapCanvas ) , mIconSize( 5 ) @@ -54,26 +49,17 @@ QgsRubberBand::QgsRubberBand() { } -/*! - Set the stroke and fill color. - */ void QgsRubberBand::setColor( const QColor &color ) { setStrokeColor( color ); setFillColor( color ); } -/*! - Set the fill color. - */ void QgsRubberBand::setFillColor( const QColor &color ) { mBrush.setColor( color ); } -/*! - Set the stroke - */ void QgsRubberBand::setStrokeColor( const QColor &color ) { mPen.setColor( color ); @@ -84,9 +70,6 @@ void QgsRubberBand::setSecondaryStrokeColor( const QColor &color ) mSecondaryPen.setColor( color ); } -/*! - Set the stroke width. - */ void QgsRubberBand::setWidth( int width ) { mPen.setWidth( width ); @@ -112,9 +95,6 @@ void QgsRubberBand::setBrushStyle( Qt::BrushStyle brushStyle ) mBrush.setStyle( brushStyle ); } -/*! - Remove all points from the shape being created. - */ void QgsRubberBand::reset( QgsWkbTypes::GeometryType geometryType ) { mPoints.clear(); @@ -123,9 +103,6 @@ void QgsRubberBand::reset( QgsWkbTypes::GeometryType geometryType ) update(); } -/*! - Add a point to the shape being created. - */ void QgsRubberBand::addPoint( const QgsPoint &p, bool doUpdate /* = true */, int geometryIndex ) { if ( geometryIndex < 0 ) @@ -214,9 +191,6 @@ void QgsRubberBand::removeLastPoint( int geometryIndex, bool doUpdate/* = true*/ removePoint( -1, doUpdate, geometryIndex ); } -/*! - Update the line between the last added point and the mouse position. - */ void QgsRubberBand::movePoint( const QgsPoint &p, int geometryIndex ) { if ( mPoints.size() < geometryIndex + 1 ) @@ -438,9 +412,6 @@ void QgsRubberBand::setToCanvasRectangle( QRect rect ) addPoint( ul, true ); } -/*! - Paint the rubber band in response to an update event. - */ void QgsRubberBand::paint( QPainter *p ) { if ( !mPoints.isEmpty() ) diff --git a/src/gui/qgsrubberband.h b/src/gui/qgsrubberband.h index fdd51ccca43c..886666e7fc5e 100644 --- a/src/gui/qgsrubberband.h +++ b/src/gui/qgsrubberband.h @@ -28,7 +28,9 @@ class QPaintEvent; /** \ingroup gui * A class for drawing transient features (e.g. digitizing lines) on the map. - * It may be used + * + * The QgsRubberBand class provides a transparent overlay widget + for tracking the mouse while drawing polylines or polygons. */ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem { @@ -71,20 +73,20 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem /** * Creates a new RubberBand. - * @param mapCanvas The map canvas to draw onto. It's CRS will be used map points onto screen coordinates. - * @param geometryType Defines how the data should be drawn onto the screen. (Use Qgis::Line, Qgis::Polygon or Qgis::Point) + * \param mapCanvas The map canvas to draw onto. It's CRS will be used map points onto screen coordinates. + * \param geometryType Defines how the data should be drawn onto the screen. (Use Qgis::Line, Qgis::Polygon or Qgis::Point) */ QgsRubberBand( QgsMapCanvas *mapCanvas, QgsWkbTypes::GeometryType geometryType = QgsWkbTypes::LineGeometry ); /** * Sets the color for the rubberband - * @param color The color used to render this rubberband + * \param color The color used to render this rubberband */ void setColor( const QColor &color ); /** * Sets the fill color for the rubberband - * @param color The color used to render this rubberband + * \param color The color used to render this rubberband * \since QGIS 2.6 */ void setFillColor( const QColor &color ); @@ -96,7 +98,7 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem /** * Sets the stroke color for the rubberband - * @param color The color used to render this rubberband + * \param color The color used to render this rubberband * \since QGIS 2.6 */ void setStrokeColor( const QColor &color ); @@ -109,7 +111,7 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem /** * Sets a secondary stroke color for the rubberband which will be drawn under the main stroke color. * Set to an invalid color to avoid drawing the secondary stroke. - * @param color The color used to render a secondary stroke color to this rubberband + * \param color The color used to render a secondary stroke color to this rubberband * \since QGIS 3.0 */ void setSecondaryStrokeColor( const QColor &color ); @@ -121,7 +123,7 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem /** * Sets the width of the line. Stroke width for polygon. - * @param width The width for any lines painted for this rubberband + * \param width The width for any lines painted for this rubberband */ void setWidth( int width ); @@ -132,7 +134,7 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem /** * Sets the icon type to highlight point geometries. - * @param icon The icon to visualize point geometries + * \param icon The icon to visualize point geometries */ void setIcon( IconType icon ); @@ -165,7 +167,7 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem /** * Clears all the geometries in this rubberband. * Sets the representation type according to geometryType. - * @param geometryType Defines how the data should be drawn onto the screen. (Use Qgis::Line, Qgis::Polygon or Qgis::Point) + * \param geometryType Defines how the data should be drawn onto the screen. (Use Qgis::Line, Qgis::Polygon or Qgis::Point) */ void reset( QgsWkbTypes::GeometryType geometryType = QgsWkbTypes::LineGeometry ); @@ -173,25 +175,25 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem * Adds a vertex to the rubberband and update canvas. * The rendering of the vertex depends on the current GeometryType and icon. * If adding more points consider using update=false for better performance - * @param p The vertex/point to add - * @param doUpdate Should the map canvas be updated immediately? - * @param geometryIndex The index of the feature part (in case of multipart geometries) + * \param p The vertex/point to add + * \param doUpdate Should the map canvas be updated immediately? + * \param geometryIndex The index of the feature part (in case of multipart geometries) */ void addPoint( const QgsPoint &p, bool doUpdate = true, int geometryIndex = 0 ); /** Ensures that a polygon geometry is closed and that the last vertex equals the * first vertex. - * @param doUpdate set to true to update the map canvas immediately - * @param geometryIndex index of the feature part (in case of multipart geometries) + * \param doUpdate set to true to update the map canvas immediately + * \param geometryIndex index of the feature part (in case of multipart geometries) * \since QGIS 2.16 */ void closePoints( bool doUpdate = true, int geometryIndex = 0 ); /** * Removes a vertex from the rubberband and (optionally) updates canvas. - * @param index The index of the vertex/point to remove, negative indexes start at end - * @param doUpdate Should the map canvas be updated immediately? - * @param geometryIndex The index of the feature part (in case of multipart geometries) + * \param index The index of the vertex/point to remove, negative indexes start at end + * \param doUpdate Should the map canvas be updated immediately? + * \param geometryIndex The index of the feature part (in case of multipart geometries) */ void removePoint( int index = 0, bool doUpdate = true, int geometryIndex = 0 ); @@ -214,24 +216,24 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem /** * Returns number of vertices in feature part - * @param geometryIndex The index of the feature part (in case of multipart geometries) - * @return number of vertices + * \param geometryIndex The index of the feature part (in case of multipart geometries) + * \returns number of vertices */ int partSize( int geometryIndex ) const; /** * Sets this rubber band to the geometry of an existing feature. * This is useful for feature highlighting. - * In contrast to {@link addGeometry}, this method does also change the geometry type of the rubberband. - * @param geom the geometry object - * @param layer the layer containing the feature, used for coord transformation to map + * In contrast to addGeometry(), this method does also change the geometry type of the rubberband. + * \param geom the geometry object + * \param layer the layer containing the feature, used for coord transformation to map * crs. In case of 0 pointer, the coordinates are not going to be transformed. */ void setToGeometry( const QgsGeometry &geom, QgsVectorLayer *layer ); /** * Sets this rubber band to a map canvas rectangle - * @param rect rectangle in canvas coordinates + * \param rect rectangle in canvas coordinates */ void setToCanvasRectangle( QRect rect ); @@ -239,44 +241,44 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem * Adds the geometry of an existing feature to a rubberband * This is useful for multi feature highlighting. * As of 2.0, this method does not change the GeometryType any more. You need to set the GeometryType - * of the rubberband explicitly by calling {@link reset} or {@link setToGeometry} with appropriate arguments. - * {@link setToGeometry} is also to be preferred for backwards-compatibility. + * of the rubberband explicitly by calling reset() or setToGeometry() with appropriate arguments. + * setToGeometry() is also to be preferred for backwards-compatibility. * - * @param geom the geometry object. Will be treated as a collection of vertices. - * @param layer the layer containing the feature, used for coord transformation to map + * \param geom the geometry object. Will be treated as a collection of vertices. + * \param layer the layer containing the feature, used for coord transformation to map * crs. In case of 0 pointer, the coordinates are not going to be transformed. */ void addGeometry( const QgsGeometry &geom, QgsVectorLayer *layer ); /** * Adds translation to original coordinates (all in map coordinates) - * @param dx x translation - * @param dy y translation + * \param dx x translation + * \param dy y translation */ void setTranslationOffset( double dx, double dy ); /** * Returns number of geometries - * @return number of geometries + * \returns number of geometries */ int size() const; /** * Returns count of vertices in all lists of mPoint - * @return The total number of vertices + * \returns The total number of vertices */ int numberOfVertices() const; /** * Returns a vertex - * @param i The geometry index - * @param j The vertex index within geometry i + * \param i The geometry index + * \param j The vertex index within geometry i */ const QgsPoint *getPoint( int i, int j = 0 ) const; /** * Returns the rubberband as a Geometry - * @return A geometry object which reflects the current state of the rubberband. + * \returns A geometry object which reflects the current state of the rubberband. */ QgsGeometry asGeometry() const; @@ -286,14 +288,14 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem /** * Paints the rubber band in response to an update event. - * @param p The QPainter object + * \param p The QPainter object */ virtual void paint( QPainter *p ) override; /** * Draws shape of the rubber band. - * @param p The QPainter object - * @param pts A list of points used to draw the shape + * \param p The QPainter object + * \param pts A list of points used to draw the shape */ void drawShape( QPainter *p, QVector &pts ); diff --git a/src/gui/qgsscalecombobox.cpp b/src/gui/qgsscalecombobox.cpp index b6ae1ca15bdd..d290cb445404 100644 --- a/src/gui/qgsscalecombobox.cpp +++ b/src/gui/qgsscalecombobox.cpp @@ -114,13 +114,11 @@ void QgsScaleComboBox::showPopup() view()->setMinimumWidth( view()->sizeHintForColumn( 0 ) ); } -//! Function to read the selected scale as text QString QgsScaleComboBox::scaleString() { return toString( mScale ); } -//! Function to set the selected scale from text bool QgsScaleComboBox::setScaleString( const QString &scaleTxt ) { bool ok; @@ -147,19 +145,16 @@ bool QgsScaleComboBox::setScaleString( const QString &scaleTxt ) } } -//! Function to read the selected scale as double double QgsScaleComboBox::scale() const { return mScale; } -//! Function to set the selected scale from double void QgsScaleComboBox::setScale( double scale ) { setScaleString( toString( scale ) ); } -//! Slot called when QComboBox has changed void QgsScaleComboBox::fixupScale() { QStringList txtList = currentText().split( ':' ); diff --git a/src/gui/qgsscalerangewidget.h b/src/gui/qgsscalerangewidget.h index b489aa445243..9b278bc4b41a 100644 --- a/src/gui/qgsscalerangewidget.h +++ b/src/gui/qgsscalerangewidget.h @@ -36,7 +36,7 @@ class GUI_EXPORT QgsScaleRangeWidget : public QWidget //! set the map canvas which will be used for the current scale buttons /** - * @brief setMapCanvas set the map canvas which will be used for the current scale buttons + * \brief setMapCanvas set the map canvas which will be used for the current scale buttons * if not set, the buttons are hidden. */ void setMapCanvas( QgsMapCanvas *mapCanvas ); @@ -79,8 +79,8 @@ class GUI_EXPORT QgsScaleRangeWidget : public QWidget signals: /** Emitted when the scale range set in the widget is changed. - * @param min minimum scale - * @param max maximum scale + * \param min minimum scale + * \param max maximum scale * \since QGIS 2.16 */ void rangeChanged( double min, double max ); diff --git a/src/gui/qgsscalewidget.h b/src/gui/qgsscalewidget.h index 739e2462301e..f244e5bfadb3 100644 --- a/src/gui/qgsscalewidget.h +++ b/src/gui/qgsscalewidget.h @@ -40,7 +40,7 @@ class GUI_EXPORT QgsScaleWidget : public QWidget explicit QgsScaleWidget( QWidget *parent = nullptr ); //! shows a button to set the scale to the current scale of the map canvas next to the combobox - //! @note the map canvas must be defined to show the button + //! \note the map canvas must be defined to show the button void setShowCurrentScaleButton( bool showCurrentScaleButton ); bool showCurrentScaleButton() { return mShowCurrentScaleButton;} diff --git a/src/gui/qgssearchquerybuilder.cpp b/src/gui/qgssearchquerybuilder.cpp index dc6c199dd6ef..c6a046e4a7fa 100644 --- a/src/gui/qgssearchquerybuilder.cpp +++ b/src/gui/qgssearchquerybuilder.cpp @@ -126,7 +126,7 @@ void QgsSearchQueryBuilder::getFieldValues( int limit ) mModelValues->blockSignals( true ); lstValues->setUpdatesEnabled( false ); - //! MH: keep already inserted values in a set. Querying is much faster compared to QStandardItemModel::findItems + // MH: keep already inserted values in a set. Querying is much faster compared to QStandardItemModel::findItems QSet insertedValues; while ( fit.nextFeature( feat ) && diff --git a/src/gui/qgssearchquerybuilder.h b/src/gui/qgssearchquerybuilder.h index 233c040099cf..8304837ac2fe 100644 --- a/src/gui/qgssearchquerybuilder.h +++ b/src/gui/qgssearchquerybuilder.h @@ -74,13 +74,13 @@ class GUI_EXPORT QgsSearchQueryBuilder : public QDialog, private Ui::QgsQueryBui */ void on_btnTest_clicked(); - /*! + /** * Get all distinct values for the field. Values are inserted * into the value list box */ void on_btnGetAllValues_clicked(); - /*! + /** * Get sample distinct values for the selected field. The sample size is * limited to an arbitrary value (currently set to 25). The values * are inserted into the values list box. @@ -94,23 +94,24 @@ class GUI_EXPORT QgsSearchQueryBuilder : public QDialog, private Ui::QgsQueryBui private: - /*! + /** * Populate the field list for the selected table */ void populateFields(); - /*! + + /** * Setup models for listviews */ void setupListViews(); /** Get the number of records that would be returned by the current SQL - * @return Number of records or -1 if an error was encountered + * \returns Number of records or -1 if an error was encountered */ long countRecords( const QString &sql ); - /*! + /** * populates list box with values of selected field - * @param limit if not zero, inserts only this count of values + * \param limit if not zero, inserts only this count of values */ void getFieldValues( int limit ); diff --git a/src/gui/qgsshortcutsmanager.h b/src/gui/qgsshortcutsmanager.h index c2fd788e8be8..f5a710a1d1de 100644 --- a/src/gui/qgsshortcutsmanager.h +++ b/src/gui/qgsshortcutsmanager.h @@ -39,8 +39,8 @@ class GUI_EXPORT QgsShortcutsManager : public QObject static QgsShortcutsManager *instance(); /** Constructor for QgsShortcutsManager. - * @param parent parent object - * @param settingsRoot root QgsSettings path for storing settings, e.g., "/myplugin/shortcuts". Leave + * \param parent parent object + * \param settingsRoot root QgsSettings path for storing settings, e.g., "/myplugin/shortcuts". Leave * as the default value to store settings alongside built in QGIS shortcuts, but care must be * taken to not register actions which conflict with the built in QGIS actions. */ @@ -48,169 +48,169 @@ class GUI_EXPORT QgsShortcutsManager : public QObject /** Automatically registers all QActions and QShortcuts which are children of the * passed object. - * @param object parent object containing actions and shortcuts to register - * @param recursive set to true to recursively add child actions and shortcuts - * @see registerAllChildActions() - * @see registerAllChildShortcuts() + * \param object parent object containing actions and shortcuts to register + * \param recursive set to true to recursively add child actions and shortcuts + * \see registerAllChildActions() + * \see registerAllChildShortcuts() */ void registerAllChildren( QObject *object, bool recursive = false ); /** Automatically registers all QActions which are children of the passed object. - * @param object parent object containing actions to register - * @param recursive set to true to recursively add child actions - * @see registerAction() - * @see registerAllChildren() - * @see registerAllChildShortcuts() + * \param object parent object containing actions to register + * \param recursive set to true to recursively add child actions + * \see registerAction() + * \see registerAllChildren() + * \see registerAllChildShortcuts() */ void registerAllChildActions( QObject *object, bool recursive = false ); /** Automatically registers all QShortcuts which are children of the passed object. - * @param object parent object containing shortcuts to register - * @param recursive set to true to recursively add child shortcuts - * @see registerShortcut() - * @see registerAllChildren() - * @see registerAllChildActions() + * \param object parent object containing shortcuts to register + * \param recursive set to true to recursively add child shortcuts + * \see registerShortcut() + * \see registerAllChildren() + * \see registerAllChildActions() */ void registerAllChildShortcuts( QObject *object, bool recursive = false ); /** Registers an action with the manager so the shortcut can be configured in GUI. - * @param action action to register. The action must have a unique text string for + * \param action action to register. The action must have a unique text string for * identification. - * @param defaultShortcut default key sequence for action - * @returns true if action was successfully registered - * @see registerShortcut() - * @see unregisterAction() - * @see registerAllChildActions() + * \param defaultShortcut default key sequence for action + * \returns true if action was successfully registered + * \see registerShortcut() + * \see unregisterAction() + * \see registerAllChildActions() */ bool registerAction( QAction *action, const QString &defaultShortcut = QString() ); /** Registers a QShortcut with the manager so the shortcut can be configured in GUI. - * @param shortcut QShortcut to register. The shortcut must have a unique QObject::objectName() for + * \param shortcut QShortcut to register. The shortcut must have a unique QObject::objectName() for * identification. - * @param defaultSequence default key sequence for shortcut - * @returns true if shortcut was successfully registered - * @see registerAction() - * @see registerAllChildShortcuts() + * \param defaultSequence default key sequence for shortcut + * \returns true if shortcut was successfully registered + * \see registerAction() + * \see registerAllChildShortcuts() */ bool registerShortcut( QShortcut *shortcut, const QString &defaultSequence = QString() ); /** Removes an action from the manager. - * @param action action to remove - * @returns true if action was previously registered in manager and has been removed, or + * \param action action to remove + * \returns true if action was previously registered in manager and has been removed, or * false if action was not previously registered in manager - * @see registerAction() - * @see unregisterShortcut() + * \see registerAction() + * \see unregisterShortcut() */ bool unregisterAction( QAction *action ); /** Removes a shortcut from the manager. - * @param shortcut shortcut to remove - * @returns true if shortcut was previously registered in manager and has been removed, or + * \param shortcut shortcut to remove + * \returns true if shortcut was previously registered in manager and has been removed, or * false if shortcut was not previously registered in manager - * @see registerShortcut() - * @see unregisterAction() + * \see registerShortcut() + * \see unregisterAction() */ bool unregisterShortcut( QShortcut *shortcut ); /** Returns a list of all actions in the manager. - * @see listShortcuts() - * @see listAll() + * \see listShortcuts() + * \see listAll() */ QList listActions() const; /** Returns a list of shortcuts in the manager. - * @see listActions() - * @see listAll() + * \see listActions() + * \see listAll() */ QList listShortcuts() const; /** Returns a list of both actions and shortcuts in the manager. - * @see listAction() - * @see listShortcuts() + * \see listAction() + * \see listShortcuts() */ QList listAll() const; /** Returns the default sequence for an object (either a QAction or QShortcut). * An empty return string indicates no shortcut. - * @param object QAction or QShortcut to return default key sequence for - * @see defaultKeySequence() + * \param object QAction or QShortcut to return default key sequence for + * \see defaultKeySequence() */ QString objectDefaultKeySequence( QObject *object ) const; /** Returns the default sequence for an action. An empty return string indicates * no default sequence. - * @param action action to return default key sequence for - * @see objectDefaultKeySequence() + * \param action action to return default key sequence for + * \see objectDefaultKeySequence() */ QString defaultKeySequence( QAction *action ) const; /** Returns the default sequence for a shortcut. An empty return string indicates * no default sequence. - * @param shortcut shortcut to return default key sequence for - * @see objectDefaultKeySequence() + * \param shortcut shortcut to return default key sequence for + * \see objectDefaultKeySequence() */ QString defaultKeySequence( QShortcut *shortcut ) const; /** Modifies an action or shortcut's key sequence. - * @param name name of action or shortcut to modify. Must match the action's QAction::text() or the + * \param name name of action or shortcut to modify. Must match the action's QAction::text() or the * shortcut's QObject::objectName() - * @param sequence new shortcut key sequence - * @see setObjectKeySequence() + * \param sequence new shortcut key sequence + * \see setObjectKeySequence() */ bool setKeySequence( const QString &name, const QString &sequence ); /** Modifies an object's (either a QAction or a QShortcut) key sequence. - * @param object QAction or QShortcut to modify - * @param sequence new shortcut key sequence - * @see setKeySequence() + * \param object QAction or QShortcut to modify + * \param sequence new shortcut key sequence + * \see setKeySequence() */ bool setObjectKeySequence( QObject *object, const QString &sequence ); /** Modifies an action's key sequence. - * @param action action to modify - * @param sequence new shortcut key sequence - * @see setObjectKeySequence() + * \param action action to modify + * \param sequence new shortcut key sequence + * \see setObjectKeySequence() */ bool setKeySequence( QAction *action, const QString &sequence ); /** Modifies a shortcuts's key sequence. - * @param shortcut QShortcut to modify - * @param sequence new shortcut key sequence - * @see setObjectKeySequence() + * \param shortcut QShortcut to modify + * \param sequence new shortcut key sequence + * \see setObjectKeySequence() */ bool setKeySequence( QShortcut *shortcut, const QString &sequence ); /** Returns the object (QAction or QShortcut) matching the specified key sequence, - * @param sequence key sequence to find - * @returns object with matching sequence, or nullptr if not found - * @see actionForSequence() - * @see shortcutForSequence() + * \param sequence key sequence to find + * \returns object with matching sequence, or nullptr if not found + * \see actionForSequence() + * \see shortcutForSequence() */ QObject *objectForSequence( const QKeySequence &sequence ) const; /** Returns the action which is associated for a shortcut sequence, or nullptr if no action is associated. - * @param sequence shortcut key sequence - * @see objectForSequence() - * @see shortcutForSequence() + * \param sequence shortcut key sequence + * \see objectForSequence() + * \see shortcutForSequence() */ QAction *actionForSequence( const QKeySequence &sequence ) const; /** Returns the shortcut which is associated for a key sequence, or nullptr if no shortcut is associated. - * @param sequence shortcut key sequence - * @see objectForSequence() - * @see actionForSequence() + * \param sequence shortcut key sequence + * \see objectForSequence() + * \see actionForSequence() */ QShortcut *shortcutForSequence( const QKeySequence &sequence ) const; /** Returns an action by its name, or nullptr if nothing found. - * @param name action name. Must match QAction's text. - * @see shortcutByName() + * \param name action name. Must match QAction's text. + * \see shortcutByName() */ QAction *actionByName( const QString &name ) const; /** Returns a shortcut by its name, or nullptr if nothing found - * @param name shortcut name. Must match QShortcut's QObject::objectName() property. - * @see actionByName() + * \param name shortcut name. Must match QShortcut's QObject::objectName() property. + * \see actionByName() */ QShortcut *shortcutByName( const QString &name ) const; @@ -235,8 +235,8 @@ class GUI_EXPORT QgsShortcutsManager : public QObject /** * Updates the action to include the shortcut keys. Shortcut keys are * included between () at the end of the action tooltop. - * @param action The action to append the shortcut. - * @param sequence The shortcut sequence. + * \param action The action to append the shortcut. + * \param sequence The shortcut sequence. */ void updateActionToolTip( QAction *action, const QString &sequence ); }; diff --git a/src/gui/qgssourceselectdialog.h b/src/gui/qgssourceselectdialog.h index b85323893c4d..4ec80f05fd59 100644 --- a/src/gui/qgssourceselectdialog.h +++ b/src/gui/qgssourceselectdialog.h @@ -87,7 +87,7 @@ class GUI_EXPORT QgsSourceSelectDialog : public QDialog, protected Ui::QgsSource 1. project CRS if contained in the set 2. WGS84 if contained in the set 3. the first entry in the set else - @return the authority id of the crs or an empty string in case of error*/ + \returns the authority id of the crs or an empty string in case of error*/ QString getPreferredCrs( const QSet &crsSet ) const; private slots: diff --git a/src/gui/qgssqlcomposerdialog.h b/src/gui/qgssqlcomposerdialog.h index f379a0a45230..6405ba6ea306 100644 --- a/src/gui/qgssqlcomposerdialog.h +++ b/src/gui/qgssqlcomposerdialog.h @@ -31,7 +31,7 @@ email : even.rouault at spatialys.com /** \ingroup gui * SQL composer dialog - * @note not available in Python bindings + * \note not available in Python bindings */ class GUI_EXPORT QgsSQLComposerDialog : public QDialog, private Ui::QgsSQLComposerDialogBase { @@ -47,7 +47,7 @@ class GUI_EXPORT QgsSQLComposerDialog : public QDialog, private Ui::QgsSQLCompos /** \ingroup gui * Callback to do actions on table selection - * @note not available in Python bindings + * \note not available in Python bindings */ class GUI_EXPORT TableSelectedCallback { @@ -59,7 +59,7 @@ class GUI_EXPORT QgsSQLComposerDialog : public QDialog, private Ui::QgsSQLCompos /** \ingroup gui * Callback to do validation check on dialog validation. - * @note not available in Python bindings + * \note not available in Python bindings */ class GUI_EXPORT SQLValidatorCallback { diff --git a/src/gui/qgssubstitutionlistwidget.h b/src/gui/qgssubstitutionlistwidget.h index acb6220155d7..bdbffacf2b89 100644 --- a/src/gui/qgssubstitutionlistwidget.h +++ b/src/gui/qgssubstitutionlistwidget.h @@ -39,18 +39,18 @@ class GUI_EXPORT QgsSubstitutionListWidget : public QgsPanelWidget, private Ui:: public: /** Constructor for QgsSubstitutionListWidget. - * @param parent parent widget + * \param parent parent widget */ QgsSubstitutionListWidget( QWidget *parent = nullptr ); /** Sets the list of substitutions to show in the widget. - * @param substitutions substitution list - * @see substitutions() + * \param substitutions substitution list + * \see substitutions() */ void setSubstitutions( const QgsStringReplacementCollection &substitutions ); /** Returns the list of substitutions currently defined by the widget. - * @see setSubstitutions() + * \see setSubstitutions() */ QgsStringReplacementCollection substitutions() const; @@ -88,18 +88,18 @@ class GUI_EXPORT QgsSubstitutionListDialog : public QDialog public: /** Constructor for QgsSubstitutionListDialog. - * @param parent parent widget + * \param parent parent widget */ QgsSubstitutionListDialog( QWidget *parent = nullptr ); /** Sets the list of substitutions to show in the dialog. - * @param substitutions substitution list - * @see substitutions() + * \param substitutions substitution list + * \see substitutions() */ void setSubstitutions( const QgsStringReplacementCollection &substitutions ); /** Returns the list of substitutions currently defined by the dialog. - * @see setSubstitutions() + * \see setSubstitutions() */ QgsStringReplacementCollection substitutions() const; diff --git a/src/gui/qgstaskmanagerwidget.h b/src/gui/qgstaskmanagerwidget.h index 054a2c64fb33..a6cae9659af4 100644 --- a/src/gui/qgstaskmanagerwidget.h +++ b/src/gui/qgstaskmanagerwidget.h @@ -33,7 +33,7 @@ class QgsTaskManagerModel; * \ingroup gui * \class QgsTaskManagerWidget * A widget which displays tasks from a QgsTaskManager and allows for interaction with the manager. - * @see QgsTaskManager + * \see QgsTaskManager * \since QGIS 3.0 */ class GUI_EXPORT QgsTaskManagerWidget : public QWidget @@ -43,8 +43,8 @@ class GUI_EXPORT QgsTaskManagerWidget : public QWidget public: /** Constructor for QgsTaskManagerWidget - * @param manager task manager associated with widget - * @param parent parent widget + * \param manager task manager associated with widget + * \param parent parent widget */ QgsTaskManagerWidget( QgsTaskManager *manager, QWidget *parent = nullptr ); @@ -66,7 +66,7 @@ class GUI_EXPORT QgsTaskManagerWidget : public QWidget * \ingroup gui * \class QgsTaskManagerFloatingWidget * A widget which displays tasks from a QgsTaskManager and allows for interaction with the manager. - * @see QgsTaskManager + * \see QgsTaskManager * \since QGIS 3.0 */ class GUI_EXPORT QgsTaskManagerFloatingWidget : public QgsFloatingWidget @@ -76,8 +76,8 @@ class GUI_EXPORT QgsTaskManagerFloatingWidget : public QgsFloatingWidget public: /** Constructor for QgsTaskManagerWidget - * @param manager task manager associated with widget - * @param parent parent widget + * \param manager task manager associated with widget + * \param parent parent widget */ QgsTaskManagerFloatingWidget( QgsTaskManager *manager, QWidget *parent = nullptr ); @@ -87,7 +87,7 @@ class GUI_EXPORT QgsTaskManagerFloatingWidget : public QgsFloatingWidget * \class QgsTaskManagerStatusBarWidget * A compact widget designed for embedding in a status bar, which displays tasks from a * QgsTaskManager and allows for interaction with the manager. - * @see QgsTaskManager + * \see QgsTaskManager * \ingroup gui * \since QGIS 3.0 */ @@ -98,8 +98,8 @@ class GUI_EXPORT QgsTaskManagerStatusBarWidget : public QToolButton public: /** Constructor for QgsTaskManagerWidget. - * @param manager task manager associated with widget - * @param parent parent widget + * \param manager task manager associated with widget + * \param parent parent widget */ QgsTaskManagerStatusBarWidget( QgsTaskManager *manager, QWidget *parent = nullptr ); @@ -124,7 +124,7 @@ class GUI_EXPORT QgsTaskManagerStatusBarWidget : public QToolButton * \ingroup gui * \class QgsTaskManagerModel * A model representing a QgsTaskManager. - * @see QgsTaskManager + * \see QgsTaskManager * \since QGIS 3.0 */ class GUI_EXPORT QgsTaskManagerModel: public QAbstractItemModel @@ -141,8 +141,8 @@ class GUI_EXPORT QgsTaskManagerModel: public QAbstractItemModel }; /** Constructor for QgsTaskManagerModel - * @param manager task manager for model - * @param parent parent object + * \param manager task manager for model + * \param parent parent object */ explicit QgsTaskManagerModel( QgsTaskManager *manager, QObject *parent = nullptr ); @@ -198,7 +198,7 @@ class GUI_EXPORT QgsTaskStatusWidget : public QWidget public: /** Constructor for QgsTaskStatusWidget - * @param parent parent object + * \param parent parent object */ QgsTaskStatusWidget( QWidget *parent = nullptr, QgsTask::TaskStatus status = QgsTask::Queued, bool canCancel = true ); diff --git a/src/gui/qgstextformatwidget.h b/src/gui/qgstextformatwidget.h index 8557df1c4140..d752fe6d6a30 100644 --- a/src/gui/qgstextformatwidget.h +++ b/src/gui/qgstextformatwidget.h @@ -52,9 +52,9 @@ class GUI_EXPORT QgsTextFormatWidget : public QWidget, protected Ui::QgsTextForm public: /** Constructor for QgsTextFormatWidget. - * @param format initial formatting settings to show in widget - * @param mapCanvas associated map canvas - * @param parent parent widget + * \param format initial formatting settings to show in widget + * \param mapCanvas associated map canvas + * \param parent parent widget */ QgsTextFormatWidget( const QgsTextFormat &format = QgsTextFormat(), QgsMapCanvas *mapCanvas = nullptr, QWidget *parent = nullptr ); @@ -67,7 +67,7 @@ class GUI_EXPORT QgsTextFormatWidget : public QWidget, protected Ui::QgsTextForm public slots: /** Sets whether the widget should be shown in a compact dock mode. - * @param enabled set to true to show in dock mode. + * \param enabled set to true to show in dock mode. */ void setDockMode( bool enabled ); @@ -86,24 +86,24 @@ class GUI_EXPORT QgsTextFormatWidget : public QWidget, protected Ui::QgsTextForm }; /** Constructor for QgsTextFormatWidget. - * @param mapCanvas associated map canvas - * @param parent parent widget - * @param mode widget mode + * \param mapCanvas associated map canvas + * \param parent parent widget + * \param mode widget mode */ QgsTextFormatWidget( QgsMapCanvas *mapCanvas, QWidget *parent, Mode mode ); /** Updates the widget's state to reflect the settings in a QgsTextFormat. - * @param format source format + * \param format source format */ void updateWidgetForFormat( const QgsTextFormat &format ); /** Sets the background color for the text preview widget. - * @param color background color + * \param color background color */ void setPreviewBackground( const QColor &color ); /** Controls whether data defined alignment buttons are enabled. - * @param enable set to true to enable alignment controls + * \param enable set to true to enable alignment controls */ void enableDataDefinedAlignment( bool enable ); @@ -214,10 +214,10 @@ class GUI_EXPORT QgsTextFormatDialog : public QDialog public: /** Constructor for QgsTextFormatDialog. - * @param format initial format settings to show in dialog - * @param mapCanvas optional associated map canvas - * @param parent parent widget - * @param fl window flags for dialog + * \param format initial format settings to show in dialog + * \param mapCanvas optional associated map canvas + * \param parent parent widget + * \param fl window flags for dialog */ QgsTextFormatDialog( const QgsTextFormat &format, QgsMapCanvas *mapCanvas = nullptr, QWidget *parent = nullptr, Qt::WindowFlags fl = QgisGui::ModalDialogFlags ); @@ -250,9 +250,9 @@ class GUI_EXPORT QgsTextFormatPanelWidget : public QgsPanelWidgetWrapper public: /** Constructor for QgsTextFormatPanelWidget. - * @param format initial format settings to show in dialog - * @param mapCanvas optional associated map canvas - * @param parent parent widget + * \param format initial format settings to show in dialog + * \param mapCanvas optional associated map canvas + * \param parent parent widget */ QgsTextFormatPanelWidget( const QgsTextFormat &format, QgsMapCanvas *mapCanvas = nullptr, QWidget *parent = nullptr ); diff --git a/src/gui/qgstextpreview.h b/src/gui/qgstextpreview.h index 02e60292955f..8d61654c18a1 100644 --- a/src/gui/qgstextpreview.h +++ b/src/gui/qgstextpreview.h @@ -46,46 +46,46 @@ class GUI_EXPORT QgsTextPreview : public QLabel public: /** Constructor for QgsTextPreview - * @param parent parent widget + * \param parent parent widget */ QgsTextPreview( QWidget *parent = nullptr ); void paintEvent( QPaintEvent *e ) override; /** Sets the text format for previewing in the widget. - * @param format text format - * @see format() + * \param format text format + * \see format() */ void setFormat( const QgsTextFormat &format ); /** Returns the text format used for previewing text in the widget. - * @see setFormat() + * \see setFormat() */ QgsTextFormat format() const { return mFormat; } /** Sets the scale to use for previewing format sizes in map units. - * @param scale preview map scale - * @see scale() - * @see setMapUnits() + * \param scale preview map scale + * \see scale() + * \see setMapUnits() */ void setScale( double scale ); /** Returns the scale used for previewing format sizes in map units. - * @see setScale() - * @see mapUnits() + * \see setScale() + * \see mapUnits() */ double scale() const { return mScale; } /** Sets the map unit type for previewing format sizes in map units. - * @param unit map units - * @see mapUnits() - * @see setScale() + * \param unit map units + * \see mapUnits() + * \see setScale() */ void setMapUnits( QgsUnitTypes::DistanceUnit unit ); /** Returns the map unit type used for previewing format sizes in map units. - * @see setMapUnits() - * @see scale() + * \see setMapUnits() + * \see scale() */ QgsUnitTypes::DistanceUnit mapUnits() const { return mMapUnits; } diff --git a/src/gui/qgstreewidgetitem.h b/src/gui/qgstreewidgetitem.h index 0a72d52e519d..3006880511ef 100644 --- a/src/gui/qgstreewidgetitem.h +++ b/src/gui/qgstreewidgetitem.h @@ -36,84 +36,84 @@ class GUI_EXPORT QgsTreeWidgetItem : public QTreeWidgetItem public: /** Constructor for QgsTreeWidgetItem - * @param view parent QTreeWidget view - * @param type item type + * \param view parent QTreeWidget view + * \param type item type */ explicit QgsTreeWidgetItem( QTreeWidget *view, int type = Type ); /** Constructor for QgsTreeWidgetItem - * @param type item type + * \param type item type */ explicit QgsTreeWidgetItem( int type = Type ); /** Constructor for QgsTreeWidgetItem - * @param strings list of strings containing text for each column in the item - * @param type item type + * \param strings list of strings containing text for each column in the item + * \param type item type */ QgsTreeWidgetItem( const QStringList &strings, int type = Type ); /** Constructor for QgsTreeWidgetItem - * @param view parent QTreeWidget view - * @param strings list of strings containing text for each column in the item - * @param type item type + * \param view parent QTreeWidget view + * \param strings list of strings containing text for each column in the item + * \param type item type */ QgsTreeWidgetItem( QTreeWidget *view, const QStringList &strings, int type = Type ); /** Constructor for QgsTreeWidgetItem - * @param view parent QTreeWidget view - * @param after QTreeWidgetItem to place insert item after in the view - * @param type item type + * \param view parent QTreeWidget view + * \param after QTreeWidgetItem to place insert item after in the view + * \param type item type */ QgsTreeWidgetItem( QTreeWidget *view, QTreeWidgetItem *after, int type = Type ); /** Constructor for QgsTreeWidgetItem - * @param parent QTreeWidgetItem item - * @param type item type + * \param parent QTreeWidgetItem item + * \param type item type */ explicit QgsTreeWidgetItem( QTreeWidgetItem *parent, int type = Type ); /** Constructor for QgsTreeWidgetItem - * @param parent QTreeWidgetItem item - * @param strings list of strings containing text for each column in the item - * @param type item type + * \param parent QTreeWidgetItem item + * \param strings list of strings containing text for each column in the item + * \param type item type */ QgsTreeWidgetItem( QTreeWidgetItem *parent, const QStringList &strings, int type = Type ); /** Constructor for QgsTreeWidgetItem - * @param parent QTreeWidgetItem item - * @param after QTreeWidgetItem to place insert item after in the view - * @param type item type + * \param parent QTreeWidgetItem item + * \param after QTreeWidgetItem to place insert item after in the view + * \param type item type */ QgsTreeWidgetItem( QTreeWidgetItem *parent, QTreeWidgetItem *after, int type = Type ); /** Sets the custom sort data for a specified column. If set, this value will be used when * sorting the item instead of the item's display text. If not set, the item's display * text will be used when sorting. - * @param column column index - * @param value sort value - * @see sortData() + * \param column column index + * \param value sort value + * \see sortData() */ void setSortData( int column, const QVariant &value ); /** Returns the custom sort data for a specified column. If set, this value will be used when * sorting the item instead of the item's display text. If not set, the item's display * text will be used when sorting. - * @see setSortData() + * \see setSortData() */ QVariant sortData( int column ) const; /** Sets a the item to display always on top of other items in the widget, regardless of the * sort column and sort or display value for the item. - * @param priority priority for sorting always on top items. Items with a lower priority will + * \param priority priority for sorting always on top items. Items with a lower priority will * be placed above items with a higher priority. - * @see alwaysOnTopPriority() + * \see alwaysOnTopPriority() */ void setAlwaysOnTopPriority( int priority ); /** Returns the item's priority when it is set to show always on top. Items with a lower priority will * be placed above items with a higher priority. - * @returns priority, or -1 if item is not set to show always on top - * @see setAlwaysOnTopPriority() + * \returns priority, or -1 if item is not set to show always on top + * \see setAlwaysOnTopPriority() */ int alwaysOnTopPriority() const; @@ -151,7 +151,7 @@ class GUI_EXPORT QgsTreeWidgetItemObject: public QObject, public QgsTreeWidgetIt public: /** Constructor for QgsTreeWidgetItemObject - * @param type item type + * \param type item type */ explicit QgsTreeWidgetItemObject( int type = Type ); diff --git a/src/gui/qgsunitselectionwidget.h b/src/gui/qgsunitselectionwidget.h index d244192a382d..cfb35ffc54b1 100644 --- a/src/gui/qgsunitselectionwidget.h +++ b/src/gui/qgsunitselectionwidget.h @@ -45,35 +45,35 @@ class GUI_EXPORT QgsMapUnitScaleWidget : public QgsPanelWidget, private Ui::QgsM public: /** Constructor for QgsMapUnitScaleWidget. - * @param parent parent widget + * \param parent parent widget */ QgsMapUnitScaleWidget( QWidget *parent = nullptr ); /** Returns a QgsMapUnitScale representing the settings shown in the * widget. - * @see setMapUnitScale() - * @see mapUnitScaleChanged() + * \see setMapUnitScale() + * \see mapUnitScaleChanged() */ QgsMapUnitScale mapUnitScale() const; /** Updates the widget to reflect the settings from the specified * QgsMapUnitScale object. - * @param scale map unit scale to show in widget - * @see mapUnitScale() - * @see mapUnitScaleChanged() + * \param scale map unit scale to show in widget + * \see mapUnitScale() + * \see mapUnitScaleChanged() */ void setMapUnitScale( const QgsMapUnitScale &scale ); /** Sets the map canvas associated with the widget. This allows the * widget to retrieve the current map scale from the canvas. - * @param canvas map canvas + * \param canvas map canvas */ void setMapCanvas( QgsMapCanvas *canvas ); signals: /** Emitted when the settings in the widget are modified. - * @param scale QgsMapUnitScale reflecting new settings from the widget + * \param scale QgsMapUnitScale reflecting new settings from the widget */ void mapUnitScaleChanged( const QgsMapUnitScale &scale ); @@ -104,26 +104,26 @@ class GUI_EXPORT QgsMapUnitScaleDialog : public QDialog public: /** Constructor for QgsMapUnitScaleDialog. - * @param parent parent widget + * \param parent parent widget */ QgsMapUnitScaleDialog( QWidget *parent = nullptr ); /** Returns a QgsMapUnitScale representing the settings shown in the * dialog. - * @see setMapUnitScale() + * \see setMapUnitScale() */ QgsMapUnitScale getMapUnitScale() const; /** Updates the dialog to reflect the settings from the specified * QgsMapUnitScale object. - * @param scale map unit scale to show in dialog - * @see mapUnitScale() + * \param scale map unit scale to show in dialog + * \see mapUnitScale() */ void setMapUnitScale( const QgsMapUnitScale &scale ); /** Sets the map canvas associated with the dialog. This allows the dialog to retrieve the current * map scale from the canvas. - * @param canvas map canvas + * \param canvas map canvas * \since QGIS 2.12 */ void setMapCanvas( QgsMapCanvas *canvas ); @@ -149,18 +149,18 @@ class GUI_EXPORT QgsUnitSelectionWidget : public QWidget, private Ui::QgsUnitSel public: /** Constructor for QgsUnitSelectionWidget. - * @param parent parent widget + * \param parent parent widget */ QgsUnitSelectionWidget( QWidget *parent = nullptr ); /** Sets the units which the user can choose from in the combobox. - * @param units list of strings for custom units to display in the widget - * @param mapUnitIdx specifies which entry corresponds to the map units, or -1 if none + * \param units list of strings for custom units to display in the widget + * \param mapUnitIdx specifies which entry corresponds to the map units, or -1 if none */ void setUnits( const QStringList &units, int mapUnitIdx ); /** Sets the units which the user can choose from in the combobox. Clears any existing units. - * @param units list of valid units + * \param units list of valid units * \since QGIS 2.9 */ void setUnits( const QgsUnitTypes::RenderUnitList &units ); @@ -169,19 +169,19 @@ class GUI_EXPORT QgsUnitSelectionWidget : public QWidget, private Ui::QgsUnitSel int getUnit() const { return mUnitCombo->currentIndex(); } /** Returns the current predefined selected unit (if applicable). - * @returns selected output unit, or QgsUnitTypes::RenderUnknownUnit if the widget was populated with custom unit types + * \returns selected output unit, or QgsUnitTypes::RenderUnknownUnit if the widget was populated with custom unit types * \since QGIS 2.9 */ QgsUnitTypes::RenderUnit unit() const; /** Sets the selected unit index - * @param unitIndex index of unit to set as current - * @note available in Python bindings as setUnitIndex + * \param unitIndex index of unit to set as current + * \note available in Python bindings as setUnitIndex */ void setUnit( int unitIndex ); /** Sets the selected unit - * @param unit predefined unit to set as current + * \param unit predefined unit to set as current */ void setUnit( QgsUnitTypes::RenderUnit unit ); @@ -193,7 +193,7 @@ class GUI_EXPORT QgsUnitSelectionWidget : public QWidget, private Ui::QgsUnitSel /** Sets the map canvas associated with the widget. This allows the widget to retrieve the current * map scale from the canvas. - * @param canvas map canvas + * \param canvas map canvas * \since QGIS 2.12 */ void setMapCanvas( QgsMapCanvas *canvas ); diff --git a/src/gui/qgsuserinputdockwidget.h b/src/gui/qgsuserinputdockwidget.h index a98882f592f8..96f957ee25fc 100644 --- a/src/gui/qgsuserinputdockwidget.h +++ b/src/gui/qgsuserinputdockwidget.h @@ -27,7 +27,7 @@ class QBoxLayout; /** \ingroup gui - * @brief The QgsUserInputDockWidget class is a dock widget that shall be used to display widgets for user inputs. + * \brief The QgsUserInputDockWidget class is a dock widget that shall be used to display widgets for user inputs. * It can be used by map tools, plugins, etc. * Several widgets can be displayed at once, they will be separated by a separator. Widgets will be either layout horizontally or vertically. * The dock is automatically hidden if it contains no widget. @@ -39,7 +39,7 @@ class GUI_EXPORT QgsUserInputDockWidget : public QgsDockWidget QgsUserInputDockWidget( QWidget *parent = nullptr ); /** Add a widget to be displayed in the dock. - * @param widget widget to add. Ownership is not transferred. + * \param widget widget to add. Ownership is not transferred. */ void addUserInputWidget( QWidget *widget ); diff --git a/src/gui/qgsvariableeditorwidget.h b/src/gui/qgsvariableeditorwidget.h index 01e0cfa6e75a..ba9d2578558e 100644 --- a/src/gui/qgsvariableeditorwidget.h +++ b/src/gui/qgsvariableeditorwidget.h @@ -47,7 +47,7 @@ class GUI_EXPORT QgsVariableEditorWidget : public QWidget public: /** Constructor for QgsVariableEditorWidget. - * @param parent parent widget + * \param parent parent widget */ QgsVariableEditorWidget( QWidget *parent = nullptr ); @@ -56,44 +56,44 @@ class GUI_EXPORT QgsVariableEditorWidget : public QWidget /** Overwrites the QgsExpressionContext for the widget. Setting a context * allows the widget to show all inherited variables for the context, * and highlight any overridden variables within scopes. - * @param context expression context - * @see context() + * \param context expression context + * \see context() */ void setContext( QgsExpressionContext *context ); /** Returns the current expression context for the widget. QgsVariableEditorWidget widgets * are created with an empty context by default. - * @see setContext() + * \see setContext() */ QgsExpressionContext *context() const { return mContext.get(); } /** Sets the editable scope for the widget. Only variables from the editable scope can * be modified by users. - * @param scopeIndex index of current editable scope. Set to -1 to disable + * \param scopeIndex index of current editable scope. Set to -1 to disable * editing and make the widget read-only. - * @see editableScope() + * \see editableScope() */ void setEditableScopeIndex( int scopeIndex ); /** Returns the current editable scope for the widget. - * @returns editable scope, or 0 if no editable scope is set - * @see setEditableScopeIndex() + * \returns editable scope, or 0 if no editable scope is set + * \see setEditableScopeIndex() */ QgsExpressionContextScope *editableScope() const; /** Sets the setting group for the widget. QgsVariableEditorWidget widgets with * the same setting group will synchronise their settings, e.g., the size * of columns in the tree widget. - * @param group setting group - * @see settingGroup() + * \param group setting group + * \see settingGroup() */ void setSettingGroup( const QString &group ) { mSettingGroup = group; } /** Returns the setting group for the widget. QgsVariableEditorWidget widgets with * the same setting group will synchronise their settings, e.g., the size * of columns in the tree widget. - * @returns setting group name - * @see setSettingGroup() + * \returns setting group name + * \see setSettingGroup() */ QString settingGroup() const { return mSettingGroup; } @@ -107,7 +107,7 @@ class GUI_EXPORT QgsVariableEditorWidget : public QWidget /** Reloads all scopes from the editor's current context. This method should be called * after adding or removing scopes from the attached context. - * @see context() + * \see context() */ void reloadContext(); diff --git a/src/gui/qgsvertexmarker.h b/src/gui/qgsvertexmarker.h index bc3e61c42dc6..431a1522831e 100644 --- a/src/gui/qgsvertexmarker.h +++ b/src/gui/qgsvertexmarker.h @@ -49,15 +49,15 @@ class GUI_EXPORT QgsVertexMarker : public QgsMapCanvasItem /** * Sets the stroke \a color for the marker. - * @see color() - * @see setFillColor() + * \see color() + * \see setFillColor() */ void setColor( const QColor &color ); /** * Returns the stroke color for the marker. - * @see setColor() - * @see fillColor() + * \see setColor() + * \see fillColor() * \since QGIS 3.0 */ QColor color() const { return mColor; } @@ -66,8 +66,8 @@ class GUI_EXPORT QgsVertexMarker : public QgsMapCanvasItem * Sets the fill \a color for the marker. This setting only * applies to some icon types. * \since QGIS 3.0 - * @see fillColor() - * @see setColor() + * \see fillColor() + * \see setColor() */ void setFillColor( const QColor &color ); @@ -75,8 +75,8 @@ class GUI_EXPORT QgsVertexMarker : public QgsMapCanvasItem * Returns the fill \a color for the marker. This setting only * applies to some icon types. * \since QGIS 3.0 - * @see setFillColor() - * @see color() + * \see setFillColor() + * \see color() */ QColor fillColor() const { return mFillColor; } diff --git a/src/gui/raster/qgshillshaderendererwidget.h b/src/gui/raster/qgshillshaderendererwidget.h index d8bbf0971317..a026b2a6e005 100644 --- a/src/gui/raster/qgshillshaderendererwidget.h +++ b/src/gui/raster/qgshillshaderendererwidget.h @@ -26,8 +26,8 @@ #include "qgis_gui.h" /** - * @brief Renderer widget for the hill shade renderer. - * @ingroup gui + * \brief Renderer widget for the hill shade renderer. + * \ingroup gui * \since QGIS 2.16 */ class GUI_EXPORT QgsHillshadeRendererWidget: public QgsRasterRendererWidget, private Ui::QgsHillShadeWidget @@ -36,9 +36,9 @@ class GUI_EXPORT QgsHillshadeRendererWidget: public QgsRasterRendererWidget, pri public: /** - * @brief Renderer widget for the hill shade renderer. - * @param layer The layer attached for this widget. - * @param extent The current extent. + * \brief Renderer widget for the hill shade renderer. + * \param layer The layer attached for this widget. + * \param extent The current extent. */ QgsHillshadeRendererWidget( QgsRasterLayer *layer, const QgsRectangle &extent = QgsRectangle() ); @@ -48,65 +48,65 @@ class GUI_EXPORT QgsHillshadeRendererWidget: public QgsRasterRendererWidget, pri static QgsRasterRendererWidget *create( QgsRasterLayer *layer, const QgsRectangle &extent ) { return new QgsHillshadeRendererWidget( layer, extent ); } /** - * @brief The renderer for the widget. - * @return A new renderer for the the config in the widget + * \brief The renderer for the widget. + * \returns A new renderer for the the config in the widget */ QgsRasterRenderer *renderer() override; /** - * @brief Set the widget state from the given renderer. - * @param renderer The renderer to take the state from. + * \brief Set the widget state from the given renderer. + * \param renderer The renderer to take the state from. */ void setFromRenderer( const QgsRasterRenderer *renderer ); /** * Returns the direction of the light over the raster between 0-360. - * @see setAzimuth() + * \see setAzimuth() */ double azimuth() const; /** Returns the angle of the light source over the raster. - * @see setAltitude() + * \see setAltitude() */ double altitude() const; /** Returns the Z scaling factor. - * @see setZFactor() + * \see setZFactor() */ double zFactor() const; /** * Returns true if the renderer should use the multi-directional hillshade algorithm. - * @see setMultiDirectional() + * \see setMultiDirectional() */ bool multiDirectional() const; public slots: /** - * @brief Set the altitude of the light source - * @param altitude the altitude - * @see altitude() + * \brief Set the altitude of the light source + * \param altitude the altitude + * \see altitude() */ void setAltitude( double altitude ); /** - * @brief Set the azimuth of the light source. - * @param azimuth The azimuth of the light source, between 0 and 360.0 - * @see azimuth() + * \brief Set the azimuth of the light source. + * \param azimuth The azimuth of the light source, between 0 and 360.0 + * \see azimuth() */ void setAzimuth( double azimuth ); /** - * @brief Set the Z scaling factor of the result image. - * @param zfactor The z factor - * @see zFactor() + * \brief Set the Z scaling factor of the result image. + * \param zfactor The z factor + * \see zFactor() */ void setZFactor( double zfactor ); /** Sets whether to render using a multi-directional hillshade algorithm. - * @param isMultiDirectional set to true to use multi directional rendering - * @see multiDirectional() + * \param isMultiDirectional set to true to use multi directional rendering + * \see multiDirectional() */ void setMultiDirectional( bool isMultiDirectional ); diff --git a/src/gui/raster/qgsrasterhistogramwidget.h b/src/gui/raster/qgsrasterhistogramwidget.h index 6a40aa4bdefb..cc0e02c62347 100644 --- a/src/gui/raster/qgsrasterhistogramwidget.h +++ b/src/gui/raster/qgsrasterhistogramwidget.h @@ -35,7 +35,6 @@ typedef QPointF QwtDoublePoint; /** \ingroup gui * Histogram widget - *@author Etienne Tourigny */ class GUI_EXPORT QgsRasterHistogramWidget : public QgsMapLayerConfigWidget, private Ui::QgsRasterHistogramWidgetBase @@ -84,7 +83,7 @@ class GUI_EXPORT QgsRasterHistogramWidget : public QgsMapLayerConfigWidget, priv void histoPickerSelected( QPointF ); /** Called when a selection has been made using the plot picker (for qwt5 only). - @note not available in Python bindings + \note not available in Python bindings */ void histoPickerSelectedQwt5( QwtDoublePoint ); //! Various actions that are stored in btnHistoActions. diff --git a/src/gui/raster/qgsrasterminmaxwidget.h b/src/gui/raster/qgsrasterminmaxwidget.h index 5d8b568916ca..67844cc59cfe 100644 --- a/src/gui/raster/qgsrasterminmaxwidget.h +++ b/src/gui/raster/qgsrasterminmaxwidget.h @@ -39,8 +39,8 @@ class GUI_EXPORT QgsRasterMinMaxWidget: public QWidget, private Ui::QgsRasterMin QgsRasterMinMaxWidget( QgsRasterLayer *layer, QWidget *parent = nullptr ); /** Sets the extent to use for minimum and maximum value calculation. - * @param extent extent in raster layer's CRS - * @note if a map canvas is set using setMapCanvas(), its extent will take + * \param extent extent in raster layer's CRS + * \note if a map canvas is set using setMapCanvas(), its extent will take * precedence over any extent set using this method. */ void setExtent( const QgsRectangle &extent ) { mExtent = extent; } @@ -48,15 +48,15 @@ class GUI_EXPORT QgsRasterMinMaxWidget: public QWidget, private Ui::QgsRasterMin /** Sets the map canvas associated with the widget. This allows the widget to retrieve the current * map extent from the canvas. If a canvas is set it will take precedence over any extent * set from calling setExtent(). - * @param canvas map canvas - * @see mapCanvas() + * \param canvas map canvas + * \see mapCanvas() * \since QGIS 2.16 */ void setMapCanvas( QgsMapCanvas *canvas ); /** Returns the map canvas associated with the widget. - * @see setMapCanvas() - * @see canvasExtent() + * \see setMapCanvas() + * \see canvasExtent() * \since QGIS 2.16 */ QgsMapCanvas *mapCanvas(); diff --git a/src/gui/raster/qgsrasterrendererwidget.h b/src/gui/raster/qgsrasterrendererwidget.h index fef3258d95e7..de47e68c0062 100644 --- a/src/gui/raster/qgsrasterrendererwidget.h +++ b/src/gui/raster/qgsrasterrendererwidget.h @@ -51,15 +51,15 @@ class GUI_EXPORT QgsRasterRendererWidget: public QWidget /** Sets the map canvas associated with the widget. This allows the widget to retrieve the current * map extent and other properties from the canvas. - * @param canvas map canvas - * @see mapCanvas() + * \param canvas map canvas + * \see mapCanvas() * \since QGIS 2.16 */ virtual void setMapCanvas( QgsMapCanvas *canvas ); /** Returns the map canvas associated with the widget. - * @see setMapCanvas() - * @see canvasExtent() + * \see setMapCanvas() + * \see canvasExtent() * \since QGIS 2.16 */ QgsMapCanvas *mapCanvas(); diff --git a/src/gui/raster/qgsrastertransparencywidget.h b/src/gui/raster/qgsrastertransparencywidget.h index a75f6b677d74..036b6723fe57 100644 --- a/src/gui/raster/qgsrastertransparencywidget.h +++ b/src/gui/raster/qgsrastertransparencywidget.h @@ -30,7 +30,7 @@ class QgsPoint; /** \ingroup gui - * @brief Widget to control a layers transparency and related options + * \brief Widget to control a layers transparency and related options */ class GUI_EXPORT QgsRasterTransparencyWidget : public QgsMapLayerConfigWidget, private Ui::QgsRasterTransparencyWidget { @@ -38,7 +38,7 @@ class GUI_EXPORT QgsRasterTransparencyWidget : public QgsMapLayerConfigWidget, p public: /** - * @brief Widget to control a layers transparency and related options + * \brief Widget to control a layers transparency and related options */ QgsRasterTransparencyWidget( QgsRasterLayer *layer, QgsMapCanvas *canvas, QWidget *parent = 0 ); diff --git a/src/gui/raster/qgsrendererrasterpropertieswidget.h b/src/gui/raster/qgsrendererrasterpropertieswidget.h index 5964a353eb4a..6e102ab8efed 100644 --- a/src/gui/raster/qgsrendererrasterpropertieswidget.h +++ b/src/gui/raster/qgsrendererrasterpropertieswidget.h @@ -39,15 +39,15 @@ class GUI_EXPORT QgsRendererRasterPropertiesWidget : public QgsMapLayerConfigWid /** * A widget to hold the renderer properties for a raster layer. - * @param layer The raster layer to style - * @param canvas The canvas object used to calculate the max and min values from the extent. - * @param parent Parent object + * \param layer The raster layer to style + * \param canvas The canvas object used to calculate the max and min values from the extent. + * \param parent Parent object */ QgsRendererRasterPropertiesWidget( QgsMapLayer *layer, QgsMapCanvas *canvas, QWidget *parent = nullptr ); /** Sets the map canvas associated with the dialog. This allows the widget to retrieve the current * map scale and other properties from the canvas. - * @param canvas map canvas + * \param canvas map canvas * \since QGIS 2.12 */ void setMapCanvas( QgsMapCanvas *canvas ); @@ -65,8 +65,8 @@ class GUI_EXPORT QgsRendererRasterPropertiesWidget : public QgsMapLayerConfigWid void apply(); /** - * @brief Sync the widget to the given layer. - * @param layer The layer to use for the widget + * \brief Sync the widget to the given layer. + * \param layer The layer to use for the widget */ void syncToLayer( QgsRasterLayer *layer ); diff --git a/src/gui/raster/qgssinglebandpseudocolorrendererwidget.cpp b/src/gui/raster/qgssinglebandpseudocolorrendererwidget.cpp index 9469356e8bfe..a0f93832cab9 100644 --- a/src/gui/raster/qgssinglebandpseudocolorrendererwidget.cpp +++ b/src/gui/raster/qgssinglebandpseudocolorrendererwidget.cpp @@ -191,10 +191,6 @@ void QgsSingleBandPseudoColorRendererWidget::setMapCanvas( QgsMapCanvas *canvas mMinMaxWidget->setMapCanvas( canvas ); } -/** Generate labels from the values in the color map. - * Skip labels which were manually edited (black text). - * Text of generated labels is made gray - */ void QgsSingleBandPseudoColorRendererWidget::autoLabel() { QgsColorRampShader::Type interpolation = static_cast< QgsColorRampShader::Type >( mColorInterpolationComboBox->currentData().toInt() ); @@ -240,7 +236,6 @@ void QgsSingleBandPseudoColorRendererWidget::autoLabel() } } -//! Extract the unit out of the current labels and set the unit field. void QgsSingleBandPseudoColorRendererWidget::setUnitFromLabels() { QgsColorRampShader::Type interpolation = static_cast< QgsColorRampShader::Type >( mColorInterpolationComboBox->currentData().toInt() ); @@ -634,7 +629,6 @@ void QgsSingleBandPseudoColorRendererWidget::on_mColormapTreeWidget_itemDoubleCl } } -//! Update the colormap table after manual edit. void QgsSingleBandPseudoColorRendererWidget::mColormapTreeWidget_itemEdited( QTreeWidgetItem *item, int column ) { Q_UNUSED( item ); diff --git a/src/gui/raster/qgssinglebandpseudocolorrendererwidget.h b/src/gui/raster/qgssinglebandpseudocolorrendererwidget.h index 0f30a1420fd0..f97b59fb4b3f 100644 --- a/src/gui/raster/qgssinglebandpseudocolorrendererwidget.h +++ b/src/gui/raster/qgssinglebandpseudocolorrendererwidget.h @@ -65,7 +65,14 @@ class GUI_EXPORT QgsSingleBandPseudoColorRendererWidget: public QgsRasterRendere }; void populateColormapTreeWidget( const QList &colorRampItems ); + + /** Generate labels from the values in the color map. + * Skip labels which were manually edited (black text). + * Text of generated labels is made gray + */ void autoLabel(); + + //! Extract the unit out of the current labels and set the unit field. void setUnitFromLabels(); QMenu *contextMenu = nullptr; diff --git a/src/gui/symbology-ng/characterwidget.cpp b/src/gui/symbology-ng/characterwidget.cpp index 7001ba74fac9..967345ba40e6 100644 --- a/src/gui/symbology-ng/characterwidget.cpp +++ b/src/gui/symbology-ng/characterwidget.cpp @@ -53,44 +53,35 @@ #include "characterwidget.h" -//! [0] CharacterWidget::CharacterWidget( QWidget *parent ) : QWidget( parent ) { - squareSize = 24; - columns = 16; - lastKey = -1; setMouseTracking( true ); } -//! [0] -//! [1] -void CharacterWidget::updateFont( const QFont &font ) +void CharacterWidget::setFont( const QFont &font ) { - displayFont.setFamily( font.family() ); - squareSize = qMax( 24, QFontMetrics( displayFont ).xHeight() * 3 ); + mDisplayFont.setFamily( font.family() ); + mSquareSize = qMax( 24, QFontMetrics( mDisplayFont ).xHeight() * 3 ); adjustSize(); update(); } -//! [1] -//! [2] -void CharacterWidget::updateSize( double fontSize ) +void CharacterWidget::setFontSize( double fontSize ) { - displayFont.setPointSizeF( fontSize ); - squareSize = qMax( 24, QFontMetrics( displayFont ).xHeight() * 3 ); + mDisplayFont.setPointSizeF( fontSize ); + mSquareSize = qMax( 24, QFontMetrics( mDisplayFont ).xHeight() * 3 ); adjustSize(); update(); } -//! [2] -void CharacterWidget::updateStyle( const QString &fontStyle ) +void CharacterWidget::setFontStyle( const QString &fontStyle ) { QFontDatabase fontDatabase; - const QFont::StyleStrategy oldStrategy = displayFont.styleStrategy(); - displayFont = fontDatabase.font( displayFont.family(), fontStyle, displayFont.pointSize() ); - displayFont.setStyleStrategy( oldStrategy ); - squareSize = qMax( 24, QFontMetrics( displayFont ).xHeight() * 3 ); + const QFont::StyleStrategy oldStrategy = mDisplayFont.styleStrategy(); + mDisplayFont = fontDatabase.font( mDisplayFont.family(), fontStyle, mDisplayFont.pointSize() ); + mDisplayFont.setStyleStrategy( oldStrategy ); + mSquareSize = qMax( 24, QFontMetrics( mDisplayFont ).xHeight() * 3 ); adjustSize(); update(); } @@ -98,94 +89,80 @@ void CharacterWidget::updateStyle( const QString &fontStyle ) void CharacterWidget::updateFontMerging( bool enable ) { if ( enable ) - displayFont.setStyleStrategy( QFont::PreferDefault ); + mDisplayFont.setStyleStrategy( QFont::PreferDefault ); else - displayFont.setStyleStrategy( QFont::NoFontMerging ); + mDisplayFont.setStyleStrategy( QFont::NoFontMerging ); adjustSize(); update(); } -void CharacterWidget::updateColumns( int cols ) +void CharacterWidget::setColumns( int columns ) { - if ( columns == cols || cols < 1 ) + if ( mColumns == columns || columns < 1 ) return; - columns = cols; + mColumns = columns; adjustSize(); update(); } void CharacterWidget::setCharacter( QChar character ) { - lastKey = character.unicode(); + mLastKey = character.unicode(); update(); } -//! [3] QSize CharacterWidget::sizeHint() const { - return QSize( columns * squareSize, ( 65536 / columns ) * squareSize ); + return QSize( mColumns * mSquareSize, ( 65536 / mColumns ) * mSquareSize ); } -//! [3] -//! [4] void CharacterWidget::mouseMoveEvent( QMouseEvent *event ) { QPoint widgetPosition = mapFromGlobal( event->globalPos() ); - uint key = ( widgetPosition.y() / squareSize ) * columns + widgetPosition.x() / squareSize; + uint key = ( widgetPosition.y() / mSquareSize ) * mColumns + widgetPosition.x() / mSquareSize; QString text = tr( "

Character: %2

Value: 0x%3" ) - .arg( displayFont.family() ) + .arg( mDisplayFont.family() ) .arg( QChar( key ) ) .arg( key, 16 ); QToolTip::showText( event->globalPos(), text, this ); } -//! [4] -//! [5] void CharacterWidget::mousePressEvent( QMouseEvent *event ) { if ( event->button() == Qt::LeftButton ) { - lastKey = ( event->y() / squareSize ) * columns + event->x() / squareSize; - if ( QChar( lastKey ).category() != QChar::Other_NotAssigned ) - emit characterSelected( QChar( lastKey ) ); + mLastKey = ( event->y() / mSquareSize ) * mColumns + event->x() / mSquareSize; + if ( QChar( mLastKey ).category() != QChar::Other_NotAssigned ) + emit characterSelected( QChar( mLastKey ) ); update(); } else QWidget::mousePressEvent( event ); } -//! [5] -//! [6] void CharacterWidget::paintEvent( QPaintEvent *event ) { QPainter painter( this ); painter.fillRect( event->rect(), QBrush( Qt::white ) ); - painter.setFont( displayFont ); -//! [6] + painter.setFont( mDisplayFont ); -//! [7] QRect redrawRect = event->rect(); - int beginRow = redrawRect.top() / squareSize; - int endRow = redrawRect.bottom() / squareSize; - int beginColumn = redrawRect.left() / squareSize; - int endColumn = redrawRect.right() / squareSize; -//! [7] + int beginRow = redrawRect.top() / mSquareSize; + int endRow = redrawRect.bottom() / mSquareSize; + int beginColumn = redrawRect.left() / mSquareSize; + int endColumn = redrawRect.right() / mSquareSize; -//! [8] painter.setPen( QPen( Qt::gray ) ); for ( int row = beginRow; row <= endRow; ++row ) { for ( int column = beginColumn; column <= endColumn; ++column ) { - painter.drawRect( column * squareSize, row * squareSize, squareSize, squareSize ); + painter.drawRect( column * mSquareSize, row * mSquareSize, mSquareSize, mSquareSize ); } -//! [8] //! [9] } -//! [9] -//! [10] - QFontMetrics fontMetrics( displayFont ); + QFontMetrics fontMetrics( mDisplayFont ); painter.setPen( QPen( Qt::black ) ); for ( int row = beginRow; row <= endRow; ++row ) { @@ -193,16 +170,15 @@ void CharacterWidget::paintEvent( QPaintEvent *event ) for ( int column = beginColumn; column <= endColumn; ++column ) { - int key = row * columns + column; - painter.setClipRect( column * squareSize, row * squareSize, squareSize, squareSize ); + int key = row * mColumns + column; + painter.setClipRect( column * mSquareSize, row * mSquareSize, mSquareSize, mSquareSize ); - if ( key == lastKey ) - painter.fillRect( column * squareSize + 1, row * squareSize + 1, squareSize, squareSize, QBrush( Qt::red ) ); + if ( key == mLastKey ) + painter.fillRect( column * mSquareSize + 1, row * mSquareSize + 1, mSquareSize, mSquareSize, QBrush( Qt::red ) ); - painter.drawText( column * squareSize + ( squareSize / 2 ) - fontMetrics.width( QChar( key ) ) / 2, - row * squareSize + 4 + fontMetrics.ascent(), + painter.drawText( column * mSquareSize + ( mSquareSize / 2 ) - fontMetrics.width( QChar( key ) ) / 2, + row * mSquareSize + 4 + fontMetrics.ascent(), QString( QChar( key ) ) ); } } } -//! [10] diff --git a/src/gui/symbology-ng/characterwidget.h b/src/gui/symbology-ng/characterwidget.h index 2817753d25de..8533ba36639d 100644 --- a/src/gui/symbology-ng/characterwidget.h +++ b/src/gui/symbology-ng/characterwidget.h @@ -52,34 +52,99 @@ #include #include #include +#include "qgis.h" #include "qgis_gui.h" -QT_BEGIN_NAMESPACE class QMouseEvent; class QPaintEvent; -QT_END_NAMESPACE -//! \ingroup gui +/** + * \ingroup gui + * + * A widget for displaying characters available in a preset font, and allowing + * users to select an individual character. + */ class GUI_EXPORT CharacterWidget : public QWidget { Q_OBJECT + Q_PROPERTY( QChar character READ character WRITE setCharacter NOTIFY characterSelected ) + Q_PROPERTY( int columns READ columns WRITE setColumns ) + Q_PROPERTY( QFont font READ font WRITE setFont ) public: - CharacterWidget( QWidget *parent = nullptr ); + + /** + * Constructor for CharacterWidget. + */ + CharacterWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr ); + QSize sizeHint() const override; - int getColumns() const { return columns; } - int getSquareSize() const { return squareSize; } + /** + * Returns the number of columns of characters shown in the widget. + */ + int columns() const { return mColumns; } + + /** + * Returns the size (in pixels) of the square used to render each character preview. + */ + int squareSize() const { return mSquareSize; } + + /** + * Returns the currently selected character in the widget. + * \see setCharacter() + * \since QGIS 3.0 + */ + QChar character() const { return QChar( mLastKey ); } + + /** + * Returns the font shown in the widget + * \see setFont() + * \since QGIS 3.0 + */ + QFont font() const { return mDisplayFont; } public slots: - void updateFont( const QFont &font ); - void updateSize( double fontSize ); - void updateStyle( const QString &fontStyle ); + + /** + * Sets the \a font to show in the widget. + * \see font() + * \since QGIS 3.0 + */ + void setFont( const QFont &font ); + + /** + * Sets the font size (in points) to render in the widget. + * \since QGIS 3.0 + */ + void setFontSize( double fontSize ); + + /** + * Sets the font style to show in the widget. + * \since QGIS 3.0 + */ + void setFontStyle( const QString &fontStyle ); + void updateFontMerging( bool enable ); - void updateColumns( int cols ); + + /** + * Sets the number of columns of characters to show in the widget. + * \since QGIS 3.0 + */ + void setColumns( int columns ); + + /** + * Sets the currently selected \a character in the widget. + * \see character() + * \see characterSelected() + */ void setCharacter( QChar character ); signals: + + /** + * Emitted when a character is selected in the widget. + */ void characterSelected( QChar character ); protected: @@ -88,11 +153,10 @@ class GUI_EXPORT CharacterWidget : public QWidget void paintEvent( QPaintEvent *event ) override; private: - QFont displayFont; - int columns; - int lastKey; - int squareSize; + QFont mDisplayFont; + int mColumns = 16; + int mLastKey = -1; + int mSquareSize = 24; }; -//! [0] #endif diff --git a/src/gui/symbology-ng/qgs25drendererwidget.h b/src/gui/symbology-ng/qgs25drendererwidget.h index bbbaeda0e106..fbc017d3ae0b 100644 --- a/src/gui/symbology-ng/qgs25drendererwidget.h +++ b/src/gui/symbology-ng/qgs25drendererwidget.h @@ -32,16 +32,16 @@ class GUI_EXPORT Qgs25DRendererWidget : public QgsRendererWidget, Ui::Qgs25DRend public: /** Static creation method - * @param layer the layer where this renderer is applied - * @param style - * @param renderer the mask renderer (will not take ownership) + * \param layer the layer where this renderer is applied + * \param style + * \param renderer the mask renderer (will not take ownership) */ static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ); /** Constructor - * @param layer the layer where this renderer is applied - * @param style - * @param renderer the mask renderer (will not take ownership) + * \param layer the layer where this renderer is applied + * \param style + * \param renderer the mask renderer (will not take ownership) */ Qgs25DRendererWidget( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ); diff --git a/src/gui/symbology-ng/qgsarrowsymbollayerwidget.h b/src/gui/symbology-ng/qgsarrowsymbollayerwidget.h index 171cc4d1597c..eb1d6422fad9 100644 --- a/src/gui/symbology-ng/qgsarrowsymbollayerwidget.h +++ b/src/gui/symbology-ng/qgsarrowsymbollayerwidget.h @@ -31,13 +31,13 @@ class GUI_EXPORT QgsArrowSymbolLayerWidget: public QgsSymbolLayerWidget, private public: /** Constructor - * @param layer the layer where this symbol layer is applied - * @param parent the parent widget + * \param layer the layer where this symbol layer is applied + * \param parent the parent widget */ QgsArrowSymbolLayerWidget( const QgsVectorLayer *layer, QWidget *parent = nullptr ); /** Static creation method - * @param layer the layer where this symbol layer is applied + * \param layer the layer where this symbol layer is applied */ static QgsSymbolLayerWidget *create( const QgsVectorLayer *layer ) { return new QgsArrowSymbolLayerWidget( layer ); } diff --git a/src/gui/symbology-ng/qgscategorizedsymbolrendererwidget.h b/src/gui/symbology-ng/qgscategorizedsymbolrendererwidget.h index 8c5ea951cdaf..7d6e3a563395 100644 --- a/src/gui/symbology-ng/qgscategorizedsymbolrendererwidget.h +++ b/src/gui/symbology-ng/qgscategorizedsymbolrendererwidget.h @@ -94,10 +94,10 @@ class GUI_EXPORT QgsCategorizedSymbolRendererWidget : public QgsRendererWidget, /** Replaces category symbols with the symbols from a style that have a matching * name. - * @param style style containing symbols to match with - * @return number of symbols matched - * @see matchToSymbolsFromLibrary - * @see matchToSymbolsFromXml + * \param style style containing symbols to match with + * \returns number of symbols matched + * \see matchToSymbolsFromLibrary + * \see matchToSymbolsFromXml * \since QGIS 2.9 */ int matchToSymbols( QgsStyle *style ); @@ -122,16 +122,16 @@ class GUI_EXPORT QgsCategorizedSymbolRendererWidget : public QgsRendererWidget, /** Replaces category symbols with the symbols from the users' symbol library that have a * matching name. - * @see matchToSymbolsFromXml - * @see matchToSymbols + * \see matchToSymbolsFromXml + * \see matchToSymbols * \since QGIS 2.9 */ void matchToSymbolsFromLibrary(); /** Prompts for selection of an xml file, then replaces category symbols with the symbols * from the XML file with a matching name. - * @see matchToSymbolsFromLibrary - * @see matchToSymbols + * \see matchToSymbolsFromLibrary + * \see matchToSymbols * \since QGIS 2.9 */ void matchToSymbolsFromXml(); diff --git a/src/gui/symbology-ng/qgscptcitycolorrampdialog.h b/src/gui/symbology-ng/qgscptcitycolorrampdialog.h index 4fb40e723e60..137363d2b3ff 100644 --- a/src/gui/symbology-ng/qgscptcitycolorrampdialog.h +++ b/src/gui/symbology-ng/qgscptcitycolorrampdialog.h @@ -45,19 +45,19 @@ class GUI_EXPORT QgsCptCityColorRampDialog : public QDialog, private Ui::QgsCptC public: /** Constructor for QgsCptCityColorRampDialog. - * @param ramp initial ramp to show in dialog - * @param parent parent widget + * \param ramp initial ramp to show in dialog + * \param parent parent widget */ QgsCptCityColorRampDialog( const QgsCptCityColorRamp &ramp, QWidget *parent = nullptr ); /** Returns a color ramp representing the current settings from the dialog. - * @see setRamp() + * \see setRamp() */ QgsCptCityColorRamp ramp() const { return mRamp; } /** Sets the color ramp to show in the dialog. - * @param ramp color ramp - * @see ramp() + * \param ramp color ramp + * \see ramp() */ void setRamp( const QgsCptCityColorRamp &ramp ); diff --git a/src/gui/symbology-ng/qgsgraduatedhistogramwidget.h b/src/gui/symbology-ng/qgsgraduatedhistogramwidget.h index cb5a0a4784d2..a62384d575e6 100644 --- a/src/gui/symbology-ng/qgsgraduatedhistogramwidget.h +++ b/src/gui/symbology-ng/qgsgraduatedhistogramwidget.h @@ -38,20 +38,20 @@ class GUI_EXPORT QgsGraduatedHistogramWidget : public QgsHistogramWidget public: /** QgsGraduatedHistogramWidget constructor - * @param parent parent widget + * \param parent parent widget */ QgsGraduatedHistogramWidget( QWidget *parent = nullptr ); /** Sets the QgsGraduatedSymbolRenderer renderer associated with the histogram. * The histogram will fetch the ranges from the renderer before every refresh. - * @param renderer associated QgsGraduatedSymbolRenderer + * \param renderer associated QgsGraduatedSymbolRenderer */ void setRenderer( QgsGraduatedSymbolRenderer *renderer ); signals: /** Emitted when the user modifies the graduated ranges using the histogram widget. - * @param rangesAdded true if the user has added ranges, false if the user has just + * \param rangesAdded true if the user has added ranges, false if the user has just * modified existing range breaks */ void rangesModified( bool rangesAdded ); diff --git a/src/gui/symbology-ng/qgsheatmaprendererwidget.h b/src/gui/symbology-ng/qgsheatmaprendererwidget.h index 9ad3994158b7..cd08dfb0ee1f 100644 --- a/src/gui/symbology-ng/qgsheatmaprendererwidget.h +++ b/src/gui/symbology-ng/qgsheatmaprendererwidget.h @@ -32,16 +32,16 @@ class GUI_EXPORT QgsHeatmapRendererWidget : public QgsRendererWidget, private Ui public: /** Static creation method - * @param layer the layer where this renderer is applied - * @param style - * @param renderer the mask renderer (will not take ownership) + * \param layer the layer where this renderer is applied + * \param style + * \param renderer the mask renderer (will not take ownership) */ static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ); /** Constructor - * @param layer the layer where this renderer is applied - * @param style - * @param renderer the mask renderer (will not take ownership) + * \param layer the layer where this renderer is applied + * \param style + * \param renderer the mask renderer (will not take ownership) */ QgsHeatmapRendererWidget( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ); diff --git a/src/gui/symbology-ng/qgsinvertedpolygonrendererwidget.h b/src/gui/symbology-ng/qgsinvertedpolygonrendererwidget.h index 0cacd4e4ecdc..aebf56e2afdc 100644 --- a/src/gui/symbology-ng/qgsinvertedpolygonrendererwidget.h +++ b/src/gui/symbology-ng/qgsinvertedpolygonrendererwidget.h @@ -34,16 +34,16 @@ class GUI_EXPORT QgsInvertedPolygonRendererWidget : public QgsRendererWidget, pr public: /** Static creation method - * @param layer the layer where this renderer is applied - * @param style - * @param renderer the mask renderer (will not take ownership) + * \param layer the layer where this renderer is applied + * \param style + * \param renderer the mask renderer (will not take ownership) */ static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ); /** Constructor - * @param layer the layer where this renderer is applied - * @param style - * @param renderer the mask renderer (will not take ownership) + * \param layer the layer where this renderer is applied + * \param style + * \param renderer the mask renderer (will not take ownership) */ QgsInvertedPolygonRendererWidget( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ); diff --git a/src/gui/symbology-ng/qgslayerpropertieswidget.h b/src/gui/symbology-ng/qgslayerpropertieswidget.h index 8365f9e356e5..74079d70cf1c 100644 --- a/src/gui/symbology-ng/qgslayerpropertieswidget.h +++ b/src/gui/symbology-ng/qgslayerpropertieswidget.h @@ -45,14 +45,14 @@ class GUI_EXPORT QgsLayerPropertiesWidget : public QgsPanelWidget, public QgsExp QgsLayerPropertiesWidget( QgsSymbolLayer *layer, const QgsSymbol *symbol, const QgsVectorLayer *vl, QWidget *parent = nullptr ); /** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @param context symbol widget context - * @see context() + * \param context symbol widget context + * \see context() * \since QGIS 3.0 */ void setContext( const QgsSymbolWidgetContext &context ); /** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @see setContext() + * \see setContext() * \since QGIS 3.0 */ QgsSymbolWidgetContext context() const; @@ -60,7 +60,7 @@ class GUI_EXPORT QgsLayerPropertiesWidget : public QgsPanelWidget, public QgsExp /** * Set the widget in dock mode which tells the widget to emit panel * widgets and not open dialogs - * @param dockMode True to enable dock mode. + * \param dockMode True to enable dock mode. */ virtual void setDockMode( bool dockMode ) override; diff --git a/src/gui/symbology-ng/qgspointclusterrendererwidget.h b/src/gui/symbology-ng/qgspointclusterrendererwidget.h index 33c75f4abf50..d3d56a3fcb12 100644 --- a/src/gui/symbology-ng/qgspointclusterrendererwidget.h +++ b/src/gui/symbology-ng/qgspointclusterrendererwidget.h @@ -36,17 +36,17 @@ class GUI_EXPORT QgsPointClusterRendererWidget: public QgsRendererWidget, privat public: /** Returns a new QgsPointClusterRendererWidget. - * @param layer associated vector layer - * @param style style collection - * @param renderer source QgsPointClusterRenderer renderer - * @returns new QgsRendererWidget + * \param layer associated vector layer + * \param style style collection + * \param renderer source QgsPointClusterRenderer renderer + * \returns new QgsRendererWidget */ static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ); /** Constructor for QgsPointClusterRendererWidget. - * @param layer associated vector layer - * @param style style collection - * @param renderer source QgsPointClusterRenderer renderer + * \param layer associated vector layer + * \param style style collection + * \param renderer source QgsPointClusterRenderer renderer */ QgsPointClusterRendererWidget( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ); diff --git a/src/gui/symbology-ng/qgsrendererpropertiesdialog.h b/src/gui/symbology-ng/qgsrendererpropertiesdialog.h index d7952082066f..3ff26cd5286a 100644 --- a/src/gui/symbology-ng/qgsrendererpropertiesdialog.h +++ b/src/gui/symbology-ng/qgsrendererpropertiesdialog.h @@ -43,18 +43,18 @@ class GUI_EXPORT QgsRendererPropertiesDialog : public QDialog, private Ui::QgsRe public: /** Constructor for QgsRendererPropertiesDialog. - * @param layer associated layer - * @param style style collection - * @param embedded set to true to indicate that the dialog will be embedded in another widget, rather + * \param layer associated layer + * \param style style collection + * \param embedded set to true to indicate that the dialog will be embedded in another widget, rather * than shown as a dialog by itself - * @param parent parent widget + * \param parent parent widget */ QgsRendererPropertiesDialog( QgsVectorLayer *layer, QgsStyle *style, bool embedded = false, QWidget *parent = nullptr ); ~QgsRendererPropertiesDialog(); /** Sets the map canvas associated with the dialog. This allows the widget to retrieve the current * map scale and other properties from the canvas. - * @param canvas map canvas + * \param canvas map canvas * \since QGIS 2.12 */ void setMapCanvas( QgsMapCanvas *canvas ); @@ -62,7 +62,7 @@ class GUI_EXPORT QgsRendererPropertiesDialog : public QDialog, private Ui::QgsRe /** * Set the widget in dock mode which tells the widget to emit panel * widgets and not open dialogs - * @param dockMode True to enable dock mode. + * \param dockMode True to enable dock mode. */ void setDockMode( bool dockMode ); @@ -83,8 +83,8 @@ class GUI_EXPORT QgsRendererPropertiesDialog : public QDialog, private Ui::QgsRe /** * Emit when you require a panel to be show in the interface. - * @param panel The panel widget to show. - * @note If you are connected to this signal you should also connect + * \param panel The panel widget to show. + * \note If you are connected to this signal you should also connect * given panels showPanel signal as they can be nested. */ void showPanel( QgsPanelWidget *panel ); @@ -107,7 +107,7 @@ class GUI_EXPORT QgsRendererPropertiesDialog : public QDialog, private Ui::QgsRe * If dock mode is false this method will open a dialog * and block the user. * - * @param panel The panel widget to open. + * \param panel The panel widget to open. */ void openPanel( QgsPanelWidget *panel ); @@ -128,8 +128,8 @@ class GUI_EXPORT QgsRendererPropertiesDialog : public QDialog, private Ui::QgsRe * Each widget is checked for type and the common type of signal is connected * to the slot. * - * @param widgets The list of widgets to check. - * @param slot The slot to connect to the signals. + * \param widgets The list of widgets to check. + * \param slot The slot to connect to the signals. */ void connectValueChanged( const QList &widgets, const char *slot ); diff --git a/src/gui/symbology-ng/qgsrendererwidget.h b/src/gui/symbology-ng/qgsrendererwidget.h index 85d3a6c8fa76..ae6f42d0f12a 100644 --- a/src/gui/symbology-ng/qgsrendererwidget.h +++ b/src/gui/symbology-ng/qgsrendererwidget.h @@ -52,14 +52,14 @@ class GUI_EXPORT QgsRendererWidget : public QgsPanelWidget void showSymbolLevelsDialog( QgsFeatureRenderer *r ); /** Sets the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts. - * @param context symbol widget context - * @see context() + * \param context symbol widget context + * \see context() * \since QGIS 3.0 */ virtual void setContext( const QgsSymbolWidgetContext &context ); /** Returns the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts. - * @see setContext() + * \see setContext() * \since QGIS 3.0 */ QgsSymbolWidgetContext context() const; @@ -149,21 +149,21 @@ class GUI_EXPORT QgsDataDefinedValueDialog : public QDialog, public Ui::QgsDataD public: /** Constructor - * @param symbolList must not be empty - * @param layer must not be null - * @param label value label + * \param symbolList must not be empty + * \param layer must not be null + * \param label value label */ QgsDataDefinedValueDialog( const QList &symbolList, QgsVectorLayer *layer, const QString &label ); /** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @param context symbol widget context - * @see context() + * \param context symbol widget context + * \see context() * \since QGIS 3.0 */ void setContext( const QgsSymbolWidgetContext &context ); /** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @see setContext() + * \see setContext() * \since QGIS 3.0 */ QgsSymbolWidgetContext context() const; @@ -181,7 +181,7 @@ class GUI_EXPORT QgsDataDefinedValueDialog : public QDialog, public Ui::QgsDataD /** * Should be called in the constructor of child classes. * - * @note May be missing Python bindings depending on the platform. + * \note May be missing Python bindings depending on the platform. */ void init( int propertyKey ); // needed in children ctor to call virtual diff --git a/src/gui/symbology-ng/qgsrulebasedrendererwidget.h b/src/gui/symbology-ng/qgsrulebasedrendererwidget.h index 87da1355e5a2..af745083beb0 100644 --- a/src/gui/symbology-ng/qgsrulebasedrendererwidget.h +++ b/src/gui/symbology-ng/qgsrulebasedrendererwidget.h @@ -82,7 +82,7 @@ class GUI_EXPORT QgsRuleBasedRendererModel : public QAbstractItemModel void willAddRules( const QModelIndex &parent, int count ); // call beginInsertRows void finishedAddingRules(); // call endInsertRows - //! @note not available in Python bindungs + //! \note not available in Python bindungs void setFeatureCounts( const QHash &countMap ); void clearFeatureCounts(); @@ -185,17 +185,17 @@ class GUI_EXPORT QgsRendererRulePropsWidget : public QgsPanelWidget, private Ui: /** * Widget to edit the details of a rule based renderer rule. - * @param rule The rule to edit. - * @param layer The layer used to pull layer related information. - * @param style The active QGIS style. - * @param parent The parent widget. - * @param context the symbol widget context + * \param rule The rule to edit. + * \param layer The layer used to pull layer related information. + * \param style The active QGIS style. + * \param parent The parent widget. + * \param context the symbol widget context */ QgsRendererRulePropsWidget( QgsRuleBasedRenderer::Rule *rule, QgsVectorLayer *layer, QgsStyle *style, QWidget *parent = nullptr, const QgsSymbolWidgetContext &context = QgsSymbolWidgetContext() ); /** * Return the current set rule. - * @return The current rule. + * \returns The current rule. */ QgsRuleBasedRenderer::Rule *rule() { return mRule; } @@ -218,7 +218,7 @@ class GUI_EXPORT QgsRendererRulePropsWidget : public QgsPanelWidget, private Ui: /** * Set the widget in dock mode. - * @param dockMode True for dock mode. + * \param dockMode True for dock mode. */ virtual void setDockMode( bool dockMode ); @@ -242,11 +242,11 @@ class GUI_EXPORT QgsRendererRulePropsDialog : public QDialog public: /** Constructor for QgsRendererRulePropsDialog - * @param rule associated rule based renderer rule - * @param layer source vector layer - * @param style style collection - * @param parent parent widget - * @param context symbol widget context + * \param rule associated rule based renderer rule + * \param layer source vector layer + * \param style style collection + * \param parent parent widget + * \param context symbol widget context */ QgsRendererRulePropsDialog( QgsRuleBasedRenderer::Rule *rule, QgsVectorLayer *layer, QgsStyle *style, QWidget *parent = nullptr, const QgsSymbolWidgetContext &context = QgsSymbolWidgetContext() ); diff --git a/src/gui/symbology-ng/qgssinglesymbolrendererwidget.h b/src/gui/symbology-ng/qgssinglesymbolrendererwidget.h index 4f6d5edd7c3e..01e6a6c3d715 100644 --- a/src/gui/symbology-ng/qgssinglesymbolrendererwidget.h +++ b/src/gui/symbology-ng/qgssinglesymbolrendererwidget.h @@ -43,7 +43,7 @@ class GUI_EXPORT QgsSingleSymbolRendererWidget : public QgsRendererWidget /** * Set the widget in dock mode which tells the widget to emit panel * widgets and not open dialogs - * @param dockMode True to enable dock mode. + * \param dockMode True to enable dock mode. */ virtual void setDockMode( bool dockMode ) override; diff --git a/src/gui/symbology-ng/qgssmartgroupeditordialog.h b/src/gui/symbology-ng/qgssmartgroupeditordialog.h index 3dfd8e94f6fa..a15cce3b5383 100644 --- a/src/gui/symbology-ng/qgssmartgroupeditordialog.h +++ b/src/gui/symbology-ng/qgssmartgroupeditordialog.h @@ -77,14 +77,14 @@ class GUI_EXPORT QgsSmartGroupEditorDialog : public QDialog, private Ui::QgsSmar QString smartgroupName(); //! returns the condition map - //! @note not available in Python bindings + //! \note not available in Python bindings QgsSmartConditionMap conditionMap(); //! returns the AND/OR condition QString conditionOperator(); //! sets up the GUI for the given conditionmap - //! @note not available in Python bindings + //! \note not available in Python bindings void setConditionMap( const QgsSmartConditionMap & ); //! sets the operator AND/OR diff --git a/src/gui/symbology-ng/qgsstyleexportimportdialog.h b/src/gui/symbology-ng/qgsstyleexportimportdialog.h index e19925c06ce1..f99eccbd08c4 100644 --- a/src/gui/symbology-ng/qgsstyleexportimportdialog.h +++ b/src/gui/symbology-ng/qgsstyleexportimportdialog.h @@ -51,14 +51,14 @@ class GUI_EXPORT QgsStyleExportImportDialog : public QDialog, private Ui::QgsSty ~QgsStyleExportImportDialog(); /** - * @brief selectSymbols select symbols by name - * @param symbolNames list of symbol names + * \brief selectSymbols select symbols by name + * \param symbolNames list of symbol names */ void selectSymbols( const QStringList &symbolNames ); /** - * @brief deselectSymbols deselect symbols by name - * @param symbolNames list of symbol names + * \brief deselectSymbols deselect symbols by name + * \param symbolNames list of symbol names */ void deselectSymbols( const QStringList &symbolNames ); @@ -66,41 +66,41 @@ class GUI_EXPORT QgsStyleExportImportDialog : public QDialog, private Ui::QgsSty void doExportImport(); /** - * @brief selectByGroup open select by group dialog + * \brief selectByGroup open select by group dialog */ void selectByGroup(); /** - * @brief selectAll selects all symbols + * \brief selectAll selects all symbols */ void selectAll(); /** - * @brief clearSelection deselects all symbols + * \brief clearSelection deselects all symbols */ void clearSelection(); /** * Select the symbols belonging to the given tag - * @param tagName the name of the group to be selected + * \param tagName the name of the group to be selected */ void selectTag( const QString &tagName ); /** * Deselect the symbols belonging to the given tag - * @param tagName the name of the group to be deselected + * \param tagName the name of the group to be deselected */ void deselectTag( const QString &tagName ); /** - * @brief selectSmartgroup selects all symbols from a smart group - * @param groupName + * \brief selectSmartgroup selects all symbols from a smart group + * \param groupName */ void selectSmartgroup( const QString &groupName ); /** - * @brief deselectSmartgroup deselects all symbols from a smart group - * @param groupName + * \brief deselectSmartgroup deselects all symbols from a smart group + * \param groupName */ void deselectSmartgroup( const QString &groupName ); diff --git a/src/gui/symbology-ng/qgsstylegroupselectiondialog.h b/src/gui/symbology-ng/qgsstylegroupselectiondialog.h index 37f37413163e..558a6cf6d3a5 100644 --- a/src/gui/symbology-ng/qgsstylegroupselectiondialog.h +++ b/src/gui/symbology-ng/qgsstylegroupselectiondialog.h @@ -57,8 +57,8 @@ class GUI_EXPORT QgsStyleGroupSelectionDialog : public QDialog, private Ui::Symb private: /** - * @brief build group tree - * @param parent + * \brief build group tree + * \param parent */ void buildTagTree( QStandardItem *&parent ); QgsStyle *mStyle = nullptr; diff --git a/src/gui/symbology-ng/qgsstylesavedialog.h b/src/gui/symbology-ng/qgsstylesavedialog.h index 996931bc8897..ec2714337295 100644 --- a/src/gui/symbology-ng/qgsstylesavedialog.h +++ b/src/gui/symbology-ng/qgsstylesavedialog.h @@ -35,8 +35,8 @@ class GUI_EXPORT QgsStyleSaveDialog: public QDialog, private Ui::QgsStyleSaveDia public: /** Constructor for QgsSymbolSaveDialog - * @param parent parent widget - * @param type the QgsStyle entity type being saved + * \param parent parent widget + * \param type the QgsStyle entity type being saved */ QgsStyleSaveDialog( QWidget *parent = nullptr, QgsStyle::StyleEntity type = QgsStyle::SymbolEntity ); diff --git a/src/gui/symbology-ng/qgssvgselectorwidget.h b/src/gui/symbology-ng/qgssvgselectorwidget.h index 2d3764891f1e..19b91e86a772 100644 --- a/src/gui/symbology-ng/qgssvgselectorwidget.h +++ b/src/gui/symbology-ng/qgssvgselectorwidget.h @@ -51,7 +51,7 @@ class GUI_EXPORT QgsSvgSelectorLoader : public QThread public: /** Constructor for QgsSvgSelectorLoader - * @param parent parent object + * \param parent parent object */ QgsSvgSelectorLoader( QObject *parent = nullptr ); @@ -59,7 +59,7 @@ class GUI_EXPORT QgsSvgSelectorLoader : public QThread /** Starts the loader finding and generating previews for SVG images. foundSvgs() will be * emitted as the loader encounters SVG images. - * @brief run + * \brief run */ virtual void run() override; @@ -80,7 +80,7 @@ class GUI_EXPORT QgsSvgSelectorLoader : public QThread /** Emitted when the loader has found a block of SVG images. This signal is emitted with blocks * of SVG images to prevent spamming any connected model. - * @param svgs list of SVGs and preview images found. + * \param svgs list of SVGs and preview images found. */ void foundSvgs( QStringList svgs ); @@ -111,14 +111,14 @@ class GUI_EXPORT QgsSvgGroupLoader : public QThread public: /** Constructor for QgsSvgGroupLoader - * @param parent parent object + * \param parent parent object */ QgsSvgGroupLoader( QObject *parent = nullptr ); ~QgsSvgGroupLoader(); /** Starts the loader finding folders for SVG images. - * @brief run + * \brief run */ virtual void run() override; @@ -139,7 +139,7 @@ class GUI_EXPORT QgsSvgGroupLoader : public QThread /** Emitted when the loader has found a block of SVG images. This signal is emitted with blocks * of SVG images to prevent spamming any connected model. - * @param svgs list of SVGs and preview images found. + * \param svgs list of SVGs and preview images found. */ void foundPath( const QString &parentPath, const QString &path ); @@ -170,13 +170,13 @@ class GUI_EXPORT QgsSvgSelectorListModel : public QAbstractListModel /** Constructor for QgsSvgSelectorListModel. All SVGs in folders from the application SVG * search paths will be shown. - * @param parent parent object + * \param parent parent object */ QgsSvgSelectorListModel( QObject *parent ); /** Constructor for creating a model for SVG files in a specific path. - * @param parent parent object - * @param path initial path, which is recursively searched + * \param parent parent object + * \param path initial path, which is recursively searched */ QgsSvgSelectorListModel( QObject *parent, const QString &path ); @@ -193,7 +193,7 @@ class GUI_EXPORT QgsSvgSelectorListModel : public QAbstractListModel private slots: /** Called to add SVG files to the model. - * @param svgs list of SVG files to add to model. + * \param svgs list of SVG files to add to model. */ void addSvgs( const QStringList &svgs ); diff --git a/src/gui/symbology-ng/qgssymbollayerwidget.cpp b/src/gui/symbology-ng/qgssymbollayerwidget.cpp index 418fda87a052..4df354bf1d85 100644 --- a/src/gui/symbology-ng/qgssymbollayerwidget.cpp +++ b/src/gui/symbology-ng/qgssymbollayerwidget.cpp @@ -2695,7 +2695,7 @@ void QgsFontMarkerSymbolLayerWidget::setSymbolLayer( QgsSymbolLayer *layer ) whileBlocking( spinAngle )->setValue( mLayer->angle() ); widgetChar->blockSignals( true ); - widgetChar->updateFont( layerFont ); + widgetChar->setFont( layerFont ); widgetChar->setCharacter( mLayer->character() ); widgetChar->blockSignals( false ); @@ -2746,7 +2746,7 @@ QgsSymbolLayer *QgsFontMarkerSymbolLayerWidget::symbolLayer() void QgsFontMarkerSymbolLayerWidget::setFontFamily( const QFont &font ) { mLayer->setFontFamily( font.family() ); - widgetChar->updateFont( font ); + widgetChar->setFont( font ); emit changed(); } diff --git a/src/gui/symbology-ng/qgssymbollayerwidget.h b/src/gui/symbology-ng/qgssymbollayerwidget.h index 0ba6229e378c..6257d2820ba2 100644 --- a/src/gui/symbology-ng/qgssymbollayerwidget.h +++ b/src/gui/symbology-ng/qgssymbollayerwidget.h @@ -44,14 +44,14 @@ class GUI_EXPORT QgsSymbolLayerWidget : public QWidget, protected QgsExpressionC virtual QgsSymbolLayer *symbolLayer() = 0; /** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @param context symbol widget context - * @see context() + * \param context symbol widget context + * \see context() * \since QGIS 3.0 */ void setContext( const QgsSymbolWidgetContext &context ); /** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @see setContext() + * \see setContext() * \since QGIS 3.0 */ QgsSymbolWidgetContext context() const; @@ -82,15 +82,15 @@ class GUI_EXPORT QgsSymbolLayerWidget : public QWidget, protected QgsExpressionC /** * Should be emitted whenever configuration changes happened on this symbol layer configuration. - * If the subsymbol is changed, {@link symbolChanged()} should be emitted instead. + * If the subsymbol is changed, symbolChanged() should be emitted instead. */ void changed(); /** * Should be emitted whenever the sub symbol changed on this symbol layer configuration. - * Normally {@link changed()} should be preferred. + * Normally changed() should be preferred. * - * @see {@link changed()} + * \see changed() */ void symbolChanged(); @@ -256,13 +256,13 @@ class GUI_EXPORT QgsFilledMarkerSymbolLayerWidget : public QgsSymbolLayerWidget, public: /** Constructor for QgsFilledMarkerSymbolLayerWidget. - * @param vl associated vector layer - * @param parent parent widget + * \param vl associated vector layer + * \param parent parent widget */ QgsFilledMarkerSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent = nullptr ); /** Creates a new QgsFilledMarkerSymbolLayerWidget. - * @param vl associated vector layer + * \param vl associated vector layer */ static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) { return new QgsFilledMarkerSymbolLayerWidget( vl ); } @@ -537,7 +537,7 @@ class GUI_EXPORT QgsSVGFillSymbolLayerWidget : public QgsSymbolLayerWidget, priv /** Enables or disables svg fill color, stroke color and stroke width based on whether the * svg file supports custom parameters. - * @param resetValues set to true to overwrite existing layer fill color, stroke color and stroke width + * \param resetValues set to true to overwrite existing layer fill color, stroke color and stroke width * with default values from svg file */ void updateParamGui( bool resetValues = true ); diff --git a/src/gui/symbology-ng/qgssymbollevelsdialog.h b/src/gui/symbology-ng/qgssymbollevelsdialog.h index 4195ffc8444c..a326bf321b3d 100644 --- a/src/gui/symbology-ng/qgssymbollevelsdialog.h +++ b/src/gui/symbology-ng/qgssymbollevelsdialog.h @@ -31,7 +31,7 @@ class GUI_EXPORT QgsSymbolLevelsDialog : public QDialog, private Ui::QgsSymbolLe { Q_OBJECT public: - //! @note not available in Python bindings + //! \note not available in Python bindings QgsSymbolLevelsDialog( const QgsLegendSymbolList &list, bool usingSymbolLevels, QWidget *parent = nullptr ); ~QgsSymbolLevelsDialog(); @@ -47,9 +47,9 @@ class GUI_EXPORT QgsSymbolLevelsDialog : public QDialog, private Ui::QgsSymbolLe void renderingPassChanged( int row, int column ); protected: - //! @note not available in Python bindings + //! \note not available in Python bindings void populateTable(); - //! @note not available in Python bindings + //! \note not available in Python bindings void setDefaultLevels(); protected: diff --git a/src/gui/symbology-ng/qgssymbolselectordialog.h b/src/gui/symbology-ng/qgssymbolselectordialog.h index f30ecabbee0f..f753a8d53ffb 100644 --- a/src/gui/symbology-ng/qgssymbolselectordialog.h +++ b/src/gui/symbology-ng/qgssymbolselectordialog.h @@ -89,10 +89,10 @@ class GUI_EXPORT QgsSymbolSelectorWidget: public QgsPanelWidget, private Ui::Qgs /** * Symbol selector widget that can be used to select and build a symbol - * @param symbol The symbol to load into the widget as a start point. - * @param style The style used by the widget. - * @param vl The vector layer for the symbol. - * @param parent + * \param symbol The symbol to load into the widget as a start point. + * \param style The style used by the widget. + * \param vl The vector layer for the symbol. + * \param parent */ QgsSymbolSelectorWidget( QgsSymbol *symbol, QgsStyle *style, const QgsVectorLayer *vl, QWidget *parent = nullptr ); @@ -100,21 +100,21 @@ class GUI_EXPORT QgsSymbolSelectorWidget: public QgsPanelWidget, private Ui::Qgs QMenu *advancedMenu(); /** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @param context symbol widget context - * @see context() + * \param context symbol widget context + * \see context() * \since QGIS 3.0 */ void setContext( const QgsSymbolWidgetContext &context ); /** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @see setContext() + * \see setContext() * \since QGIS 3.0 */ QgsSymbolWidgetContext context() const; /** - * @brief Return the symbol that is currently active in the widget. Can be null. - * @return The active symbol. + * \brief Return the symbol that is currently active in the widget. Can be null. + * \returns The active symbol. */ QgsSymbol *symbol() { return mSymbol; } @@ -124,12 +124,12 @@ class GUI_EXPORT QgsSymbolSelectorWidget: public QgsPanelWidget, private Ui::Qgs * Reload the current symbol in the view. */ void loadSymbol(); - //! @note not available in Python bindings + //! \note not available in Python bindings /** * Load the given symbol into the widget.. - * @param symbol The symbol to load. - * @param parent The parent symbol layer item. + * \param symbol The symbol to load. + * \param parent The parent symbol layer item. */ void loadSymbol( QgsSymbol *symbol, SymbolLayerItem *parent ); @@ -143,24 +143,24 @@ class GUI_EXPORT QgsSymbolSelectorWidget: public QgsPanelWidget, private Ui::Qgs */ void updateLockButton(); - //! @note not available in Python bindings + //! \note not available in Python bindings SymbolLayerItem *currentLayerItem(); /** * The current symbol layer that is active in the interface. - * @return The active symbol layer. + * \returns The active symbol layer. */ QgsSymbolLayer *currentLayer(); /** * Move the current active layer by a set offset in the list. - * @param offset The offset to move the layer by + * \param offset The offset to move the layer by */ void moveLayerByOffset( int offset ); /** * Set the properties widget for the active symbol layer. - * @param widget The widget to set to configure the active symbol layer. + * \param widget The widget to set to configure the active symbol layer. */ void setWidget( QWidget *widget ); @@ -221,7 +221,7 @@ class GUI_EXPORT QgsSymbolSelectorWidget: public QgsPanelWidget, private Ui::Qgs //! Slot to update tree when a new symbol from style void symbolChanged(); //! alters tree and sets proper widget when Layer Type is changed - //! @note: The layer is received from the LayerPropertiesWidget + //! \note: The layer is received from the LayerPropertiesWidget void changeLayer( QgsSymbolLayer *layer ); @@ -254,21 +254,21 @@ class GUI_EXPORT QgsSymbolSelectorDialog : public QDialog QMenu *advancedMenu(); /** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @param context symbol widget context - * @see context() + * \param context symbol widget context + * \see context() * \since QGIS 3.0 */ void setContext( const QgsSymbolWidgetContext &context ); /** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @see setContext() + * \see setContext() * \since QGIS 3.0 */ QgsSymbolWidgetContext context() const; /** - * @brief Return the symbol that is currently active in the widget. Can be null. - * @return The active symbol. + * \brief Return the symbol that is currently active in the widget. Can be null. + * \returns The active symbol. */ QgsSymbol *symbol(); @@ -277,14 +277,14 @@ class GUI_EXPORT QgsSymbolSelectorDialog : public QDialog void keyPressEvent( QKeyEvent *e ) override; void loadSymbol(); - //! @note not available in Python bindings + //! \note not available in Python bindings void loadSymbol( QgsSymbol *symbol, SymbolLayerItem *parent ); void updateUi(); void updateLockButton(); - //! @note not available in Python bindings + //! \note not available in Python bindings SymbolLayerItem *currentLayerItem(); QgsSymbolLayer *currentLayer(); @@ -316,7 +316,7 @@ class GUI_EXPORT QgsSymbolSelectorDialog : public QDialog //! Slot to update tree when a new symbol from style void symbolChanged(); //! alters tree and sets proper widget when Layer Type is changed - //! @note: The layer is received from the LayerPropertiesWidget + //! \note: The layer is received from the LayerPropertiesWidget void changeLayer( QgsSymbolLayer *layer ); private: diff --git a/src/gui/symbology-ng/qgssymbolslistwidget.h b/src/gui/symbology-ng/qgssymbolslistwidget.h index e7daa4dbd2a1..65da9e425e0f 100644 --- a/src/gui/symbology-ng/qgssymbolslistwidget.h +++ b/src/gui/symbology-ng/qgssymbolslistwidget.h @@ -43,14 +43,14 @@ class GUI_EXPORT QgsSymbolsListWidget : public QWidget, private Ui::SymbolsListW virtual ~QgsSymbolsListWidget(); /** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @param context symbol widget context - * @see context() + * \param context symbol widget context + * \see context() * \since QGIS 3.0 */ void setContext( const QgsSymbolWidgetContext &context ); /** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @see setContext() + * \see setContext() * \since QGIS 3.0 */ QgsSymbolWidgetContext context() const; diff --git a/src/gui/symbology-ng/qgssymbolwidgetcontext.h b/src/gui/symbology-ng/qgssymbolwidgetcontext.h index bb2e14296630..39403db8ea8f 100644 --- a/src/gui/symbology-ng/qgssymbolwidgetcontext.h +++ b/src/gui/symbology-ng/qgssymbolwidgetcontext.h @@ -36,7 +36,7 @@ class GUI_EXPORT QgsSymbolWidgetContext // clazy:exclude=rule-of-three QgsSymbolWidgetContext(); /** Copy constructor. - * @param other source QgsSymbolWidgetContext + * \param other source QgsSymbolWidgetContext */ QgsSymbolWidgetContext( const QgsSymbolWidgetContext &other ); @@ -44,40 +44,40 @@ class GUI_EXPORT QgsSymbolWidgetContext // clazy:exclude=rule-of-three /** Sets the map canvas associated with the widget. This allows the widget to retrieve the current * map scale and other properties from the canvas. - * @param canvas map canvas - * @see mapCanvas() + * \param canvas map canvas + * \see mapCanvas() */ void setMapCanvas( QgsMapCanvas *canvas ); /** Returns the map canvas associated with the widget. - * @see setMapCanvas() + * \see setMapCanvas() */ QgsMapCanvas *mapCanvas() const; /** Sets the optional expression context used for the widget. This expression context is used for * evaluating data defined symbol properties and for populating based expression widgets in * the layer widget. - * @param context expression context pointer. Ownership is not transferred. - * @see expressionContext() - * @see setAdditionalExpressionContextScopes() + * \param context expression context pointer. Ownership is not transferred. + * \see expressionContext() + * \see setAdditionalExpressionContextScopes() */ void setExpressionContext( QgsExpressionContext *context ); /** Returns the expression context used for the widget, if set. This expression context is used for * evaluating data defined symbol properties and for populating based expression widgets in * the layer widget. - * @see setExpressionContext() + * \see setExpressionContext() */ QgsExpressionContext *expressionContext() const; /** Sets a list of additional expression context scopes to show as available within the layer. - * @param scopes list of additional scopes which will be added in order to the end of the default expression context - * @see setExpressionContext() + * \param scopes list of additional scopes which will be added in order to the end of the default expression context + * \see setExpressionContext() */ void setAdditionalExpressionContextScopes( const QList< QgsExpressionContextScope > &scopes ); /** Returns the list of additional expression context scopes to show as available within the layer. - * @see setAdditionalExpressionContextScopes() + * \see setAdditionalExpressionContextScopes() */ QList< QgsExpressionContextScope > additionalExpressionContextScopes() const; diff --git a/src/plugins/compass/qgscompassplugin.h b/src/plugins/compass/qgscompassplugin.h index 90c5a1ebd5be..51ec3b5e6584 100644 --- a/src/plugins/compass/qgscompassplugin.h +++ b/src/plugins/compass/qgscompassplugin.h @@ -36,7 +36,7 @@ class QgsCompassPlugin: public QObject, public QgisPlugin, private Ui::QgsCompas /** * Constructor for a plugin. The QgisInterface pointer is passed by * QGIS when it attempts to instantiate the plugin. - * @param qI Pointer to the QgisInterface object + * \param qI Pointer to the QgisInterface object */ explicit QgsCompassPlugin( QgisInterface * ); diff --git a/src/plugins/coordinate_capture/coordinatecapture.h b/src/plugins/coordinate_capture/coordinatecapture.h index 41904c7c7a64..0713ff7d1244 100644 --- a/src/plugins/coordinate_capture/coordinatecapture.h +++ b/src/plugins/coordinate_capture/coordinatecapture.h @@ -77,7 +77,7 @@ class CoordinateCapture: public QObject, public QgisPlugin /** * Constructor for a plugin. The QgisInterface pointer is passed by * QGIS when it attempts to instantiate the plugin. - * @param interface Pointer to the QgisInterface object. + * \param interface Pointer to the QgisInterface object. */ explicit CoordinateCapture( QgisInterface *interface ); diff --git a/src/plugins/coordinate_capture/coordinatecapturegui.h b/src/plugins/coordinate_capture/coordinatecapturegui.h index 517d5b6292e4..929fbb6938d3 100644 --- a/src/plugins/coordinate_capture/coordinatecapturegui.h +++ b/src/plugins/coordinate_capture/coordinatecapturegui.h @@ -16,7 +16,6 @@ #include "qgshelp.h" /** -@author Tim Sutton */ class CoordinateCaptureGui : public QDialog { diff --git a/src/plugins/geometry_checker/utils/qgsgeometrycheckerutils.h b/src/plugins/geometry_checker/utils/qgsgeometrycheckerutils.h index 28b52bedd6f2..fdcf9701f49a 100644 --- a/src/plugins/geometry_checker/utils/qgsgeometrycheckerutils.h +++ b/src/plugins/geometry_checker/utils/qgsgeometrycheckerutils.h @@ -33,9 +33,9 @@ namespace QgsGeometryCheckerUtils void filter1DTypes( QgsAbstractGeometry *geom ); /** - * @brief Return the number of points in a polyline, accounting for duplicate start and end point if the polyline is closed - * @param polyLine The polyline - * @return The number of distinct points of the polyline + * \brief Return the number of points in a polyline, accounting for duplicate start and end point if the polyline is closed + * \param polyLine The polyline + * \returns The number of distinct points of the polyline */ inline int polyLineSize( const QgsAbstractGeometry *geom, int iPart, int iRing, bool *isClosed = nullptr ) { @@ -60,11 +60,11 @@ namespace QgsGeometryCheckerUtils double sharedEdgeLength( const QgsAbstractGeometry *geom1, const QgsAbstractGeometry *geom2, double tol ); /** - * @brief Determine whether two points are equal up to the specified tolerance - * @param p1 The first point - * @param p2 The second point - * @param tol The tolerance - * @return Whether the points are equal + * \brief Determine whether two points are equal up to the specified tolerance + * \param p1 The first point + * \param p2 The second point + * \param tol The tolerance + * \returns Whether the points are equal */ inline bool pointsFuzzyEqual( const QgsPointV2 &p1, const QgsPointV2 &p2, double tol ) { diff --git a/src/plugins/georeferencer/qgsgeorefplugin.h b/src/plugins/georeferencer/qgsgeorefplugin.h index c1457bb20c9e..e051915288be 100644 --- a/src/plugins/georeferencer/qgsgeorefplugin.h +++ b/src/plugins/georeferencer/qgsgeorefplugin.h @@ -71,8 +71,8 @@ class QgsGeorefPlugin: public QObject, public QgisPlugin /** * Constructor for a plugin. The QgisApp and QgisIface pointers are passed by * QGIS when it attempts to instantiate the plugin. - * @param Pointer to the QgisApp object - * @param Pointer to the QgisIface object. + * \param Pointer to the QgisApp object + * \param Pointer to the QgisIface object. */ explicit QgsGeorefPlugin( QgisInterface * ); diff --git a/src/plugins/georeferencer/qgsgeorefplugingui.h b/src/plugins/georeferencer/qgsgeorefplugingui.h index 83ed666a03eb..931763f7c16c 100644 --- a/src/plugins/georeferencer/qgsgeorefplugingui.h +++ b/src/plugins/georeferencer/qgsgeorefplugingui.h @@ -192,8 +192,8 @@ class QgsGeorefPluginGui : public QMainWindow, private Ui::QgsGeorefPluginGuiBas * ground control points and transform method. * Note that the RMSE measure is adjusted for the degrees of freedom of the * used polynomial transform. - * @param error out: the mean error - * @return true in case of success + * \param error out: the mean error + * \returns true in case of success */ bool calculateMeanError( double &error ) const; diff --git a/src/plugins/gps_importer/qgsgpsplugin.h b/src/plugins/gps_importer/qgsgpsplugin.h index 245987c5b7c0..ae21d6b08c11 100644 --- a/src/plugins/gps_importer/qgsgpsplugin.h +++ b/src/plugins/gps_importer/qgsgpsplugin.h @@ -37,7 +37,7 @@ class QgsGPSPlugin: public QObject, public QgisPlugin /** Constructor for a plugin. The QgisInterface pointer * is passed by QGIS when it attempts to instantiate the plugin. - * @param qI Pointer to the QgisInterface object. + * \param qI Pointer to the QgisInterface object. */ explicit QgsGPSPlugin( QgisInterface * ); diff --git a/src/plugins/gps_importer/qgsgpsplugingui.h b/src/plugins/gps_importer/qgsgpsplugingui.h index f125615c706e..1ccce24e32d6 100644 --- a/src/plugins/gps_importer/qgsgpsplugingui.h +++ b/src/plugins/gps_importer/qgsgpsplugingui.h @@ -29,7 +29,6 @@ /** -@author Tim Sutton */ class QgsGPSPluginGui : public QDialog, private Ui::QgsGPSPluginGuiBase { diff --git a/src/plugins/grass/qgsgrassmodule.h b/src/plugins/grass/qgsgrassmodule.h index bfbab3fad416..900a05d8b1b5 100644 --- a/src/plugins/grass/qgsgrassmodule.h +++ b/src/plugins/grass/qgsgrassmodule.h @@ -127,8 +127,8 @@ class QgsGrassModule : public QWidget, private Ui::QgsGrassModuleBase private: /** Set progress bar or busy indicator if percent is 100 - * @param percent progress to show in % - * @param force to set progress for 100% */ + * \param percent progress to show in % + * \param force to set progress for 100% */ void setProgress( int percent, bool force = false ); //! Pointer to the QGIS interface object diff --git a/src/plugins/grass/qgsgrassmoduleoptions.h b/src/plugins/grass/qgsgrassmoduleoptions.h index 1e97223dc90e..e8424ec2f274 100644 --- a/src/plugins/grass/qgsgrassmoduleoptions.h +++ b/src/plugins/grass/qgsgrassmoduleoptions.h @@ -181,12 +181,12 @@ class QgsGrassModuleStandardOptions: public QWidget, public QgsGrassModuleOption private: /** Read and parse module options (--interface-description). - * @param errors - list to which possible errors are added + * \param errors - list to which possible errors are added */ QDomDocument readInterfaceDescription( const QString &xname, QStringList &errors ); /** Get region for currently selected map. It will show warning dialog if region could not be read. - * @return true if region was successfully read + * \returns true if region was successfully read */ bool getCurrentMapRegion( QgsGrassModuleInput *param, struct Cell_head *window ); diff --git a/src/plugins/grass/qgsgrassplugin.h b/src/plugins/grass/qgsgrassplugin.h index 9e1848479faa..92643fa19cee 100644 --- a/src/plugins/grass/qgsgrassplugin.h +++ b/src/plugins/grass/qgsgrassplugin.h @@ -49,7 +49,7 @@ class QgsGrassPlugin : public QObject, public QgisPlugin /** * Constructor for a plugin. The QgisInterface pointer is passed by * QGIS when it attempts to instantiate the plugin. - * @param qI Pointer to the QgisInterface object. + * \param qI Pointer to the QgisInterface object. */ explicit QgsGrassPlugin( QgisInterface *qI ); diff --git a/src/plugins/grass/qtermwidget/Character.h b/src/plugins/grass/qtermwidget/Character.h index 9a0a42da60e0..313666a4ffea 100644 --- a/src/plugins/grass/qtermwidget/Character.h +++ b/src/plugins/grass/qtermwidget/Character.h @@ -59,10 +59,10 @@ class Character /** * Constructs a new character. * - * @param _c The unicode character value of this character. - * @param _f The foreground color used to draw the character. - * @param _b The color used to draw the character's background. - * @param _r A set of rendition flags which specify how this character is to be drawn. + * \param _c The unicode character value of this character. + * \param _f The foreground color used to draw the character. + * \param _b The color used to draw the character's background. + * \param _r A set of rendition flags which specify how this character is to be drawn. */ inline Character(quint16 _c = ' ', CharacterColor _f = CharacterColor(COLOR_SPACE_DEFAULT,DEFAULT_FORE_COLOR), @@ -187,19 +187,19 @@ class ExtendedCharTable * If the same sequence already exists in the table, the hash * of the existing sequence will be returned. * - * @param unicodePoints An array of unicode character points - * @param length Length of @p unicodePoints + * \param unicodePoints An array of unicode character points + * \param length Length of @p unicodePoints */ ushort createExtendedChar(ushort* unicodePoints , ushort length); /** * Looks up and returns a pointer to a sequence of unicode characters * which was added to the table using createExtendedChar(). * - * @param hash The hash key returned by createExtendedChar() - * @param length This variable is set to the length of the + * \param hash The hash key returned by createExtendedChar() + * \param length This variable is set to the length of the * character sequence. * - * @return A unicode character sequence of size @p length. + * \returns A unicode character sequence of size @p length. */ ushort* lookupExtendedChar(ushort hash , ushort& length) const; diff --git a/src/plugins/grass/qtermwidget/CharacterColor.h b/src/plugins/grass/qtermwidget/CharacterColor.h index 248885ca8c0f..423d8cad443d 100644 --- a/src/plugins/grass/qtermwidget/CharacterColor.h +++ b/src/plugins/grass/qtermwidget/CharacterColor.h @@ -65,9 +65,9 @@ class ColorEntry /** * Constructs a new color palette entry. * - * @param c The color value for this entry. - * @param tr Specifies that the color should be transparent when used as a background color. - * @param weight Specifies the font weight to use when drawing text with this color. + * \param c The color value for this entry. + * \param tr Specifies that the color should be transparent when used as a background color. + * \param weight Specifies the font weight to use when drawing text with this color. */ ColorEntry(QColor c, bool tr, FontWeight weight = UseCurrentFormat) : color(c), transparent(tr), fontWeight(weight) {} diff --git a/src/plugins/grass/qtermwidget/ColorScheme.h b/src/plugins/grass/qtermwidget/ColorScheme.h index dd9e89d28879..b22e071e8f46 100644 --- a/src/plugins/grass/qtermwidget/ColorScheme.h +++ b/src/plugins/grass/qtermwidget/ColorScheme.h @@ -82,9 +82,9 @@ class ColorScheme * Copies the color entries which form the palette for this color scheme * into @p table. @p table should be an array with TABLE_COLORS entries. * - * @param table Array into which the color entries for this color scheme + * \param table Array into which the color entries for this color scheme * are copied. - * @param randomSeed Color schemes may allow certain colors in their + * \param randomSeed Color schemes may allow certain colors in their * palette to be randomized. The seed is used to pick the random color. */ void getColorTable(ColorEntry* table, uint randomSeed = 0) const; @@ -314,7 +314,7 @@ class ColorSchemeManager /** Returns the global color scheme manager instance. */ static ColorSchemeManager* instance(); - /** @brief Loads a custom color scheme under given \em path. + /** \brief Loads a custom color scheme under given \em path. * * The \em path may refer to either KDE 4 .colorscheme or KDE 3 * .schema file @@ -323,8 +323,8 @@ class ColorSchemeManager * the base name of the \em path via the allColorSchemes() and * findColorScheme() methods after this call if loaded successfully. * - * @param[in] path The path to KDE 4 .colorscheme or KDE 3 .schema. - * @return Whether the color scheme is loaded successfully. + * \param[in] path The path to KDE 4 .colorscheme or KDE 3 .schema. + * \returns Whether the color scheme is loaded successfully. */ bool loadCustomColorScheme(const QString& path); private: diff --git a/src/plugins/grass/qtermwidget/Emulation.h b/src/plugins/grass/qtermwidget/Emulation.h index d934c04dd065..87117abc5cd8 100644 --- a/src/plugins/grass/qtermwidget/Emulation.h +++ b/src/plugins/grass/qtermwidget/Emulation.h @@ -164,11 +164,11 @@ Q_OBJECT * into @p stream, using @p decoder to convert the terminal * characters into text. * - * @param decoder A decoder which converts lines of terminal characters with + * \param decoder A decoder which converts lines of terminal characters with * appearance attributes into output text. PlainTextDecoder is the most commonly * used decoder. - * @param startLine Index of first line to copy - * @param endLine Index of last line to copy + * \param startLine Index of first line to copy + * \param endLine Index of last line to copy */ virtual void writeToStream(TerminalCharacterDecoder* decoder,int startLine,int endLine); @@ -244,8 +244,8 @@ public slots: /** * Sends a string of characters to the foreground terminal process. * - * @param string The characters to send. - * @param length Length of @p string or if set to a negative value, @p string will + * \param string The characters to send. + * \param length Length of @p string or if set to a negative value, @p string will * be treated as a null-terminated string and its length will be determined automatically. */ virtual void sendString(const char* string, int length = -1) = 0; @@ -259,8 +259,8 @@ public slots: * to be emitted when it expires. The timer allows multiple updates in quick * succession to be buffered into a single outputChanged() signal emission. * - * @param buffer A string of characters received from the terminal program. - * @param len The length of @p buffer + * \param buffer A string of characters received from the terminal program. + * \param len The length of @p buffer */ void receiveData(const char* buffer,int len); @@ -270,8 +270,8 @@ public slots: * Emitted when a buffer of data is ready to send to the * standard input of the terminal. * - * @param data The buffer of data ready to be sent - * @param len The length of @p data in bytes + * \param data The buffer of data ready to be sent + * \param len The length of @p data in bytes */ void sendData(const char* data,int len); @@ -279,7 +279,7 @@ public slots: * Requests that sending of input to the emulation * from the terminal process be suspended or resumed. * - * @param suspend If true, requests that sending of + * \param suspend If true, requests that sending of * input from the terminal process' stdout be * suspended. Otherwise requests that sending of * input be resumed. @@ -297,7 +297,7 @@ public slots: /** * Emitted when the activity state of the emulation is set. * - * @param state The new activity state, one of NOTIFYNORMAL, NOTIFYACTIVITY + * \param state The new activity state, one of NOTIFYNORMAL, NOTIFYACTIVITY * or NOTIFYBELL */ void stateSet(int state); @@ -320,7 +320,7 @@ public slots: * This is emitted when the program running in the shell indicates whether or * not it is interested in mouse events. * - * @param usesMouse This will be true if the program wants to be informed about + * \param usesMouse This will be true if the program wants to be informed about * mouse events or false otherwise. */ void programUsesMouseChanged(bool usesMouse); @@ -352,7 +352,7 @@ public slots: * is used to perform a whole range of tasks besides just setting * the user-title of the session. * - * @param title Specifies what to change. + * \param title Specifies what to change. *

    *
  • 0 - Set window icon text and session title to @p newTitle
    • *
  • 1 - Set window icon text to @p newTitle
    • @@ -368,7 +368,7 @@ public slots: * of the icon to use, which can be the name of any icon in the current KDE icon * theme (e.g., 'konsole', 'kate', 'folder_home') *
- * @param newTitle Specifies the new title + * \param newTitle Specifies the new title */ void titleChanged(int title,const QString& newTitle); @@ -387,14 +387,14 @@ public slots: * by a string containing a series of name and value pairs is received. * This string can be parsed using a ProfileCommandParser instance. * - * @param text A string expected to contain a series of key and value pairs in + * \param text A string expected to contain a series of key and value pairs in * the form: name=value;name2=value2 ... */ void profileChangeCommandReceived(const QString& text); /** * Emitted when a flow control key combination ( Ctrl+S or Ctrl+Q ) is pressed. - * @param suspendKeyPressed True if Ctrl+S was pressed to suspend output or Ctrl+Q to + * \param suspendKeyPressed True if Ctrl+S was pressed to suspend output or Ctrl+Q to * resume output. */ void flowControlKeyPressed(bool suspendKeyPressed); @@ -414,7 +414,7 @@ public slots: * The primary screen is used by default. When certain interactive programs such * as Vim are run, they trigger a switch to the alternate screen. * - * @param index 0 to switch to the primary screen, or 1 to switch to the alternate screen + * \param index 0 to switch to the primary screen, or 1 to switch to the alternate screen */ void setScreen(int index); diff --git a/src/plugins/grass/qtermwidget/Filter.h b/src/plugins/grass/qtermwidget/Filter.h index a7e69b25ffaa..897f26267b2c 100644 --- a/src/plugins/grass/qtermwidget/Filter.h +++ b/src/plugins/grass/qtermwidget/Filter.h @@ -105,7 +105,7 @@ class Filter : public QObject /** * Causes the an action associated with a hotspot to be triggered. * - * @param action The action to trigger. This is + * \param action The action to trigger. This is * typically empty ( in which case the default action should be performed ) or * one of the object names from the actions() list. In which case the associated * action should be performed. @@ -376,10 +376,10 @@ class TerminalImageFilterChain : public FilterChain /** * Set the current terminal image to @p image. * - * @param image The terminal image - * @param lines The number of lines in the terminal image - * @param columns The number of columns in the terminal image - * @param lineProperties The line properties to set for image + * \param image The terminal image + * \param lines The number of lines in the terminal image + * \param columns The number of columns in the terminal image + * \param lineProperties The line properties to set for image */ void setImage(const Character* const image , int lines , int columns, const QVector& lineProperties); diff --git a/src/plugins/grass/qtermwidget/KeyboardTranslator.h b/src/plugins/grass/qtermwidget/KeyboardTranslator.h index 2c0507bd3c2d..7558e13ce0be 100644 --- a/src/plugins/grass/qtermwidget/KeyboardTranslator.h +++ b/src/plugins/grass/qtermwidget/KeyboardTranslator.h @@ -147,10 +147,10 @@ class KeyboardTranslator * TODO: The numbers used to replace '*' characters are taken from the Konsole/KDE 3 code. * Document them. * - * @param expandWildCards Specifies whether wild cards (occurrences of the '*' character) in + * \param expandWildCards Specifies whether wild cards (occurrences of the '*' character) in * the entry should be replaced with a number to indicate the modifier keys being pressed. * - * @param modifiers The keyboard modifiers being pressed. + * \param modifiers The keyboard modifiers being pressed. */ QByteArray text(bool expandWildCards = false, Qt::KeyboardModifiers modifiers = Qt::NoModifier) const; @@ -164,8 +164,8 @@ class KeyboardTranslator * * e.g., \\E for Escape, \\t for tab, \\n for new line. * - * @param expandWildCards See text() - * @param modifiers See text() + * \param expandWildCards See text() + * \param modifiers See text() */ QByteArray escapedText(bool expandWildCards = false, Qt::KeyboardModifiers modifiers = Qt::NoModifier) const; @@ -227,8 +227,8 @@ class KeyboardTranslator * Returns this entry's result ( ie. its command or character sequence ) * as a string. * - * @param expandWildCards See text() - * @param modifiers See text() + * \param expandWildCards See text() + * \param modifiers See text() */ QString resultToString(bool expandWildCards = false, Qt::KeyboardModifiers modifiers = Qt::NoModifier) const; @@ -282,9 +282,9 @@ class KeyboardTranslator * Returns the matching entry if found or a null Entry otherwise ( ie. * entry.isNull() will return true ) * - * @param keyCode A key code from the Qt::Key enum - * @param modifiers A combination of modifiers - * @param state Optional flags which specify the current state of the terminal + * \param keyCode A key code from the Qt::Key enum + * \param modifiers A combination of modifiers + * \param state Optional flags which specify the current state of the terminal */ Entry findEntry(int keyCode , Qt::KeyboardModifiers modifiers , @@ -428,7 +428,7 @@ class KeyboardTranslatorWriter /** * Writes the header for the keyboard translator. - * @param description Description of the keyboard translator. + * \param description Description of the keyboard translator. */ void writeHeader( const QString& description ); /** Writes a translator entry. */ diff --git a/src/plugins/grass/qtermwidget/Pty.h b/src/plugins/grass/qtermwidget/Pty.h index e5f6cebf9b2b..c52a5692f4e8 100644 --- a/src/plugins/grass/qtermwidget/Pty.h +++ b/src/plugins/grass/qtermwidget/Pty.h @@ -86,18 +86,18 @@ Q_OBJECT * Returns 0 if the process was started successfully or non-zero * otherwise. * - * @param program Path to the program to start - * @param arguments Arguments to pass to the program being started - * @param environment A list of key=value pairs which will be added + * \param program Path to the program to start + * \param arguments Arguments to pass to the program being started + * \param environment A list of key=value pairs which will be added * to the environment for the new process. At the very least this * should include an assignment for the TERM environment variable. - * @param winid Specifies the value of the WINDOWID environment variable + * \param winid Specifies the value of the WINDOWID environment variable * in the process's environment. - * @param addToUtmp Specifies whether a utmp entry should be created for + * \param addToUtmp Specifies whether a utmp entry should be created for * the pty used. See K3Process::setUsePty() - * @param dbusService Specifies the value of the KONSOLE_DBUS_SERVICE + * \param dbusService Specifies the value of the KONSOLE_DBUS_SERVICE * environment variable in the process's environment. - * @param dbusSession Specifies the value of the KONSOLE_DBUS_SESSION + * \param dbusSession Specifies the value of the KONSOLE_DBUS_SESSION * environment variable in the process's environment. */ int start( const QString& program, @@ -163,7 +163,7 @@ Q_OBJECT * * See K3Process::suspend() and K3Process::resume() * - * @param lock If true, processing of output is suspended, + * \param lock If true, processing of output is suspended, * otherwise processing is resumed. */ void lockPty(bool lock); @@ -172,8 +172,8 @@ Q_OBJECT * Sends data to the process currently controlling the * teletype ( whose id is returned by foregroundProcessGroup() ) * - * @param buffer Pointer to the data to send. - * @param length Length of @p buffer. + * \param buffer Pointer to the data to send. + * \param length Length of @p buffer. */ void sendData(const char* buffer, int length); @@ -183,8 +183,8 @@ Q_OBJECT * Emitted when a new block of data is received from * the teletype. * - * @param buffer Pointer to the data received. - * @param length Length of @p buffer + * \param buffer Pointer to the data received. + * \param length Length of @p buffer */ void receivedData(const char* buffer, int length); diff --git a/src/plugins/grass/qtermwidget/Screen.h b/src/plugins/grass/qtermwidget/Screen.h index 6316ad48e1e5..fe7b813474d4 100644 --- a/src/plugins/grass/qtermwidget/Screen.h +++ b/src/plugins/grass/qtermwidget/Screen.h @@ -107,8 +107,8 @@ class Screen /** * Sets the margins for scrolling the screen. * - * @param topLine The top line of the new scrolling margin. - * @param bottomLine The bottom line of the new scrolling margin. + * \param topLine The top line of the new scrolling margin. + * \param bottomLine The bottom line of the new scrolling margin. */ void setMargins(int topLine , int bottomLine); /** Returns the top line of the scrolling region. */ @@ -262,33 +262,33 @@ class Screen * Enables the given @p rendition flag. Rendition flags control the appearance * of characters on the screen. * - * @see Character::rendition + * \see Character::rendition */ void setRendition(int rendition); /** * Disables the given @p rendition flag. Rendition flags control the appearance * of characters on the screen. * - * @see Character::rendition + * \see Character::rendition */ void resetRendition(int rendition); /** * Sets the cursor's foreground color. - * @param space The color space used by the @p color argument - * @param color The new foreground color. The meaning of this depends on + * \param space The color space used by the @p color argument + * \param color The new foreground color. The meaning of this depends on * the color @p space used. * - * @see CharacterColor + * \see CharacterColor */ void setForeColor(int space, int color); /** * Sets the cursor's background color. - * @param space The color space used by the @p color argumnet. - * @param color The new background color. The meaning of this depends on + * \param space The color space used by the @p color argumnet. + * \param color The new background color. The meaning of this depends on * the color @p space used. * - * @see CharacterColor + * \see CharacterColor */ void setBackColor(int space, int color); /** @@ -363,10 +363,10 @@ class Screen * The result is an array of Characters of size [getLines()][getColumns()] which * must be freed by the caller after use. * - * @param dest Buffer to copy the characters into - * @param size Size of @p dest in Characters - * @param startLine Index of first line to copy - * @param endLine Index of last line to copy + * \param dest Buffer to copy the characters into + * \param size Size of @p dest in Characters + * \param startLine Index of first line to copy + * \param endLine Index of last line to copy */ void getImage( Character* dest , int size , int startLine , int endLine ) const; @@ -404,17 +404,17 @@ class Screen /** * Sets the start of the selection. * - * @param column The column index of the first character in the selection. - * @param line The line index of the first character in the selection. - * @param blockSelectionMode True if the selection is in column mode. + * \param column The column index of the first character in the selection. + * \param line The line index of the first character in the selection. + * \param blockSelectionMode True if the selection is in column mode. */ void setSelectionStart(const int column, const int line, const bool blockSelectionMode); /** * Sets the end of the current selection. * - * @param column The column index of the last character in the selection. - * @param line The line index of the last character in the selection. + * \param column The column index of the last character in the selection. + * \param line The line index of the last character in the selection. */ void setSelectionEnd(const int column, const int line); @@ -441,7 +441,7 @@ class Screen /** * Convenience method. Returns the currently selected text. - * @param preserveLineBreaks Specifies whether new line characters should + * \param preserveLineBreaks Specifies whether new line characters should * be inserted into the returned text at the end of each terminal line. */ QString selectedText(bool preserveLineBreaks) const; @@ -449,20 +449,20 @@ class Screen /** * Copies part of the output to a stream. * - * @param decoder A decoder which converts terminal characters into text - * @param fromLine The first line in the history to retrieve - * @param toLine The last line in the history to retrieve + * \param decoder A decoder which converts terminal characters into text + * \param fromLine The first line in the history to retrieve + * \param toLine The last line in the history to retrieve */ void writeLinesToStream(TerminalCharacterDecoder* decoder, int fromLine, int toLine) const; /** - * Copies the selected characters, set using @see setSelBeginXY and @see setSelExtentXY + * Copies the selected characters, set using \see setSelBeginXY and \see setSelExtentXY * into a stream. * - * @param decoder A decoder which converts terminal characters into text. + * \param decoder A decoder which converts terminal characters into text. * PlainTextDecoder is the most commonly used decoder which converts characters * into plain text with no formatting. - * @param preserveLineBreaks Specifies whether new line characters should + * \param preserveLineBreaks Specifies whether new line characters should * be inserted into the returned text at the end of each terminal line. */ void writeSelectionToStream(TerminalCharacterDecoder* decoder , bool @@ -475,15 +475,15 @@ class Screen * The loc(x,y) macro can be used to generate these values from a * column,line pair. * - * @param from The start of the area to check. - * @param to The end of the area to check + * \param from The start of the area to check. + * \param to The end of the area to check */ void checkSelection(int from, int to); /** * Sets or clears an attribute of the current line. * - * @param property The attribute to set or clear + * \param property The attribute to set or clear * Possible properties are: * LINE_WRAPPED: Specifies that the line is wrapped. * LINE_DOUBLEWIDTH: Specifies that the characters in the current line @@ -495,7 +495,7 @@ class Screen * This allows other parts of the code to work on the * assumption that all lines are the same height. * - * @param enable true to apply the attribute to the current line or false to remove it + * \param enable true to apply the attribute to the current line or false to remove it */ void setLineProperty(LineProperty property , bool enable); diff --git a/src/plugins/grass/qtermwidget/ScreenWindow.h b/src/plugins/grass/qtermwidget/ScreenWindow.h index 87d08406e1dd..f1f3ac35d651 100644 --- a/src/plugins/grass/qtermwidget/ScreenWindow.h +++ b/src/plugins/grass/qtermwidget/ScreenWindow.h @@ -186,9 +186,9 @@ Q_OBJECT /** * Scrolls the window relative to its current position on the screen. * - * @param mode Specifies whether @p amount refers to the number of lines or the number + * \param mode Specifies whether @p amount refers to the number of lines or the number * of pages to scroll. - * @param amount The number of lines or pages ( depending on @p mode ) to scroll by. If + * \param amount The number of lines or pages ( depending on @p mode ) to scroll by. If * this number is positive, the view is scrolled down. If this number is negative, the view * is scrolled up. */ @@ -211,7 +211,7 @@ Q_OBJECT /** * Returns the text which is currently selected. * - * @param preserveLineBreaks See Screen::selectedText() + * \param preserveLineBreaks See Screen::selectedText() */ QString selectedText( bool preserveLineBreaks ) const; @@ -232,7 +232,7 @@ public slots: /** * Emitted when the screen window is scrolled to a different position. * - * @param line The line which is now at the top of the window. + * \param line The line which is now at the top of the window. */ void scrolled(int line); diff --git a/src/plugins/grass/qtermwidget/Session.h b/src/plugins/grass/qtermwidget/Session.h index 396a1d0d0381..ba0379e17e9f 100644 --- a/src/plugins/grass/qtermwidget/Session.h +++ b/src/plugins/grass/qtermwidget/Session.h @@ -82,7 +82,7 @@ class Session : public QObject { /** * Sets the profile associated with this session. * - * @param profileKey A key which can be used to obtain the current + * \param profileKey A key which can be used to obtain the current * profile settings from the SessionManager */ void setProfileKey(const QString & profileKey); @@ -161,8 +161,8 @@ class Session : public QObject { /** * Sets the format used by this session for tab titles. * - * @param context The context whoose format should be set. - * @param format The tab title format. This may be a mixture + * \param context The context whoose format should be set. + * \param format The tab title format. This may be a mixture * of plain text and dynamic elements denoted by a '%' character * followed by a letter (e.g., %d for directory). The dynamic * elements available depend on the @p context @@ -245,7 +245,7 @@ class Session : public QObject { * specify how input key sequences are translated into * the character stream which is sent to the terminal. * - * @param id The name of the key bindings to use. The + * \param id The name of the key bindings to use. The * names of available key bindings can be determined using the * KeyboardTranslatorManager class. */ @@ -329,7 +329,7 @@ class Session : public QObject { * Emits a request to resize the session to accommodate * the specified window size. * - * @param size The size in lines and columns to request. + * \param size The size in lines and columns to request. */ void setSize(const QSize & size); @@ -423,7 +423,7 @@ public slots: /** * Emitted when the activity state of this session changes. * - * @param state The new state of the session. This may be one + * \param state The new state of the session. This may be one * of NOTIFYNORMAL, NOTIFYSILENCE or NOTIFYACTIVITY */ void stateChanged(int state); @@ -455,14 +455,14 @@ public slots: * Emitted when the terminal process requests a change * in the size of the terminal window. * - * @param size The requested window size in terms of lines and columns. + * \param size The requested window size in terms of lines and columns. */ void resizeRequest(const QSize & size); /** * Emitted when a profile change command is received from the terminal. * - * @param text The text of the command. This is a string of the form + * \param text The text of the command. This is a string of the form * "PropertyName=Value;PropertyName=Value ..." */ void profileChangeCommandReceived(const QString & text); @@ -470,7 +470,7 @@ public slots: /** * Emitted when the flow control state changes. * - * @param enabled True if flow control is enabled or false otherwise. + * \param enabled True if flow control is enabled or false otherwise. */ void flowControlEnabledChanged(bool enabled); @@ -588,8 +588,8 @@ class SessionGroup : public QObject { * Changes or activity in the group's master sessions may be propagated * to all the sessions in the group, depending on the current masterMode() * - * @param session The session whoose master status should be changed. - * @param master True to make this session a master or false otherwise + * \param session The session whoose master status should be changed. + * \param master True to make this session a master or false otherwise */ void setMasterStatus( Session * session , bool master ); /** Returns the master status of a session. See setMasterStatus() */ @@ -611,7 +611,7 @@ class SessionGroup : public QObject { * Specifies which activity in the group's master sessions is propagated * to all sessions in the group. * - * @param mode A bitwise OR of MasterMode flags. + * \param mode A bitwise OR of MasterMode flags. */ void setMasterMode( int mode ); /** diff --git a/src/plugins/grass/qtermwidget/ShellCommand.h b/src/plugins/grass/qtermwidget/ShellCommand.h index 419503afecd4..359e1f01dfad 100644 --- a/src/plugins/grass/qtermwidget/ShellCommand.h +++ b/src/plugins/grass/qtermwidget/ShellCommand.h @@ -53,7 +53,7 @@ class ShellCommand { /** * Constructs a ShellCommand from a command line. * - * @param fullCommand The command line to parse. + * \param fullCommand The command line to parse. */ ShellCommand(const QString & fullCommand); /** diff --git a/src/plugins/grass/qtermwidget/TerminalCharacterDecoder.h b/src/plugins/grass/qtermwidget/TerminalCharacterDecoder.h index 75d40c36d648..79f0524a9703 100644 --- a/src/plugins/grass/qtermwidget/TerminalCharacterDecoder.h +++ b/src/plugins/grass/qtermwidget/TerminalCharacterDecoder.h @@ -54,9 +54,9 @@ class TerminalCharacterDecoder * Converts a line of terminal characters with associated properties into a text string * and writes the string into an output QTextStream. * - * @param characters An array of characters of length @p count. - * @param count The number of characters - * @param properties Additional properties which affect all characters in the line + * \param characters An array of characters of length @p count. + * \param count The number of characters + * \param properties Additional properties which affect all characters in the line */ virtual void decodeLine(const Character* const characters, int count, diff --git a/src/plugins/grass/qtermwidget/TerminalDisplay.h b/src/plugins/grass/qtermwidget/TerminalDisplay.h index 17a4e24ee3aa..05c9302ad988 100644 --- a/src/plugins/grass/qtermwidget/TerminalDisplay.h +++ b/src/plugins/grass/qtermwidget/TerminalDisplay.h @@ -123,8 +123,8 @@ class KONSOLEPRIVATE_EXPORT TerminalDisplay : public QWidget /** * Sets the current position and range of the display's scroll bar. * - * @param cursor The position of the scroll bar's thumb. - * @param lines The maximum value of the scroll bar. + * \param cursor The position of the scroll bar's thumb. + * \param lines The maximum value of the scroll bar. */ void setScroll(int cursor, int lines); @@ -241,11 +241,11 @@ class KONSOLEPRIVATE_EXPORT TerminalDisplay : public QWidget * The keyboard cursor defaults to using the foreground color of the character * underneath it. * - * @param useForegroundColor If true, the cursor color will change to match + * \param useForegroundColor If true, the cursor color will change to match * the foreground color of the character underneath it as it is moved, in this * case, the @p color parameter is ignored and the color of the character * under the cursor is inverted to ensure that it is still readable. - * @param color The color to use to draw the cursor. This is only taken into + * \param color The color to use to draw the cursor. This is only taken into * account if @p useForegroundColor is false. */ void setKeyboardCursorColor(bool useForegroundColor , const QColor& color); @@ -297,7 +297,7 @@ class KONSOLEPRIVATE_EXPORT TerminalDisplay : public QWidget * The word boundaries occur at the first and last characters which * are either a letter, number, or a character in @p wc * - * @param wc An array of characters which are to be considered parts + * \param wc An array of characters which are to be considered parts * of a word ( in addition to letters and numbers ). */ void setWordCharacters(const QString& wc); @@ -305,7 +305,7 @@ class KONSOLEPRIVATE_EXPORT TerminalDisplay : public QWidget * Returns the characters which are considered part of a word for the * purpose of selecting words in the display with the mouse. * - * @see setWordCharacters() + * \see setWordCharacters() */ QString wordCharacters() { return _wordCharacters; } @@ -480,7 +480,7 @@ public slots: * Causes the widget to display or hide a message informing the user that terminal * output has been suspended (by using the flow control key combination Ctrl+S) * - * @param suspended True if terminal output has been suspended and the warning message should + * \param suspended True if terminal output has been suspended and the warning message should * be shown or false to indicate that terminal output has been resumed and that * the warning message should disappear. */ @@ -497,7 +497,7 @@ public slots: * view area - since the program running in the terminal is being allowed to handle normal mouse * events itself. * - * @param usesMouse Set to true if the program running in the terminal is interested in mouse events + * \param usesMouse Set to true if the program running in the terminal is interested in mouse events * or false otherwise. */ void setUsesMouse(bool usesMouse); @@ -513,13 +513,13 @@ public slots: /** * Sets the background of the display to the specified color. - * @see setColorTable(), setForegroundColor() + * \see setColorTable(), setForegroundColor() */ void setBackgroundColor(const QColor& color); /** * Sets the text of the display to the specified color. - * @see setColorTable(), setBackgroundColor() + * \see setColorTable(), setBackgroundColor() */ void setForegroundColor(const QColor& color); @@ -534,10 +534,10 @@ public slots: /** * A mouse event occurred. - * @param button The mouse button (0 for left button, 1 for middle button, 2 for right button, 3 for release) - * @param column The character column where the event occurred - * @param line The character row where the event occurred - * @param eventType The type of event. 0 for a mouse press / release or 1 for mouse motion + * \param button The mouse button (0 for left button, 1 for middle button, 2 for right button, 3 for release) + * \param column The character column where the event occurred + * \param line The character row where the event occurred + * \param eventType The type of event. 0 for a mouse press / release or 1 for mouse motion */ void mouseSignal(int button, int column, int line, int eventType); void changedFontMetricSignal(int height, int width); diff --git a/src/plugins/grass/qtermwidget/kprocess.h b/src/plugins/grass/qtermwidget/kprocess.h index babcc2a232da..1ae67f12f5b2 100644 --- a/src/plugins/grass/qtermwidget/kprocess.h +++ b/src/plugins/grass/qtermwidget/kprocess.h @@ -93,14 +93,14 @@ class KProcess : public QProcess * * This function must be called before starting the process. * - * @param mode the output channel handling mode + * \param mode the output channel handling mode */ void setOutputChannelMode(OutputChannelMode mode); /** * Query how the output channels of the child process are handled. * - * @return the output channel handling mode + * \returns the output channel handling mode */ OutputChannelMode outputChannelMode() const; @@ -109,7 +109,7 @@ class KProcess : public QProcess * * This function must be called before starting the process, obviously. * - * @param mode the open mode. Note that this mode is automatically + * \param mode the open mode. Note that this mode is automatically * "reduced" according to the channel modes and redirections. * The default is QIODevice::ReadWrite. */ @@ -120,9 +120,9 @@ class KProcess : public QProcess * * This function must be called before starting the process. * - * @param name the name of the environment variable - * @param value the new value for the environment variable - * @param overwrite if @c false and the environment variable is already + * \param name the name of the environment variable + * \param value the new value for the environment variable + * \param overwrite if @c false and the environment variable is already * set, the old value will be preserved */ void setEnv(const QString &name, const QString &value, bool overwrite = true); @@ -132,7 +132,7 @@ class KProcess : public QProcess * * This function must be called before starting the process. * - * @param name the name of the environment variable + * \param name the name of the environment variable */ void unsetEnv(const QString &name); @@ -151,8 +151,8 @@ class KProcess : public QProcess * * This function must be called before starting the process, obviously. * - * @param exe the program to execute - * @param args the command line arguments for the program, + * \param exe the program to execute + * \param args the command line arguments for the program, * one per list element */ void setProgram(const QString &exe, const QStringList &args = QStringList()); @@ -160,7 +160,7 @@ class KProcess : public QProcess /** * @overload * - * @param argv the program to execute and the command line arguments + * \param argv the program to execute and the command line arguments * for the program, one per list element */ void setProgram(const QStringList &argv); @@ -179,16 +179,16 @@ class KProcess : public QProcess * * This function must be called before starting the process, obviously. * - * @param arg the argument to add - * @return a reference to this KProcess + * \param arg the argument to add + * \returns a reference to this KProcess */ KProcess &operator<<(const QString& arg); /** * @overload * - * @param args the arguments to add - * @return a reference to this KProcess + * \param args the arguments to add + * \returns a reference to this KProcess */ KProcess &operator<<(const QStringList& args); @@ -212,7 +212,7 @@ class KProcess : public QProcess * * This function must be called before starting the process, obviously. * - * @param cmd the command to execute through a shell. + * \param cmd the command to execute through a shell. * The caller must make sure that all filenames etc. are properly * quoted when passed as argument. Failure to do so often results in * serious security holes. See KShell::quoteArg(). @@ -222,7 +222,7 @@ class KProcess : public QProcess /** * Obtain the currently set program and arguments. * - * @return a list, the first element being the program, the remaining ones + * \returns a list, the first element being the program, the remaining ones * being command line arguments to the program. */ QStringList program() const; @@ -230,7 +230,7 @@ class KProcess : public QProcess /** * Start the process. * - * @see QProcess::start(const QString &, const QStringList &, OpenMode) + * \see QProcess::start(const QString &, const QStringList &, OpenMode) */ void start(); @@ -247,8 +247,8 @@ class KProcess : public QProcess * Unlike the other execute() variants this method is not static, * so the process can be parametrized properly and talked to. * - * @param msecs time to wait for process to exit before killing it - * @return -2 if the process could not be started, -1 if it crashed, + * \param msecs time to wait for process to exit before killing it + * \returns -2 if the process could not be started, -1 if it crashed, * otherwise its exit code */ int execute(int msecs = -1); @@ -256,11 +256,11 @@ class KProcess : public QProcess /** * @overload * - * @param exe the program to execute - * @param args the command line arguments for the program, + * \param exe the program to execute + * \param args the command line arguments for the program, * one per list element - * @param msecs time to wait for process to exit before killing it - * @return -2 if the process could not be started, -1 if it crashed, + * \param msecs time to wait for process to exit before killing it + * \returns -2 if the process could not be started, -1 if it crashed, * otherwise its exit code */ static int execute(const QString &exe, const QStringList &args = QStringList(), int msecs = -1); @@ -268,10 +268,10 @@ class KProcess : public QProcess /** * @overload * - * @param argv the program to execute and the command line arguments + * \param argv the program to execute and the command line arguments * for the program, one per list element - * @param msecs time to wait for process to exit before killing it - * @return -2 if the process could not be started, -1 if it crashed, + * \param msecs time to wait for process to exit before killing it + * \returns -2 if the process could not be started, -1 if it crashed, * otherwise its exit code */ static int execute(const QStringList &argv, int msecs = -1); @@ -282,32 +282,32 @@ class KProcess : public QProcess * * Unlike the other startDetached() variants this method is not static, * so the process can be parametrized properly. - * @note Currently, only the setProgram()/setShellCommand() and + * \note Currently, only the setProgram()/setShellCommand() and * setWorkingDirectory() parametrizations are supported. * * The KProcess object may be re-used immediately after calling this * function. * - * @return the PID of the started process or 0 on error + * \returns the PID of the started process or 0 on error */ int startDetached(); /** * @overload * - * @param exe the program to start - * @param args the command line arguments for the program, + * \param exe the program to start + * \param args the command line arguments for the program, * one per list element - * @return the PID of the started process or 0 on error + * \returns the PID of the started process or 0 on error */ static int startDetached(const QString &exe, const QStringList &args = QStringList()); /** * @overload * - * @param argv the program to start and the command line arguments + * \param argv the program to start and the command line arguments * for the program, one per list element - * @return the PID of the started process or 0 on error + * \returns the PID of the started process or 0 on error */ static int startDetached(const QStringList &argv); @@ -319,7 +319,7 @@ class KProcess : public QProcess * This function can be called only while the process is running. * It cannot be applied to detached processes. * - * @return the process ID + * \returns the process ID */ int pid() const; diff --git a/src/plugins/grass/qtermwidget/kpty.h b/src/plugins/grass/qtermwidget/kpty.h index b2392c104bfd..fe1bf9ac4a71 100644 --- a/src/plugins/grass/qtermwidget/kpty.h +++ b/src/plugins/grass/qtermwidget/kpty.h @@ -50,7 +50,7 @@ class KPty { /** * Create a pty master/slave pair. * - * @return true if a pty pair was successfully opened + * \returns true if a pty pair was successfully opened */ bool open(); @@ -86,8 +86,8 @@ class KPty { * Creates an utmp entry for the tty. * This function must be called after calling setCTty and * making this pty the stdin. - * @param user the user to be logged on - * @param remotehost the host from which the login is coming. This is + * \param user the user to be logged on + * \param remotehost the host from which the login is coming. This is * @em not the local host. For remote logins it should be the hostname * of the client. For local logins from inside an X session it should * be the name of the X display. Otherwise it should be empty. @@ -106,11 +106,11 @@ class KPty { * You will need an #include <termios.h> to do anything useful * with it. * - * @param ttmode a pointer to a termios structure. + * \param ttmode a pointer to a termios structure. * Note: when declaring ttmode, @c struct @c ::termios must be used - * without the '::' some version of HP-UX thinks, this declares * the struct in your class, in your method. - * @return @c true on success, false otherwise + * \returns @c true on success, false otherwise */ bool tcGetAttr(struct ::termios * ttmode) const; @@ -119,8 +119,8 @@ class KPty { * * This function can be used only while the PTY is open. * - * @param ttmode a pointer to a termios structure. - * @return @c true on success, false otherwise. Note that success means + * \param ttmode a pointer to a termios structure. + * \returns @c true on success, false otherwise. Note that success means * that @em at @em least @em one attribute could be set. */ bool tcSetAttr(struct ::termios * ttmode); @@ -131,9 +131,9 @@ class KPty { * * This function can be used only while the PTY is open. * - * @param lines the number of rows - * @param columns the number of columns - * @return @c true on success, false otherwise + * \param lines the number of rows + * \param columns the number of columns + * \returns @c true on success, false otherwise */ bool setWinSize(int lines, int columns); @@ -146,27 +146,27 @@ class KPty { * * This function can be used only while the PTY is open. * - * @param echo true if input should be echoed. - * @return @c true on success, false otherwise + * \param echo true if input should be echoed. + * \returns @c true on success, false otherwise */ bool setEcho(bool echo); /** - * @return the name of the slave pty device. + * \returns the name of the slave pty device. * * This function should be called only while the pty is open. */ const char * ttyName() const; /** - * @return the file descriptor of the master pty + * \returns the file descriptor of the master pty * * This function should be called only while the pty is open. */ int masterFd() const; /** - * @return the file descriptor of the slave pty + * \returns the file descriptor of the slave pty * * This function should be called only while the pty slave is open. */ diff --git a/src/plugins/grass/qtermwidget/kptydevice.h b/src/plugins/grass/qtermwidget/kptydevice.h index 803754f74eb8..aba476649d33 100644 --- a/src/plugins/grass/qtermwidget/kptydevice.h +++ b/src/plugins/grass/qtermwidget/kptydevice.h @@ -68,7 +68,7 @@ class KPtyDevice : public QIODevice, public KPty { /** * Create a pty master/slave pair. * - * @return true if a pty pair was successfully opened + * \returns true if a pty pair was successfully opened */ virtual bool open(OpenMode mode = ReadWrite | Unbuffered); @@ -81,9 +81,9 @@ class KPtyDevice : public QIODevice, public KPty { * Note that you will need to use setSuspended() on both devices to * control which one gets the incoming data from the pty. * - * @param fd an open pty master file descriptor. - * @param mode the device mode to open the pty with. - * @return true if a pty pair was successfully opened + * \param fd an open pty master file descriptor. + * \param mode the device mode to open the pty with. + * \returns true if a pty pair was successfully opened */ bool open(int fd, OpenMode mode = ReadWrite | Unbuffered); @@ -117,7 +117,7 @@ class KPtyDevice : public QIODevice, public KPty { bool isSuspended() const; /** - * @return always true + * \returns always true */ virtual bool isSequential() const; diff --git a/src/plugins/grass/qtermwidget/kptyprocess.h b/src/plugins/grass/qtermwidget/kptyprocess.h index 234703ebe8d6..c3f9f143ac09 100644 --- a/src/plugins/grass/qtermwidget/kptyprocess.h +++ b/src/plugins/grass/qtermwidget/kptyprocess.h @@ -79,7 +79,7 @@ class KPtyProcess : public KProcess /** * Construct a process using an open pty master. * - * @param ptyMasterFd an open pty master file descriptor. + * \param ptyMasterFd an open pty master file descriptor. * The process does not take ownership of the descriptor; * it will not be automatically closed at any point. */ @@ -95,7 +95,7 @@ class KPtyProcess : public KProcess * * This function must be called before starting the process. * - * @param channels the output channel handling mode + * \param channels the output channel handling mode */ void setPtyChannels(PtyChannels channels); @@ -109,7 +109,7 @@ class KPtyProcess : public KProcess /** * Query to which channels the PTY is assigned. * - * @return the output channel handling mode + * \returns the output channel handling mode */ PtyChannels ptyChannels() const; @@ -122,21 +122,21 @@ class KPtyProcess : public KProcess * * This function must be called before starting the process. * - * @param value whether to register in utmp. + * \param value whether to register in utmp. */ void setUseUtmp(bool value); /** * Get whether to register the process as a TTY login in utmp. * - * @return whether to register in utmp + * \returns whether to register in utmp */ bool isUseUtmp() const; /** * Get the PTY device of this process. * - * @return the PTY device + * \returns the PTY device */ KPtyDevice *pty() const; diff --git a/src/plugins/grass/qtermwidget/qtermwidget.h b/src/plugins/grass/qtermwidget/qtermwidget.h index d8a1e46d77fa..87f5e2578782 100644 --- a/src/plugins/grass/qtermwidget/qtermwidget.h +++ b/src/plugins/grass/qtermwidget/qtermwidget.h @@ -91,9 +91,9 @@ class QTermWidget : public QWidget { //Text codec, default is UTF-8 void setTextCodec(QTextCodec * codec); - /** @brief Sets the color scheme, default is white on black + /** \brief Sets the color scheme, default is white on black * - * @param[in] name The name of the color scheme, either returned from + * \param[in] name The name of the color scheme, either returned from * availableColorSchemes() or a full path to a color scheme. */ void setColorScheme(const QString & name); @@ -148,7 +148,7 @@ class QTermWidget : public QWidget { /** * Returns the currently selected text. - * @param preserveLineBreaks Specifies whether new line characters should + * \param preserveLineBreaks Specifies whether new line characters should * be inserted into the returned text at the end of each terminal line. */ QString selectedText(bool preserveLineBreaks = true); @@ -161,14 +161,14 @@ class QTermWidget : public QWidget { * * This method may return a nullptr if no hotspot is available. * - * @param[in] pos The point of interest in the QTermWidget coordinates. - * @return Hotspot for the given position, or nullptr if no hotspot. + * \param[in] pos The point of interest in the QTermWidget coordinates. + * \returns Hotspot for the given position, or nullptr if no hotspot. */ Filter::HotSpot* getHotSpotAt(const QPoint& pos) const; /** Returns the available hotspots for the given row and column. * - * @return Hotspot for the given position, or nullptr if no hotspot. + * \returns Hotspot for the given position, or nullptr if no hotspot. */ Filter::HotSpot* getHotSpotAt(int row, int column) const; diff --git a/src/plugins/plugin_template/plugin.h b/src/plugins/plugin_template/plugin.h index fa40bfe38835..4a4b2d3f7de3 100644 --- a/src/plugins/plugin_template/plugin.h +++ b/src/plugins/plugin_template/plugin.h @@ -66,7 +66,7 @@ class [pluginname]: public QObject, public QgisPlugin /** * Constructor for a plugin. The QgisInterface pointer is passed by * QGIS when it attempts to instantiate the plugin. - * @param interface Pointer to the QgisInterface object. + * \param interface Pointer to the QgisInterface object. */ [pluginname]( QgisInterface *interface ); //! Destructor diff --git a/src/plugins/spatialquery/qgsrubberselectid.h b/src/plugins/spatialquery/qgsrubberselectid.h index 783bc36607c3..ab23fb205f8c 100644 --- a/src/plugins/spatialquery/qgsrubberselectid.h +++ b/src/plugins/spatialquery/qgsrubberselectid.h @@ -33,7 +33,7 @@ class QgsRubberSelectId /** * Constructor for a class RubberSelectedId. - * @param mapCanvas Pointer to the iface.mapCanvas(). + * \param mapCanvas Pointer to the iface.mapCanvas(). */ explicit QgsRubberSelectId( QgsMapCanvas *mapCanvas ); diff --git a/src/plugins/spatialquery/qgsspatialquerydialog.h b/src/plugins/spatialquery/qgsspatialquerydialog.h index 7761b9e20d0d..080233ec4c77 100644 --- a/src/plugins/spatialquery/qgsspatialquerydialog.h +++ b/src/plugins/spatialquery/qgsspatialquerydialog.h @@ -38,7 +38,7 @@ class QgsSpatialQueryDialog : public QDialog, private Ui::QgsSpatialQueryDialogB /** * Constructor for a dialog. The QgisInterface pointer is passed by * QGIS when it attempts to instantiate the plugin. - * @param iface Pointer to the QgisInterface object. + * \param iface Pointer to the QgisInterface object. */ QgsSpatialQueryDialog( QWidget *parent = nullptr, QgisInterface *iface = nullptr ); diff --git a/src/plugins/topology/checkDock.h b/src/plugins/topology/checkDock.h index 2788fdab5afd..84022c202d4a 100644 --- a/src/plugins/topology/checkDock.h +++ b/src/plugins/topology/checkDock.h @@ -45,8 +45,8 @@ class checkDock : public QgsDockWidget, private Ui::checkDock /** * Constructor - * @param qIface pointer to QgisInterface instance that is passed to the rulesDialog - * @param parent parent object + * \param qIface pointer to QgisInterface instance that is passed to the rulesDialog + * \param parent parent object */ checkDock( QgisInterface *qIface, QWidget *parent = nullptr ); ~checkDock(); @@ -85,7 +85,7 @@ class checkDock : public QgsDockWidget, private Ui::checkDock /** * Handles error selection - * @param index clicked index in the table + * \param index clicked index in the table */ void errorListClicked( const QModelIndex &index ); @@ -96,13 +96,13 @@ class checkDock : public QgsDockWidget, private Ui::checkDock /** * Filters all errors involving features from specified layer - * @param layerId layer ID + * \param layerId layer ID */ void parseErrorListByLayer( const QString &layerId ); /** * Clears rubberbands when window is hidden - * @param visible true if the window is visible + * \param visible true if the window is visible */ void updateRubberBands( bool visible ); @@ -130,19 +130,19 @@ class checkDock : public QgsDockWidget, private Ui::checkDock /** * Runs tests from the test table - * @param type validation type - what features to check + * \param type validation type - what features to check */ void runTests( ValidateType type ); /** * Validates topology - * @param type validation type - what features to check + * \param type validation type - what features to check */ void validate( ValidateType type ); /** * Filters all errors involving specified feature - * @param featureId feature ID + * \param featureId feature ID */ void parseErrorListByFeature( int featureId ); diff --git a/src/plugins/topology/dockModel.h b/src/plugins/topology/dockModel.h index 6d12aca10974..e262de42e8d6 100644 --- a/src/plugins/topology/dockModel.h +++ b/src/plugins/topology/dockModel.h @@ -32,56 +32,56 @@ class DockModel: public QAbstractTableModel /** * Constructor - * @param errorList reference to the ErrorList where errors will be stored - * @param parent parent object + * \param errorList reference to the ErrorList where errors will be stored + * \param parent parent object */ DockModel( ErrorList &errorList, QObject *parent ); /** * Returns header data - * @param section required section - * @param orientation horizontal or vertical orientation - * @param role data role + * \param section required section + * \param orientation horizontal or vertical orientation + * \param role data role */ QVariant headerData( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const override; /** * Returns data on the given index - * @param index model index - * @param role data role + * \param index model index + * \param role data role */ virtual QVariant data( const QModelIndex &index, int role ) const override; /** * Updates data on given index - * @param index model index - * @param value new data value - * @param role data role + * \param index model index + * \param value new data value + * \param role data role */ virtual bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ) override; /** * Returns item flags for the index - * @param index model index + * \param index model index */ Qt::ItemFlags flags( const QModelIndex &index ) const override; /** * Returns the number of rows - * @param parent parent index + * \param parent parent index */ int rowCount( const QModelIndex &parent ) const override; /** * Returns the number of columns - * @param parent parent index + * \param parent parent index */ int columnCount( const QModelIndex &parent ) const override; /** * Reloads the model data between indices - * @param index1 start index - * @param index2 end index + * \param index1 start index + * \param index2 end index */ void reload( const QModelIndex &index1, const QModelIndex &index2 ); diff --git a/src/plugins/topology/rulesDialog.h b/src/plugins/topology/rulesDialog.h index 7dab54ba038c..75e7eb0bf329 100644 --- a/src/plugins/topology/rulesDialog.h +++ b/src/plugins/topology/rulesDialog.h @@ -35,10 +35,10 @@ class rulesDialog : public QDialog, private Ui::rulesDialog public: /* * Constructor - * @param layerList List of layer IDs - * @param testMap maps test names to test routines - * @param qgisIface pointer to a QgisInterface instance - * @param parent parent widget + * \param layerList List of layer IDs + * \param testMap maps test names to test routines + * \param qgisIface pointer to a QgisInterface instance + * \param parent parent widget */ rulesDialog( const QMap &testMap, QgisInterface *qgisIface, QWidget *parent ); ~rulesDialog(); @@ -63,8 +63,8 @@ class rulesDialog : public QDialog, private Ui::rulesDialog /* * Reads a test from the project - * @param index test index - * @param project pointer to QgsProject + * \param index test index + * \param project pointer to QgsProject */ void readTest( int index, QgsProject *project ); /* @@ -77,7 +77,7 @@ class rulesDialog : public QDialog, private Ui::rulesDialog private slots: /* * Shows or hides controls according to test settings - * @param testName name of the test + * \param testName name of the test */ void showControls( const QString &testName ); /* @@ -94,7 +94,7 @@ class rulesDialog : public QDialog, private Ui::rulesDialog void projectRead(); /* * Updates Rule combobox to mach first layer - * @param layerId layer ID + * \param layerId layer ID */ void updateRuleItems( const QString &layerName ); diff --git a/src/plugins/topology/topol.h b/src/plugins/topology/topol.h index c6823a2fb549..11c26a4aa7c4 100644 --- a/src/plugins/topology/topol.h +++ b/src/plugins/topology/topol.h @@ -68,7 +68,7 @@ class Topol: public QObject, public QgisPlugin /** * Constructor for a plugin. The QgisInterface pointer is passed by * QGIS when it attempts to instantiate the plugin. - * @param interface Pointer to the QgisInterface object. + * \param interface Pointer to the QgisInterface object. */ explicit Topol( QgisInterface *interface ); diff --git a/src/plugins/topology/topolError.h b/src/plugins/topology/topolError.h index 389c7c3e2770..de54a594bd1f 100644 --- a/src/plugins/topology/topolError.h +++ b/src/plugins/topology/topolError.h @@ -36,8 +36,8 @@ class FeatureLayer /** * Constructor - * @param layer layer pointer - * @param feature QgsFeature + * \param layer layer pointer + * \param feature QgsFeature */ FeatureLayer( QgsVectorLayer *layer, const QgsFeature &feature ) : layer( layer ) @@ -101,15 +101,15 @@ class TopolError /** * Makes geometry difference - * @param fl1 first FeatureLayer pair - * @param fl2 second FeatureLayer pair + * \param fl1 first FeatureLayer pair + * \param fl2 second FeatureLayer pair */ bool fixMove( const FeatureLayer &fl1, const FeatureLayer &fl2 ); /** * Unions features to the first one - * @param fl1 first FeatureLayer pair - * @param fl2 second FeatureLayer pair + * \param fl1 first FeatureLayer pair + * \param fl2 second FeatureLayer pair */ bool fixUnion( const FeatureLayer &fl1, const FeatureLayer &fl2 ); @@ -117,9 +117,9 @@ class TopolError /** * Constructor - * @param boundingBox bounding box of the two features - * @param conflict geometry representation of the conflict - * @param featurePairs FeatureLayer pairs of the two features + * \param boundingBox bounding box of the two features + * \param conflict geometry representation of the conflict + * \param featurePairs FeatureLayer pairs of the two features */ TopolError( const QgsRectangle &boundingBox, const QgsGeometry &conflict, const QList &featurePairs ); @@ -127,7 +127,7 @@ class TopolError /** * Runs fixing function - * @param fixName name of the fix + * \param fixName name of the fix */ virtual bool fix( const QString &fixName ); diff --git a/src/plugins/topology/topolTest.h b/src/plugins/topology/topolTest.h index 164a4f8deb09..625e04a4ed95 100644 --- a/src/plugins/topology/topolTest.h +++ b/src/plugins/topology/topolTest.h @@ -113,27 +113,27 @@ class topolTest: public QObject /** * Runs the test and returns all found errors - * @param testName name of the test - * @param layer1 pointer to the first layer - * @param layer2 pointer to the second layer - * @param type type what features to validate - * @param tolerance possible tolerance + * \param testName name of the test + * \param layer1 pointer to the first layer + * \param layer2 pointer to the second layer + * \param type type what features to validate + * \param tolerance possible tolerance */ ErrorList runTest( const QString &testName, QgsVectorLayer *layer1, QgsVectorLayer *layer2, ValidateType type, double tolerance ); /** * Checks for intersections of the two layers - * @param tolerance not used - * @param layer1 pointer to the first layer - * @param layer2 pointer to the second layer + * \param tolerance not used + * \param layer1 pointer to the first layer + * \param layer2 pointer to the second layer */ ErrorList checkOverlapWithLayer( double tolerance, QgsVectorLayer *layer1, QgsVectorLayer *layer2, bool isExtent ); /** * Checks for self-intersections in the layer - * @param tolerance not used - * @param layer1 pointer to the first layer - * @param layer2 not used + * \param tolerance not used + * \param layer1 pointer to the first layer + * \param layer2 not used */ ErrorList checkSelfIntersections( double tolerance, QgsVectorLayer *layer1, QgsVectorLayer *layer2, bool isExtent ); @@ -141,114 +141,114 @@ class topolTest: public QObject /** * Checks for features that are too close - * @param tolerance allowed tolerance - * @param layer1 pointer to the first layer - * @param layer2 pointer to the second layer + * \param tolerance allowed tolerance + * \param layer1 pointer to the first layer + * \param layer2 pointer to the second layer */ ErrorList checkCloseFeature( double tolerance, QgsVectorLayer *layer1, QgsVectorLayer *layer2, bool isExtent ); #endif /** * Checks for short segments - * @param tolerance tolerance - not used - * @param layer1 pointer to the first layer - * @param layer2 pointer to the second layer + * \param tolerance tolerance - not used + * \param layer1 pointer to the first layer + * \param layer2 pointer to the second layer */ ErrorList checkSegmentLength( double tolerance, QgsVectorLayer *layer1, QgsVectorLayer *layer2, bool isExtent ); /** * Checks for dangling lines - * @param tolerance allowed tolerance - * @param layer1 pointer to the first layer - * @param layer2 not used + * \param tolerance allowed tolerance + * \param layer1 pointer to the first layer + * \param layer2 not used */ ErrorList checkDanglingLines( double tolerance, QgsVectorLayer *layer1, QgsVectorLayer *layer2, bool isExtent ); /** * Checks for points not covered by any segment - * @param tolerance not used - * @param layer1 pointer to the first layer - * @param layer2 pointer to the second layer + * \param tolerance not used + * \param layer1 pointer to the first layer + * \param layer2 pointer to the second layer */ ErrorList checkPointCoveredBySegment( double tolerance, QgsVectorLayer *layer1, QgsVectorLayer *layer2, bool isExtent ); /** * Checks for invalid geometries - * @param tolerance not used - * @param layer1 pointer to the first layer - * @param layer2 not used + * \param tolerance not used + * \param layer1 pointer to the first layer + * \param layer2 not used */ ErrorList checkValid( double tolerance, QgsVectorLayer *layer1, QgsVectorLayer *layer2, bool isExtent ); /** * Checks for duplicate geometries - * @param tolerance not used - * @param layer1 pointer to the first layer - * @param layer2 not used + * \param tolerance not used + * \param layer1 pointer to the first layer + * \param layer2 not used */ ErrorList checkDuplicates( double tolerance, QgsVectorLayer *layer1, QgsVectorLayer *layer2, bool isExtent ); /** * Checks for pseudo nodes - * @param tolerance not used - * @param layer1 pointer to the first layer - * @param layer2 not used + * \param tolerance not used + * \param layer1 pointer to the first layer + * \param layer2 not used */ ErrorList checkPseudos( double tolerance, QgsVectorLayer *layer1, QgsVectorLayer *layer2, bool isExtent ); /** * Checks for overlaps of polygons from same layer - * @param tolerance not used - * @param layer1 pointer to the first layer - * @param layer2 not used + * \param tolerance not used + * \param layer1 pointer to the first layer + * \param layer2 not used */ ErrorList checkOverlaps( double tolerance, QgsVectorLayer *layer1, QgsVectorLayer *layer2, bool isExtent ); /** * Checks for gaps among polygons from same layer - * @param tolerance not used - * @param layer1 pointer to the first layer - * @param layer2 not used + * \param tolerance not used + * \param layer1 pointer to the first layer + * \param layer2 not used */ ErrorList checkGaps( double tolerance, QgsVectorLayer *layer1, QgsVectorLayer *layer2, bool isExtent ); /** * Checks for points form one layer that are not covered by line ends form another layer - * @param tolerance not used - * @param layer1 pointer to the first point layer - * @param layer2 pointer to the second line layer + * \param tolerance not used + * \param layer1 pointer to the first point layer + * \param layer2 pointer to the second line layer */ ErrorList checkPointCoveredByLineEnds( double tolerance, QgsVectorLayer *layer1, QgsVectorLayer *layer2, bool isExtent ); /** * Checks for points that are not inside any polygons from another layer - * @param tolerance not used - * @param layer1 pointer to the first point layer - * @param layer2 pointer to the second polygon layer + * \param tolerance not used + * \param layer1 pointer to the first point layer + * \param layer2 pointer to the second polygon layer */ ErrorList checkPointInPolygon( double tolerance, QgsVectorLayer *layer1, QgsVectorLayer *layer2, bool isExtent ); /** * Checks for polygons that do not contain any points form another layer - * @param tolerance not used - * @param layer1 pointer to the first polygon layer - * @param layer2 pointer to the second point layer + * \param tolerance not used + * \param layer1 pointer to the first polygon layer + * \param layer2 pointer to the second point layer */ ErrorList checkPolygonContainsPoint( double tolerance, QgsVectorLayer *layer1, QgsVectorLayer *layer2, bool isExtent ); /** * Checks for multipart features - * @param tolerance not used - * @param layer1 pointer to the first layer - * @param layer2 not used + * \param tolerance not used + * \param layer1 pointer to the first layer + * \param layer2 not used */ ErrorList checkMultipart( double tolerance, QgsVectorLayer *layer1, QgsVectorLayer *layer2, bool isExtent ); /** * Checks for line features that do not have both ends covered by points from another layer - * @param tolerance not used - * @param layer1 pointer to the first linelayer - * @param layer2 pointer to the second point layer + * \param tolerance not used + * \param layer1 pointer to the first linelayer + * \param layer2 pointer to the second point layer */ ErrorList checkyLineEndsCoveredByPoints( double tolerance, QgsVectorLayer *layer1, QgsVectorLayer *layer2, bool isExtent ); @@ -257,9 +257,9 @@ class topolTest: public QObject /** * Checks for invalid geometries - * @param tolerance not used - * @param layer1 pointer to the first layer - * @param layer2 not used + * \param tolerance not used + * \param layer1 pointer to the first layer + * \param layer2 not used */ void setTestCanceled(); @@ -275,21 +275,21 @@ class topolTest: public QObject /** * Builds spatial index for the layer - * @param layer pointer to the layer + * \param layer pointer to the layer */ QgsSpatialIndex *createIndex( QgsVectorLayer *layer, const QgsRectangle &extent ); /** * Fills the feature list with features from the layer - * @param layer pointer to the layer - * @param extent of the layer to add features + * \param layer pointer to the layer + * \param extent of the layer to add features */ void fillFeatureList( QgsVectorLayer *layer, const QgsRectangle &extent ); /** * Fills the feature map with features from the layer - * @param layer pointer to the layer - * @param extent of the layer to create index + * \param layer pointer to the layer + * \param extent of the layer to create index */ void fillFeatureMap( QgsVectorLayer *layer, const QgsRectangle &extent ); @@ -302,7 +302,7 @@ class topolTest: public QObject /** * Informs progress dialog about current status - * @param value process status + * \param value process status */ void progress( int value ); }; diff --git a/src/providers/arcgisrest/qgsafsprovider.h b/src/providers/arcgisrest/qgsafsprovider.h index 83c44efe67f7..523899557519 100644 --- a/src/providers/arcgisrest/qgsafsprovider.h +++ b/src/providers/arcgisrest/qgsafsprovider.h @@ -25,7 +25,7 @@ #include "qgsfields.h" /** - * @brief A provider reading features from a ArcGIS Feature Service + * \brief A provider reading features from a ArcGIS Feature Service */ class QgsAfsProvider : public QgsVectorDataProvider { diff --git a/src/providers/db2/qgsdb2dataitems.h b/src/providers/db2/qgsdb2dataitems.h index c54913926514..4d152f2c278f 100644 --- a/src/providers/db2/qgsdb2dataitems.h +++ b/src/providers/db2/qgsdb2dataitems.h @@ -25,8 +25,8 @@ class QgsDb2SchemaItem; class QgsDb2LayerItem; /** - * @class QgsDb2RootItem - * @brief Browser Panel DB2 root object. + * \class QgsDb2RootItem + * \brief Browser Panel DB2 root object. */ class QgsDb2RootItem : public QgsDataCollectionItem { @@ -51,8 +51,8 @@ class QgsDb2RootItem : public QgsDataCollectionItem }; /** - * @class QgsDb2ConnectionItem - * @brief Browser Panel DB2 connection object (under root). + * \class QgsDb2ConnectionItem + * \brief Browser Panel DB2 connection object (under root). */ class QgsDb2ConnectionItem : public QgsDataCollectionItem { @@ -125,8 +125,8 @@ class QgsDb2ConnectionItem : public QgsDataCollectionItem }; /** - * @class QgsDb2SchemaItem - * @brief Browser Panel DB2 schema object (under connections). + * \class QgsDb2SchemaItem + * \brief Browser Panel DB2 schema object (under connections). */ class QgsDb2SchemaItem : public QgsDataCollectionItem { @@ -146,8 +146,8 @@ class QgsDb2SchemaItem : public QgsDataCollectionItem }; /** - * @class QgsDb2LayerItem - * @brief Browser Panel DB2 layer object (under schemas). + * \class QgsDb2LayerItem + * \brief Browser Panel DB2 layer object (under schemas). */ class QgsDb2LayerItem : public QgsLayerItem { diff --git a/src/providers/db2/qgsdb2geometrycolumns.h b/src/providers/db2/qgsdb2geometrycolumns.h index a645bdc563a0..8da8d31db628 100644 --- a/src/providers/db2/qgsdb2geometrycolumns.h +++ b/src/providers/db2/qgsdb2geometrycolumns.h @@ -22,8 +22,8 @@ #include /** - * @class QgsDb2GeometryColumns - * @brief Data provider for DB2 server. + * \class QgsDb2GeometryColumns + * \brief Data provider for DB2 server. */ static const int ENV_LUW = 1, ENV_ZOS = 2; diff --git a/src/providers/db2/qgsdb2newconnection.h b/src/providers/db2/qgsdb2newconnection.h index 9797b25ebc5d..2a3853115de8 100644 --- a/src/providers/db2/qgsdb2newconnection.h +++ b/src/providers/db2/qgsdb2newconnection.h @@ -40,7 +40,7 @@ class QgsDb2NewConnection : public QDialog, private Ui::QgsDb2NewConnectionBase bool testConnection(); /** - * @brief List all databases found for the given server. + * \brief List all databases found for the given server. */ void listDatabases(); public slots: diff --git a/src/providers/db2/qgsdb2provider.h b/src/providers/db2/qgsdb2provider.h index 0c74b9d39db2..bd7503561a3a 100644 --- a/src/providers/db2/qgsdb2provider.h +++ b/src/providers/db2/qgsdb2provider.h @@ -26,8 +26,8 @@ #include /** - * @class QgsDb2Provider - * @brief Data provider for DB2 server. + * \class QgsDb2Provider + * \brief Data provider for DB2 server. */ class QgsDb2Provider : public QgsVectorDataProvider { @@ -44,7 +44,7 @@ class QgsDb2Provider : public QgsVectorDataProvider * If service is provided, then username and password is required. * If service is not provided, the remaining arguments are required. * - * @param connInfo A string containing all connection information. + * \param connInfo A string containing all connection information. */ static QSqlDatabase getDatabase( const QString &connInfo, QString &errMsg ); diff --git a/src/providers/delimitedtext/qgsdelimitedtextfile.h b/src/providers/delimitedtext/qgsdelimitedtextfile.h index f8e170fc8a25..95d868e0435b 100644 --- a/src/providers/delimitedtext/qgsdelimitedtextfile.h +++ b/src/providers/delimitedtext/qgsdelimitedtextfile.h @@ -99,12 +99,12 @@ class QgsDelimitedTextFile : public QObject virtual ~QgsDelimitedTextFile(); /** Set the filename - * @param filename the name of the file + * \param filename the name of the file */ void setFileName( const QString &filename ); /** Return the filename - * @return filename the name of the file + * \returns filename the name of the file */ QString fileName() { @@ -112,27 +112,27 @@ class QgsDelimitedTextFile : public QObject } /** Set the file encoding (defuault is UTF-8) - * @param encoding the encoding to use for the fileName() + * \param encoding the encoding to use for the fileName() */ void setEncoding( const QString &encoding ); /** Return the file encoding - * @return encoding The file encoding + * \returns encoding The file encoding */ QString encoding() { return mEncoding; } /** Decode the parser settings from a url as a string - * @param url The url from which the delimiter and delimiterType items are read + * \param url The url from which the delimiter and delimiterType items are read */ bool setFromUrl( const QString &url ); /** Decode the parser settings from a url - * @param url The url from which the delimiter and delimiterType items are read + * \param url The url from which the delimiter and delimiterType items are read */ bool setFromUrl( const QUrl &url ); /** Encode the parser settings into a QUrl - * @return url The url into which the delimiter and delimiterType items are set + * \returns url The url into which the delimiter and delimiterType items are set */ QUrl url(); @@ -141,25 +141,25 @@ class QgsDelimitedTextFile : public QObject void setTypeWhitespace(); /** Set the parser for parsing based on a reqular expression delimiter - * @param regexp A string defining the regular expression + * \param regexp A string defining the regular expression */ void setTypeRegexp( const QString ®exp ); /** Set the parser to use a character type delimiter. - * @param delim The field delimiter character set - * @param quote The quote character, used to define quoted fields - * @param escape The escape character used to escape quote or delim + * \param delim The field delimiter character set + * \param quote The quote character, used to define quoted fields + * \param escape The escape character used to escape quote or delim * characters. */ void setTypeCSV( const QString &delim = QString( "," ), const QString "e = QString( "\"" ), const QString &escape = QString( "\"" ) ); /** Set the number of header lines to skip - * @param skiplines The maximum lines to skip + * \param skiplines The maximum lines to skip */ void setSkipLines( int skiplines ); /** Return the number of header lines to skip - * @return skiplines The maximum lines to skip + * \returns skiplines The maximum lines to skip */ int skipLines() { @@ -167,12 +167,12 @@ class QgsDelimitedTextFile : public QObject } /** Set reading field names from the first record - * @param useheaders Field names will be read if true + * \param useheaders Field names will be read if true */ void setUseHeader( bool useheader = true ); /** Return the option for reading field names from the first record - * @return useheaders Field names will be read if true + * \returns useheaders Field names will be read if true */ bool useHeader() { @@ -180,12 +180,12 @@ class QgsDelimitedTextFile : public QObject } /** Set the option for dicarding empty fields - * @param useheaders Empty fields will be discarded if true + * \param useheaders Empty fields will be discarded if true */ void setDiscardEmptyFields( bool discardEmptyFields = true ); /** Return the option for discarding empty fields - * @return useheaders Empty fields will be discarded if true + * \returns useheaders Empty fields will be discarded if true */ bool discardEmptyFields() { @@ -193,12 +193,12 @@ class QgsDelimitedTextFile : public QObject } /** Set the option for trimming whitespace from fields - * @param trimFields Fields will be trimmed if true + * \param trimFields Fields will be trimmed if true */ void setTrimFields( bool trimFields = true ); /** Return the option for trimming empty fields - * @return useheaders Empty fields will be trimmed if true + * \returns useheaders Empty fields will be trimmed if true */ bool trimFields() { @@ -207,12 +207,12 @@ class QgsDelimitedTextFile : public QObject /** Set the maximum number of fields that will be read from a record * By default the maximum number is unlimited (0) - * @param maxFields The maximum number of fields that will be read + * \param maxFields The maximum number of fields that will be read */ void setMaxFields( int maxFields ); /** Return the maximum number of fields that will be read - * @return maxFields The maximum number of fields that will be read + * \returns maxFields The maximum number of fields that will be read */ int maxFields() { return mMaxFields; } @@ -220,7 +220,7 @@ class QgsDelimitedTextFile : public QObject * Field names are set from QStringList. Names may be modified * to ensure that they are unique, not empty, and do not conflict * with default field name (field_##) - * @param names A list of proposed field names + * \param names A list of proposed field names */ void setFieldNames( const QStringList &names ); @@ -230,21 +230,21 @@ class QgsDelimitedTextFile : public QObject * not been read then the field names are empty until records have * been read. The list may be expanded as the file is read and records * with more fields are loaded. - * @return names A list of field names in the file + * \returns names A list of field names in the file */ QStringList &fieldNames(); /** Return the index of a names field - * @param name The name of the field to find. This will also accept an + * \param name The name of the field to find. This will also accept an * integer string ("1" = first field). - * @return index The zero based index of the field name, or -1 if the field + * \returns index The zero based index of the field name, or -1 if the field * name does not exist or cannot be inferred */ int fieldIndex( const QString &name ); /** Reads the next record from the stream splits into string fields. - * @param fields The string list to populate with the fields - * @return status The result of trying to parse a record. RecordOk + * \param fields The string list to populate with the fields + * \returns status The result of trying to parse a record. RecordOk * if read successfully, RecordEOF if reached the end of the * file, RecordEmpty if no data on the next line, and * RecordInvalid if the record is ill-formatted. @@ -252,7 +252,7 @@ class QgsDelimitedTextFile : public QObject Status nextRecord( QStringList &fields ); /** Return the line number of the start of the last record read - * @return linenumber The line number of the start of the record + * \returns linenumber The line number of the start of the record */ int recordId() { @@ -260,14 +260,14 @@ class QgsDelimitedTextFile : public QObject } /** Set the index of the next record to return. - * @param nextRecordId The id to set the next record to - * @return valid True if the next record can be located + * \param nextRecordId The id to set the next record to + * \returns valid True if the next record can be located */ bool setNextRecordId( long nextRecordId ); /** Number record number of records visited. After scanning the file * serves as a record count. - * @return maxRecordNumber The maximum record number + * \returns maxRecordNumber The maximum record number */ long recordCount() { return mMaxRecordNumber; } @@ -276,32 +276,32 @@ class QgsDelimitedTextFile : public QObject Status reset(); /** Return a string defining the type of the delimiter as a string - * @return type The delimiter type as a string + * \returns type The delimiter type as a string */ QString type(); /** Check that provider is valid (filename and definition valid) * - * @return valid True if the provider is valid + * \returns valid True if the provider is valid */ bool isValid(); /** Encode characters - used to convert delimiter/quote/escape characters to * encoded form (e.g., replace tab with \t) - * @param string The unencoded string - * @return encstring The encoded string + * \param string The unencoded string + * \returns encstring The encoded string */ static QString encodeChars( QString string ); /** Encode characters - used to encoded character strings to * decoded form (e.g., replace \t with tab) - * @param string The unencoded string - * @return decstring The decoded string + * \param string The unencoded string + * \returns decstring The decoded string */ static QString decodeChars( QString string ); /** Set to use or not use a QFileWatcher to notify of changes to the file - * @param useWatcher True to use a watcher, false otherwise + * \param useWatcher True to use a watcher, false otherwise */ void setUseWatcher( bool useWatcher ); @@ -322,7 +322,7 @@ class QgsDelimitedTextFile : public QObject /** Open the file * - * @return valid True if the file is successfully opened + * \returns valid True if the file is successfully opened */ bool open(); diff --git a/src/providers/delimitedtext/qgsdelimitedtextprovider.cpp b/src/providers/delimitedtext/qgsdelimitedtextprovider.cpp index 21a967f3186a..f2dc3b787629 100644 --- a/src/providers/delimitedtext/qgsdelimitedtextprovider.cpp +++ b/src/providers/delimitedtext/qgsdelimitedtextprovider.cpp @@ -1107,17 +1107,11 @@ QgsRectangle QgsDelimitedTextProvider::extent() const return mExtent; } -/** - * Return the feature type - */ QgsWkbTypes::Type QgsDelimitedTextProvider::wkbType() const { return mWkbType; } -/** - * Return the feature type - */ long QgsDelimitedTextProvider::featureCount() const { if ( mRescanRequired ) const_cast( this )->rescanFile(); diff --git a/src/providers/delimitedtext/qgsdelimitedtextprovider.h b/src/providers/delimitedtext/qgsdelimitedtextprovider.h index caee6fa12f89..e502451dff5c 100644 --- a/src/providers/delimitedtext/qgsdelimitedtextprovider.h +++ b/src/providers/delimitedtext/qgsdelimitedtextprovider.h @@ -90,16 +90,8 @@ class QgsDelimitedTextProvider : public QgsVectorDataProvider virtual QgsFeatureIterator getFeatures( const QgsFeatureRequest &request ) const override; - /** - * Get feature type. - * @return int representing the feature type - */ virtual QgsWkbTypes::Type wkbType() const override; - /** - * Number of features in the layer - * @return long containing number of features - */ virtual long featureCount() const override; virtual QgsFields fields() const override; @@ -112,7 +104,7 @@ class QgsDelimitedTextProvider : public QgsVectorDataProvider virtual QgsVectorDataProvider::Capabilities capabilities() const override; /** Creates a spatial index on the data - * @return indexCreated Returns true if a spatial index is created + * \returns indexCreated Returns true if a spatial index is created */ virtual bool createSpatialIndex() override; @@ -125,7 +117,7 @@ class QgsDelimitedTextProvider : public QgsVectorDataProvider * if more than one provider supports a given format, the user is able to * select a specific provider to open that file. * - * @note + * \note * * Instead of being pure virtual, might be better to generalize this * behavior and presume that none of the sub-classes are going to do @@ -137,7 +129,7 @@ class QgsDelimitedTextProvider : public QgsVectorDataProvider * * Return a terse string describing what the provider is. * - * @note + * \note * * Instead of being pure virtual, might be better to generalize this * behavior and presume that none of the sub-classes are going to do @@ -167,9 +159,9 @@ class QgsDelimitedTextProvider : public QgsVectorDataProvider /** * Check to see if the point is withn the selection * rectangle - * @param x X value of point - * @param y Y value of point - * @return True if point is within the rectangle + * \param x X value of point + * \param y Y value of point + * \returns True if point is within the rectangle */ bool boundsCheck( double x, double y ); @@ -177,17 +169,17 @@ class QgsDelimitedTextProvider : public QgsVectorDataProvider /** * Check to see if a geometry overlaps the selection * rectangle - * @param geom geometry to test against bounds - * @param y Y value of point - * @return True if point is within the rectangle + * \param geom geometry to test against bounds + * \param y Y value of point + * \returns True if point is within the rectangle */ bool boundsCheck( QgsGeometry *geom ); /** * Try to read field types from CSVT (or equivalent xxxT) file. - * @param filename The name of the file from which to read the field types - * @param message Pointer to a string to receive a status message - * @return A list of field type strings, empty if not found or not valid + * \param filename The name of the file from which to read the field types + * \param message Pointer to a string to receive a status message + * \returns A list of field type strings, empty if not found or not valid */ QStringList readCsvtFieldTypes( const QString &filename, QString *message = nullptr ); diff --git a/src/providers/grass/qgsgrass.h b/src/providers/grass/qgsgrass.h index 172e322a3973..40a1d64b4cb5 100644 --- a/src/providers/grass/qgsgrass.h +++ b/src/providers/grass/qgsgrass.h @@ -102,7 +102,7 @@ class GRASS_LIB_EXPORT QgsGrassObject void setName( const QString &name ) { mName = name; } /** Return full name (map@mapset) - * @return full name or empty string if map name is empty */ + * \returns full name or empty string if map name is empty */ QString fullName() const; /** Parse full name in map@mapset form and set map and mapset. If mapset is not @@ -217,26 +217,26 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject /** Init or reset GRASS library * - * @param gisdbase full path to GRASS GISDBASE. - * @param location location name (not path!). + * \param gisdbase full path to GRASS GISDBASE. + * \param location location name (not path!). */ static void setLocation( const QString &gisdbase, const QString &location ); /*! - * @param gisdbase full path to GRASS GISDBASE. - * @param location location name (not path!). - * @param mapset current mupset. Note that some variables depend on mapset and + * \param gisdbase full path to GRASS GISDBASE. + * \param location location name (not path!). + * \param mapset current mupset. Note that some variables depend on mapset and * may influence behavior of some functions (e.g. search path etc.) */ static void setMapset( const QString &gisdbase, const QString &location, const QString &mapset ); /** Set mapset according to object gisdbase, location and mapset - * @param grassObject + * \param grassObject */ static void setMapset( const QgsGrassObject &grassObject ); /** Check if mapset is in search pat set by g.mapsets - * @return true if in search path + * \returns true if in search path */ bool isMapsetInSearchPath( const QString &mapset ); @@ -271,7 +271,7 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject /** Open existing GRASS mapset. * Emits signal mapsetChanged(). - * \return Empty string or error message + * \returns Empty string or error message */ static QString openMapset( const QString &gisdbase, const QString &location, const QString &mapset ); @@ -280,7 +280,7 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject * Delete GISRC, lock and temporary directory. * Emits signal mapsetChanged(). * \param showError show error dialog on error - * \return Empty string or error message + * \returns Empty string or error message */ static QString closeMapset(); @@ -360,13 +360,13 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject struct Cell_head *window ); /** Read mapset current region (WIND) - * @throws QgsGrass::Exception + * \throws QgsGrass::Exception */ static void region( const QString &gisdbase, const QString &location, const QString &mapset, struct Cell_head *window ); /** Read default mapset current region (WIND) - * @throws QgsGrass::Exception + * \throws QgsGrass::Exception */ static void region( struct Cell_head *window ); @@ -392,7 +392,7 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject struct Cell_head *target ); /** Initialize GRASS library. This has to be called before any other function is used. - * @return true if successfully initialized */ + * \returns true if successfully initialized */ static bool init( void ); //! test if the directory is location @@ -409,15 +409,15 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject /** Find a module trying to append .bat, .py and .exe on Windows. The module may be a full path * without extension or just a module name in which case it is searched in grassModulesPaths(). - * @param module module name or path to module without extension - * @return full path including extension or empty string */ + * \param module module name or path to module without extension + * \returns full path including extension or empty string */ static QString findModule( QString module ); /** Start a GRASS module in any gisdbase/location/mapset. - * @param mapset if empty a first mapset owned by user will be used, if no mapset is owned + * \param mapset if empty a first mapset owned by user will be used, if no mapset is owned * by user, exception is thrown. - * @param qgisModule append GRASS major version (for modules built in qgis) - * @throws QgsGrass::Exception */ + * \param qgisModule append GRASS major version (for modules built in qgis) + * \throws QgsGrass::Exception */ static QProcess *startModule( const QString &gisdbase, const QString &location, const QString &mapset, const QString &moduleName, const QStringList &arguments, QTemporaryFile &gisrcFile, @@ -430,17 +430,17 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject bool qgisModule = true ); /** \brief Get info string from qgis.g.info module - * @param info info type - * @gisdbase GISBASE path - * @location location name - * @mapset mapset name - * @map map name - * @type map type - * @x x coordinate for query - * @y y coordinate for query - * @extent extent for statistics - * @sampleSize sample size for statistics - * @timeOut timeout + * \param info info type + * \param gisdbase GISBASE path + * \param location location name + * \param mapset mapset name + * \param map map name + * \param type map type + * \param x x coordinate for query + * \param y y coordinate for query + * \param extent extent for statistics + * \param sampleSize sample size for statistics + * \param timeOut timeout */ static QString getInfo( const QString &info, const QString &gisdbase, const QString &location, const QString &mapset = "PERMANENT", @@ -456,7 +456,7 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject static QgsCoordinateReferenceSystem crsDirect( const QString &gisdbase, const QString &location ); // ! Get map extent - // @param error set to error if happens + // \param error set to error if happens static QgsRectangle extent( const QString &gisdbase, const QString &location, const QString &mapset, const QString &map, QgsGrassObject::Type type, QString &error ); @@ -467,7 +467,7 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject // ! Get raster info, info is either 'info' or 'stats' // extent and sampleSize are stats options - // @param error set to error if happens + // \param error set to error if happens static QHash info( const QString &gisdbase, const QString &location, const QString &mapset, const QString &map, QgsGrassObject::Type type, @@ -494,13 +494,13 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject static bool deleteObject( const QgsGrassObject &object ); /** Ask user confirmation to delete a map - * @return true if confirmed + * \returns true if confirmed */ static bool deleteObjectDialog( const QgsGrassObject &object ); /** Create new vector map - * @param object GRASS object specifying location/mapset/map - * @param error */ + * \param object GRASS object specifying location/mapset/map + * \param error */ static void createVectorMap( const QgsGrassObject &object, QString &error ); //! Create new table. Throws QgsGrass::Exception @@ -514,19 +514,19 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject static bool isExternal( const QgsGrassObject &object ); /** Adjust cell header, G_adjust_Cell_head wrapper - * @throws QgsGrass::Exception */ + * \throws QgsGrass::Exception */ static void adjustCellHead( struct Cell_head *cellhd, int row_flag, int col_flag ); //! Get map of vector types / names static QMap vectorTypeMap(); /** Get GRASS vector type from name - * @param point,centroid,line,boundary,area,face,kernel - * @returns type GV_POINT, GV_CENTROID, GV_LINE, GV_BOUNDARY, GV_AREA, GV_FACE,GV_KERNEL */ + * \param point,centroid,line,boundary,area,face,kernel + * \returns type GV_POINT, GV_CENTROID, GV_LINE, GV_BOUNDARY, GV_AREA, GV_FACE,GV_KERNEL */ static int vectorType( const QString &name ); /** Get name for vector primitive type - * @param type GV_POINT, GV_CENTROID, GV_LINE, GV_BOUNDARY, GV_AREA, GV_FACE, GV_KERNEL */ + * \param type GV_POINT, GV_CENTROID, GV_LINE, GV_BOUNDARY, GV_AREA, GV_FACE, GV_KERNEL */ static QString vectorTypeName( int type ); //! Library version @@ -619,10 +619,10 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject void emitNewLayer( const QString &uri, const QString &name ) { emit newLayer( uri, name ); } /** Parse single line of output from GRASS modules run with GRASS_MESSAGE_FORMAT=gui - * @param input input string read from module stderr - * @param text parsed text - * @param html html formatted parsed text, e.g. + icons - * @param value percent 0-100 or progress as absolute number if total is unknown*/ + * \param input input string read from module stderr + * \param text parsed text + * \param html html formatted parsed text, e.g. + icons + * \param value percent 0-100 or progress as absolute number if total is unknown*/ static ModuleOutput parseModuleOutput( const QString &input, QString &text, QString &html, int &value ); public slots: diff --git a/src/providers/grass/qgsgrassfeatureiterator.h b/src/providers/grass/qgsgrassfeatureiterator.h index ea119c6a2dfb..259a5a6992ee 100644 --- a/src/providers/grass/qgsgrassfeatureiterator.h +++ b/src/providers/grass/qgsgrassfeatureiterator.h @@ -114,15 +114,15 @@ class GRASS_LIB_EXPORT QgsGrassFeatureIterator : public QObject, public QgsAbstr void setFeatureGeometry( QgsFeature &feature, int id, int type ); /** Set feature attributes. - * @param feature - * @param cat category number + * \param feature + * \param cat category number */ void setFeatureAttributes( int cat, QgsFeature *feature, QgsGrassVectorMap::TopoSymbol symbol ); /** Set feature attributes. - * @param feature - * @param cat category number - * @param attlist a list containing the index number of the fields to set + * \param feature + * \param cat category number + * \param attlist a list containing the index number of the fields to set */ void setFeatureAttributes( int cat, QgsFeature *feature, const QgsAttributeList &attlist, QgsGrassVectorMap::TopoSymbol symbol ); diff --git a/src/providers/grass/qgsgrassprovider.h b/src/providers/grass/qgsgrassprovider.h index 5339b7c764b3..ea0b1a2bfeb4 100644 --- a/src/providers/grass/qgsgrassprovider.h +++ b/src/providers/grass/qgsgrassprovider.h @@ -81,7 +81,7 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider QVariant minimumValue( int index ) const override; /** Returns the maximum value of an attribute - * @param index the index of the attribute */ + * \param index the index of the attribute */ QVariant maxValue( int index ); /** Update (reload) non static members (marked !UPDATE!) from the static layer and the map. @@ -115,21 +115,21 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider // ----------------------------------- Edit ---------------------------------- /** Is the layer editable? I.e. the layer is valid and current user is owner of the mapset - * @return true the layer editable - * @return false the is not editable + * \returns true the layer editable + * \returns false the is not editable */ bool isGrassEditable(); /** Returns true if the layer is currently edited (opened in update mode) - * @return true in update mode - * @return false not edited + * \returns true in update mode + * \returns false not edited */ bool isEdited(); /** Returns true if the layer is currently froze, i.e. a module * from GRASS Tools is writing to this vector - * @return true in update mode - * @return false not edited + * \returns true in update mode + * \returns false not edited */ bool isFrozen(); @@ -144,107 +144,107 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider void thaw(); /** Close editing. Rebuild topology, GMAP.update = false - * @param newMap set to true if a new map was created + * \param newMap set to true if a new map was created * and it is not yet used as layer - * @return true success - * @return false failed to close vector or vector was not in update mode + * \returns true success + * \returns false failed to close vector or vector was not in update mode */ bool closeEdit( bool newMap = false, QgsVectorLayer *vectorLayer = 0 ); /** Get current number of lines. - * @return number of lines + * \returns number of lines */ int numLines( void ); /** Get current number of nodes. - * @return number of nodes + * \returns number of nodes */ int numNodes( void ); /** Read line - * @param Points pointer to existing structure or NULL - * @param Cats pointer to existing structure or NULL - * @param line line number - * @return line type - * @return <0 deadline or error + * \param Points pointer to existing structure or NULL + * \param Cats pointer to existing structure or NULL + * \param line line number + * \returns line type + * \returns <0 deadline or error */ int readLine( struct line_pnts *Points, struct line_cats *Cats, int line ); /** Read node coordinates - * @param line line number - * @return true node is alive - * @return false node is dead + * \param line line number + * \returns true node is alive + * \returns false node is dead */ bool nodeCoor( int node, double *x, double *y ); /** Read line nodes - * @param line line number - * @return true line is alive - * @return false line is dead + * \param line line number + * \returns true line is alive + * \returns false line is dead */ bool lineNodes( int line, int *node1, int *node2 ); /** Read boundary areas - * @param line line number - * @return true line is alive - * @return false line is dead + * \param line line number + * \returns true line is alive + * \returns false line is dead */ bool lineAreas( int line, int *left, int *right ); /** Get isle area - * @param isle number - * @return area number + * \param isle number + * \returns area number */ int isleArea( int isle ); /** Get centroid area - * @param centroid line number - * @return area number (negative for island) + * \param centroid line number + * \returns area number (negative for island) */ int centroidArea( int centroid ); /** Get number of lines at node - * @param node node number - * @return number of lines at node (including dead lines) + * \param node node number + * \returns number of lines at node (including dead lines) */ int nodeNLines( int node ); /** Get line number of line at node for given line index - * @param node node number - * @param idx line index - * @return line number + * \param node node number + * \param idx line index + * \returns line number */ int nodeLine( int node, int idx ); /** True if line is alive - * @param line line number - * @return true alive - * @return false dead + * \param line line number + * \returns true alive + * \returns false dead */ int lineAlive( int line ); /** True if node is alive - * @param node node number - * @return true alive - * @return false dead + * \param node node number + * \returns true alive + * \returns false dead */ int nodeAlive( int node ); /** Write a new line into vector. - * @return line number - * @return -1 error + * \returns line number + * \returns -1 error */ int writeLine( int type, struct line_pnts *Points, struct line_cats *Cats ); /** Rewrite line. - * @return line number - * @return -1 error + * \returns line number + * \returns -1 error */ int rewriteLine( int lid, int type, struct line_pnts *Points, struct line_cats *Cats ); /** Delete line - * @return 0 OK - * @return -1 error + * \returns 0 OK + * \returns -1 error */ int deleteLine( int line ); @@ -265,42 +265,42 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider int updatedNode( int idx ); /** Find nearest line - * @param threshold maximum distance - * @return line number - * @return 0 nothing found + * \param threshold maximum distance + * \returns line number + * \returns 0 nothing found */ int findLine( double x, double y, int type, double threshold ); /** Find nearest node - * @param threshold maximum distance - * @return node number - * @return 0 nothing found + * \param threshold maximum distance + * \returns node number + * \returns 0 nothing found */ int findNode( double x, double y, double threshold ); // TODO is it used? /** Read attributes from DB - * @param field - * @param cat - * @return vector of attributes + * \param field + * \param cat + * \returns vector of attributes */ QgsAttributeMap *attributes( int field, int cat ); /** Key (cat) column name - * @param field - * @return Key column name or empty string + * \param field + * \returns Key column name or empty string */ QString key( int field ); /** Get number of db links - * @return number of links + * \returns number of links */ int numDbLinks( void ); /** Get db link field - * @param link - * @return field number or 0 + * \param link + * \returns field number or 0 */ int dbLinkField( int link ); @@ -405,10 +405,10 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider static QgsFeatureId makeFeatureId( int grassId, int cat ); /** Get attribute by category(key) and attribute number. - * @param layerId - * @param category (key) - * @param column column number ( < nColumns ) - * @return pointer to string representation of the value or NULL, this value must not be changed + * \param layerId + * \param category (key) + * \param column column number ( < nColumns ) + * \returns pointer to string representation of the value or NULL, this value must not be changed */ static char *attribute( int layerId, int cat, int column ); diff --git a/src/providers/grass/qgsgrassrasterprovider.h b/src/providers/grass/qgsgrassrasterprovider.h index e08695418549..d887dfddb919 100644 --- a/src/providers/grass/qgsgrassrasterprovider.h +++ b/src/providers/grass/qgsgrassrasterprovider.h @@ -113,7 +113,7 @@ class GRASS_LIB_EXPORT QgsGrassRasterProvider : public QgsRasterDataProvider * if more than one provider supports a given format, the user is able to * select a specific provider to open that file. * - * @note + * \note * * Instead of being pure virtual, might be better to generalize this * behavior and presume that none of the sub-classes are going to do @@ -127,7 +127,7 @@ class GRASS_LIB_EXPORT QgsGrassRasterProvider : public QgsRasterDataProvider * * Return a terse string describing what the provider is. * - * @note + * \note * * Instead of being pure virtual, might be better to generalize this * behavior and presume that none of the sub-classes are going to do diff --git a/src/providers/grass/qgsgrassvector.h b/src/providers/grass/qgsgrassvector.h index 8695ecb583aa..54ea1aa288b8 100644 --- a/src/providers/grass/qgsgrassvector.h +++ b/src/providers/grass/qgsgrassvector.h @@ -89,14 +89,14 @@ class GRASS_LIB_EXPORT QgsGrassVector : public QObject QList layers() const { return mLayers; } /** Get numbers of primitives - * @return type/count pairs */ + * \returns type/count pairs */ QMap typeCounts() const {return mTypeCounts; } //! Get total number of primitives of given type. Types may be combined by bitwise or) int typeCount( int type ) const; /** Maximum layer number (field). - * @return max layer number or 0 if no layer exists */ + * \returns max layer number or 0 if no layer exists */ int maxLayerNumber() const; //! Get number of nodes diff --git a/src/providers/grass/qgsgrassvectormap.h b/src/providers/grass/qgsgrassvectormap.h index 75fea239fe13..b94518c14aaf 100644 --- a/src/providers/grass/qgsgrassvectormap.h +++ b/src/providers/grass/qgsgrassvectormap.h @@ -63,7 +63,7 @@ class GRASS_LIB_EXPORT QgsGrassVectorMap : public QObject int userCount() const; /** Get current number of lines. - * @return number of lines */ + * \returns number of lines */ int numLines(); int numAreas(); // 3D map with z coordinates @@ -89,7 +89,7 @@ class GRASS_LIB_EXPORT QgsGrassVectorMap : public QObject QMap > &undoCommands() { return mUndoCommands; } /** Get geometry of line. - * @return geometry (point,line or polygon(GV_FACE)) or 0 */ + * \returns geometry (point,line or polygon(GV_FACE)) or 0 */ QgsAbstractGeometry *lineGeometry( int id ); QgsAbstractGeometry *nodeGeometry( int id ); QgsAbstractGeometry *areaGeometry( int id ); @@ -114,13 +114,13 @@ class GRASS_LIB_EXPORT QgsGrassVectorMap : public QObject void clearUndoCommands(); /** Get layer, layer is created and loaded if not yet. - * @param field - * @return pointer to layer or 0 if layer doe not exist */ + * \param field + * \returns pointer to layer or 0 if layer doe not exist */ QgsGrassVectorMapLayer *openLayer( int field ); /** Close layer and release cached data if there are no more users and close map * if there are no more map users. - * @param layer */ + * \param layer */ void closeLayer( QgsGrassVectorMapLayer *layer ); /** Update map. Close and reopen vector and refresh layers. @@ -141,8 +141,8 @@ class GRASS_LIB_EXPORT QgsGrassVectorMap : public QObject QString toString(); /** Get topology symbol code - * @param lid line or area number - * @param type geometry type */ + * \param lid line or area number + * \param type geometry type */ TopoSymbol topoSymbol( int lid ); static QString topoSymbolFieldName() { return QStringLiteral( "topo_symbol" ) ; } @@ -227,8 +227,8 @@ class GRASS_LIB_EXPORT QgsGrassVectorMapStore static void setStore( QgsGrassVectorMapStore *store ) { sStore = store; } /** Open map. - * @param grassObject - * @return map, the map may be invalide */ + * \param grassObject + * \returns map, the map may be invalide */ QgsGrassVectorMap *openMap( const QgsGrassObject &grassObject ); private: diff --git a/src/providers/grass/qgsgrassvectormaplayer.h b/src/providers/grass/qgsgrassvectormaplayer.h index 555f926c7230..40d7fec2098a 100644 --- a/src/providers/grass/qgsgrassvectormaplayer.h +++ b/src/providers/grass/qgsgrassvectormaplayer.h @@ -103,55 +103,55 @@ class GRASS_LIB_EXPORT QgsGrassVectorMapLayer : public QObject void setMapset(); /** Execute SQL statement - * @param sql */ + * \param sql */ void executeSql( const QString &sql, QString &error ); /** Update attributes - * @param cat - * @param index ields index */ + * \param cat + * \param index ields index */ void changeAttributeValue( int cat, const QgsField &field, const QVariant &value, QString &error ); /** Insert new attributes to the table (it does not check if attributes already exists) - * @param cat */ + * \param cat */ void insertAttributes( int cat, const QgsFeature &feature, QString &error ); /** Restore previously deleted table record using data from mAttributes, if exists. * If there the cat is not in mAttributes, nothing is inserted (to keep previous state). - * @param cat */ + * \param cat */ void reinsertAttributes( int cat, QString &error ); /** Update existing record by values from feature. - * @param cat - * @param nullValues override all values, if false, only non empty values are used for update + * \param cat + * \param nullValues override all values, if false, only non empty values are used for update */ void updateAttributes( int cat, QgsFeature &feature, QString &error, bool nullValues = false ); /** Delete attributes from the table - * @param cat + * \param cat */ void deleteAttribute( int cat, QString &error ); /** Check if a database row exists - * @param cat - * @param error set to error if happens - * @return true if cat is orphan + * \param cat + * \param error set to error if happens + * \returns true if cat is orphan */ bool recordExists( int cat, QString &error ); /** Check if a database row exists and it is orphan (no more lines with that category) - * @param cat - * @param error set to error if happens - * @return true if cat is orphan + * \param cat + * \param error set to error if happens + * \returns true if cat is orphan */ bool isOrphan( int cat, QString &error ); /** Create table and link vector to this table - * @param fields fields to be created without cat (id) field + * \param fields fields to be created without cat (id) field */ void createTable( const QgsFields &fields, QString &error ); /** Add column to table - * @param field + * \param field */ void addColumn( const QgsField &field, QString &error ); diff --git a/src/providers/mssql/qgsmssqlnewconnection.h b/src/providers/mssql/qgsmssqlnewconnection.h index a3c87c28e542..09c8a59bc1c9 100644 --- a/src/providers/mssql/qgsmssqlnewconnection.h +++ b/src/providers/mssql/qgsmssqlnewconnection.h @@ -39,7 +39,7 @@ class QgsMssqlNewConnection : public QDialog, private Ui::QgsMssqlNewConnectionB bool testConnection( const QString &testDatabase = QString() ); /** - * @brief List all databases found for the given server. + * \brief List all databases found for the given server. */ void listDatabases(); public slots: diff --git a/src/providers/ogr/qgsogrconnpool.h b/src/providers/ogr/qgsogrconnpool.h index ff9ffa195a87..bb503d540d8e 100644 --- a/src/providers/ogr/qgsogrconnpool.h +++ b/src/providers/ogr/qgsogrconnpool.h @@ -111,9 +111,9 @@ class QgsOgrConnPool : public QgsConnectionPool &layers, bool searchGeometryColumnsOnly = true, @@ -285,8 +285,8 @@ class QgsPostgresConn : public QObject const QString &schema = QString() ); /** Get the list of database schemas - * @param schemas list to store schemas in - * @returns true if schemas where fetched successfully + * \param schemas list to store schemas in + * \returns true if schemas where fetched successfully * \since QGIS 2.7 */ bool getSchemas( QList &schemas ); @@ -294,12 +294,12 @@ class QgsPostgresConn : public QObject void retrieveLayerTypes( QgsPostgresLayerProperty &layerProperty, bool useEstimatedMetadata ); /** Gets information about the spatial tables - * @param searchGeometryColumnsOnly only look for geometry columns which are + * \param searchGeometryColumnsOnly only look for geometry columns which are * contained in the geometry_columns metatable - * @param searchPublicOnly - * @param allowGeometrylessTables - * @param schema restrict tables to those within specified schema - * @returns true if tables were successfully queried + * \param searchPublicOnly + * \param allowGeometrylessTables + * \param schema restrict tables to those within specified schema + * \returns true if tables were successfully queried */ bool getTableInfo( bool searchGeometryColumnsOnly, bool searchPublicOnly, bool allowGeometrylessTables, const QString &schema = QString() ); @@ -395,7 +395,7 @@ class QgsPostgresConn : public QObject /** * Flag indicating whether data from binary cursors must undergo an * endian conversion prior to use - @note + \note XXX Umm, it'd be helpful to know what we're swapping from and to. XXX Presumably this means swapping from big-endian (network) byte order diff --git a/src/providers/postgres/qgspostgresprovider.h b/src/providers/postgres/qgspostgresprovider.h index 052071cc6684..2485b94a68ec 100644 --- a/src/providers/postgres/qgspostgresprovider.h +++ b/src/providers/postgres/qgspostgresprovider.h @@ -50,7 +50,7 @@ class QgsPostgresProvider : public QgsVectorDataProvider public: /** Import a vector layer into the database - * @param options options for provider, specified via a map of option name + * \param options options for provider, specified via a map of option name * to value. Valid options are lowercaseFieldNames (set to true to convert * field names to lowercase), dropStringConstraints (set to true to remove * length constraints on character fields). @@ -69,7 +69,7 @@ class QgsPostgresProvider : public QgsVectorDataProvider /** * Constructor for the provider. The uri must be in the following format: * host=localhost dbname=test [user=gsherman [password=xxx] | authcfg=xxx] table=test.alaska (the_geom) - * @param uri String containing the required parameters to connect to the database + * \param uri String containing the required parameters to connect to the database * and query the table. */ explicit QgsPostgresProvider( QString const &uri = "" ); @@ -84,7 +84,7 @@ class QgsPostgresProvider : public QgsVectorDataProvider QgsWkbTypes::Type wkbType() const override; /** Return the number of layers for the current data source - * @note Should this be subLayerCount() instead? + * \note Should this be subLayerCount() instead? */ size_t layerCount() const; @@ -174,10 +174,10 @@ class QgsPostgresProvider : public QgsVectorDataProvider /** * Convert the postgres string representation into the given QVariant type. - * @param type the wanted type - * @param subType if type is a collection, the wanted element type - * @param value the value to convert - * @return a QVariant of the given type or a null QVariant + * \param type the wanted type + * \param subType if type is a collection, the wanted element type + * \param value the value to convert + * \returns a QVariant of the given type or a null QVariant */ static QVariant convertValue( QVariant::Type type, QVariant::Type subType, const QString &value ); @@ -221,8 +221,8 @@ class QgsPostgresProvider : public QgsVectorDataProvider QString geomParam( int offset ) const; /** Get parametrized primary key clause - * @param offset specifies offset to use for the pk value parameter - * @param alias specifies an optional alias given to the subject table + * \param offset specifies offset to use for the pk value parameter + * \param alias specifies an optional alias given to the subject table */ QString pkParamWhereClause( int offset, const char *alias = nullptr ) const; QString whereClause( QgsFeatureId featureId ) const; @@ -245,24 +245,24 @@ class QgsPostgresProvider : public QgsVectorDataProvider static bool convertField( QgsField &field, const QMap *options = nullptr ); /** Parses the enum_range of an attribute and inserts the possible values into a stringlist - @param enumValues the stringlist where the values are appended - @param attributeName the name of the enum attribute - @return true in case of success and fals in case of error (e.g. if the type is not an enum type)*/ + \param enumValues the stringlist where the values are appended + \param attributeName the name of the enum attribute + \returns true in case of success and fals in case of error (e.g. if the type is not an enum type)*/ bool parseEnumRange( QStringList &enumValues, const QString &attributeName ) const; /** Parses the possible enum values of a domain type (given in the check constraint of the domain type) - * @param enumValues Reference to list that receives enum values - * @param attributeName Name of the domain type attribute - * @return true in case of success and false in case of error (e.g. if the attribute is not a domain type or does not have a check constraint) + * \param enumValues Reference to list that receives enum values + * \param attributeName Name of the domain type attribute + * \returns true in case of success and false in case of error (e.g. if the attribute is not a domain type or does not have a check constraint) */ bool parseDomainCheckConstraint( QStringList &enumValues, const QString &attributeName ) const; /** Return the type of primary key for a PK field * - * @param fld the field to determine PK type of - * @return the PrimaryKeyType + * \param fld the field to determine PK type of + * \returns the PrimaryKeyType * - * @note that this only makes sense for single-field primary keys, + * \note that this only makes sense for single-field primary keys, * whereas multi-field keys always need the PktFidMap * primary key type. */ diff --git a/src/providers/spatialite/qgsspatialiteconnection.h b/src/providers/spatialite/qgsspatialiteconnection.h index c14381a079b0..cc99914fd1cb 100644 --- a/src/providers/spatialite/qgsspatialiteconnection.h +++ b/src/providers/spatialite/qgsspatialiteconnection.h @@ -86,7 +86,7 @@ class QgsSpatiaLiteConnection : public QObject int checkHasMetadataTables( sqlite3 *handle ); /** Inserts information about the spatial tables into mTables - @return true if querying of tables was successful, false on error */ + \returns true if querying of tables was successful, false on error */ bool getTableInfo( sqlite3 *handle, bool loadGeometrylessTables ); #ifdef SPATIALITE_VERSION_GE_4_0_0 diff --git a/src/providers/spatialite/qgsspatialiteprovider.h b/src/providers/spatialite/qgsspatialiteprovider.h index 0db4e88de26c..d4b607545ff3 100644 --- a/src/providers/spatialite/qgsspatialiteprovider.h +++ b/src/providers/spatialite/qgsspatialiteprovider.h @@ -69,7 +69,7 @@ class QgsSpatiaLiteProvider: public QgsVectorDataProvider /** * Constructor of the vector provider - * @param uri uniform resource locator (URI) for a dataset + * \param uri uniform resource locator (URI) for a dataset */ explicit QgsSpatiaLiteProvider( QString const &uri = "" ); @@ -86,7 +86,7 @@ class QgsSpatiaLiteProvider: public QgsVectorDataProvider /** Return the number of layers for the current data source * - * @note Should this be subLayerCount() instead? + * \note Should this be subLayerCount() instead? */ size_t layerCount() const; diff --git a/src/providers/virtual/qgsvirtuallayerprovider.h b/src/providers/virtual/qgsvirtuallayerprovider.h index bc6766dae90f..6999cb370fa4 100644 --- a/src/providers/virtual/qgsvirtuallayerprovider.h +++ b/src/providers/virtual/qgsvirtuallayerprovider.h @@ -32,7 +32,7 @@ class QgsVirtualLayerProvider: public QgsVectorDataProvider /** * Constructor of the vector provider - * @param uri uniform resource locator (URI) for a dataset + * \param uri uniform resource locator (URI) for a dataset */ explicit QgsVirtualLayerProvider( QString const &uri = "" ); diff --git a/src/providers/wcs/qgswcscapabilities.h b/src/providers/wcs/qgswcscapabilities.h index f41cd89fdabe..92ec83abcc45 100644 --- a/src/providers/wcs/qgswcscapabilities.h +++ b/src/providers/wcs/qgswcscapabilities.h @@ -265,7 +265,7 @@ class QgsWcsCapabilities : public QObject //! Retrieve the best WCS version supported by server and QGIS bool retrieveServerCapabilities(); - //! \return false if the capabilities document could not be parsed - see lastError() for more info + //! \returns false if the capabilities document could not be parsed - see lastError() for more info bool parseCapabilitiesDom( QByteArray const &xml, QgsWcsCapabilitiesProperty &capabilities ); // ------------- 1.0 -------------------- diff --git a/src/providers/wfs/qgswfsconnection.h b/src/providers/wfs/qgswfsconnection.h index 55fcf7d15ef3..e95b21d8dee6 100644 --- a/src/providers/wfs/qgswfsconnection.h +++ b/src/providers/wfs/qgswfsconnection.h @@ -24,7 +24,7 @@ class QgsWfsConnection : public QgsOwsConnection /** * Constructor - * @param connName connection name + * \param connName connection name */ explicit QgsWfsConnection( const QString &connName ); diff --git a/src/providers/wfs/qgswfsfeatureiterator.h b/src/providers/wfs/qgswfsfeatureiterator.h index 0f3936cbf03d..8db94c63a249 100644 --- a/src/providers/wfs/qgswfsfeatureiterator.h +++ b/src/providers/wfs/qgswfsfeatureiterator.h @@ -94,8 +94,8 @@ class QgsWFSFeatureDownloader: public QgsWfsRequest ~QgsWFSFeatureDownloader(); /** Start the download. - * @param serializeFeatures whether to notify the sharedData serializer. - * @param maxFeatures user-defined limit of features to download. Overrides + * \param serializeFeatures whether to notify the sharedData serializer. + * \param maxFeatures user-defined limit of features to download. Overrides * the one defined in the URI. Typically by the QgsWFSProvider, * when it cannot guess the geometry type. */ diff --git a/src/providers/wfs/qgswfsprovider.h b/src/providers/wfs/qgswfsprovider.h index 7c43186c7478..124f2464472b 100644 --- a/src/providers/wfs/qgswfsprovider.h +++ b/src/providers/wfs/qgswfsprovider.h @@ -161,7 +161,7 @@ class QgsWFSProvider : public QgsVectorDataProvider //helper methods for WFS-T /** Sends the transaction document to the server using HTTP POST - @return true if transmission to the server succeeded, otherwise false + \returns true if transmission to the server succeeded, otherwise false note: true does not automatically mean that the transaction succeeded*/ bool sendTransactionDocument( const QDomDocument &doc, QDomDocument &serverResponse ); diff --git a/src/providers/wfs/qgswfssourceselect.h b/src/providers/wfs/qgswfssourceselect.h index fcc2fcae25f5..6cceae88893f 100644 --- a/src/providers/wfs/qgswfssourceselect.h +++ b/src/providers/wfs/qgswfssourceselect.h @@ -77,7 +77,7 @@ class QgsWFSSourceSelect: public QDialog, private Ui::QgsWFSSourceSelectBase 1. project CRS if contained in the set 2. WGS84 if contained in the set 3. the first entry in the set else - @return the authority id of the crs or an empty string in case of error*/ + \returns the authority id of the crs or an empty string in case of error*/ QString getPreferredCrs( const QSet &crsSet ) const; private slots: diff --git a/src/providers/wms/qgstilecache.h b/src/providers/wms/qgstilecache.h index 9d4186c50770..f440a65bed41 100644 --- a/src/providers/wms/qgstilecache.h +++ b/src/providers/wms/qgstilecache.h @@ -38,7 +38,7 @@ class QgsTileCache static void insertTile( const QUrl &url, const QImage &image ); //! Try to access a tile and load it into "image" argument - //! @returns true if the tile exists in the cache + //! \returns true if the tile exists in the cache static bool tile( const QUrl &url, QImage &image ); //! how many tiles are stored in the in-memory cache diff --git a/src/providers/wms/qgswmsprovider.h b/src/providers/wms/qgswmsprovider.h index 6b52e43cc17c..4886fd743a2e 100644 --- a/src/providers/wms/qgswmsprovider.h +++ b/src/providers/wms/qgswmsprovider.h @@ -346,7 +346,7 @@ class QgsWmsProvider : public QgsRasterDataProvider /** Return the full url to request legend graphic * The visibleExtent isi only used if provider supports contextual * legends according to the QgsWmsSettings - * @added in 2.8 + * \since QGIS 2.8 */ QUrl getLegendGraphicFullURL( double scale, const QgsRectangle &visibleExtent ); diff --git a/src/python/qgspythonutils.h b/src/python/qgspythonutils.h index fa82eb6d7a2f..473f297da006 100644 --- a/src/python/qgspythonutils.h +++ b/src/python/qgspythonutils.h @@ -67,17 +67,17 @@ class PYTHON_EXPORT QgsPythonUtils /* console */ //! run a statement, show an error message on error - //! @return true if no error occurred + //! \returns true if no error occurred virtual bool runString( const QString &command, QString msgOnError = QString(), bool single = true ) = 0; //! run a statement, error reporting is not done - //! @return true if no error occurred + //! \returns true if no error occurred virtual bool runStringUnsafe( const QString &command, bool single = true ) = 0; virtual bool evalString( const QString &command, QString &result ) = 0; //! get information about error to the supplied arguments - //! @return false if there was no Python error + //! \returns false if there was no Python error virtual bool getError( QString &errorClassName, QString &errorText ) = 0; /* plugins */ @@ -98,7 +98,7 @@ class PYTHON_EXPORT QgsPythonUtils virtual bool startPlugin( const QString &packageName ) = 0; //! helper function to get some information about plugin - //! @param function one of these strings: name, tpye, version, description + //! \param function one of these strings: name, tpye, version, description virtual QString getPluginMetadata( const QString &pluginName, const QString &function ) = 0; //! confirm that the plugin can be uninstalled diff --git a/src/python/qgspythonutilsimpl.h b/src/python/qgspythonutilsimpl.h index 10b981567e4d..1d552d8783e5 100644 --- a/src/python/qgspythonutilsimpl.h +++ b/src/python/qgspythonutilsimpl.h @@ -57,20 +57,20 @@ class QgsPythonUtilsImpl : public QgsPythonUtils //! run a statement (wrapper for PyRun_String) //! this command is more advanced as enables error checking etc. //! when an exception is raised, it shows dialog with exception details - //! @return true if no error occurred + //! \returns true if no error occurred bool runString( const QString &command, QString msgOnError = QString(), bool single = true ) override; //! run a statement, error reporting is not done - //! @return true if no error occurred + //! \returns true if no error occurred bool runStringUnsafe( const QString &command, bool single = true ) override; bool evalString( const QString &command, QString &result ) override; - //! @return object's type name as a string + //! \returns object's type name as a string QString getTypeAsString( PyObject *obj ); //! get information about error to the supplied arguments - //! @return false if there was no Python error + //! \returns false if there was no Python error bool getError( QString &errorClassName, QString &errorText ) override; /* plugins related functions */ @@ -103,7 +103,7 @@ class QgsPythonUtilsImpl : public QgsPythonUtils bool startPlugin( const QString &packageName ) override; //! helper function to get some information about plugin - //! @param function one of these strings: name, tpye, version, description + //! \param function one of these strings: name, tpye, version, description QString getPluginMetadata( const QString &pluginName, const QString &function ) override; //! confirm it is safe to uninstall the plugin @@ -120,10 +120,10 @@ class QgsPythonUtilsImpl : public QgsPythonUtils void init(); //! check qgis imports and plugins - //@return true if all imports worked + //\returns true if all imports worked bool checkSystemImports(); - //@return true if qgis.user could be imported + //\returns true if qgis.user could be imported bool checkQgisUser(); //! import custom user and global Python code (startup scripts) diff --git a/src/server/qgsaccesscontrol.h b/src/server/qgsaccesscontrol.h index 1a6dba136640..34f6c910aaef 100644 --- a/src/server/qgsaccesscontrol.h +++ b/src/server/qgsaccesscontrol.h @@ -58,74 +58,74 @@ class SERVER_EXPORT QgsAccessControl : public QgsFeatureFilterProvider } /** Resolve features' filter of layers - * @param layers to filter + * \param layers to filter */ void resolveFilterFeatures( const QList &layers ); /** Filter the features of the layer - * @param layer the layer to control - * @param filterFeatures the request to fill + * \param layer the layer to control + * \param filterFeatures the request to fill */ void filterFeatures( const QgsVectorLayer *layer, QgsFeatureRequest &filterFeatures ) const; /** Return a clone of the object - * @return A clone + * \returns A clone */ QgsFeatureFilterProvider *clone() const; /** Return an additional subset string (typically SQL) filter - * @param layer the layer to control - * @return the subset string to use + * \param layer the layer to control + * \returns the subset string to use */ QString extraSubsetString( const QgsVectorLayer *layer ) const; /** Return the layer read right - * @param layer the layer to control - * @return true if it can be read + * \param layer the layer to control + * \returns true if it can be read */ bool layerReadPermission( const QgsMapLayer *layer ) const; /** Return the layer insert right - * @param layer the layer to control - * @return true if we can insert on it + * \param layer the layer to control + * \returns true if we can insert on it */ bool layerInsertPermission( const QgsVectorLayer *layer ) const; /** Return the layer update right - * @param layer the layer to control - * @return true if we can do an update + * \param layer the layer to control + * \returns true if we can do an update */ bool layerUpdatePermission( const QgsVectorLayer *layer ) const; /** Return the layer delete right - * @param layer the layer to control - * @return true if we can do a delete + * \param layer the layer to control + * \returns true if we can do a delete */ bool layerDeletePermission( const QgsVectorLayer *layer ) const; /** Return the authorized layer attributes - * @param layer the layer to control - * @param attributes the list of attribute - * @return the list of visible attributes + * \param layer the layer to control + * \param attributes the list of attribute + * \returns the list of visible attributes */ QStringList layerAttributes( const QgsVectorLayer *layer, const QStringList &attributes ) const; /** Are we authorized to modify the following geometry - * @param layer the layer to control - * @param feature the concerned feature - * @return true if we are allowed to edit the feature + * \param layer the layer to control + * \param feature the concerned feature + * \returns true if we are allowed to edit the feature */ bool allowToEdit( const QgsVectorLayer *layer, const QgsFeature &feature ) const; /** Fill the capabilities caching key - * @param cacheKey the list to fill with a cache variant - * @return false if we can't create a cache + * \param cacheKey the list to fill with a cache variant + * \returns false if we can't create a cache */ bool fillCacheKey( QStringList &cacheKey ) const; /** Register an access control filter - * @param accessControl the access control to add - * @priority the priority used to define the order + * \param accessControl the access control to add + * \param priority the priority used to define the order */ void registerAccessControl( QgsAccessControlFilter *accessControl, int priority = 0 ); diff --git a/src/server/qgsaccesscontrolfilter.h b/src/server/qgsaccesscontrolfilter.h index 89e6d004e632..6c44c07b3b38 100644 --- a/src/server/qgsaccesscontrolfilter.h +++ b/src/server/qgsaccesscontrolfilter.h @@ -71,39 +71,39 @@ class SERVER_EXPORT QgsAccessControlFilter const QgsServerInterface *serverInterface() const { return mServerInterface; } /** Return an additional expression filter - * @param layer the layer to control - * @return the filter expression + * \param layer the layer to control + * \returns the filter expression */ virtual QString layerFilterExpression( const QgsVectorLayer *layer ) const; /** Return an additional subset string (typically SQL) filter - * @param layer the layer to control - * @return the subset string + * \param layer the layer to control + * \returns the subset string */ virtual QString layerFilterSubsetString( const QgsVectorLayer *layer ) const; /** Return the layer permissions - * @param layer the layer to control - * @return the permission to use on the layer + * \param layer the layer to control + * \returns the permission to use on the layer */ virtual LayerPermissions layerPermissions( const QgsMapLayer *layer ) const; /** Return the authorized layer attributes - * @param layer the layer to control - * @param attributes the current list of visible attribute - * @return the new list of visible attributes + * \param layer the layer to control + * \param attributes the current list of visible attribute + * \returns the new list of visible attributes */ virtual QStringList authorizedLayerAttributes( const QgsVectorLayer *layer, const QStringList &attributes ) const; /** Are we authorized to modify the following geometry - * @param layer the layer to control - * @param feature the concerned feature - * @return true if we are allowed to edit + * \param layer the layer to control + * \param feature the concerned feature + * \returns true if we are allowed to edit */ virtual bool allowToEdit( const QgsVectorLayer *layer, const QgsFeature &feature ) const; /** Cache key to used to create the capabilities cache - * @return the cache key, "" for no cache + * \returns the cache key, "" for no cache */ virtual QString cacheKey() const; diff --git a/src/server/qgsbufferserverresponse.h b/src/server/qgsbufferserverresponse.h index ab084d4a760e..644c778d6acc 100644 --- a/src/server/qgsbufferserverresponse.h +++ b/src/server/qgsbufferserverresponse.h @@ -96,16 +96,16 @@ class QgsBufferServerRequest : public QgsServerRequest /** * Constructor * - * @param url the url string - * @param method the request method + * \param url the url string + * \param method the request method */ QgsBufferServerRequest( const QString &url, Method method = GetMethod, QByteArray *data = nullptr ); /** * Constructor * - * @param url QUrl - * @param method the request method + * \param url QUrl + * \param method the request method */ QgsBufferServerRequest( const QUrl &url, Method method = GetMethod, QByteArray *data = nullptr ); diff --git a/src/server/qgscapabilitiescache.h b/src/server/qgscapabilitiescache.h index d9690afac8f5..7d46397f05da 100644 --- a/src/server/qgscapabilitiescache.h +++ b/src/server/qgscapabilitiescache.h @@ -34,20 +34,20 @@ class SERVER_EXPORT QgsCapabilitiesCache : public QObject QgsCapabilitiesCache(); /** Returns cached capabilities document (or 0 if document for configuration file not in cache) - * @param configFilePath the progect file path - * @param key key used to separate different version in different cache + * \param configFilePath the progect file path + * \param key key used to separate different version in different cache */ const QDomDocument *searchCapabilitiesDocument( const QString &configFilePath, const QString &key ); /** Inserts new capabilities document (creates a copy of the document, does not take ownership) - * @param configFilePath the project file path - * @param key key used to separate different version in different cache - * @param doc the DOM document + * \param configFilePath the project file path + * \param key key used to separate different version in different cache + * \param doc the DOM document */ void insertCapabilitiesDocument( const QString &configFilePath, const QString &key, const QDomDocument *doc ); /** Remove capabilities document - * @param path the project file path + * \param path the project file path * \since QGIS 2.16 */ void removeCapabilitiesDocument( const QString &path ); diff --git a/src/server/qgsftptransaction.h b/src/server/qgsftptransaction.h index 0e1bb0504ad0..2d1285e15875 100644 --- a/src/server/qgsftptransaction.h +++ b/src/server/qgsftptransaction.h @@ -19,7 +19,7 @@ /** A class for synchronous ftp access (using QFtp in background) * - * @deprecated because of QFtp removal in Qt5. + * \deprecated because of QFtp removal in Qt5. */ class QgsFtpTransaction: public QObject { @@ -29,9 +29,9 @@ class QgsFtpTransaction: public QObject ~QgsFtpTransaction(); /** Transfers the file with the given Url and stores it into ba - @param ftpUrl url of the file to access - @param pointer to buffer to store file contents - @return 0 in case of success*/ + \param ftpUrl url of the file to access + \param pointer to buffer to store file contents + \returns 0 in case of success*/ Q_DECL_DEPRECATED int get( const QString &ftpUrl, QByteArray &ba ); public slots: diff --git a/src/server/qgshttptransaction.h b/src/server/qgshttptransaction.h index a7c63741f950..27b6b8b5e618 100644 --- a/src/server/qgshttptransaction.h +++ b/src/server/qgshttptransaction.h @@ -34,7 +34,7 @@ class QTimer; * HTTP request/response manager that is redirect-aware. * This class extends the Qt QHttp concept by being able to recognise * and respond to redirection responses (e.g. HTTP code 302) - * @note not available in Python bindings + * \note not available in Python bindings */ class QgsHttpTransaction : public QObject @@ -66,15 +66,15 @@ class QgsHttpTransaction : public QObject /*! The function returns false if there is an error while getting the response. - @param[out] respondedContent is replaced with the new content. + \param[out] respondedContent is replaced with the new content. - @param[in] redirections is used to measure how many http redirections we've been through. + \param[in] redirections is used to measure how many http redirections we've been through. Clients typically don't need to set this. - @param postData data to send with the http message. This is only used for HTTP POST. If + \param postData data to send with the http message. This is only used for HTTP POST. If 0 then the request is done with HTTP GET. - @return true in case of success + \returns true in case of success */ bool getSynchronously( QByteArray &respondedContent, int redirections = 0, const QByteArray *postData = nullptr ); @@ -89,7 +89,7 @@ class QgsHttpTransaction : public QObject QString errorString(); /** Apply proxy settings from QSettings to a http object - @return true if proxy settings was applied, false else*/ + \returns true if proxy settings was applied, false else*/ static bool applyProxySettings( QHttp &http, const QString &url ); //! Set the credentials (username and password) diff --git a/src/server/qgsinterpolationlayerbuilder.h b/src/server/qgsinterpolationlayerbuilder.h index b39ad4751ea6..6fc43799f296 100644 --- a/src/server/qgsinterpolationlayerbuilder.h +++ b/src/server/qgsinterpolationlayerbuilder.h @@ -30,11 +30,11 @@ class QgsInterpolationLayerBuilder: public QgsMSLayerBuilder explicit QgsInterpolationLayerBuilder( QgsVectorLayer *vl ); /** Creates a maplayer from xml tag - @param elem xml element containing description of datasource - @param filesToRemove list to append files that should be removed after the request - @param layersToRemove list to append layers that should be removed after the request - @param allowCaching flag if layers are allowed to be fetched from layer cache or not - @return the created layer or 0 in case of error*/ + \param elem xml element containing description of datasource + \param filesToRemove list to append files that should be removed after the request + \param layersToRemove list to append layers that should be removed after the request + \param allowCaching flag if layers are allowed to be fetched from layer cache or not + \returns the created layer or 0 in case of error*/ QgsMapLayer *createMapLayer( const QDomElement &elem, const QString &layerName, QList &filesToRemove, QList &layersToRemove, bool allowCaching = true ) const override; private: diff --git a/src/server/qgsmslayerbuilder.h b/src/server/qgsmslayerbuilder.h index 669a423db39d..f2ab764615e2 100644 --- a/src/server/qgsmslayerbuilder.h +++ b/src/server/qgsmslayerbuilder.h @@ -35,12 +35,12 @@ class QgsMSLayerBuilder virtual ~QgsMSLayerBuilder() = default; /** Creates a maplayer from xml tag - @param elem xml element containing description of datasource - @param layerName sld name of the maplayer - @param filesToRemove list to append files that should be removed after the request - @param layersToRemove list to append layers that should be removed after the request - @param allowCaching flag if layers are allowed to be fetched from layer cache or not - @return the created layer or 0 in case of error*/ + \param elem xml element containing description of datasource + \param layerName sld name of the maplayer + \param filesToRemove list to append files that should be removed after the request + \param layersToRemove list to append layers that should be removed after the request + \param allowCaching flag if layers are allowed to be fetched from layer cache or not + \returns the created layer or 0 in case of error*/ virtual QgsMapLayer *createMapLayer( const QDomElement &elem, const QString &layerName, QList &filesToRemove, QList &layersToRemove, bool allowCaching = true ) const = 0; protected: //! Tries to create a suitable layer name from a URL. diff --git a/src/server/qgsmslayercache.h b/src/server/qgsmslayercache.h index 0a72744d724d..97b80c049762 100644 --- a/src/server/qgsmslayercache.h +++ b/src/server/qgsmslayercache.h @@ -58,20 +58,20 @@ class QgsMSLayerCache: public QObject /** * Set the maximum number of layers in cache. - * @param maxCacheLayers the number of layers in cache + * \param maxCacheLayers the number of layers in cache * \since QGIS 3.0 */ void setMaxCacheLayers( int maxCacheLayers ); /** Inserts a new layer into the cash - @param url the layer datasource - @param layerName the layer name (to distinguish between different layers in a request using the same datasource - @param configFile path of the config file (to invalidate entries if file changes). Can be empty (e.g. layers from sld) - @param tempFiles some layers have temporary files. The cash makes sure they are removed when removing the layer from the cash*/ + \param url the layer datasource + \param layerName the layer name (to distinguish between different layers in a request using the same datasource + \param configFile path of the config file (to invalidate entries if file changes). Can be empty (e.g. layers from sld) + \param tempFiles some layers have temporary files. The cash makes sure they are removed when removing the layer from the cash*/ void insertLayer( const QString &url, const QString &layerName, QgsMapLayer *layer, const QString &configFile = QString(), const QList &tempFiles = QList() ); /** Searches for the layer with the given url. - @return a pointer to the layer or 0 if no such layer*/ + \returns a pointer to the layer or 0 if no such layer*/ QgsMapLayer *searchLayer( const QString &url, const QString &layerName, const QString &configFile = QString() ); int projectsMaxLayers() const { return mProjectMaxLayers; } diff --git a/src/server/qgsremotedatasourcebuilder.h b/src/server/qgsremotedatasourcebuilder.h index 897c87f1393c..e6284734abe6 100644 --- a/src/server/qgsremotedatasourcebuilder.h +++ b/src/server/qgsremotedatasourcebuilder.h @@ -36,7 +36,7 @@ class QgsRemoteDataSourceBuilder: public QgsMSLayerBuilder QgsVectorLayer *vectorLayerFromRemoteVDS( const QDomElement &remoteVDSElem, const QString &layerName, QList &filesToRemove, QList &layersToRemove, bool allowCaching = true ) const; /** Loads data from http or ftp - @return 0 in case of success*/ + \returns 0 in case of success*/ int loadData( const QString &url, QByteArray &data ) const; }; diff --git a/src/server/qgsrequesthandler.h b/src/server/qgsrequesthandler.h index 24262838b4f9..e769f7e6f643 100644 --- a/src/server/qgsrequesthandler.h +++ b/src/server/qgsrequesthandler.h @@ -101,7 +101,7 @@ class SERVER_EXPORT QgsRequestHandler void removeParameter( const QString &key ); /** Parses the input and creates a request neutral Parameter/Value map - * @note not available in Python bindings + * \note not available in Python bindings */ void parseInput(); diff --git a/src/server/qgssentdatasourcebuilder.h b/src/server/qgssentdatasourcebuilder.h index f9ffa57279ec..7ef543019921 100644 --- a/src/server/qgssentdatasourcebuilder.h +++ b/src/server/qgssentdatasourcebuilder.h @@ -30,11 +30,11 @@ class QgsSentDataSourceBuilder: public QgsMSLayerBuilder QgsSentDataSourceBuilder(); /** Creates a maplayer from xml tag - @param elem xml element containing description of datasource - @param filesToRemove list to append files that should be removed after the request - @param layersToRemove list to append layers that should be removed after the request - @param allowCaching flag if layers are allowed to be fetched from layer cache or not - @return the created layer or 0 in case of error*/ + \param elem xml element containing description of datasource + \param filesToRemove list to append files that should be removed after the request + \param layersToRemove list to append layers that should be removed after the request + \param allowCaching flag if layers are allowed to be fetched from layer cache or not + \returns the created layer or 0 in case of error*/ QgsMapLayer *createMapLayer( const QDomElement &elem, const QString &layerName, QList &filesToRemove, QList &layersToRemove, bool allowCaching = true ) const override; private: diff --git a/src/server/qgsserver.h b/src/server/qgsserver.h index 447a94f2733a..4dd053e074b4 100644 --- a/src/server/qgsserver.h +++ b/src/server/qgsserver.h @@ -57,8 +57,8 @@ class SERVER_EXPORT QgsServer QgsServer(); /** Set environment variable - * @param var environment variable name - * @param val value + * \param var environment variable name + * \param val value * \since QGIS 2.14 */ void putenv( const QString &var, const QString &val ); @@ -68,8 +68,8 @@ class SERVER_EXPORT QgsServer * but can be also passed in args and in this case overrides the environment * variable * - * @param request a QgsServerRequest holding request parameters - * @param response a QgsServerResponse for handling response I/O) + * \param request a QgsServerRequest holding request parameters + * \param response a QgsServerResponse for handling response I/O) */ void handleRequest( QgsServerRequest &request, QgsServerResponse &response ); @@ -78,8 +78,8 @@ class SERVER_EXPORT QgsServer * but can be also passed in args and in this case overrides the environment * variable. * - * @param queryString QString containing the query string - * @return the response headers and body QPair of QByteArray + * \param queryString QString containing the query string + * \returns the response headers and body QPair of QByteArray */ QPair handleRequest( const QString &queryString ); @@ -103,9 +103,9 @@ class SERVER_EXPORT QgsServer const QMap ¶meters ); /** - * @brief QgsServer::printRequestParameters prints the request parameters - * @param parameterMap - * @param logLevel + * \brief QgsServer::printRequestParameters prints the request parameters + * \param parameterMap + * \param logLevel */ static void printRequestParameters( const QMap< QString, QString> ¶meterMap, diff --git a/src/server/qgsserverexception.h b/src/server/qgsserverexception.h index 79a6608216f8..5f2edddbec47 100644 --- a/src/server/qgsserverexception.h +++ b/src/server/qgsserverexception.h @@ -37,14 +37,14 @@ class SERVER_EXPORT QgsServerException : public QgsException QgsServerException( const QString &message, int responseCode = 500 ); /** - * @return the return HTTP response code associated with this exception + * \returns the return HTTP response code associated with this exception */ int responseCode() const { return mResponseCode; } /** Format the exception for sending to client * - * @param responseFormat QString to store the content type of the response format. - * @return QByteArray the fermatted response. + * \param responseFormat QString to store the content type of the response format. + * \returns QByteArray the fermatted response. * * The defaolt implementation return text/xml format. */ @@ -70,13 +70,13 @@ class SERVER_EXPORT QgsOgcServiceException : public QgsServerException QgsOgcServiceException( const QString &code, const QString &message, const QString &locator = QString(), int responseCode = 200, const QString &version = QStringLiteral( "1.3.0" ) ); - //! @return message + //! \returns message QString message() const { return mMessage; } - //! @return code + //! \returns code QString code() const { return mCode; } - //! @return locator + //! \returns locator QString locator() const { return mLocator; } //!return exception version diff --git a/src/server/qgsserverinterface.h b/src/server/qgsserverinterface.h index 35213e7a6521..6e26571d7241 100644 --- a/src/server/qgsserverinterface.h +++ b/src/server/qgsserverinterface.h @@ -62,52 +62,52 @@ class SERVER_EXPORT QgsServerInterface /** * Set the request handler - * @param requestHandler request handler - * @note not available in Python bindings + * \param requestHandler request handler + * \note not available in Python bindings */ virtual void setRequestHandler( QgsRequestHandler *requestHandler ) = 0; /** * Clear the request handler * - * @note not available in Python bindings + * \note not available in Python bindings */ virtual void clearRequestHandler() = 0; /** * Get pointer to the capabiblities cache - * @return QgsCapabilitiesCache + * \returns QgsCapabilitiesCache */ virtual QgsCapabilitiesCache *capabilitiesCache() = 0; /** * Get pointer to the request handler - * @return QgsRequestHandler + * \returns QgsRequestHandler */ virtual QgsRequestHandler *requestHandler() = 0; /** * Register a QgsServerFilter - * @param filter the QgsServerFilter to add - * @param priority an optional priority for the filter order + * \param filter the QgsServerFilter to add + * \param priority an optional priority for the filter order */ virtual void registerFilter( QgsServerFilter *filter, int priority = 0 ) = 0; /** * Set the filters map - * @param filters the QgsServerFiltersMap + * \param filters the QgsServerFiltersMap */ virtual void setFilters( QgsServerFiltersMap *filters ) = 0; /** * Return the list of current QgsServerFilter - * @return QgsServerFiltersMap list of QgsServerFilter + * \returns QgsServerFiltersMap list of QgsServerFilter */ virtual QgsServerFiltersMap filters() = 0; /** Register an access control filter - * @param accessControl the access control to register - * @param priority the priority used to order them + * \param accessControl the access control to register + * \param priority the priority used to order them */ virtual void registerAccessControl( QgsAccessControlFilter *accessControl, int priority = 0 ) = 0; @@ -119,39 +119,39 @@ class SERVER_EXPORT QgsServerInterface /** * Return the configuration file path - * @return QString containing the configuration file path + * \returns QString containing the configuration file path */ virtual QString configFilePath() = 0; /** * Set the configuration file path - * @param configFilePath QString with the configuration file path + * \param configFilePath QString with the configuration file path */ virtual void setConfigFilePath( const QString &configFilePath ) = 0; /** * Remove entry from config cache - * @param path the path of the file to remove + * \param path the path of the file to remove */ virtual void removeConfigCacheEntry( const QString &path ) = 0; /** * Remove entries from layer cache - * @param path the path of the project which own the layers to be removed + * \param path the path of the project which own the layers to be removed */ virtual void removeProjectLayers( const QString &path ) = 0; /** * Return the service registry - * @return QgsServiceResgistry + * \returns QgsServiceResgistry */ virtual QgsServiceRegistry *serviceRegistry() = 0; /** * Return the server settings - * @return QgsServerSettings + * \returns QgsServerSettings * - * @note not available in Python bindings + * \note not available in Python bindings */ virtual QgsServerSettings *serverSettings() = 0; diff --git a/src/server/qgsserverinterfaceimpl.h b/src/server/qgsserverinterfaceimpl.h index 87ccf8f2399e..a93f81fbbfa7 100644 --- a/src/server/qgsserverinterfaceimpl.h +++ b/src/server/qgsserverinterfaceimpl.h @@ -54,7 +54,7 @@ class QgsServerInterfaceImpl : public QgsServerInterface void registerAccessControl( QgsAccessControlFilter *accessControl, int priority = 0 ) override; /** Gets the helper over all the registered access control filters - * @return the access control helper + * \returns the access control helper */ QgsAccessControl *accessControls() const override { return mAccessControls; } QString getEnv( const QString &name ) const override; diff --git a/src/server/qgsserverlogger.h b/src/server/qgsserverlogger.h index f1fda9670142..dab2d551ac46 100644 --- a/src/server/qgsserverlogger.h +++ b/src/server/qgsserverlogger.h @@ -38,14 +38,14 @@ class QgsServerLogger: public QObject /** * Get the current log level - * @return the log level + * \returns the log level * \since QGIS 3.0 */ QgsMessageLog::MessageLevel logLevel() const { return mLogLevel; } /** * Set the current log level - * @param level the log level + * \param level the log level * \since QGIS 3.0 */ void setLogLevel( QgsMessageLog::MessageLevel level ); @@ -60,9 +60,9 @@ class QgsServerLogger: public QObject /** * Log a message from the server context * - * @param message the message - * @param tag tag of the message - * @param level log level of the message + * \param message the message + * \param tag tag of the message + * \param level log level of the message */ void logMessage( const QString &message, const QString &tag, QgsMessageLog::MessageLevel level ); diff --git a/src/server/qgsserverplugins.h b/src/server/qgsserverplugins.h index 56bd829ac8ba..1578979d11d3 100644 --- a/src/server/qgsserverplugins.h +++ b/src/server/qgsserverplugins.h @@ -25,7 +25,7 @@ class QgsPythonUtils; /** - * @brief Init Python server plugins and store a list of server plugin names + * \brief Init Python server plugins and store a list of server plugin names */ class SERVER_EXPORT QgsServerPlugins { @@ -34,8 +34,8 @@ class SERVER_EXPORT QgsServerPlugins /** * Initialize the Python plugins - * @param interface QgsServerInterface - * @return bool true on success + * \param interface QgsServerInterface + * \returns bool true on success */ static bool initPlugins( QgsServerInterface *interface ); //! List of available server plugin names diff --git a/src/server/qgsserverprojectparser.h b/src/server/qgsserverprojectparser.h index f4575927999b..dc8fcdd37b35 100644 --- a/src/server/qgsserverprojectparser.h +++ b/src/server/qgsserverprojectparser.h @@ -51,7 +51,7 @@ class SERVER_EXPORT QgsServerProjectParser QString convertToAbsolutePath( const QString &file ) const; /** Creates a maplayer object from element. The layer cash owns the maplayer, so don't delete it - @return the maplayer or 0 in case of error*/ + \returns the maplayer or 0 in case of error*/ QgsMapLayer *createLayerFromElement( const QDomElement &elem, bool useCache = true ) const; QgsMapLayer *mapLayerFromLayerId( const QString &lId, bool useCache = true ) const; @@ -59,7 +59,7 @@ class SERVER_EXPORT QgsServerProjectParser //! Returns the layer id under a tag in the QGIS projectfile QString layerIdFromLegendLayer( const QDomElement &legendLayer ) const; - //! @param considerMapExtent Take user-defined map extent instead of data-calculated extent if present in project file + //! \param considerMapExtent Take user-defined map extent instead of data-calculated extent if present in project file void combineExtentAndCrsOfGroupChildren( QDomElement &groupElement, QDomDocument &doc, bool considerMapExtent = false ) const; void addLayerProjectSettings( QDomElement &layerElem, QDomDocument &doc, QgsMapLayer *currentLayer ) const; @@ -102,7 +102,7 @@ class SERVER_EXPORT QgsServerProjectParser QList< QPair< QString, QgsDatumTransformStore::Entry > > layerCoordinateTransforms() const; /** Returns the text of the element for a layer element - @return name or a null string in case of error*/ + \returns name or a null string in case of error*/ QString layerName( const QDomElement &layerElem ) const; QStringList wfsLayers() const; @@ -116,11 +116,11 @@ class SERVER_EXPORT QgsServerProjectParser void addGetFeatureLayers( const QDomElement &layerElem ) const; /** Returns the text of the element for a layer element - @return id or a null string in case of error*/ + \returns id or a null string in case of error*/ QString layerId( const QDomElement &layerElem ) const; /** Returns the text of the element for a layer element - @return id or a null string in case of error*/ + \returns id or a null string in case of error*/ QString layerShortName( const QDomElement &layerElem ) const; QgsRectangle projectExtent() const; diff --git a/src/server/qgsserverprojectutils.h b/src/server/qgsserverprojectutils.h index d8bc0fb53092..5c1c5a5dfd4c 100644 --- a/src/server/qgsserverprojectutils.h +++ b/src/server/qgsserverprojectutils.h @@ -30,110 +30,110 @@ namespace QgsServerProjectUtils { /** Returns if owsService capabilities are enabled. - * @param project the QGIS project - * @return if owsService capabilities are enabled. + * \param project the QGIS project + * \returns if owsService capabilities are enabled. */ SERVER_EXPORT bool owsServiceCapabilities( const QgsProject &project ); /** Returns the owsService title defined in project. - * @param project the QGIS project - * @return the owsService title if defined in project. + * \param project the QGIS project + * \returns the owsService title if defined in project. */ SERVER_EXPORT QString owsServiceTitle( const QgsProject &project ); /** Returns the owsService abstract defined in project. - * @param project the QGIS project - * @return the owsService abstract if defined in project. + * \param project the QGIS project + * \returns the owsService abstract if defined in project. */ SERVER_EXPORT QString owsServiceAbstract( const QgsProject &project ); /** Returns the owsService keywords defined in project. - * @param project the QGIS project - * @return the owsService keywords if defined in project. + * \param project the QGIS project + * \returns the owsService keywords if defined in project. */ SERVER_EXPORT QStringList owsServiceKeywords( const QgsProject &project ); /** Returns the owsService online resource defined in project. - * @param project the QGIS project - * @return the owsService online resource if defined in project. + * \param project the QGIS project + * \returns the owsService online resource if defined in project. */ SERVER_EXPORT QString owsServiceOnlineResource( const QgsProject &project ); /** Returns the owsService contact organization defined in project. - * @param project the QGIS project - * @return the owsService contact organization if defined in project. + * \param project the QGIS project + * \returns the owsService contact organization if defined in project. */ SERVER_EXPORT QString owsServiceContactOrganization( const QgsProject &project ); /** Returns the owsService contact position defined in project. - * @param project the QGIS project - * @return the owsService contact position if defined in project. + * \param project the QGIS project + * \returns the owsService contact position if defined in project. */ SERVER_EXPORT QString owsServiceContactPosition( const QgsProject &project ); /** Returns the owsService contact person defined in project. - * @param project the QGIS project - * @return the owsService contact person if defined in project. + * \param project the QGIS project + * \returns the owsService contact person if defined in project. */ SERVER_EXPORT QString owsServiceContactPerson( const QgsProject &project ); /** Returns the owsService contact mail defined in project. - * @param project the QGIS project - * @return the owsService contact mail if defined in project. + * \param project the QGIS project + * \returns the owsService contact mail if defined in project. */ SERVER_EXPORT QString owsServiceContactMail( const QgsProject &project ); /** Returns the owsService contact phone defined in project. - * @param project the QGIS project - * @return the owsService contact phone if defined in project. + * \param project the QGIS project + * \returns the owsService contact phone if defined in project. */ SERVER_EXPORT QString owsServiceContactPhone( const QgsProject &project ); /** Returns the owsService fees defined in project. - * @param project the QGIS project - * @return the owsService fees if defined in project. + * \param project the QGIS project + * \returns the owsService fees if defined in project. */ SERVER_EXPORT QString owsServiceFees( const QgsProject &project ); /** Returns the owsService access constraints defined in project. - * @param project the QGIS project - * @return the owsService access constraints if defined in project. + * \param project the QGIS project + * \returns the owsService access constraints if defined in project. */ SERVER_EXPORT QString owsServiceAccessConstraints( const QgsProject &project ); /** Returns the maximum width for WMS images defined in a QGIS project. - * @param project the QGIS project - * @return width if defined in project, -1 otherwise. + * \param project the QGIS project + * \returns width if defined in project, -1 otherwise. */ SERVER_EXPORT int wmsMaxWidth( const QgsProject &project ); /** Returns the maximum height for WMS images defined in a QGIS project. - * @param project the QGIS project - * @return height if defined in project, -1 otherwise. + * \param project the QGIS project + * \returns height if defined in project, -1 otherwise. */ SERVER_EXPORT int wmsMaxHeight( const QgsProject &project ); /** Returns the WMS service url defined in a QGIS project. - * @param project the QGIS project - * @return url if defined in project, an empty string otherwise. + * \param project the QGIS project + * \returns url if defined in project, an empty string otherwise. */ SERVER_EXPORT QString wmsServiceUrl( const QgsProject &project ); /** Returns the WFS service url defined in a QGIS project. - * @param project the QGIS project - * @return url if defined in project, an empty string otherwise. + * \param project the QGIS project + * \returns url if defined in project, an empty string otherwise. */ SERVER_EXPORT QString wfsServiceUrl( const QgsProject &project ); /** Returns the WCS service url defined in a QGIS project. - * @param project the QGIS project - * @return url if defined in project, an empty string otherwise. + * \param project the QGIS project + * \returns url if defined in project, an empty string otherwise. */ SERVER_EXPORT QString wcsServiceUrl( const QgsProject &project ); /** Returns the Layer ids list defined in a QGIS project as published in WCS. - * @param project the QGIS project - * @return the Layer ids list. + * \param project the QGIS project + * \returns the Layer ids list. */ SERVER_EXPORT QStringList wcsLayers( const QgsProject &project ); }; diff --git a/src/server/qgsserverrequest.h b/src/server/qgsserverrequest.h index 053e882f41b3..197cfb3879f6 100644 --- a/src/server/qgsserverrequest.h +++ b/src/server/qgsserverrequest.h @@ -57,16 +57,16 @@ class SERVER_EXPORT QgsServerRequest /** * Constructor * - * @param url the url string - * @param method the request method + * \param url the url string + * \param method the request method */ QgsServerRequest( const QString &url, Method method = GetMethod ); /** * Constructor * - * @param url QUrl - * @param method the request method + * \param url QUrl + * \param method the request method */ QgsServerRequest( const QUrl &url, Method method = GetMethod ); @@ -74,12 +74,12 @@ class SERVER_EXPORT QgsServerRequest virtual ~QgsServerRequest() = default; /** - * @return the request url + * \returns the request url */ QUrl url() const; /** - * @return the request method + * \returns the request method */ Method method() const; @@ -112,7 +112,7 @@ class SERVER_EXPORT QgsServerRequest virtual QByteArray data() const; /** - * @return the value of the header field for that request + * \returns the value of the header field for that request */ virtual QString getHeader( const QString &name ) const; diff --git a/src/server/qgsserverresponse.h b/src/server/qgsserverresponse.h index 7deb05f6a07d..241f46e89a49 100644 --- a/src/server/qgsserverresponse.h +++ b/src/server/qgsserverresponse.h @@ -78,7 +78,7 @@ class SERVER_EXPORT QgsServerResponse /** Set the http return code - * @param code HTTP return code value + * \param code HTTP return code value */ virtual void setReturnCode( int code ) = 0; @@ -88,8 +88,8 @@ class SERVER_EXPORT QgsServerResponse * from calling setReturnCode() which let you return a specific response body. * Calling sendError() will end the transaction and any attempt to write data * or set headers will be an error. - * @param code HHTP return code value - * @param message An informative error message + * \param code HHTP return code value + * \param message An informative error message */ virtual void sendError( int code, const QString &message ) = 0; @@ -104,7 +104,7 @@ class SERVER_EXPORT QgsServerResponse * Write chunk of data * This is a convenient method that will write directly * to the underlying I/O device - * @return the number of bytes that were actually written + * \returns the number of bytes that were actually written */ virtual qint64 write( const QByteArray &byteArray ); @@ -113,9 +113,9 @@ class SERVER_EXPORT QgsServerResponse * * This is a convenient method that will write directly * to the underlying I/O device - * @return the number of bytes written + * \returns the number of bytes written * - * @note not available in Python bindings + * \note not available in Python bindings */ virtual qint64 write( const char *data, qint64 maxsize ); @@ -124,9 +124,9 @@ class SERVER_EXPORT QgsServerResponse * * This is a convenient method that will write directly * to the underlying I/O device - * @return the number of bytes written + * \returns the number of bytes written * - * @note not available in Python bindings + * \note not available in Python bindings */ virtual qint64 write( const char *data ); diff --git a/src/server/qgsserversettings.h b/src/server/qgsserversettings.h index 08292dced9d0..c4284f07a690 100644 --- a/src/server/qgsserversettings.h +++ b/src/server/qgsserversettings.h @@ -87,7 +87,7 @@ class SERVER_EXPORT QgsServerSettings void load(); /** Load setting for a specific environment variable name. - * @return true if loading is successful, false in case of an invalid name. + * \returns true if loading is successful, false in case of an invalid name. */ bool load( const QString &envVarName ); @@ -96,48 +96,48 @@ class SERVER_EXPORT QgsServerSettings void logSummary() const; /** Returns the ini file loaded by QSetting. - * @return the path of the ini file or an empty string if none is loaded. + * \returns the path of the ini file or an empty string if none is loaded. */ QString iniFile() const; /** Returns parallel rendering setting. - * @return true if parallel rendering is activated, false otherwise. + * \returns true if parallel rendering is activated, false otherwise. */ bool parallelRendering() const; /** Returns the maximum number of threads to use. - * @return the number of threads. + * \returns the number of threads. */ int maxThreads() const; /** * Returns the maximum number of cached layers. - * @return the number of cached layers. + * \returns the number of cached layers. */ int maxCacheLayers() const; /** Returns the log level. - * @return the log level. + * \returns the log level. */ QgsMessageLog::MessageLevel logLevel() const; /** Returns the QGS project file to use. - * @return the path of the QGS project or an empty string if none is defined. + * \returns the path of the QGS project or an empty string if none is defined. */ QString projectFile() const; /** Returns the log file. - * @return the path of the log file or an empty string if none is defined. + * \returns the path of the log file or an empty string if none is defined. */ QString logFile() const; /** Returns the cache size. - * @return the cache size. + * \returns the cache size. */ qint64 cacheSize() const; /** Returns the cache directory. - * @return the directory. + * \returns the directory. */ QString cacheDirectory() const; diff --git a/src/server/qgsservice.h b/src/server/qgsservice.h index 3fa05a38cdec..1da1ec4d553a 100644 --- a/src/server/qgsservice.h +++ b/src/server/qgsservice.h @@ -47,12 +47,12 @@ class SERVER_EXPORT QgsService virtual ~QgsService() = default; /** - * @return the name of the service + * \returns the name of the service */ virtual QString name() const = 0; /** - * @return the version of the service + * \returns the version of the service */ virtual QString version() const = 0; diff --git a/src/server/qgsservicemodule.h b/src/server/qgsservicemodule.h index b0b3e27af8d5..e31f792d0c72 100644 --- a/src/server/qgsservicemodule.h +++ b/src/server/qgsservicemodule.h @@ -48,7 +48,7 @@ class SERVER_EXPORT QgsServiceModule /** * Ask module to register all provided services - * @param registry QgsServiceRegistry + * \param registry QgsServiceRegistry */ virtual void registerSelf( QgsServiceRegistry ®istry, QgsServerInterface *serverIface = nullptr ) = 0; diff --git a/src/server/qgsservicenativeloader.h b/src/server/qgsservicenativeloader.h index c050615fe399..5c7229950f70 100644 --- a/src/server/qgsservicenativeloader.h +++ b/src/server/qgsservicenativeloader.h @@ -49,9 +49,9 @@ class SERVER_EXPORT QgsServiceNativeLoader /** * Lead all medules from path - * @param modulePath the path to look for module - * @param registrar QgsServiceRegistry instance for registering services - * @param serverIface QgsServerInterface instarce + * \param modulePath the path to look for module + * \param registrar QgsServiceRegistry instance for registering services + * \param serverIface QgsServerInterface instarce */ void loadModules( const QString &modulePath, QgsServiceRegistry ®istrar, QgsServerInterface *serverIface = nullptr ); @@ -64,8 +64,8 @@ class SERVER_EXPORT QgsServiceNativeLoader /** * Load the native module from path * - * @param location QString location holding the module relalive path - * @return a qgsservicemodule instance + * \param location QString location holding the module relalive path + * \returns a qgsservicemodule instance */ QgsServiceModule *loadNativeModule( const QString &location ); @@ -75,8 +75,8 @@ class SERVER_EXPORT QgsServiceNativeLoader /** * Find module - * @param path the module path - * @return a module hook entry + * \param path the module path + * \returns a module hook entry */ QgsServiceNativeModuleEntry *findModuleEntry( const QString &path ); diff --git a/src/server/qgsserviceregistry.h b/src/server/qgsserviceregistry.h index cae5577e6cb9..65cc6b10fe76 100644 --- a/src/server/qgsserviceregistry.h +++ b/src/server/qgsserviceregistry.h @@ -56,9 +56,9 @@ class SERVER_EXPORT QgsServiceRegistry /** * Retrieve a service from its name - * @param name the name of the service - * @param version the version string (optional) - * @return QgsService + * \param name the name of the service + * \param version the version string (optional) + * \returns QgsService * * If the version is not provided the higher version of the service is returned */ @@ -72,16 +72,16 @@ class SERVER_EXPORT QgsServiceRegistry * * The registry gain ownership of services and will call 'delete' on cleanup * - * @param service a QgsServerResponse to be registered + * \param service a QgsServerResponse to be registered */ void registerService( QgsService *service ); /** * Unregister service from its name and version * - * @param name the tame of the service - * @param version (optional) the specific version to unload - * @return the number of services unregistered + * \param name the tame of the service + * \param version (optional) the specific version to unload + * \returns the number of services unregistered * * If the version is not specified then all versions from the specified service * are unloaded @@ -90,8 +90,8 @@ class SERVER_EXPORT QgsServiceRegistry /** * Initialize registry, load modules and auto register services - * @param serverIface the server interface - * @param nativeModulepath the native module path + * \param serverIface the server interface + * \param nativeModulepath the native module path */ void init( const QString &nativeModulepath, QgsServerInterface *serverIface = nullptr ); diff --git a/src/server/qgssldconfigparser.h b/src/server/qgssldconfigparser.h index 389ec1b90106..9278e5452dc6 100644 --- a/src/server/qgssldconfigparser.h +++ b/src/server/qgssldconfigparser.h @@ -30,15 +30,15 @@ class SERVER_EXPORT QgsSLDConfigParser : public QgsWmsConfigParser public: /** Constructor takes a dom document as argument. The class takes ownership of the document and deletes it in the destructor - @param doc SLD document - @param parameterMap map containing the wms request parameters*/ + \param doc SLD document + \param parameterMap map containing the wms request parameters*/ QgsSLDConfigParser( QDomDocument *doc, const QMap ¶meters ); virtual ~QgsSLDConfigParser(); void setFallbackParser( QgsWmsConfigParser *p ) { mFallbackParser = p; } /** Adds layer and style specific capabilities elements to the parent node. This includes the individual layers and styles, their description, native CRS, bounding boxes, etc. - @param fullProjectInformation If true: add extended project information (does not validate against WMS schema)*/ + \param fullProjectInformation If true: add extended project information (does not validate against WMS schema)*/ void layersAndStylesCapabilities( QDomElement &parentElement, QDomDocument &doc, const QString &version, const QString &serviceUrl, bool fullProjectSettings = false ) const override; //! Returns one or possibly several maplayers for a given layer name and style. If no layers/style are found, an empty list is returned @@ -176,23 +176,23 @@ class SERVER_EXPORT QgsSLDConfigParser : public QgsWmsConfigParser QgsFeatureRenderer *rendererFromUserStyle( const QDomElement &userStyleElement, QgsVectorLayer *vec ) const; /** Searches for a element and applies the settings to the vector layer - @return true if settings have been applied, false in case of element not present or error*/ + \returns true if settings have been applied, false in case of element not present or error*/ bool labelSettingsFromUserStyle( const QDomElement &userStyleElement, QgsVectorLayer *vec ) const; /** Searches for a element and applies the settings to the raster layer - @return true if settings have been applied, false in case of error*/ + \returns true if settings have been applied, false in case of error*/ bool rasterSymbologyFromUserStyle( const QDomElement &userStyleElement, QgsRasterLayer *r ) const; /** Creates a line layer (including renderer) from contour symboliser - @return the layer or 0 if no layer could be created*/ + \returns the layer or 0 if no layer could be created*/ QgsVectorLayer *contourLayerFromRaster( const QDomElement &userStyleElem, QgsRasterLayer *rasterLayer ) const; //! Returns the dom node or a null node in case of failure QDomElement findUserLayerElement( const QString &layerName ) const; /** Creates a vector layer from a tag. - @param layerName the WMS layer name. This is only necessary for the fallback SLD parser - @return 0 in case of error. + \param layerName the WMS layer name. This is only necessary for the fallback SLD parser + \returns 0 in case of error. Delegates the work to specific methods for , or */ QgsMapLayer *mapLayerFromUserLayer( const QDomElement &userLayerElem, const QString &layerName, bool allowCaching = true ) const; diff --git a/src/server/qgswmsconfigparser.h b/src/server/qgswmsconfigparser.h index 7f821ceec64b..256094a5703f 100644 --- a/src/server/qgswmsconfigparser.h +++ b/src/server/qgswmsconfigparser.h @@ -43,7 +43,7 @@ class SERVER_EXPORT QgsWmsConfigParser virtual ~QgsWmsConfigParser() = default; /** Adds layer and style specific capabilities elements to the parent node. This includes the individual layers and styles, their description, native CRS, bounding boxes, etc. - @param fullProjectInformation If true: add extended project information (does not validate against WMS schema)*/ + \param fullProjectInformation If true: add extended project information (does not validate against WMS schema)*/ virtual void layersAndStylesCapabilities( QDomElement &parentElement, QDomDocument &doc, const QString &version, const QString &serviceUrl, bool fullProjectSettings = false ) const = 0; //! Returns one or possibly several maplayers for a given layer name and style. If no layers/style are found, an empty list is returned diff --git a/src/server/qgswmsprojectparser.h b/src/server/qgswmsprojectparser.h index c1d063c0854a..ff64bc5a3b65 100644 --- a/src/server/qgswmsprojectparser.h +++ b/src/server/qgswmsprojectparser.h @@ -39,7 +39,7 @@ class SERVER_EXPORT QgsWmsProjectParser : public QgsWmsConfigParser virtual ~QgsWmsProjectParser(); /** Adds layer and style specific capabilities elements to the parent node. This includes the individual layers and styles, their description, native CRS, bounding boxes, etc. - @param fullProjectInformation If true: add extended project information (does not validate against WMS schema)*/ + \param fullProjectInformation If true: add extended project information (does not validate against WMS schema)*/ void layersAndStylesCapabilities( QDomElement &parentElement, QDomDocument &doc, const QString &version, const QString &serviceUrl, bool fullProjectSettings = false ) const override; QList mapLayerFromStyle( const QString &lName, const QString &styleName, bool useCache = true ) const override; diff --git a/src/server/services/wfs/qgswfsgetfeature.cpp b/src/server/services/wfs/qgswfsgetfeature.cpp index 1d50090084d2..378f7830b18c 100644 --- a/src/server/services/wfs/qgswfsgetfeature.cpp +++ b/src/server/services/wfs/qgswfsgetfeature.cpp @@ -65,8 +65,6 @@ namespace QgsWfs } - /** Output WFS GetCapabilities response - */ void writeGetFeature( QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response ) diff --git a/src/server/services/wms/qgsmaprendererjobproxy.h b/src/server/services/wms/qgsmaprendererjobproxy.h index 3bbe1cdeaed4..985758336fad 100644 --- a/src/server/services/wms/qgsmaprendererjobproxy.h +++ b/src/server/services/wms/qgsmaprendererjobproxy.h @@ -34,7 +34,7 @@ namespace QgsWms public: /** Constructor. - * @param accessControl Does not take ownership of QgsAccessControl + * \param accessControl Does not take ownership of QgsAccessControl */ QgsMapRendererJobProxy( bool parallelRendering @@ -43,13 +43,13 @@ namespace QgsWms ); /** Sequential or parallel map rendering according to qsettings. - * @param mapSettings passed to MapRendererJob - * @param the rendered image + * \param mapSettings passed to MapRendererJob + * \param the rendered image */ void render( const QgsMapSettings &mapSettings, QImage *image ); /** Take ownership of the painter used for rendering. - * @return painter + * \returns painter */ QPainter *takePainter(); diff --git a/src/server/services/wms/qgswmsgetcapabilities.h b/src/server/services/wms/qgswmsgetcapabilities.h index f3c27d47ab46..6cda859c115e 100644 --- a/src/server/services/wms/qgswmsgetcapabilities.h +++ b/src/server/services/wms/qgswmsgetcapabilities.h @@ -34,8 +34,8 @@ namespace QgsWms * Create WMS GetCapabilities document * * Returns an XML document with the capabilities description (as described in the WMS specs) - * @param version WMS version - * @param projectSettings If true: add extended project information (does not validate against WMS schema) + * \param version WMS version + * \param projectSettings If true: add extended project information (does not validate against WMS schema) */ QDomDocument getCapabilities( QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, bool projectSettings ); diff --git a/src/server/services/wms/qgswmsrenderer.h b/src/server/services/wms/qgswmsrenderer.h index 49cdbb3348bd..8e4a9475a751 100644 --- a/src/server/services/wms/qgswmsrenderer.h +++ b/src/server/services/wms/qgswmsrenderer.h @@ -100,8 +100,8 @@ namespace QgsWms /** Returns printed page as binary - @param formatString out: format of the print output (e.g. pdf, svg, png, ...) - @return printed page as binary or 0 in case of error*/ + \param formatString out: format of the print output (e.g. pdf, svg, png, ...) + \returns printed page as binary or 0 in case of error*/ QByteArray *getPrint( const QString &formatString ); /** Creates an xml document that describes the result of the getFeatureInfo request. @@ -112,26 +112,26 @@ namespace QgsWms private: /** Initializes WMS layers and configures rendering. - * @param layersList out: list with WMS layer names - * @param stylesList out: list with WMS style names - * @param layerIdList out: list with QGIS layer ids - * @return image configured. The calling function takes ownership of the image + * \param layersList out: list with WMS layer names + * \param stylesList out: list with WMS style names + * \param layerIdList out: list with QGIS layer ids + * \returns image configured. The calling function takes ownership of the image * may throw an exception */ QImage *initializeRendering( QStringList &layersList, QStringList &stylesList, QStringList &layerIdList, QgsMapSettings &mapSettings ); /** Creates a QImage from the HEIGHT and WIDTH parameters - * @param width image width (or -1 if width should be taken from WIDTH wms parameter) - * @param height image height (or -1 if height should be taken from HEIGHT wms parameter) - * @param useBbox flag to indicate if the BBOX has to be used to adapt aspect ratio - * @return a non null pointer + * \param width image width (or -1 if width should be taken from WIDTH wms parameter) + * \param height image height (or -1 if height should be taken from HEIGHT wms parameter) + * \param useBbox flag to indicate if the BBOX has to be used to adapt aspect ratio + * \returns a non null pointer * may throw an exception */ QImage *createImage( int width = -1, int height = -1, bool useBbox = true ) const; /** Configures mapSettings to the parameters * HEIGHT, WIDTH, BBOX, CRS. - * @param paintDevice the device that is used for painting (for dpi) + * \param paintDevice the device that is used for painting (for dpi) * may throw an exception */ void configureMapSettings( const QPaintDevice *paintDevice, QgsMapSettings &mapSettings ) const; @@ -144,8 +144,8 @@ namespace QgsWms void initializeSLDParser( QStringList &layersList, QStringList &stylesList ); /** Appends feature info xml for the layer to the layer element of the feature info dom document - @param featureBBox the bounding box of the selected features in output CRS - @return true in case of success*/ + \param featureBBox the bounding box of the selected features in output CRS + \returns true in case of success*/ bool featureInfoFromVectorLayer( QgsVectorLayer *layer, const QgsPoint *infoPoint, int nFeatures, @@ -166,7 +166,7 @@ namespace QgsWms const QString &infoFormat ) const; /** Creates a layer set and returns a stringlist with layer ids that can be passed to a renderer. Usually used in conjunction with readLayersAndStyles - @param scaleDenominator Filter out layer if scale based visibility does not match (or use -1 if no scale restriction)*/ + \param scaleDenominator Filter out layer if scale based visibility does not match (or use -1 if no scale restriction)*/ QStringList layerSet( const QStringList &layersList, const QStringList &stylesList, const QgsCoordinateReferenceSystem &destCRS, double scaleDenominator = -1 ) const; //! Record which symbols would be used if the map was in the current configuration of renderer. This is useful for content-based legend @@ -179,9 +179,9 @@ namespace QgsWms double &symbolSpace, double &iconLabelSpace, double &symbolWidth, double &symbolHeight, QFont &layerFont, QFont &itemFont, QColor &layerFontColor, QColor &itemFontColor ); /** Apply filter (subset) strings from the request to the layers. Example: '&FILTER=:"AND property > 100",:"AND bla = 'hallo!'" ' - * @param layerList list of layer IDs to filter - * @param originalFilters hash of layer ID to original filter string - * @note It is strongly recommended that this method be called alongside use of QgsOWSServerFilterRestorer + * \param layerList list of layer IDs to filter + * \param originalFilters hash of layer ID to original filter string + * \note It is strongly recommended that this method be called alongside use of QgsOWSServerFilterRestorer * to ensure that the original filters are always correctly restored, regardless of whether exceptions * are thrown or functions are terminated early. */ @@ -190,20 +190,20 @@ namespace QgsWms #ifdef HAVE_SERVER_PYTHON_PLUGINS /** Apply filter strings from the access control to the layers. - * @param layerList layers to filter - * @param originalLayerFilters the original layers filter dictionary + * \param layerList layers to filter + * \param originalLayerFilters the original layers filter dictionary */ void applyAccessControlLayersFilters( const QStringList &layerList, QHash &originalLayerFilters ) const; #endif /** Tests if a filter sql string is allowed (safe) - @return true in case of success, false if string seems unsafe*/ + \returns true in case of success, false if string seems unsafe*/ bool testFilterStringSafety( const QString &filter ) const; //! Helper function for filter safety test. Groups stringlist to merge entries starting/ending with quotes static void groupStringList( QStringList &list, const QString &groupString ); /** Select vector features with ids specified in parameter SELECTED, e.g. ...&SELECTED=layer1:1,2,9;layer2:3,5,10&... - @return list with layer ids where selections have been created*/ + \returns list with layer ids where selections have been created*/ QStringList applyFeatureSelections( const QStringList &layerList ) const; //! Clear all feature selections in the given layers void clearFeatureSelections( const QStringList &layerIds ) const; @@ -222,7 +222,7 @@ namespace QgsWms QList< QPair< QgsVectorLayer *, double > > &labelBufferTransparencies ); /** Checks WIDTH/HEIGHT values against MaxWidth and MaxHeight - @return true if width/height values are okay*/ + \returns true if width/height values are okay*/ bool checkMaximumWidthHeight() const; //! Converts a feature info xml document to SIA2045 norm diff --git a/src/server/services/wms/qgswmsutils.h b/src/server/services/wms/qgswmsutils.h index 6a7ea73323ac..9ea52ac68aaa 100644 --- a/src/server/services/wms/qgswmsutils.h +++ b/src/server/services/wms/qgswmsutils.h @@ -64,7 +64,7 @@ namespace QgsWms QgsWmsConfigParser *getConfigParser( QgsServerInterface *serverIface ); /** Parse image format parameter - * @return OutputFormat + * \returns OutputFormat */ ImageOutputFormat parseImageFormat( const QString &format ); @@ -75,8 +75,8 @@ namespace QgsWms /** * Parse bbox parameter - * @param bboxstr the bbox string as comma separated values - * @return QgsRectangle + * \param bboxstr the bbox string as comma separated values + * \returns QgsRectangle * * If the parsing fail then an empty bbox is returned */ diff --git a/tests/scripts/sipifyheader.h b/tests/scripts/sipifyheader.h index 54724ffab2b3..e726dbfe6c20 100644 --- a/tests/scripts/sipifyheader.h +++ b/tests/scripts/sipifyheader.h @@ -152,7 +152,7 @@ class CORE_EXPORT QgsSipifyHeader : public QtClass, private QgsBaseCla /** * \brief some brief - * My long doc string + * My long doc \a string * is not very interesting! */ void LongDocStringMethodWithBrief();