Skip to content

Commit

Permalink
Use auto doxygen links where possible instead of explicit \link
Browse files Browse the repository at this point in the history 
Will make things nicer in Python documentation
  • Loading branch information
@nyalldawson
nyalldawson committed Apr 3, 2017
1 parent f92f14d commit 266f182
Show file tree
Hide file tree
Showing 40 changed files with 144 additions and 146 deletions.
10 changes: 5 additions & 5 deletions src/app/qgisapp.h
View file
Expand Up @@ -997,7 +997,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 removeToolBarIcon()
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget
Expand All @@ -1011,7 +1011,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 removeRasterToolBarIcon()
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget
Expand All @@ -1025,7 +1025,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 removeVectorToolBarIcon()
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget
Expand All @@ -1039,7 +1039,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 removeDatabaseToolBarIcon()
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget
Expand All @@ -1053,7 +1053,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 removeWebToolBarIcon()
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget
Expand Down
10 changes: 5 additions & 5 deletions src/app/qgisappinterface.h
View file
Expand Up @@ -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 removeToolBarIcon()
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget
Expand All @@ -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 removeRasterToolBarIcon()
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget
Expand All @@ -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 removeVectorToolBarIcon()
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget
Expand All @@ -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 removeDatabaseToolBarIcon()
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget
Expand All @@ -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 removeWebToolBarIcon()
* with the returned QAction.
*
* \param widget widget to add. The toolbar will take ownership of this widget
Expand Down
16 changes: 8 additions & 8 deletions src/core/composer/qgscomposerscalebar.h
View file
Expand Up @@ -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 segmentSizeMode() is set
* to SegmentSizeFitWidth.
* \see segmentSizeMode
* \see setMinBarWidth
* \see maxBarWidth
Expand All @@ -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 segmentSizeMode() is set
* to SegmentSizeFitWidth.
* \param minWidth minimum width in millimeters
* \see minBarWidth
* \see setMaxBarWidth
Expand All @@ -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 segmentSizeMode() is set
* to SegmentSizeFitWidth.
* \see segmentSizeMode
* \see setMaxBarWidth
* \see minBarWidth
Expand All @@ -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 segmentSizeMode() is set
* to SegmentSizeFitWidth.
* \param maxWidth maximum width in millimeters
* \see minBarWidth
* \see setMaxBarWidth
Expand Down
2 changes: 1 addition & 1 deletion src/core/composer/qgscomposertexttable.h
View file
Expand Up @@ -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, setContents() is much faster
*/
void addRow( const QStringList &row );

Expand Down
4 changes: 2 additions & 2 deletions src/core/effects/qgsblureffect.h
View file
Expand Up @@ -56,15 +56,15 @@ 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 blurMethod(), this parameter
* has different effects
* \see blurLevel
* \see blurMethod
*/
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 blurMethod(), this parameter
* has different effects
* \see setBlurLevel
* \see blurMethod
Expand Down
8 changes: 4 additions & 4 deletions src/core/effects/qgscoloreffect.h
View file
Expand Up @@ -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.
* setColorizeOn() is set to true.
* \param colorizeColor colorization color
* \see colorizeColor
* \see setColorizeOn
Expand All @@ -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.
* colorizeOn() is set to true.
* \returns colorization color
* \see setColorizeColor
* \see colorizeOn
Expand All @@ -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.
* setColorizeOn() is set to true.
* \param colorizeStrength colorization strength, between 0 and 100
* \see colorizeStrength
* \see setColorizeOn
Expand All @@ -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.
* setColorizeOn() is set to true.
* \returns colorization strength, between 0 and 100
* \see setColorizeStrengths
* \see colorizeOn
Expand Down
12 changes: 6 additions & 6 deletions src/core/effects/qgsgloweffect.h
View file
Expand Up @@ -53,15 +53,15 @@ 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 setSpreadUnit()
* \see spread
* \see setSpreadUnit
* \see setSpreadMapUnitScale
*/
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 spreadUnit()
* \see setSpread
* \see spreadUnit
* \see spreadMapUnitScale
Expand Down Expand Up @@ -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 colorType()
* is set to SingleColor. The glow will fade between the specified color and
* a totally transparent version of the color.
* \param color glow color
Expand All @@ -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 colorType()
* is set to SingleColor. The glow will fade between the specified color and
* a totally transparent version of the color.
* \returns glow color
Expand All @@ -147,15 +147,15 @@ 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 colorType()
* 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
* \see setColorType
*/
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 colorType()
* is set to ColorRamp. The glow will utilize colors from the ramp.
* \returns color ramp for glow
* \see setRamp
Expand Down
20 changes: 10 additions & 10 deletions src/core/effects/qgspainteffect.h
View file
Expand Up @@ -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 render() 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 begin() 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 end()
* method. This will perform the paint effect on the intercepted drawing operations
* and render the result to the render context's paint device.
*
Expand Down Expand Up @@ -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.
* properties().
* \param doc destination DOM document
* \param element destination DOM element
* \returns true if save was successful
Expand All @@ -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
* end() 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
Expand Down Expand Up @@ -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 QgsEffectStack.
* \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 QgsEffectStack.
* \param drawMode draw mode for effect
* \see drawMode
*/
Expand Down Expand Up @@ -181,17 +181,17 @@ 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 draw() member can utilize this when
* drawing the effect.
* \returns source QPicture
* \see drawSource
* \see sourceAsImage
*/
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 draw() 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 boundingRect() method.
* The result is cached to speed up subsequent calls to sourceAsImage.
* \returns source QPicture rendered to an image
* \see drawSource
Expand Down
4 changes: 2 additions & 2 deletions src/core/effects/qgsshadoweffect.h
View file
Expand Up @@ -69,15 +69,15 @@ 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 setOffsetUnit()
* \see offsetDistance
* \see setOffsetUnit
* \see setOffsetMapUnitScale
*/
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 offsetUnit()
* \see setOffsetDistance
* \see offsetUnit
* \see offsetMapUnitScale
Expand Down
6 changes: 3 additions & 3 deletions src/core/geometry/qgsgeometry.h
View file
Expand Up @@ -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 QgsAbstractGeometry within the container, and
* can be accessed via the geometry() method or set using the setGeometry() method.
*/

class CORE_EXPORT QgsGeometry
Expand Down Expand Up @@ -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 geometry() ).
* \see geometry
* \since QGIS 2.10
* \see isEmpty()
Expand Down
2 changes: 1 addition & 1 deletion src/core/qgscacheindex.h
View file
Expand Up @@ -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 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.
Expand Down
4 changes: 2 additions & 2 deletions src/core/qgsdatetimestatisticalsummary.h
View file
Expand Up @@ -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 calculate() 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 setStatistics().
*
* \since QGIS 2.16
*/
Expand Down

0 comments on commit 266f182

Please sign in to comment.