Skip to content

Commit f29306d

Browse files
committed
[doxygen] replace @param by \param
1 parent b72c569 commit f29306d

17 files changed

+43
-43
lines changed

python/core/layout/qgslayoutitem.sip

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -735,7 +735,7 @@ class QgsLayoutItem : QgsLayoutObject, QGraphicsRectItem, QgsLayoutUndoObjectInt
735735
%Docstring
736736
Draws a debugging rectangle of the item's current bounds within the specified
737737
painter.
738-
@param painter destination QPainter
738+
\param painter destination QPainter
739739
%End
740740

741741
virtual void draw( QgsRenderContext &context, const QStyleOptionGraphicsItem *itemStyle = 0 ) = 0;

python/core/qgsvectorlayerlabeling.sip

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,9 @@ Try to create instance of an implementation based on the XML data
9898
%Docstring
9999
Writes a TextSymbolizer element contents based on the provided labeling settings
100100
writeTextSymbolizer
101-
@param parent the node that will have the text symbolizer element added to it
102-
@param settings the settings getting translated to a TextSymbolizer
103-
@param props a open ended set of properties that can drive/inform the SLD encoding
101+
\param parent the node that will have the text symbolizer element added to it
102+
\param settings the settings getting translated to a TextSymbolizer
103+
\param props a open ended set of properties that can drive/inform the SLD encoding
104104
%End
105105

106106
private:

python/gui/qgsdial.sip

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class QgsDial : QDial
2020
QgsDial( QWidget *parent /TransferThis/ = 0 );
2121
%Docstring
2222
QgsDial constructor for QgsDial
23-
@param parent parent object
23+
\param parent parent object
2424
%End
2525

2626
void setMinimum( const QVariant &min );

python/server/qgsserverprojectutils.sip

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ namespace QgsServerProjectUtils
316316
QStringList wfsLayerIds( const QgsProject &project );
317317
%Docstring
318318
Returns the Layer ids list defined in a QGIS project as published in WFS.
319-
@param project the QGIS project
319+
\param project the QGIS project
320320
@return the Layer ids list.
321321
:rtype: list of str
322322
%End
@@ -325,32 +325,32 @@ namespace QgsServerProjectUtils
325325
int wfsLayerPrecision( const QgsProject &project, const QString &layerId );
326326
%Docstring
327327
Returns the Layer precision defined in a QGIS project for the WFS GetFeature.
328-
@param project the QGIS project
329-
@param layerId the layer id in the project
328+
\param project the QGIS project
329+
\param layerId the layer id in the project
330330
@return the layer precision for WFS GetFeature.
331331
:rtype: int
332332
%End
333333

334334
QStringList wfstUpdateLayerIds( const QgsProject &project );
335335
%Docstring
336336
Returns the Layer ids list defined in a QGIS project as published as WFS-T with update capabilities.
337-
@param project the QGIS project
337+
\param project the QGIS project
338338
@return the Layer ids list.
339339
:rtype: list of str
340340
%End
341341

342342
QStringList wfstInsertLayerIds( const QgsProject &project );
343343
%Docstring
344344
Returns the Layer ids list defined in a QGIS project as published as WFS-T with insert capabilities.
345-
@param project the QGIS project
345+
\param project the QGIS project
346346
@return the Layer ids list.
347347
:rtype: list of str
348348
%End
349349

350350
QStringList wfstDeleteLayerIds( const QgsProject &project );
351351
%Docstring
352352
Returns the Layer ids list defined in a QGIS project as published as WFS-T with delete capabilities.
353-
@param project the QGIS project
353+
\param project the QGIS project
354354
@return the Layer ids list.
355355
:rtype: list of str
356356
%End

python/server/qgsserverrequest.sip

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,16 +97,16 @@ destructor
9797
QString header( const QString &name ) const;
9898
%Docstring
9999
Return the header value
100-
@param name of the header
100+
\param name of the header
101101
@return the header value or an empty string
102102
:rtype: str
103103
%End
104104

105105
void setHeader( const QString &name, const QString &value );
106106
%Docstring
107107
Set an header
108-
@param name
109-
@param value
108+
\param name
109+
\param value
110110
%End
111111

112112
QMap<QString, QString> headers() const;
@@ -119,7 +119,7 @@ destructor
119119
void removeHeader( const QString &name );
120120
%Docstring
121121
Remove an header
122-
@param name
122+
\param name
123123
%End
124124

125125
virtual QByteArray data() const;

src/app/composer/qgscomposer.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -489,10 +489,10 @@ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase
489489
QgsPanelWidget *createItemWidget( QgsComposerItem *item );
490490

491491
/*Saves image to file, possibly using format specific options (e.g. LZW compression for tiff)
492-
@param img the image to save
493-
@param imageFileName output file path
494-
@param imageFormat format string
495-
@param return true in case of success*/
492+
\param img the image to save
493+
\param imageFileName output file path
494+
\param imageFormat format string
495+
\param return true in case of success*/
496496
static bool saveImage( const QImage &img, const QString &imageFilename, const QString &imageFormat );
497497

498498
QgsAppComposerInterface *mInterface = nullptr;

src/app/qgsversionmigration.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ class APP_EXPORT QgsVersionMigration
3535

3636
/**
3737
* Check if two version has a migration options.
38-
* @param fromVersion The version migrating from.
39-
* @param toVersion The version migrating to.
38+
* \param fromVersion The version migrating from.
39+
* \param toVersion The version migrating to.
4040
* @return
4141
*/
4242
static QgsVersionMigration *canMigrate( int fromVersion, int toVersion );

src/core/geometry/qgsgeos.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -226,9 +226,9 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine
226226

227227
/**
228228
* Reshapes the geometry using a line
229-
* @param reshapeWithLine the line used to reshape lines or polygons
230-
* @param errorCode if specified, provides result of operation (success or reason of failure)
231-
* @param errorMsg if specified, provides more details about failure
229+
* \param reshapeWithLine the line used to reshape lines or polygons
230+
* \param errorCode if specified, provides result of operation (success or reason of failure)
231+
* \param errorMsg if specified, provides more details about failure
232232
* @return the reshaped geometry
233233
*/
234234
std::unique_ptr< QgsAbstractGeometry > reshapeGeometry( const QgsLineString &reshapeWithLine, EngineOperationResult *errorCode, QString *errorMsg = nullptr ) const;

src/core/layout/qgslayoutitem.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -728,7 +728,7 @@ class CORE_EXPORT QgsLayoutItem : public QgsLayoutObject, public QGraphicsRectIt
728728
/**
729729
* Draws a debugging rectangle of the item's current bounds within the specified
730730
* painter.
731-
* @param painter destination QPainter
731+
* \param painter destination QPainter
732732
*/
733733
virtual void drawDebugRect( QPainter *painter );
734734

src/core/qgsfeaturefiltermodel_p.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ class QgsFieldExpressionValuesGatherer: public QThread
108108

109109
/**
110110
* Emitted when values have been collected
111-
* @param values list of unique matching string values
111+
* \param values list of unique matching string values
112112
*/
113113
void collectedValues();
114114

src/core/qgsvectorlayerlabeling.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,9 @@ class CORE_EXPORT QgsAbstractVectorLayerLabeling
107107
/**
108108
* Writes a TextSymbolizer element contents based on the provided labeling settings
109109
* @brief writeTextSymbolizer
110-
* @param parent the node that will have the text symbolizer element added to it
111-
* @param settings the settings getting translated to a TextSymbolizer
112-
* @param props a open ended set of properties that can drive/inform the SLD encoding
110+
* \param parent the node that will have the text symbolizer element added to it
111+
* \param settings the settings getting translated to a TextSymbolizer
112+
* \param props a open ended set of properties that can drive/inform the SLD encoding
113113
*/
114114
virtual void writeTextSymbolizer( QDomNode &parent, QgsPalLayerSettings &settings, const QgsStringMap &props ) const;
115115

src/gui/qgsbrowserdockwidget_p.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ class QgsBrowserTreeFilterProxyModel : public QSortFilterProxyModel
214214

215215
/**
216216
* Constructor for QgsBrowserTreeFilterProxyModel
217-
* @param parent parent widget
217+
* \param parent parent widget
218218
*/
219219
explicit QgsBrowserTreeFilterProxyModel( QObject *parent );
220220
//! Set the browser model

src/gui/qgsdial.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ class GUI_EXPORT QgsDial : public QDial
3333

3434
/**
3535
* @brief QgsDial constructor for QgsDial
36-
* @param parent parent object
36+
* \param parent parent object
3737
*/
3838
QgsDial( QWidget *parent SIP_TRANSFERTHIS = nullptr );
3939

src/gui/qgswidgetstatehelper_p.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ class QgsWidgetStateHelper : public QObject
3636

3737
/**
3838
* QgsWidgetStateHelper
39-
* @param parent Parent object
39+
* \param parent Parent object
4040
*/
4141
explicit QgsWidgetStateHelper( QObject *parent = 0 );
4242

src/server/qgsserverprojectutils.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -298,37 +298,37 @@ namespace QgsServerProjectUtils
298298

299299
/**
300300
* Returns the Layer ids list defined in a QGIS project as published in WFS.
301-
* @param project the QGIS project
301+
* \param project the QGIS project
302302
* @return the Layer ids list.
303303
*/
304304
SERVER_EXPORT QStringList wfsLayerIds( const QgsProject &project );
305305

306306
/**
307307
* Returns the Layer precision defined in a QGIS project for the WFS GetFeature.
308-
* @param project the QGIS project
309-
* @param layerId the layer id in the project
308+
* \param project the QGIS project
309+
* \param layerId the layer id in the project
310310
* @return the layer precision for WFS GetFeature.
311311
*/
312312

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

315315
/**
316316
* Returns the Layer ids list defined in a QGIS project as published as WFS-T with update capabilities.
317-
* @param project the QGIS project
317+
* \param project the QGIS project
318318
* @return the Layer ids list.
319319
*/
320320
SERVER_EXPORT QStringList wfstUpdateLayerIds( const QgsProject &project );
321321

322322
/**
323323
* Returns the Layer ids list defined in a QGIS project as published as WFS-T with insert capabilities.
324-
* @param project the QGIS project
324+
* \param project the QGIS project
325325
* @return the Layer ids list.
326326
*/
327327
SERVER_EXPORT QStringList wfstInsertLayerIds( const QgsProject &project );
328328

329329
/**
330330
* Returns the Layer ids list defined in a QGIS project as published as WFS-T with delete capabilities.
331-
* @param project the QGIS project
331+
* \param project the QGIS project
332332
* @return the Layer ids list.
333333
*/
334334
SERVER_EXPORT QStringList wfstDeleteLayerIds( const QgsProject &project );

src/server/qgsserverrequest.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,15 +113,15 @@ class SERVER_EXPORT QgsServerRequest
113113

114114
/**
115115
* Return the header value
116-
* @param name of the header
116+
* \param name of the header
117117
* @return the header value or an empty string
118118
*/
119119
QString header( const QString &name ) const;
120120

121121
/**
122122
* Set an header
123-
* @param name
124-
* @param value
123+
* \param name
124+
* \param value
125125
*/
126126
void setHeader( const QString &name, const QString &value );
127127

@@ -133,7 +133,7 @@ class SERVER_EXPORT QgsServerRequest
133133

134134
/**
135135
* Remove an header
136-
* @param name
136+
* \param name
137137
*/
138138
void removeHeader( const QString &name );
139139

src/server/services/wms/qgswmsparameters.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -913,7 +913,7 @@ namespace QgsWms
913913

914914
/**
915915
* @brief externalWMSUri
916-
* @param id the id of the external wms
916+
* \param id the id of the external wms
917917
* @return uri string or an empty string if the external wms id does not exist
918918
*/
919919
QString externalWMSUri( const QString &id ) const;

0 commit comments

Comments
 (0)