Skip to content

Commit fa6ec3a

Browse files
nyalldawsonnyalldawson
committedApr 3, 2017
@(end)link -> \(end)link
·
ltr-3_40final-3_0_0
1 parent 20ae0a8 commit fa6ec3a

39 files changed

+144
-144
lines changed
 

‎src/app/qgisapp.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -987,7 +987,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
987987

988988
/**
989989
* Add a widget to the plugins toolbar.
990-
* To remove this widget again, call {@link removeToolBarIcon}
990+
* To remove this widget again, call {\link removeToolBarIcon}
991991
* with the returned QAction.
992992
*
993993
* \param widget widget to add. The toolbar will take ownership of this widget
@@ -1001,7 +1001,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
10011001

10021002
/**
10031003
* Add a widget to the raster toolbar.
1004-
* To remove this widget again, call {@link removeRasterToolBarIcon}
1004+
* To remove this widget again, call {\link removeRasterToolBarIcon}
10051005
* with the returned QAction.
10061006
*
10071007
* \param widget widget to add. The toolbar will take ownership of this widget
@@ -1015,7 +1015,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
10151015

10161016
/**
10171017
* Add a widget to the vector toolbar.
1018-
* To remove this widget again, call {@link removeVectorToolBarIcon}
1018+
* To remove this widget again, call {\link removeVectorToolBarIcon}
10191019
* with the returned QAction.
10201020
*
10211021
* \param widget widget to add. The toolbar will take ownership of this widget
@@ -1029,7 +1029,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
10291029

10301030
/**
10311031
* Add a widget to the database toolbar.
1032-
* To remove this widget again, call {@link removeDatabaseToolBarIcon}
1032+
* To remove this widget again, call {\link removeDatabaseToolBarIcon}
10331033
* with the returned QAction.
10341034
*
10351035
* \param widget widget to add. The toolbar will take ownership of this widget
@@ -1043,7 +1043,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
10431043

10441044
/**
10451045
* Add a widget to the web toolbar.
1046-
* To remove this widget again, call {@link removeWebToolBarIcon}
1046+
* To remove this widget again, call {\link removeWebToolBarIcon}
10471047
* with the returned QAction.
10481048
*
10491049
* \param widget widget to add. The toolbar will take ownership of this widget

‎src/app/qgisappinterface.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
9191

9292
/**
9393
* Add a widget to the plugins toolbar.
94-
* To remove this widget again, call {@link removeToolBarIcon}
94+
* To remove this widget again, call {\link removeToolBarIcon}
9595
* with the returned QAction.
9696
*
9797
* \param widget widget to add. The toolbar will take ownership of this widget
@@ -105,7 +105,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
105105

106106
/**
107107
* Add a widget to the raster toolbar.
108-
* To remove this widget again, call {@link removeRasterToolBarIcon}
108+
* To remove this widget again, call {\link removeRasterToolBarIcon}
109109
* with the returned QAction.
110110
*
111111
* \param widget widget to add. The toolbar will take ownership of this widget
@@ -119,7 +119,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
119119

120120
/**
121121
* Add a widget to the vector toolbar.
122-
* To remove this widget again, call {@link removeVectorToolBarIcon}
122+
* To remove this widget again, call {\link removeVectorToolBarIcon}
123123
* with the returned QAction.
124124
*
125125
* \param widget widget to add. The toolbar will take ownership of this widget
@@ -133,7 +133,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
133133

134134
/**
135135
* Add a widget to the database toolbar.
136-
* To remove this widget again, call {@link removeDatabaseToolBarIcon}
136+
* To remove this widget again, call {\link removeDatabaseToolBarIcon}
137137
* with the returned QAction.
138138
*
139139
* \param widget widget to add. The toolbar will take ownership of this widget
@@ -147,7 +147,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
147147

148148
/**
149149
* Add a widget to the web toolbar.
150-
* To remove this widget again, call {@link removeWebToolBarIcon}
150+
* To remove this widget again, call {\link removeWebToolBarIcon}
151151
* with the returned QAction.
152152
*
153153
* \param widget widget to add. The toolbar will take ownership of this widget

‎src/core/composer/qgscomposerscalebar.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
9595
void setSegmentSizeMode( SegmentSizeMode mode );
9696

9797
/** Returns the minimum size (in millimeters) for scale bar segments. This
98-
* property is only effective if the @link segmentSizeMode @endlink is set
99-
* to @link SegmentSizeFitWidth @endlink.
98+
* property is only effective if the \link segmentSizeMode \endlink is set
99+
* to \link SegmentSizeFitWidth \endlink.
100100
* \see segmentSizeMode
101101
* \see setMinBarWidth
102102
* \see maxBarWidth
@@ -105,8 +105,8 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
105105
double minBarWidth() const { return mMinBarWidth; }
106106

107107
/** Sets the minimum size (in millimeters) for scale bar segments. This
108-
* property is only effective if the @link segmentSizeMode @endlink is set
109-
* to @link SegmentSizeFitWidth @endlink.
108+
* property is only effective if the \link segmentSizeMode \endlink is set
109+
* to \link SegmentSizeFitWidth \endlink.
110110
* \param minWidth minimum width in millimeters
111111
* \see minBarWidth
112112
* \see setMaxBarWidth
@@ -116,8 +116,8 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
116116
void setMinBarWidth( double minWidth );
117117

118118
/** Returns the maximum size (in millimeters) for scale bar segments. This
119-
* property is only effective if the @link segmentSizeMode @endlink is set
120-
* to @link SegmentSizeFitWidth @endlink.
119+
* property is only effective if the \link segmentSizeMode \endlink is set
120+
* to \link SegmentSizeFitWidth \endlink.
121121
* \see segmentSizeMode
122122
* \see setMaxBarWidth
123123
* \see minBarWidth
@@ -126,8 +126,8 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
126126
double maxBarWidth() const { return mMaxBarWidth; }
127127

128128
/** Sets the maximum size (in millimeters) for scale bar segments. This
129-
* property is only effective if the @link segmentSizeMode @endlink is set
130-
* to @link SegmentSizeFitWidth @endlink.
129+
* property is only effective if the \link segmentSizeMode \endlink is set
130+
* to \link SegmentSizeFitWidth \endlink.
131131
* \param maxWidth maximum width in millimeters
132132
* \see minBarWidth
133133
* \see setMaxBarWidth

‎src/core/composer/qgscomposertexttable.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ class CORE_EXPORT QgsComposerTextTableV2 : public QgsComposerTableV2
3838
* \note If row is shorter than the number of columns in the table than blank cells
3939
* will be inserted at the end of the row. If row contains more strings then the number
4040
* of columns in the table then these extra strings will be ignored.
41-
* \note if adding many rows, @link setContents @endlink is much faster
41+
* \note if adding many rows, \link setContents \endlink is much faster
4242
*/
4343
void addRow( const QStringList &row );
4444

‎src/core/effects/qgsblureffect.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,15 @@ class CORE_EXPORT QgsBlurEffect : public QgsPaintEffect
5656
virtual QgsBlurEffect *clone() const override;
5757

5858
/** Sets blur level (strength)
59-
* \param level blur level. Depending on the current @link blurMethod @endlink, this parameter
59+
* \param level blur level. Depending on the current \link blurMethod \endlink, this parameter
6060
* has different effects
6161
* \see blurLevel
6262
* \see blurMethod
6363
*/
6464
void setBlurLevel( const int level ) { mBlurLevel = level; }
6565

6666
/** Returns the blur level (strength)
67-
* \returns blur level. Depending on the current @link blurMethod @endlink, this parameter
67+
* \returns blur level. Depending on the current \link blurMethod \endlink, this parameter
6868
* has different effects
6969
* \see setBlurLevel
7070
* \see blurMethod

‎src/core/effects/qgscoloreffect.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
126126
bool colorizeOn() const { return mColorizeOn; }
127127

128128
/** Sets the color used for colorizing a picture. This is only used if
129-
* @link setColorizeOn @endlink is set to true.
129+
* \link setColorizeOn \endlink is set to true.
130130
* \param colorizeColor colorization color
131131
* \see colorizeColor
132132
* \see setColorizeOn
@@ -135,7 +135,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
135135
void setColorizeColor( const QColor &colorizeColor );
136136

137137
/** Returns the color used for colorizing a picture. This is only used if
138-
* @link colorizeOn @endlink is set to true.
138+
* \link colorizeOn \endlink is set to true.
139139
* \returns colorization color
140140
* \see setColorizeColor
141141
* \see colorizeOn
@@ -144,7 +144,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
144144
QColor colorizeColor() const { return mColorizeColor; }
145145

146146
/** Sets the strength for colorizing a picture. This is only used if
147-
* @link setColorizeOn @endlink is set to true.
147+
* \link setColorizeOn \endlink is set to true.
148148
* \param colorizeStrength colorization strength, between 0 and 100
149149
* \see colorizeStrength
150150
* \see setColorizeOn
@@ -153,7 +153,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
153153
void setColorizeStrength( int colorizeStrength ) { mColorizeStrength = colorizeStrength; }
154154

155155
/** Returns the strength used for colorizing a picture. This is only used if
156-
* @link setColorizeOn @endlink is set to true.
156+
* \link setColorizeOn \endlink is set to true.
157157
* \returns colorization strength, between 0 and 100
158158
* \see setColorizeStrengths
159159
* \see colorizeOn

‎src/core/effects/qgsgloweffect.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,15 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
5353
virtual void readProperties( const QgsStringMap &props ) override;
5454

5555
/** Sets the spread distance for drawing the glow effect.
56-
* \param spread spread distance. Units are specified via @link setSpreadUnit @endlink
56+
* \param spread spread distance. Units are specified via \link setSpreadUnit \endlink
5757
* \see spread
5858
* \see setSpreadUnit
5959
* \see setSpreadMapUnitScale
6060
*/
6161
void setSpread( const double spread ) { mSpread = spread; }
6262

6363
/** Returns the spread distance used for drawing the glow effect.
64-
* \returns spread distance. Units are retrieved via @link spreadUnit @endlink
64+
* \returns spread distance. Units are retrieved via \link spreadUnit \endlink
6565
* \see setSpread
6666
* \see spreadUnit
6767
* \see spreadMapUnitScale
@@ -129,7 +129,7 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
129129
*/
130130
double transparency() const { return mTransparency; }
131131

132-
/** Sets the color for the glow. This only applies if the @link colorType @endlink
132+
/** Sets the color for the glow. This only applies if the \link colorType \endlink
133133
* is set to SingleColor. The glow will fade between the specified color and
134134
* a totally transparent version of the color.
135135
* \param color glow color
@@ -138,7 +138,7 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
138138
*/
139139
void setColor( const QColor &color ) { mColor = color; }
140140

141-
/** Returns the color for the glow. This only applies if the @link colorType @endlink
141+
/** Returns the color for the glow. This only applies if the \link colorType \endlink
142142
* is set to SingleColor. The glow will fade between the specified color and
143143
* a totally transparent version of the color.
144144
* \returns glow color
@@ -147,15 +147,15 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
147147
*/
148148
QColor color() const { return mColor; }
149149

150-
/** Sets the color ramp for the glow. This only applies if the @link colorType @endlink
150+
/** Sets the color ramp for the glow. This only applies if the \link colorType \endlink
151151
* is set to ColorRamp. The glow will utilize colors from the ramp.
152152
* \param ramp color ramp for glow. Ownership of the ramp is transferred to the effect.
153153
* \see ramp
154154
* \see setColorType
155155
*/
156156
void setRamp( QgsColorRamp *ramp );
157157

158-
/** Returns the color ramp used for the glow. This only applies if the @link colorType @endlink
158+
/** Returns the color ramp used for the glow. This only applies if the \link colorType \endlink
159159
* is set to ColorRamp. The glow will utilize colors from the ramp.
160160
* \returns color ramp for glow
161161
* \see setRamp

‎src/core/effects/qgspainteffect.h

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ class QgsRenderContext;
3434
* either drawing a picture directly, or by intercepting drawing operations to a
3535
* render context.
3636
*
37-
* To directly draw a picture, use the @link render @endlink method with a source
37+
* To directly draw a picture, use the \link render \endlink method with a source
3838
* QPicture and destination render context.
3939
*
4040
* Intercepting drawing operations to a render context is achieved by first calling
41-
* the @link begin @endlink method, passing a render context. Any drawing operations
41+
* the \link begin \endlink method, passing a render context. Any drawing operations
4242
* performed on the render context will not directly affect the context's paint
43-
* device. When the drawing operations have been completed, call the @link end @endlink
43+
* device. When the drawing operations have been completed, call the \link end \endlink
4444
* method. This will perform the paint effect on the intercepted drawing operations
4545
* and render the result to the render context's paint device.
4646
*
@@ -95,7 +95,7 @@ class CORE_EXPORT QgsPaintEffect
9595

9696
/** Saves the current state of the effect to a DOM element. The default
9797
* behavior is to save the properties string map returned by
98-
* @link properties @endlink.
98+
* \link properties \endlink.
9999
* \param doc destination DOM document
100100
* \param element destination DOM element
101101
* \returns true if save was successful
@@ -118,7 +118,7 @@ class CORE_EXPORT QgsPaintEffect
118118
virtual void render( QPicture &picture, QgsRenderContext &context );
119119

120120
/** Begins intercepting paint operations to a render context. When the corresponding
121-
* @link end @endlink member is called all intercepted paint operations will be
121+
* \link end \endlink member is called all intercepted paint operations will be
122122
* drawn to the render context after being modified by the effect.
123123
* \param context destination render context
124124
* \see end
@@ -146,14 +146,14 @@ class CORE_EXPORT QgsPaintEffect
146146
void setEnabled( const bool enabled );
147147

148148
/** Returns the draw mode for the effect. This property only has an
149-
* effect if the paint effect is used in a @link QgsEffectStack @endlink
149+
* effect if the paint effect is used in a \link QgsEffectStack \endlink
150150
* \returns draw mode for effect
151151
* \see setDrawMode
152152
*/
153153
DrawMode drawMode() const { return mDrawMode; }
154154

155155
/** Sets the draw mode for the effect. This property only has an
156-
* effect if the paint effect is used in a @link QgsEffectStack @endlink
156+
* effect if the paint effect is used in a \link QgsEffectStack \endlink
157157
* \param drawMode draw mode for effect
158158
* \see drawMode
159159
*/
@@ -181,17 +181,17 @@ class CORE_EXPORT QgsPaintEffect
181181
*/
182182
void drawSource( QPainter &painter );
183183

184-
/** Returns the source QPicture. The @link draw @endlink member can utilize this when
184+
/** Returns the source QPicture. The \link draw \endlink member can utilize this when
185185
* drawing the effect.
186186
* \returns source QPicture
187187
* \see drawSource
188188
* \see sourceAsImage
189189
*/
190190
const QPicture *source() const { return mPicture; }
191191

192-
/** Returns the source QPicture rendered to a new QImage. The @link draw @endlink member can
192+
/** Returns the source QPicture rendered to a new QImage. The \link draw \endlink member can
193193
* utilize this when drawing the effect. The image will be padded or cropped from the original
194-
* source QPicture by the results of the @link boundingRect @endlink method.
194+
* source QPicture by the results of the \link boundingRect \endlink method.
195195
* The result is cached to speed up subsequent calls to sourceAsImage.
196196
* \returns source QPicture rendered to an image
197197
* \see drawSource

‎src/core/effects/qgsshadoweffect.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,15 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect
6969
int offsetAngle() const { return mOffsetAngle; }
7070

7171
/** Sets the distance for offsetting the shadow.
72-
* \param distance offset distance. Units are specified via @link setOffsetUnit @endlink
72+
* \param distance offset distance. Units are specified via \link setOffsetUnit \endlink
7373
* \see offsetDistance
7474
* \see setOffsetUnit
7575
* \see setOffsetMapUnitScale
7676
*/
7777
void setOffsetDistance( const double distance ) { mOffsetDist = distance; }
7878

7979
/** Returns the distance used for offsetting the shadow.
80-
* \returns offset distance. Distance units are retrieved via @link offsetUnit @endlink
80+
* \returns offset distance. Distance units are retrieved via \link offsetUnit \endlink
8181
* \see setOffsetDistance
8282
* \see offsetUnit
8383
* \see offsetMapUnitScale

‎src/core/geometry/qgsgeometry.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ struct QgsGeometryPrivate;
7272
* for geometry objects. QgsGeometry is implicitly shared, so making copies of geometries is inexpensive. The geometry
7373
* container class can also be stored inside a QVariant object.
7474
*
75-
* The actual geometry representation is stored as a @link QgsAbstractGeometry @endlink within the container, and
76-
* can be accessed via the @link geometry @endlink method or set using the @link setGeometry @endlink method.
75+
* The actual geometry representation is stored as a \link QgsAbstractGeometry \endlink within the container, and
76+
* can be accessed via the \link geometry \endlink method or set using the \link setGeometry \endlink method.
7777
*/
7878

7979
class CORE_EXPORT QgsGeometry
@@ -112,7 +112,7 @@ class CORE_EXPORT QgsGeometry
112112
void setGeometry( QgsAbstractGeometry *geometry );
113113

114114
/** Returns true if the geometry is null (ie, contains no underlying geometry
115-
* accessible via @link geometry @endlink).
115+
* accessible via \link geometry \endlink).
116116
* \see geometry
117117
* \since QGIS 2.10
118118
* \see isEmpty()

‎src/core/qgscacheindex.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ class CORE_EXPORT QgsAbstractCacheIndex
6666
* and set the iterator to a valid iterator over the cached features. If it is not able
6767
* it will return false.
6868
*
69-
* \param featureIterator A reference to a {@link QgsFeatureIterator}. A valid featureIterator will
69+
* \param featureIterator A reference to a {\link QgsFeatureIterator}. A valid featureIterator will
7070
* be assigned in case this index is able to answer the request and the return
7171
* value is true.
7272
* \param featureRequest The feature request, for which this index is queried.

‎src/core/qgsdatetimestatisticalsummary.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@
3333
* \class QgsDateTimeStatisticalSummary
3434
* \brief Calculator for summary statistics and aggregates for a list of datetimes.
3535
*
36-
* Statistics are calculated by calling @link calculate @endlink and passing a list of datetimes. The
36+
* Statistics are calculated by calling \link calculate \endlink and passing a list of datetimes. The
3737
* individual statistics can then be retrieved using the associated methods. Note that not all statistics
3838
* are calculated by default. Statistics which require slower computations are only calculated by
39-
* specifying the statistic in the constructor or via @link setStatistics @endlink.
39+
* specifying the statistic in the constructor or via \link setStatistics \endlink.
4040
*
4141
* \since QGIS 2.16
4242
*/

0 commit comments

Comments
 (0)
Please sign in to comment.