Skip to content
Permalink
Browse files
"Introduced in..." -> "\since"
  • Loading branch information
nyalldawson committed Apr 3, 2017
1 parent 0326f71 commit 9a4f2e412b227c5c11a95832609e9f8f881d2e8f
@@ -28,7 +28,7 @@ class QgsMapCanvas;
/** \ingroup app
* \class QgsSelectByFormDialog
* A dialog for selecting features from a layer, using a form based off the layer's editor widgets.
* \note introduced in QGIS 2.16
* \since QGIS 2.16
*/

class APP_EXPORT QgsSelectByFormDialog : public QDialog
@@ -244,7 +244,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec

/** Sets frame stroke color
* @param color new color for stroke frame
* \note introduced in 2.6
* \since QGIS 2.6
* @see frameStrokeColor
* @see setFrameEnabled
* @see setFrameJoinStyle
@@ -254,7 +254,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec

/** Returns the frame's stroke color. Only used if hasFrame is true.
* @returns frame stroke color
* \note introduced in 2.6
* \since QGIS 2.6
* @see hasFrame
* @see setFrameStrokeColor
* @see frameJoinStyle
@@ -264,7 +264,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec

/** Sets frame stroke width
* @param strokeWidth new width for stroke frame
* \note introduced in 2.2
* \since QGIS 2.2
* @see frameStrokeWidth
* @see setFrameEnabled
* @see setFrameJoinStyle
@@ -274,7 +274,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec

/** Returns the frame's stroke width. Only used if hasFrame is true.
* @returns Frame stroke width
* \note introduced in 2.3
* \since QGIS 2.3
* @see hasFrame
* @see setFrameStrokeWidth
* @see frameJoinStyle
@@ -284,7 +284,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec

/** Returns the join style used for drawing the item's frame
* @returns Join style for stroke frame
* \note introduced in 2.3
* \since QGIS 2.3
* @see hasFrame
* @see setFrameJoinStyle
* @see frameStrokeWidth
@@ -294,7 +294,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec

/** Sets join style used when drawing the item's frame
* @param style Join style for stroke frame
* \note introduced in 2.3
* \since QGIS 2.3
* @see setFrameEnabled
* @see frameJoinStyle
* @see setFrameStrokeWidth
@@ -306,7 +306,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* actual rectangle. For instance, if the item has a 2mm frame stroke, then
* 1mm of this frame is drawn outside the item's rect. In this case the
* return value will be 1.0
* \note introduced in 2.2
* \since QGIS 2.2
* @see rectWithFrame
*/
virtual double estimatedFrameBleed() const;
@@ -316,7 +316,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* more details about QGraphicsItem coordinate systems). The results differ from Qt's rect()
* function, as rect() makes no allowances for the portion of outlines which are drawn
* outside of the item.
* \note introduced in 2.2
* \since QGIS 2.2
* @see estimatedFrameBleed
*/
virtual QRectF rectWithFrame() const;
@@ -699,12 +699,12 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
void sizeChanged();

/** Emitted if the item's frame style changes
* \note: this function was introduced in version 2.2
* \since QGIS 2.2
*/
void frameChanged();

/** Emitted if the item's lock status changes
* \note: this function was introduced in version 2.5
* \since QGIS 2.5
*/
void lockChanged();

@@ -305,29 +305,29 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
* are drawn over the map's contents.
* @returns pointer to grid stack
* @see grid()
* \note introduced in QGIS 2.5
* \since QGIS 2.5
*/
QgsComposerMapGridStack *grids() { return mGridStack; }

/** Returns the map item's first grid. This is a convenience function.
* @returns pointer to first grid for map item
* @see grids()
* \note introduced in QGIS 2.5
* \since QGIS 2.5
*/
QgsComposerMapGrid *grid();

/** Returns the map item's overview stack, which is used to control how overviews
* are drawn over the map's contents.
* @returns pointer to overview stack
* @see overview()
* \note introduced in QGIS 2.5
* \since QGIS 2.5
*/
QgsComposerMapOverviewStack *overviews() { return mOverviewStack; }

/** Returns the map item's first overview. This is a convenience function.
* @returns pointer to first overview for map item
* @see overviews()
* \note introduced in QGIS 2.5
* \since QGIS 2.5
*/
QgsComposerMapOverview *overview();

@@ -259,30 +259,30 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem

/** Returns the join style used for drawing lines in the scalebar
* @returns Join style for lines
* \note introduced in 2.3
* \since QGIS 2.3
* @see setLineJoinStyle
*/
Qt::PenJoinStyle lineJoinStyle() const { return mLineJoinStyle; }

/** Sets join style used when drawing the lines in the scalebar
* @param style Join style for lines
* @returns nothing
* \note introduced in 2.3
* \since QGIS 2.3
* @see lineJoinStyle
*/
void setLineJoinStyle( Qt::PenJoinStyle style );

/** Returns the cap style used for drawing lines in the scalebar
* @returns Cap style for lines
* \note introduced in 2.3
* \since QGIS 2.3
* @see setLineCapStyle
*/
Qt::PenCapStyle lineCapStyle() const { return mLineCapStyle; }

/** Sets cap style used when drawing the lines in the scalebar
* @param style Cap style for lines
* @returns nothing
* \note introduced in 2.3
* \since QGIS 2.3
* @see lineCapStyle
*/
void setLineCapStyle( Qt::PenCapStyle style );
@@ -409,7 +409,7 @@ class CORE_EXPORT QgsMapLayer : public QObject
virtual QgsError error() const { return mError; }

/** Returns the layer's spatial reference system.
\note This was introduced in QGIS 1.4
\since QGIS 1.4
*/
QgsCoordinateReferenceSystem crs() const;

@@ -24,7 +24,7 @@ class QgsMapLayer;
/** \ingroup gui
* \class QgsLayerTreeEmbeddedConfigWidget
* A widget to configure layer tree embedded widgets for a particular map layer.
* \note introduced in QGIS 2.16
* \since QGIS 2.16
*/
class GUI_EXPORT QgsLayerTreeEmbeddedConfigWidget : public QWidget, protected Ui::QgsLayerTreeEmbeddedConfigWidget
{
@@ -28,7 +28,7 @@ class QgsMapLayer;
* Provider interface to be implemented in order to introduce new kinds of embedded widgets for use in layer tree.
* Embedded widgets are assigned per individual map layers and they are shown before any legend entries.
* @see QgsLayerTreeEmbeddedWidgetRegistry
* \note introduced in QGIS 2.16
* \since QGIS 2.16
*/
class GUI_EXPORT QgsLayerTreeEmbeddedWidgetProvider
{
@@ -57,7 +57,7 @@ class GUI_EXPORT QgsLayerTreeEmbeddedWidgetProvider
* Layer tree must have UseEmbeddedWidgets flag enabled in order to show assigned widgets.
*
* @see QgsLayerTreeEmbeddedWidgetRegistry
* \note introduced in QGIS 2.16
* \since QGIS 2.16
*/
class GUI_EXPORT QgsLayerTreeEmbeddedWidgetRegistry
{
@@ -29,7 +29,7 @@ class QgsPanelWidget;
* \class QgsColorSwatchDelegate
* A delegate for showing a color swatch in a list
* @see QgsColorSchemeList
* \note introduced in QGIS 2.5
* \since QGIS 2.5
*/
class GUI_EXPORT QgsColorSwatchDelegate : public QAbstractItemDelegate
{
@@ -59,7 +59,7 @@ class GUI_EXPORT QgsColorSwatchDelegate : public QAbstractItemDelegate
* \class QgsColorSchemeModel
* A model for colors in a color scheme
* @see QgsColorSchemeList
* \note introduced in QGIS 2.5
* \since QGIS 2.5
*/
class GUI_EXPORT QgsColorSchemeModel: public QAbstractItemModel
{
@@ -146,7 +146,7 @@ class GUI_EXPORT QgsColorSchemeModel: public QAbstractItemModel
* \class QgsColorSchemeList
* An editable list of color swatches, taken from an associated QgsColorScheme.
* @see QgsColorSchemeList
* \note introduced in QGIS 2.5
* \since QGIS 2.5
*/
class GUI_EXPORT QgsColorSchemeList: public QTreeView
{
@@ -25,7 +25,7 @@
* A grid of color swatches, which allows for user selection. Colors are taken from an
* associated QgsColorScheme.
* @see QgsColorGridAction
* \note introduced in QGIS 2.5
* \since QGIS 2.5
*/
class GUI_EXPORT QgsColorSwatchGrid : public QWidget
{
@@ -151,7 +151,7 @@ class GUI_EXPORT QgsColorSwatchGrid : public QWidget
* \class QgsColorSwatchGridAction
* A color swatch grid which can be embedded into a menu.
* @see QgsColorSwatchGrid
* \note introduced in QGIS 2.5
* \since QGIS 2.5
*/

class GUI_EXPORT QgsColorSwatchGridAction: public QWidgetAction
@@ -186,7 +186,7 @@ class GUI_EXPORT QgsColorWidget : public QWidget
* \class QgsColorWidgetAction
* An action containing a color widget, which can be embedded into a menu.
* @see QgsColorWidget
* \note introduced in QGIS 2.14
* \since QGIS 2.14
*/

class GUI_EXPORT QgsColorWidgetAction: public QWidgetAction

0 comments on commit 9a4f2e4

Please sign in to comment.