sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-04-16 00:03:12 -04:00
Code Issues Packages Projects Releases Wiki Activity

@(end)link -> \(end)link

Browse Source
This commit is contained in:
Nyall Dawson 2017-04-03 10:48:56 +10:00
parent 20ae0a8c0e
commit fa6ec3a993
39 changed files with 144 additions and 144 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/app/qgisapp.h
View File

@ -987,7 +987,7 @@ 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 {\link removeToolBarIcon}
* with the returned QAction.
*
* \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
/**
* Add a widget to the raster toolbar.
* To remove this widget again, call {@link removeRasterToolBarIcon}
* To remove this widget again, call {\link removeRasterToolBarIcon}
* with the returned QAction.
*
* \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
/**
* Add a widget to the vector toolbar.
* To remove this widget again, call {@link removeVectorToolBarIcon}
* To remove this widget again, call {\link removeVectorToolBarIcon}
* with the returned QAction.
*
* \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
/**
* Add a widget to the database toolbar.
* To remove this widget again, call {@link removeDatabaseToolBarIcon}
* To remove this widget again, call {\link removeDatabaseToolBarIcon}
* with the returned QAction.
*
* \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
/**
* Add a widget to the web toolbar.
* To remove this widget again, call {@link removeWebToolBarIcon}
* To remove this widget again, call {\link removeWebToolBarIcon}
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget

10
src/app/qgisappinterface.h
View File

@ -91,7 +91,7 @@ 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 {\link removeToolBarIcon}
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget
@ -105,7 +105,7 @@ 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 {\link removeRasterToolBarIcon}
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget
@ -119,7 +119,7 @@ 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 {\link removeVectorToolBarIcon}
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget
@ -133,7 +133,7 @@ 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 {\link removeDatabaseToolBarIcon}
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget
@ -147,7 +147,7 @@ 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 {\link removeWebToolBarIcon}
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget

16
src/core/composer/qgscomposerscalebar.h
View File

@ -95,8 +95,8 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
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.
* property is only effective if the \link segmentSizeMode \endlink is set
* to \link SegmentSizeFitWidth \endlink.
* \see segmentSizeMode
* \see setMinBarWidth
* \see maxBarWidth
@ -105,8 +105,8 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
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.
* 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
@ -116,8 +116,8 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
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.
* property is only effective if the \link segmentSizeMode \endlink is set
* to \link SegmentSizeFitWidth \endlink.
* \see segmentSizeMode
* \see setMaxBarWidth
* \see minBarWidth
@ -126,8 +126,8 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
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.
* 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

2
src/core/composer/qgscomposertexttable.h
View File

@ -38,7 +38,7 @@ class CORE_EXPORT QgsComposerTextTableV2 : public QgsComposerTableV2
* \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, \link setContents \endlink is much faster
*/
void addRow( const QStringList &row );

4
src/core/effects/qgsblureffect.h
View File

@ -56,7 +56,7 @@ 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 \link blurMethod \endlink, this parameter
* has different effects
* \see blurLevel
* \see blurMethod
@ -64,7 +64,7 @@ class CORE_EXPORT QgsBlurEffect : public QgsPaintEffect
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 \link blurMethod \endlink, this parameter
* has different effects
* \see setBlurLevel
* \see blurMethod

8
src/core/effects/qgscoloreffect.h
View File

@ -126,7 +126,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
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.
* \link setColorizeOn \endlink is set to true.
* \param colorizeColor colorization color
* \see colorizeColor
* \see setColorizeOn
@ -135,7 +135,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
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.
* \link colorizeOn \endlink is set to true.
* \returns colorization color
* \see setColorizeColor
* \see colorizeOn
@ -144,7 +144,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
QColor colorizeColor() const { return mColorizeColor; }
/** Sets the strength for colorizing a picture. This is only used if
* @link setColorizeOn @endlink is set to true.
* \link setColorizeOn \endlink is set to true.
* \param colorizeStrength colorization strength, between 0 and 100
* \see colorizeStrength
* \see setColorizeOn
@ -153,7 +153,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
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.
* \link setColorizeOn \endlink is set to true.
* \returns colorization strength, between 0 and 100
* \see setColorizeStrengths
* \see colorizeOn

12
src/core/effects/qgsgloweffect.h
View File

@ -53,7 +53,7 @@ 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
* \param spread spread distance. Units are specified via \link setSpreadUnit \endlink
* \see spread
* \see setSpreadUnit
* \see setSpreadMapUnitScale
@ -61,7 +61,7 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
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
* \returns spread distance. Units are retrieved via \link spreadUnit \endlink
* \see setSpread
* \see spreadUnit
* \see spreadMapUnitScale
@ -129,7 +129,7 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
*/
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 \link colorType \endlink
* is set to SingleColor. The glow will fade between the specified color and
* a totally transparent version of the color.
* \param color glow color
@ -138,7 +138,7 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
*/
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 \link colorType \endlink
* is set to SingleColor. The glow will fade between the specified color and
* a totally transparent version of the color.
* \returns glow color
@ -147,7 +147,7 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
*/
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 \link colorType \endlink
* 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
@ -155,7 +155,7 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
*/
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 \link colorType \endlink
* is set to ColorRamp. The glow will utilize colors from the ramp.
* \returns color ramp for glow
* \see setRamp

20
src/core/effects/qgspainteffect.h
View File

@ -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 \link render \endlink 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 \link begin \endlink 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 \link end \endlink
* method. This will perform the paint effect on the intercepted drawing operations
* and render the result to the render context's paint device.
*
@ -95,7 +95,7 @@ class CORE_EXPORT QgsPaintEffect
/** 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.
* \link properties \endlink.
* \param doc destination DOM document
* \param element destination DOM element
* \returns true if save was successful
@ -118,7 +118,7 @@ class CORE_EXPORT QgsPaintEffect
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
* \link end \endlink 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
@ -146,14 +146,14 @@ class CORE_EXPORT QgsPaintEffect
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
* effect if the paint effect is used in a \link QgsEffectStack \endlink
* \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
* effect if the paint effect is used in a \link QgsEffectStack \endlink
* \param drawMode draw mode for effect
* \see drawMode
*/
@ -181,7 +181,7 @@ class CORE_EXPORT QgsPaintEffect
*/
void drawSource( QPainter &painter );
/** Returns the source QPicture. The @link draw @endlink member can utilize this when
/** Returns the source QPicture. The \link draw \endlink member can utilize this when
* drawing the effect.
* \returns source QPicture
* \see drawSource
@ -189,9 +189,9 @@ class CORE_EXPORT QgsPaintEffect
*/
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 \link draw \endlink 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 \link boundingRect \endlink method.
* The result is cached to speed up subsequent calls to sourceAsImage.
* \returns source QPicture rendered to an image
* \see drawSource

4
src/core/effects/qgsshadoweffect.h
View File

@ -69,7 +69,7 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect
int offsetAngle() const { return mOffsetAngle; }
/** Sets the distance for offsetting the shadow.
* \param distance offset distance. Units are specified via @link setOffsetUnit @endlink
* \param distance offset distance. Units are specified via \link setOffsetUnit \endlink
* \see offsetDistance
* \see setOffsetUnit
* \see setOffsetMapUnitScale
@ -77,7 +77,7 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect
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
* \returns offset distance. Distance units are retrieved via \link offsetUnit \endlink
* \see setOffsetDistance
* \see offsetUnit
* \see offsetMapUnitScale

6
src/core/geometry/qgsgeometry.h
View File

@ -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 \link QgsAbstractGeometry \endlink within the container, and
* can be accessed via the \link geometry \endlink method or set using the \link setGeometry \endlink method.
*/
class CORE_EXPORT QgsGeometry
@ -112,7 +112,7 @@ class CORE_EXPORT QgsGeometry
void setGeometry( QgsAbstractGeometry *geometry );
/** Returns true if the geometry is null (ie, contains no underlying geometry
* accessible via @link geometry @endlink).
* accessible via \link geometry \endlink).
* \see geometry
* \since QGIS 2.10
* \see isEmpty()

2
src/core/qgscacheindex.h
View File

@ -66,7 +66,7 @@ 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 {\link 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.

4
src/core/qgsdatetimestatisticalsummary.h
View File

@ -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 \link calculate \endlink 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 \link setStatistics \endlink.
*
* \since QGIS 2.16
*/

8
src/core/qgseditformconfig.h
View File

@ -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 \link setInitCode \endlink.
*/
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 \link setInitCode \endlink.
*/
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
* \link setInitFunction \endlink
*/
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
* \link setInitFunction \endlink
*/
void setInitFilePath( const QString &filePath );

4
src/core/qgsexpression.h
View File

@ -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 {\link 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
* {\link prepare()} should always be called before every
* loop in which this expression is used.
*/
QgsExpression( const QString &expr );

12
src/core/qgsfeature.h
View File

@ -228,7 +228,7 @@ class CORE_EXPORT QgsFeature
void setId( QgsFeatureId id );
/** Returns the feature's attributes.
* @link attributes @endlink method.
* \link attributes \endlink method.
* \returns list of feature's attributes
* \see setAttributes
* \since QGIS 2.9
@ -359,7 +359,7 @@ class CORE_EXPORT QgsFeature
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 \link setFields \endlink 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
@ -393,7 +393,7 @@ 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 \link setFields \endlink
* before this method can be used.
* \param name The name of the field to delete
* \returns false if attribute name could not be converted to index (C++ only)
@ -419,7 +419,7 @@ 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 \link setFields \endlink
* before this method can be used.
* \param name The name of the attribute to get
* \returns The value of the attribute (C++: Invalid variant if no such name exists )
@ -446,7 +446,7 @@ 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 \link setFields \endlink
* before this method can be used.
* \param fieldIdx The index of the attribute to get
* \returns The value of the attribute (C++: Invalid variant if no such index exists )
@ -474,7 +474,7 @@ 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 \link setFields \endlink
* 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.

8
src/core/qgshistogram.h
View File

@ -59,7 +59,7 @@ class CORE_EXPORT QgsHistogram
* 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
* \note values must first be specified using \link setValues \endlink
*/
double optimalBinWidth() const;
@ -68,7 +68,7 @@ class CORE_EXPORT QgsHistogram
* of values and the number of values.
* \returns optimal number of bins
* \see optimalBinWidth
* \note values must first be specified using @link setValues @endlink
* \note values must first be specified using \link setValues \endlink
*/
int optimalNumberBins() const;
@ -76,14 +76,14 @@ class CORE_EXPORT QgsHistogram
* will be length bins + 1, as both the first and last value are also included.
* \param bins number of bins
* \returns list of bin edges
* \note values must first be specified using @link setValues @endlink
* \note values must first be specified using \link setValues \endlink
*/
QList<double> binEdges( int bins ) const;
/** Returns the calculated list of the counts for the histogram bins.
* \param bins number of histogram bins
* \returns list of histogram counts
* \note values must first be specified using @link setValues @endlink
* \note values must first be specified using \link setValues \endlink
*/
QList<int> counts( int bins ) const;

16
src/core/qgsproject.h
View File

@ -834,7 +834,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
*
* \param layerId The ID of the layer to be removed.
*
* \note Consider using {@link layersWillBeRemoved()} instead
* \note Consider using {\link layersWillBeRemoved()} instead
* \see layersWillBeRemoved()
* \see layerRemoved()
*/
@ -845,7 +845,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
*
* \param layer The layer to be removed.
*
* \note Consider using {@link layersWillBeRemoved()} instead
* \note Consider using {\link layersWillBeRemoved()} instead
* \see layersWillBeRemoved()
* \see layerRemoved()
*/
@ -864,14 +864,14 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
*
* \param layerId The ID of the layer removed.
*
* \note Consider using {@link layersRemoved()} instead
* \note Consider using {\link 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 {\link layersWillBeRemoved()} and
* {\link 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.
*/
@ -893,7 +893,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
/**
* Emitted when a layer was added to the registry.
*
* \note Consider using {@link layersAdded()} instead
* \note Consider using {\link layersAdded()} instead
* \see layersAdded()
*/
void layerWasAdded( QgsMapLayer *layer );
@ -901,10 +901,10 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
/**
* 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
* {\link layersAdded()} and {\link 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 {\link QgsMapLayer}s which were added to the legend.
*/
void legendLayersAdded( const QList<QgsMapLayer *> &layers );

4
src/core/qgsstatisticalsummary.h
View File

@ -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 \link calculate \endlink 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 \link setStatistics \endlink.
*
* \since QGIS 2.9
*/

4
src/core/qgsstringstatisticalsummary.h
View File

@ -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 \link calculate \endlink 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 \link setStatistics \endlink.
*
* \since QGIS 2.16
*/

40
src/core/qgsvectorlayer.h
View File

@ -422,7 +422,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
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 { \link QgsExpression }.
*
* \param displayExpression The expression which will be used to preview features
* for this layer
@ -431,7 +431,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
/**
* Get the preview expression, used to create a human readable preview string.
* Uses { @link QgsExpression }
* Uses { \link QgsExpression }
*
* \returns The expression which will be used to preview features for this layer
*/
@ -611,7 +611,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
/**
* Get a copy of the user-selected features
*
* \returns A list of { @link QgsFeature } 's
* \returns A list of { \link QgsFeature } 's
*
* \see selectedFeatureIds()
* \see selectedFeaturesIterator() which is more memory friendly when handling large selections
@ -634,7 +634,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
/**
* Return reference to identifiers of selected features
*
* \returns A list of { @link QgsFeatureId } 's
* \returns A list of { \link QgsFeatureId } 's
* \see selectedFeatures()
*/
const QgsFeatureIds &selectedFeatureIds() const;
@ -886,8 +886,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
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.
on every call. Consider using {\link changeAttributeValue()} or
{\link changeGeometry()} instead.
\param f Feature to update
\returns True in case of success and False in case of error
*/
@ -1103,7 +1103,7 @@ 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.
* Alias for {@link fields()}
* Alias for {\link fields()}
*
* \returns A list of fields
*/
@ -1111,19 +1111,19 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
/**
* Returns list of attribute indexes. i.e. a list from 0 ... fieldCount()
* Alias for {@link attributeList()}
* Alias for {\link 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 {\link attributeList()}
*/
inline QgsAttributeList attributeList() const { return mFields.allAttributesList(); }
/**
* Returns list of attributes making up the primary key
* Alias for {@link pkAttributeList()}
* Alias for {\link 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 {\link featureCount()}
*/
inline long pendingFeatureCount() const { return featureCount(); }
@ -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 {\link commitChanges()} is called and can be reverted by calling
* {\link rollBack()}.
*/
bool startEditing();
@ -1704,7 +1704,7 @@ 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 {\link QgsFields::OriginEdit}, {\link QgsFields::OriginProvider} and {\link QgsFields::OriginExpression }
*
* \param idx The index of the new attribute
*
@ -1714,7 +1714,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
/**
* 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 {\link QgsFields::OriginExpression }
*
* \param fieldName The name of the attribute to be added
*/
@ -1722,7 +1722,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
/**
* 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 {\link QgsFields::OriginEdit}, {\link QgsFields::OriginProvider} and {\link QgsFields::OriginExpression }
*
* \param idx The index of the deleted attribute
*
@ -1732,7 +1732,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
/**
* 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 {\link QgsFields::OriginExpression }
*
* \param idx The index of the attribute to be deleted
*/
@ -1749,7 +1749,7 @@ 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& )}.
* {\link featuresDeleted( const QgsFeatureIds& )}.
*
* \param fid The id of the feature which has been deleted
*/
@ -1824,14 +1824,14 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
/**
* 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()}
* to the edit buffer. See {\link 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()}
* See {\link beforeRollBack()}
*/
void editCommandDestroyed();

14
src/core/qgsvectorlayercache.h
View File

@ -31,7 +31,7 @@ class QgsAbstractCacheIndex;
* This class caches features of a given QgsVectorLayer.
*
* \brief
* The cached features can be indexed by @link QgsAbstractCacheIndex @endlink.
* The cached features can be indexed by \link QgsAbstractCacheIndex \endlink.
*
* 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 \link QgsFeature \endlink, 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.
*/
@ -157,8 +157,8 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject
/**
* \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}.
* 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}.
* The layer cache will take ownership of the index.
*
* \param cacheIndex The cache index to add.
@ -168,7 +168,7 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject
/**
* 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 {\link 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.
@ -274,7 +274,7 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject
* Please note, that this does not check, if the requested features are cached.
*
*
* \param featureRequest The {@link QgsFeatureRequest} to be answered
* \param featureRequest The {\link QgsFeatureRequest} to be answered
* \returns True if the information is being cached, false if not
*/
bool checkInformationCovered( const QgsFeatureRequest &featureRequest );
@ -301,7 +301,7 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject
/**
* \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.
* \link layer() \endlink will still return a valid pointer for cleanup purpose.
*/
void cachedLayerDeleted();

4
src/core/symbology-ng/qgsrenderer.h
View File

@ -133,8 +133,8 @@ 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 {\link startRender()} and before the first call
* to {\link 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.

2
src/gui/attributetable/qgsattributetablemodel.h
View File

@ -36,7 +36,7 @@ class QgsEditorWidgetFactory;
class QgsFieldFormatter;
/** \ingroup gui
* A model backed by a {@link QgsVectorLayerCache} which is able to provide
* A model backed by a {\link QgsVectorLayerCache} which is able to provide
* feature/attribute information to a QAbstractItemView.
*
* \brief

8
src/gui/attributetable/qgsattributetableview.h
View File

@ -36,10 +36,10 @@ class QgsAttributeTableConfig;
/** \ingroup gui
* \brief
* Provides a table view of features of a @link QgsVectorLayer @endlink.
* Provides a table view of features of a \link QgsVectorLayer \endlink.
*
* 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 \link QgsDualView \endlink stacked widget.
*/
class GUI_EXPORT QgsAttributeTableView : public QTableView
@ -112,7 +112,7 @@ class GUI_EXPORT QgsAttributeTableView : public QTableView
/**
* \brief
* Is called when the context menu will be shown. Emits a @link willShowContextMenu @endlink signal,
* Is called when the context menu will be shown. Emits a \link willShowContextMenu \endlink signal,
* so the menu can be populated by other parts of the application.
*
* \param event The associated event object.
@ -133,7 +133,7 @@ class GUI_EXPORT QgsAttributeTableView : public QTableView
*
* \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
* In most cases, this will be a \link QgsAttributeTableFilterModel \endlink
*/
void willShowContextMenu( QMenu *menu, const QModelIndex &atIndex );

6
src/gui/attributetable/qgsdualview.h
View File

@ -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 {\link 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
@ -77,7 +77,7 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas
*
* \param layer The layer which should be used to fetch features
* \param mapCanvas The mapCanvas (used for the FilterMode
* {@link QgsAttributeTableFilterModel::ShowVisible}
* {\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
@ -205,7 +205,7 @@ 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 {\link AttributeEditor} mode.
*
* \param fids A list of edited features (Currently only one at a time is supported)
*/

4
src/gui/attributetable/qgsfeaturelistmodel.h
View File

@ -83,9 +83,9 @@ class GUI_EXPORT QgsFeatureListModel : public QAbstractProxyModel, public QgsFea
QgsAttributeTableModel *masterModel();
/**
* \param expression A {@link QgsExpression} compatible string.
* \param expression A {\link 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 {@link parserErrorString()}
* If it fails, the old expression will still be applied. Call {\link parserErrorString()}
* for a meaningful error message.
*/
bool setDisplayExpression( const QString &expression );

4
src/gui/attributetable/qgsfeaturelistview.h
View File

@ -37,7 +37,7 @@ class QRect;
*
* \brief
* Accepts a display expression to define the way, features are rendered.
* Uses a {@link QgsFeatureListModel} as source model.
* Uses a {\link QgsFeatureListModel} as source model.
*
*/
class GUI_EXPORT QgsFeatureListView : public QListView
@ -60,7 +60,7 @@ class GUI_EXPORT QgsFeatureListView : public QListView
QgsVectorLayerCache *layerCache();
/**
* Set the {@link QgsFeatureListModel} which is used to retrieve information
* Set the {\link QgsFeatureListModel} which is used to retrieve information
*
* \param featureListModel The model to use
*/

2
src/gui/attributetable/qgsfeatureselectionmodel.h
View File

@ -34,7 +34,7 @@ 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 {\link 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

2
src/gui/attributetable/qgsgenericfeatureselectionmanager.h
View File

@ -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 { \link QgsVectorLayerSelectionManager } instead.
* \note not available in Python bindings
*/
class GUI_EXPORT QgsGenericFeatureSelectionManager : public QgsIFeatureSelectionManager

6
src/gui/attributetable/qgsifeatureselectionmanager.h
View File

@ -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. { \link QgsVectorLayer } implements this interface to manage its selections.
*/
class GUI_EXPORT QgsIFeatureSelectionManager : public QObject
@ -58,7 +58,7 @@ class GUI_EXPORT QgsIFeatureSelectionManager : public QObject
/**
* 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 { \link selectionChanged( const QgsFeatureIds&, const QgsFeatureIds&, bool ) } signal with the
* clearAndSelect flag set.
*
* \param ids The ids which will be the new selection
@ -68,7 +68,7 @@ class GUI_EXPORT QgsIFeatureSelectionManager : public QObject
/**
* Return reference to identifiers of selected features
*
* \returns A list of { @link QgsFeatureId } 's
* \returns A list of { \link QgsFeatureId } 's
* \see selectedFeatures()
*/
virtual const QgsFeatureIds &selectedFeatureIds() const = 0;

4
src/gui/attributetable/qgsvectorlayerselectionmanager.h
View File

@ -55,7 +55,7 @@ class GUI_EXPORT QgsVectorLayerSelectionManager : public QgsIFeatureSelectionMan
/**
* 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 { \link selectionChanged( const QgsFeatureIds&, const QgsFeatureIds&, bool ) } signal with the
* clearAndSelect flag set.
*
* \param ids The ids which will be the new selection
@ -65,7 +65,7 @@ class GUI_EXPORT QgsVectorLayerSelectionManager : public QgsIFeatureSelectionMan
/**
* Return reference to identifiers of selected features
*
* \returns A list of { @link QgsFeatureIds }
* \returns A list of { \link QgsFeatureIds }
* \see selectedFeatures()
*/
virtual const QgsFeatureIds &selectedFeatureIds() const override;

2
src/gui/editorwidgets/core/qgseditorwidgetfactory.h
View File

@ -52,7 +52,7 @@ 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 {\link QgsEditorWidgetRegistry::create()}
* instead of calling this method directly.
*
* \param vl The vector layer on which this widget will act

2
src/gui/editorwidgets/core/qgswidgetwrapper.h
View File

@ -176,7 +176,7 @@ 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 {\link initWidget(QWidget*)}.
*
* \param parent You should set this parent on the created widget.
* \returns A new widget

2
src/gui/editorwidgets/qgsrelationreferencefactory.h
View File

@ -35,7 +35,7 @@ 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 {\link QgsEditorWidgetRegistry::create()}
* instead of calling this method directly.
*
* \param vl The vector layer on which this widget will act

12
src/gui/qgisinterface.h
View File

@ -166,7 +166,7 @@ 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 {\link removeToolBarIcon}
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget
@ -179,7 +179,7 @@ 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 {\link removeRasterToolBarIcon}
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget
@ -198,7 +198,7 @@ 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 {\link removeVectorToolBarIcon}
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget
@ -214,7 +214,7 @@ 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 {\link removeDatabaseToolBarIcon}
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget
@ -230,7 +230,7 @@ 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 {\link removeWebToolBarIcon}
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget
@ -427,7 +427,7 @@ class GUI_EXPORT QgisInterface : public QObject
* \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

6
src/gui/qgshistogramwidget.h
View File

@ -77,7 +77,7 @@ class GUI_EXPORT QgsHistogramWidget : public QWidget, private Ui::QgsHistogramWi
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 \link setGraduatedRanges \endlink
* then the pen and brush will have no effect.
* \param pen histogram pen
* \see pen
@ -91,7 +91,7 @@ class GUI_EXPORT QgsHistogramWidget : public QWidget, private Ui::QgsHistogramWi
*/
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 \link setGraduatedRanges \endlink
* then the pen and brush will have no effect.
* \param brush histogram brush
* \see brush
@ -152,7 +152,7 @@ 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 \link refreshValues \endlink to do this.
*/
void refresh();

6
src/gui/qgsrubberband.h
View File

@ -222,7 +222,7 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem
/**
* 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.
* 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
* crs. In case of 0 pointer, the coordinates are not going to be transformed.
@ -239,8 +239,8 @@ 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 {\link reset} or {\link setToGeometry} with appropriate arguments.
* {\link 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

6
src/gui/symbology-ng/qgssymbollayerwidget.h
View File

@ -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, {\link 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 {\link changed()} should be preferred.
*
* \see {@link changed()}
* \see {\link changed()}
*/
void symbolChanged();

2
src/server/qgsftptransaction.h
View File

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