Skip to content

Commit

Permalink
fix 3.0 version attribution
Browse files Browse the repository at this point in the history
  • Loading branch information
jef-n committed Sep 14, 2016
1 parent 3d514db commit 0cfeef0
Show file tree
Hide file tree
Showing 43 changed files with 96 additions and 95 deletions.
4 changes: 2 additions & 2 deletions python/core/composer/qgscomposerlegend.sip
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,13 @@ class QgsComposerLegend : QgsComposerItem
* @param enabled set to false to disable automatic resizing. The legend frame will not
* be expanded to fit legend items, and items may be cropped from display.
* @see resizeToContents()
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
void setResizeToContents( bool enabled );

/** Returns whether the legend should automatically resize to fit its contents.
* @see setResizeToContents()
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
bool resizeToContents() const;

Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgscomposition.sip
Original file line number Diff line number Diff line change
Expand Up @@ -902,7 +902,7 @@ class QgsComposition : QGraphicsScene
void statusMsgChanged( QString message );

/** Emitted whenever the expression variables stored in the composition have been changed.
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
void variablesChanged();
};
2 changes: 1 addition & 1 deletion python/core/geometry/qgsabstractgeometryv2.sip
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ class QgsAbstractGeometryV2
/** Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry).
* For instance, a polygon geometry will have a boundary consisting of the linestrings for each ring in the polygon.
* @returns boundary for geometry. May be null for some geometry types.
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
virtual QgsAbstractGeometryV2* boundary() const = 0;

Expand Down
9 changes: 5 additions & 4 deletions python/core/geometry/qgsgeometry.sip
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ class QgsGeometry
* Returns the bisector angle for this geometry at the specified vertex.
* @param vertex vertex index to calculate bisector angle at
* @returns bisector angle, in radians clockwise from north
* @note added in QGIS 3.0
* @note added in QGIS 2.18
* @see interpolateAngle()
*/
double angleAtVertex( int vertex ) const;
Expand Down Expand Up @@ -482,6 +482,7 @@ class QgsGeometry
/**
* Return interpolated point on line at distance
* @note added in 1.9
* @see lineLocatePoint()
*/
QgsGeometry* interpolate( double distance ) /Factory/;

Expand All @@ -493,7 +494,7 @@ class QgsGeometry
* @return distance along line, or -1 on error
* @note only valid for linestring geometries
* @see interpolate()
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
double lineLocatePoint( const QgsGeometry& point ) const;

Expand All @@ -502,7 +503,7 @@ class QgsGeometry
* If the distance coincides precisely at a node then the average angle from the segment either side
* of the node is returned.
* @param distance distance along geometry
* @note added in QGIS 3.0
* @note added in QGIS 2.18
* @see angleAtVertex()
*/
double interpolateAngle( double distance ) const;
Expand All @@ -521,7 +522,7 @@ class QgsGeometry
* @returns a LineString or MultiLineString geometry, with any connected lines
* joined. An empty geometry will be returned if the input geometry was not a
* MultiLineString geometry.
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
QgsGeometry mergeLines() const;

Expand Down
2 changes: 1 addition & 1 deletion python/core/qgsannotation.sip
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/** \ingroup core
* \class QgsAnnotation
* \note added in QGIS 3.0
* \note added in QGIS 2.18
*
* \brief An interface for annotation items which are drawn over a map.
*
Expand Down
4 changes: 2 additions & 2 deletions python/core/qgsapplication.sip
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ static void qtgui_UpdatePyArgv(PyObject *argvlist, int argc, char **argv)
* be called whenever global, application-wide settings are altered to advise listeners
* that they may need to update their state.
* @see settingsChanged()
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
void emitSettingsChanged();

Expand All @@ -394,7 +394,7 @@ static void qtgui_UpdatePyArgv(PyObject *argvlist, int argc, char **argv)
// void preNotify( QObject * receiver, QEvent * event, bool * done );

/** Emitted whenever any global, application-wide settings are changed.
* @note added in QGIS 3.0
* @note added in QGIS 2.18
* @see emitSettingsChanged()
*/
void settingsChanged();
Expand Down
2 changes: 1 addition & 1 deletion python/core/qgscolorscheme.sip
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ class QgsUserColorScheme : QgsGplColorScheme

/** Sets whether a this scheme should be shown in color button menus.
* @param show set to true to show in color button menus, or false to hide from menus
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
void setShowSchemeInMenu( bool show );

Expand Down
2 changes: 1 addition & 1 deletion python/core/qgsexpressioncontext.sip
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ class QgsExpressionContext
/** Returns the index of the first scope with a matching name within the context.
* @param scopeName name of scope to find
* @returns index of scope, or -1 if scope was not found within the context.
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
int indexOfScope( const QString& scopeName ) const;

Expand Down
10 changes: 5 additions & 5 deletions python/core/qgsfield.sip
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ class QgsField
* field alias if set, otherwise the field name.
* @see name()
* @see alias()
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
QString displayName() const;

Expand Down Expand Up @@ -129,30 +129,30 @@ class QgsField
/** Returns the expression used when calculating the default value for the field.
* @returns expression evaluated when calculating default values for field, or an
* empty string if no default is set
* @note added in QGIS 3.0
* @note added in QGIS 2.18
* @see setDefaultValueExpression()
*/
QString defaultValueExpression() const;

/** Sets an expression to use when calculating the default value for the field.
* @param expression expression to evaluate when calculating default values for field. Pass
* an empty expression to clear the default.
* @note added in QGIS 3.0
* @note added in QGIS 2.18
* @see defaultValueExpression()
*/
void setDefaultValueExpression( const QString& expression );

/** Returns the alias for the field (the friendly displayed name of the field ),
* or an empty string if there is no alias.
* @see setAlias()
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
QString alias() const;

/** Sets the alias for the field (the friendly displayed name of the field ).
* @param alias field alias, or empty string to remove an existing alias
* @see alias()
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
void setAlias( const QString& alias );

Expand Down
12 changes: 6 additions & 6 deletions python/core/qgsoptionalexpression.sip
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
*
* QgsOptionalExpression is a container for an expression with an additional enabled/disabled flag.
*
* @note Added in QGIS 3.0
* @note Added in QGIS 2.18
*/
class QgsOptionalExpression
{
Expand Down Expand Up @@ -48,36 +48,36 @@ class QgsOptionalExpression
* This will compare the enabled flag and call the == operator
* of the contained class.
*
* @note Added in QGIS 3.0
* @note Added in QGIS 2.18
*/
bool operator== ( const QgsOptionalExpression& other ) const;
operator bool () const;

/**
* Check if this optional is enabled
*
* @note Added in QGIS 3.0
* @note Added in QGIS 2.18
*/
bool enabled() const;

/**
* Set if this optional is enabled
*
* @note Added in QGIS 3.0
* @note Added in QGIS 2.18
*/
void setEnabled( bool enabled );

/**
* Access the payload data
*
* @note Added in QGIS 3.0
* @note Added in QGIS 2.18
*/
QgsExpression data() const;

/**
* Set the payload data
*
* @note Added in QGIS 3.0
* @note Added in QGIS 2.18
*/
void setData( const QgsExpression& data );

Expand Down
4 changes: 2 additions & 2 deletions python/core/qgsproject.sip
Original file line number Diff line number Diff line change
Expand Up @@ -398,7 +398,7 @@ class QgsProject : QObject
void homePathChanged();

/** Emitted whenever the expression variables stored in the project have been changed.
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
void variablesChanged();

Expand All @@ -416,7 +416,7 @@ class QgsProject : QObject
/** Causes the project to emit the variablesChanged() signal. This should
* be called whenever expression variables related to the project are changed.
* @see variablesChanged()
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
void emitVariablesChanged();

Expand Down
4 changes: 2 additions & 2 deletions python/core/qgsstringutils.sip
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ class QgsStringUtils
* @param string input string
* @param capitalization capitalization type to apply
* @return capitalized string
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
static QString capitalize( const QString& string, Capitalization capitalization );

Expand Down Expand Up @@ -183,7 +183,7 @@ class QgsStringUtils
* @param string string to insert links into
* @param foundLinks if specified, will be set to true if any links were inserted into the string
* @returns string with inserted links
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
static QString insertLinks( const QString& string, bool* foundLinks = nullptr );
};
6 changes: 3 additions & 3 deletions python/core/qgsvectorlayer.sip
Original file line number Diff line number Diff line change
Expand Up @@ -1327,7 +1327,7 @@ class QgsVectorLayer : QgsMapLayer
* @param context optional expression context to evaluate expressions again. If not
* specified, a default context will be created
* @return calculated default value
* @note added in QGIS 3.0
* @note added in QGIS 2.18
* @see setDefaultValueExpression()
*/
QVariant defaultValue( int index, const QgsFeature& feature = QgsFeature(),
Expand All @@ -1337,7 +1337,7 @@ class QgsVectorLayer : QgsMapLayer
* @param index field index
* @param expression expression to evaluate when calculating default values for field. Pass
* an empty expression to clear the default.
* @note added in QGIS 3.0
* @note added in QGIS 2.18
* @see defaultValue()
* @see defaultValueExpression()
*/
Expand All @@ -1347,7 +1347,7 @@ class QgsVectorLayer : QgsMapLayer
* @param index field index
* @returns expression evaluated when calculating default values for field, or an
* empty string if no default is set
* @note added in QGIS 3.0
* @note added in QGIS 2.18
* @see defaultValue()
* @see setDefaultValueExpression()
*/
Expand Down
2 changes: 1 addition & 1 deletion python/gui/editorwidgets/core/qgseditorconfigwidget.sip
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ class QgsEditorConfigWidget : QWidget
signals:

/** Emitted when the configuration of the widget is changed.
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
void changed();
};
Expand Down
2 changes: 1 addition & 1 deletion python/gui/qgscolorschemelist.sip
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ class QgsColorSchemeList: QTreeView
bool isDirty() const;

/** Returns the scheme currently selected in the list.
* @note added in QGIS 3.0
* @note added in QGIS 2.18
* @see setScheme()
*/
QgsColorScheme* scheme();
Expand Down
2 changes: 1 addition & 1 deletion python/gui/qgsexpressionlineedit.sip
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* use in an expression. In contexts where the expression is directly associated with
* a layer and fields can be used, then QgsFieldExpressionWidget is a more appropriate
* choice as it gives users direct access to select fields from a drop down list.
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/

class QgsExpressionLineEdit : QWidget
Expand Down
14 changes: 7 additions & 7 deletions python/gui/qgsfilterlineedit.sip
Original file line number Diff line number Diff line change
Expand Up @@ -29,28 +29,28 @@ class QgsFilterLineEdit : QLineEdit

/** Returns true if the widget's clear button is visible.
* @see setShowClearButton()
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
bool showClearButton() const;

/** Sets whether the widget's clear button is visible.
* @param visible set to false to hide the clear button
* @see showClearButton()
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
void setShowClearButton( bool visible );

/** Returns the clear mode for the widget. The clear mode defines the behaviour of the
* widget when its value is cleared. This defaults to ClearToNull.
* @see setClearMode()
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
ClearMode clearMode() const;

/** Sets the clear mode for the widget. The clear mode defines the behaviour of the
* widget when its value is cleared. This defaults to ClearToNull.
* @see clearMode()
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
void setClearMode( ClearMode mode );

Expand All @@ -74,7 +74,7 @@ class QgsFilterLineEdit : QLineEdit
* @param defaultValue default value
* @see defaultValue()
* @see clearMode()
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
void setDefaultValue( const QString& defaultValue );

Expand All @@ -83,7 +83,7 @@ class QgsFilterLineEdit : QLineEdit
* is equal to ClearToDefault.
* @see setDefaultValue()
* @see clearMode()
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
QString defaultValue() const;

Expand Down Expand Up @@ -118,7 +118,7 @@ class QgsFilterLineEdit : QLineEdit

/** Clears the widget and resets it to the null value.
* @see nullValue()
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
virtual void clearValue();

Expand Down
2 changes: 1 addition & 1 deletion python/gui/qgspanelwidget.sip
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ class QgsPanelWidget : public QWidget
* widget.
* @param widget widget which may be contained within a panel widget
* @returns parent panel widget if found, otherwise nullptr
* @note added in QGIS 3.0
* @note added in QGIS 2.18
*/
static QgsPanelWidget* findParentPanel( QWidget* widget );

Expand Down
2 changes: 1 addition & 1 deletion src/app/qgssubstitutionlistwidget.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
* \ingroup app
* A widget which allows users to specify a list of substitutions to apply to a string, with
* options for exporting and importing substitution lists.
* \note added in QGIS 3.0
* \note added in QGIS 2.18
* \see QgsSubstitutionListDialog
*/
class APP_EXPORT QgsSubstitutionListWidget : public QgsPanelWidget, private Ui::QgsSubstitutionListWidgetBase
Expand Down
Loading

0 comments on commit 0cfeef0

Please sign in to comment.