From f29306d4af8dd1b2fe24f9a11aeff850472d5849 Mon Sep 17 00:00:00 2001 From: Denis Rouzaud Date: Wed, 6 Dec 2017 07:41:54 -0400 Subject: [PATCH] [doxygen] replace @param by \param --- python/core/layout/qgslayoutitem.sip | 2 +- python/core/qgsvectorlayerlabeling.sip | 6 +++--- python/gui/qgsdial.sip | 2 +- python/server/qgsserverprojectutils.sip | 12 ++++++------ python/server/qgsserverrequest.sip | 8 ++++---- src/app/composer/qgscomposer.h | 8 ++++---- src/app/qgsversionmigration.h | 4 ++-- src/core/geometry/qgsgeos.h | 6 +++--- src/core/layout/qgslayoutitem.h | 2 +- src/core/qgsfeaturefiltermodel_p.h | 2 +- src/core/qgsvectorlayerlabeling.h | 6 +++--- src/gui/qgsbrowserdockwidget_p.h | 2 +- src/gui/qgsdial.h | 2 +- src/gui/qgswidgetstatehelper_p.h | 2 +- src/server/qgsserverprojectutils.h | 12 ++++++------ src/server/qgsserverrequest.h | 8 ++++---- src/server/services/wms/qgswmsparameters.h | 2 +- 17 files changed, 43 insertions(+), 43 deletions(-) diff --git a/python/core/layout/qgslayoutitem.sip b/python/core/layout/qgslayoutitem.sip index 362a00c7b927..03f8d8a473f5 100644 --- a/python/core/layout/qgslayoutitem.sip +++ b/python/core/layout/qgslayoutitem.sip @@ -735,7 +735,7 @@ class QgsLayoutItem : QgsLayoutObject, QGraphicsRectItem, QgsLayoutUndoObjectInt %Docstring Draws a debugging rectangle of the item's current bounds within the specified painter. - @param painter destination QPainter + \param painter destination QPainter %End virtual void draw( QgsRenderContext &context, const QStyleOptionGraphicsItem *itemStyle = 0 ) = 0; diff --git a/python/core/qgsvectorlayerlabeling.sip b/python/core/qgsvectorlayerlabeling.sip index d2ae89c66674..6c91120f37c6 100644 --- a/python/core/qgsvectorlayerlabeling.sip +++ b/python/core/qgsvectorlayerlabeling.sip @@ -98,9 +98,9 @@ Try to create instance of an implementation based on the XML data %Docstring Writes a TextSymbolizer element contents based on the provided labeling settings writeTextSymbolizer - @param parent the node that will have the text symbolizer element added to it - @param settings the settings getting translated to a TextSymbolizer - @param props a open ended set of properties that can drive/inform the SLD encoding + \param parent the node that will have the text symbolizer element added to it + \param settings the settings getting translated to a TextSymbolizer + \param props a open ended set of properties that can drive/inform the SLD encoding %End private: diff --git a/python/gui/qgsdial.sip b/python/gui/qgsdial.sip index 8676c517e085..4094f00b3e67 100644 --- a/python/gui/qgsdial.sip +++ b/python/gui/qgsdial.sip @@ -20,7 +20,7 @@ class QgsDial : QDial QgsDial( QWidget *parent /TransferThis/ = 0 ); %Docstring QgsDial constructor for QgsDial - @param parent parent object + \param parent parent object %End void setMinimum( const QVariant &min ); diff --git a/python/server/qgsserverprojectutils.sip b/python/server/qgsserverprojectutils.sip index 81a8df7fc0b0..95852e599cea 100644 --- a/python/server/qgsserverprojectutils.sip +++ b/python/server/qgsserverprojectutils.sip @@ -316,7 +316,7 @@ namespace QgsServerProjectUtils QStringList wfsLayerIds( const QgsProject &project ); %Docstring Returns the Layer ids list defined in a QGIS project as published in WFS. - @param project the QGIS project + \param project the QGIS project @return the Layer ids list. :rtype: list of str %End @@ -325,8 +325,8 @@ namespace QgsServerProjectUtils int wfsLayerPrecision( const QgsProject &project, const QString &layerId ); %Docstring Returns the Layer precision defined in a QGIS project for the WFS GetFeature. - @param project the QGIS project - @param layerId the layer id in the project + \param project the QGIS project + \param layerId the layer id in the project @return the layer precision for WFS GetFeature. :rtype: int %End @@ -334,7 +334,7 @@ namespace QgsServerProjectUtils QStringList wfstUpdateLayerIds( const QgsProject &project ); %Docstring Returns the Layer ids list defined in a QGIS project as published as WFS-T with update capabilities. - @param project the QGIS project + \param project the QGIS project @return the Layer ids list. :rtype: list of str %End @@ -342,7 +342,7 @@ namespace QgsServerProjectUtils QStringList wfstInsertLayerIds( const QgsProject &project ); %Docstring Returns the Layer ids list defined in a QGIS project as published as WFS-T with insert capabilities. - @param project the QGIS project + \param project the QGIS project @return the Layer ids list. :rtype: list of str %End @@ -350,7 +350,7 @@ namespace QgsServerProjectUtils QStringList wfstDeleteLayerIds( const QgsProject &project ); %Docstring Returns the Layer ids list defined in a QGIS project as published as WFS-T with delete capabilities. - @param project the QGIS project + \param project the QGIS project @return the Layer ids list. :rtype: list of str %End diff --git a/python/server/qgsserverrequest.sip b/python/server/qgsserverrequest.sip index 9f1a7f59df09..525fd5837b74 100644 --- a/python/server/qgsserverrequest.sip +++ b/python/server/qgsserverrequest.sip @@ -97,7 +97,7 @@ destructor QString header( const QString &name ) const; %Docstring Return the header value - @param name of the header + \param name of the header @return the header value or an empty string :rtype: str %End @@ -105,8 +105,8 @@ destructor void setHeader( const QString &name, const QString &value ); %Docstring Set an header - @param name - @param value + \param name + \param value %End QMap headers() const; @@ -119,7 +119,7 @@ destructor void removeHeader( const QString &name ); %Docstring Remove an header - @param name + \param name %End virtual QByteArray data() const; diff --git a/src/app/composer/qgscomposer.h b/src/app/composer/qgscomposer.h index 8ea5598bcf08..a40f9770ad66 100644 --- a/src/app/composer/qgscomposer.h +++ b/src/app/composer/qgscomposer.h @@ -489,10 +489,10 @@ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase QgsPanelWidget *createItemWidget( QgsComposerItem *item ); /*Saves image to file, possibly using format specific options (e.g. LZW compression for tiff) - @param img the image to save - @param imageFileName output file path - @param imageFormat format string - @param return true in case of success*/ + \param img the image to save + \param imageFileName output file path + \param imageFormat format string + \param return true in case of success*/ static bool saveImage( const QImage &img, const QString &imageFilename, const QString &imageFormat ); QgsAppComposerInterface *mInterface = nullptr; diff --git a/src/app/qgsversionmigration.h b/src/app/qgsversionmigration.h index ad912db1e9d0..6efbf854ea3a 100644 --- a/src/app/qgsversionmigration.h +++ b/src/app/qgsversionmigration.h @@ -35,8 +35,8 @@ class APP_EXPORT QgsVersionMigration /** * Check if two version has a migration options. - * @param fromVersion The version migrating from. - * @param toVersion The version migrating to. + * \param fromVersion The version migrating from. + * \param toVersion The version migrating to. * @return */ static QgsVersionMigration *canMigrate( int fromVersion, int toVersion ); diff --git a/src/core/geometry/qgsgeos.h b/src/core/geometry/qgsgeos.h index d7ed68261cf9..9f65f22aebeb 100644 --- a/src/core/geometry/qgsgeos.h +++ b/src/core/geometry/qgsgeos.h @@ -226,9 +226,9 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine /** * Reshapes the geometry using a line - * @param reshapeWithLine the line used to reshape lines or polygons - * @param errorCode if specified, provides result of operation (success or reason of failure) - * @param errorMsg if specified, provides more details about failure + * \param reshapeWithLine the line used to reshape lines or polygons + * \param errorCode if specified, provides result of operation (success or reason of failure) + * \param errorMsg if specified, provides more details about failure * @return the reshaped geometry */ std::unique_ptr< QgsAbstractGeometry > reshapeGeometry( const QgsLineString &reshapeWithLine, EngineOperationResult *errorCode, QString *errorMsg = nullptr ) const; diff --git a/src/core/layout/qgslayoutitem.h b/src/core/layout/qgslayoutitem.h index 870731647975..ac704d65ed53 100644 --- a/src/core/layout/qgslayoutitem.h +++ b/src/core/layout/qgslayoutitem.h @@ -728,7 +728,7 @@ class CORE_EXPORT QgsLayoutItem : public QgsLayoutObject, public QGraphicsRectIt /** * Draws a debugging rectangle of the item's current bounds within the specified * painter. - * @param painter destination QPainter + * \param painter destination QPainter */ virtual void drawDebugRect( QPainter *painter ); diff --git a/src/core/qgsfeaturefiltermodel_p.h b/src/core/qgsfeaturefiltermodel_p.h index 6c27e18294bb..f02e793bca9b 100644 --- a/src/core/qgsfeaturefiltermodel_p.h +++ b/src/core/qgsfeaturefiltermodel_p.h @@ -108,7 +108,7 @@ class QgsFieldExpressionValuesGatherer: public QThread /** * Emitted when values have been collected - * @param values list of unique matching string values + * \param values list of unique matching string values */ void collectedValues(); diff --git a/src/core/qgsvectorlayerlabeling.h b/src/core/qgsvectorlayerlabeling.h index a9c0524b4ff6..103e663cf440 100644 --- a/src/core/qgsvectorlayerlabeling.h +++ b/src/core/qgsvectorlayerlabeling.h @@ -107,9 +107,9 @@ class CORE_EXPORT QgsAbstractVectorLayerLabeling /** * Writes a TextSymbolizer element contents based on the provided labeling settings * @brief writeTextSymbolizer - * @param parent the node that will have the text symbolizer element added to it - * @param settings the settings getting translated to a TextSymbolizer - * @param props a open ended set of properties that can drive/inform the SLD encoding + * \param parent the node that will have the text symbolizer element added to it + * \param settings the settings getting translated to a TextSymbolizer + * \param props a open ended set of properties that can drive/inform the SLD encoding */ virtual void writeTextSymbolizer( QDomNode &parent, QgsPalLayerSettings &settings, const QgsStringMap &props ) const; diff --git a/src/gui/qgsbrowserdockwidget_p.h b/src/gui/qgsbrowserdockwidget_p.h index a46182d90494..6da4cf7cd627 100644 --- a/src/gui/qgsbrowserdockwidget_p.h +++ b/src/gui/qgsbrowserdockwidget_p.h @@ -214,7 +214,7 @@ class QgsBrowserTreeFilterProxyModel : public QSortFilterProxyModel /** * Constructor for QgsBrowserTreeFilterProxyModel - * @param parent parent widget + * \param parent parent widget */ explicit QgsBrowserTreeFilterProxyModel( QObject *parent ); //! Set the browser model diff --git a/src/gui/qgsdial.h b/src/gui/qgsdial.h index a2601546a6a4..a92e67f8c9b6 100644 --- a/src/gui/qgsdial.h +++ b/src/gui/qgsdial.h @@ -33,7 +33,7 @@ class GUI_EXPORT QgsDial : public QDial /** * @brief QgsDial constructor for QgsDial - * @param parent parent object + * \param parent parent object */ QgsDial( QWidget *parent SIP_TRANSFERTHIS = nullptr ); diff --git a/src/gui/qgswidgetstatehelper_p.h b/src/gui/qgswidgetstatehelper_p.h index e2895507b877..4f5b2af34b8d 100644 --- a/src/gui/qgswidgetstatehelper_p.h +++ b/src/gui/qgswidgetstatehelper_p.h @@ -36,7 +36,7 @@ class QgsWidgetStateHelper : public QObject /** * QgsWidgetStateHelper - * @param parent Parent object + * \param parent Parent object */ explicit QgsWidgetStateHelper( QObject *parent = 0 ); diff --git a/src/server/qgsserverprojectutils.h b/src/server/qgsserverprojectutils.h index e5ac911cb5bd..619a13b4c83b 100644 --- a/src/server/qgsserverprojectutils.h +++ b/src/server/qgsserverprojectutils.h @@ -298,15 +298,15 @@ namespace QgsServerProjectUtils /** * Returns the Layer ids list defined in a QGIS project as published in WFS. - * @param project the QGIS project + * \param project the QGIS project * @return the Layer ids list. */ SERVER_EXPORT QStringList wfsLayerIds( const QgsProject &project ); /** * Returns the Layer precision defined in a QGIS project for the WFS GetFeature. - * @param project the QGIS project - * @param layerId the layer id in the project + * \param project the QGIS project + * \param layerId the layer id in the project * @return the layer precision for WFS GetFeature. */ @@ -314,21 +314,21 @@ namespace QgsServerProjectUtils /** * Returns the Layer ids list defined in a QGIS project as published as WFS-T with update capabilities. - * @param project the QGIS project + * \param project the QGIS project * @return the Layer ids list. */ SERVER_EXPORT QStringList wfstUpdateLayerIds( const QgsProject &project ); /** * Returns the Layer ids list defined in a QGIS project as published as WFS-T with insert capabilities. - * @param project the QGIS project + * \param project the QGIS project * @return the Layer ids list. */ SERVER_EXPORT QStringList wfstInsertLayerIds( const QgsProject &project ); /** * Returns the Layer ids list defined in a QGIS project as published as WFS-T with delete capabilities. - * @param project the QGIS project + * \param project the QGIS project * @return the Layer ids list. */ SERVER_EXPORT QStringList wfstDeleteLayerIds( const QgsProject &project ); diff --git a/src/server/qgsserverrequest.h b/src/server/qgsserverrequest.h index 31443370813e..ad3b4b1ba808 100644 --- a/src/server/qgsserverrequest.h +++ b/src/server/qgsserverrequest.h @@ -113,15 +113,15 @@ class SERVER_EXPORT QgsServerRequest /** * Return the header value - * @param name of the header + * \param name of the header * @return the header value or an empty string */ QString header( const QString &name ) const; /** * Set an header - * @param name - * @param value + * \param name + * \param value */ void setHeader( const QString &name, const QString &value ); @@ -133,7 +133,7 @@ class SERVER_EXPORT QgsServerRequest /** * Remove an header - * @param name + * \param name */ void removeHeader( const QString &name ); diff --git a/src/server/services/wms/qgswmsparameters.h b/src/server/services/wms/qgswmsparameters.h index a6ab78783f76..a3c24e898e0a 100644 --- a/src/server/services/wms/qgswmsparameters.h +++ b/src/server/services/wms/qgswmsparameters.h @@ -913,7 +913,7 @@ namespace QgsWms /** * @brief externalWMSUri - * @param id the id of the external wms + * \param id the id of the external wms * @return uri string or an empty string if the external wms id does not exist */ QString externalWMSUri( const QString &id ) const;