Skip to content
Permalink
Browse files

[doxygen] replace @param by \param

  • Loading branch information
3nids committed Dec 6, 2017
1 parent b72c569 commit f29306d4af8dd1b2fe24f9a11aeff850472d5849
@@ -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;
@@ -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:
@@ -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 );
@@ -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,32 +325,32 @@ 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

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

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

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
@@ -97,16 +97,16 @@ 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

void setHeader( const QString &name, const QString &value );
%Docstring
Set an header
@param name
@param value
\param name
\param value
%End

QMap<QString, QString> 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;
@@ -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;
@@ -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 );
@@ -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;
@@ -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 );

@@ -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();

@@ -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;

@@ -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
@@ -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 );

@@ -36,7 +36,7 @@ class QgsWidgetStateHelper : public QObject

/**
* QgsWidgetStateHelper
* @param parent Parent object
* \param parent Parent object
*/
explicit QgsWidgetStateHelper( QObject *parent = 0 );

@@ -298,37 +298,37 @@ 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.
*/

SERVER_EXPORT int wfsLayerPrecision( const QgsProject &project, const QString &layerId );

/**
* 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 );
@@ -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 );

@@ -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;

0 comments on commit f29306d

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