Use "\since" instead of "@note added in"

qgis · Apr 2, 2017 · fb91ed7 · fb91ed7
1 parent 9c1861a
commit fb91ed7
Show file tree

Hide file tree

Showing 475 changed files with 2,202 additions and 2,202 deletions.
diff --git a/python/core/annotations/qgsannotationmanager.sip b/python/core/annotations/qgsannotationmanager.sip
@@ -13,7 +13,7 @@
 class QgsAnnotationManager : QObject
 {
 %Docstring
-.. versionadded:: 3.0
+ \since QGIS 3.0
 
  Manages storage of a set of QgsAnnotation annotation objects.
 

diff --git a/python/core/annotations/qgssvgannotation.sip b/python/core/annotations/qgssvgannotation.sip
@@ -13,7 +13,7 @@ class QgsSvgAnnotation: QgsAnnotation
 {
 %Docstring
  An annotation which renders the contents of an SVG file.
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
 %TypeHeaderCode

diff --git a/python/core/annotations/qgstextannotation.sip b/python/core/annotations/qgstextannotation.sip
@@ -13,7 +13,7 @@ class QgsTextAnnotation: QgsAnnotation
 {
 %Docstring
  An annotation item that displays formatted text from a QTextDocument document.
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
 %TypeHeaderCode

diff --git a/python/core/processing/qgsprocessingfeedback.sip b/python/core/processing/qgsprocessingfeedback.sip
@@ -17,7 +17,7 @@ class QgsProcessingFeedback : QgsFeedback
  This base class implementation silently ignores all feedback reported by algorithms.
  Subclasses of QgsProcessingFeedback can be used to log this feedback or report
  it to users via the GUI.
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
 %TypeHeaderCode

diff --git a/python/core/processing/qgsprocessingprovider.sip b/python/core/processing/qgsprocessingprovider.sip
@@ -15,7 +15,7 @@ class QgsProcessingProvider
  Abstract base class for processing providers. An algorithm provider is a set of
  related algorithms, typically from the same external application or related
  to a common area of analysis.
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
 %TypeHeaderCode

diff --git a/python/core/processing/qgsprocessingregistry.sip b/python/core/processing/qgsprocessingregistry.sip
@@ -17,7 +17,7 @@ class QgsProcessingRegistry : QObject
 
  QgsProcessingRegistry is not usually directly created, but rather accessed through
  QgsApplication::processingRegistry().
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
 %TypeHeaderCode

diff --git a/python/core/qgsaction.sip b/python/core/qgsaction.sip
@@ -71,14 +71,14 @@ The short title is used to label user interface elements like buttons
 %Docstring
  Returns a unique id for this action.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     bool isValid() const;
 %Docstring
  Returns true if this action was a default constructed one.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     QString iconPath() const;
@@ -97,7 +97,7 @@ The icon
  How the content is interpreted depends on the type() and
  the actionScope().
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     ActionType type() const;
@@ -119,14 +119,14 @@ Checks if the action is runable on the current platform
 %Docstring
  Run this action.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     void run( const QgsExpressionContext &expressionContext ) const;
 %Docstring
  Run this action.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     QSet<QString> actionScopes() const;
@@ -136,7 +136,7 @@ Checks if the action is runable on the current platform
  coordinate.
 
  @see QgsActionScope
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     void setActionScopes( const QSet<QString> &actionScopes );
@@ -145,23 +145,23 @@ Checks if the action is runable on the current platform
  Action scopes may offer additional variables like the clicked
  coordinate.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     void readXml( const QDomNode &actionNode );
 %Docstring
  Reads an XML definition from actionNode
  into this object.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     void writeXml( QDomNode &actionsNode ) const;
 %Docstring
  Appends an XML definition for this action as a new
  child node to actionsNode.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
 };

diff --git a/python/core/qgsactionmanager.sip b/python/core/qgsactionmanager.sip
@@ -51,7 +51,7 @@ Constructor
 %Docstring
  Remove an action by its id.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     void doAction( const QUuid &actionId, const QgsFeature &feature, int defaultValueIndex = 0 ) /PyName=doActionFeature/;
@@ -60,7 +60,7 @@ Constructor
   field to be used if the action has a $currfield placeholder.
 .. note::
 
-   available in python bindings as doActionFeature
+   available in Python bindings as doActionFeature
 %End
 
     void doAction( const QUuid &actionId, const QgsFeature &feature, const QgsExpressionContext &context );
@@ -82,7 +82,7 @@ Removes all actions
  Return a list of actions that are available in the given action scope.
  If no action scope is provided, all actions will be returned.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     QgsVectorLayer *layer() const;
@@ -104,23 +104,23 @@ Reads the actions in in XML format
 %Docstring
  Get an action by its id.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     void setDefaultAction( const QString &actionScope, const QUuid &actionId );
 %Docstring
  Each scope can have a default action. This will be saved in the project
  file.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     QgsAction defaultAction( const QString &actionScope );
 %Docstring
  Each scope can have a default action. This will be saved in the project
  file.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
 };

diff --git a/python/core/qgsactionscope.sip b/python/core/qgsactionscope.sip
@@ -29,7 +29,7 @@ class QgsActionScope
    <dd>Show in attribute table and work on the layer or selection.</dd>
  </dl>
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
 %TypeHeaderCode
@@ -41,7 +41,7 @@ class QgsActionScope
 %Docstring
  Creates a new invalid action scope.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     explicit QgsActionScope( const QString &id, const QString &title, const QString &description, const QgsExpressionContextScope &expressionContextScope = QgsExpressionContextScope() );
@@ -62,7 +62,7 @@ class QgsActionScope
  This can be an `field_name` for the attribute which was clicked or
  `clicked_x` and `clicked_y` for actions which are available as map canvas clicks.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     void setExpressionContextScope( const QgsExpressionContextScope &expressionContextScope );
@@ -74,7 +74,7 @@ class QgsActionScope
 %Docstring
  A unique identifier for this action scope.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     void setId( const QString &id );
@@ -87,7 +87,7 @@ class QgsActionScope
  The title is a human readable and translated string that will be
  presented to the user in the properties dialog.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
     void setTitle( const QString &title );
 %Docstring
@@ -100,7 +100,7 @@ class QgsActionScope
  are available. It is not necessary to list the available expression variables
  in here, they are extracted automatically from the expressionContextScope().
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
     void setDescription( const QString &description );
 %Docstring
@@ -111,7 +111,7 @@ class QgsActionScope
 %Docstring
  Returns if this scope is valid.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
 };

diff --git a/python/core/qgsactionscoperegistry.sip b/python/core/qgsactionscoperegistry.sip
@@ -21,7 +21,7 @@ class QgsActionScopeRegistry : QObject
  QgsApplication::actionScopeRegistry()
  ```
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
 %TypeHeaderCode
@@ -37,35 +37,35 @@ class QgsActionScopeRegistry : QObject
  want to use QgsApplication::actionScopeRegistry() to get access
  to that one instead.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     QSet<QgsActionScope> actionScopes() const;
 %Docstring
  Get all registered action scopes.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     void registerActionScope( const QgsActionScope &actionScope );
 %Docstring
  Register an additional action scope.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     void unregisterActionScope( const QgsActionScope &actionScope );
 %Docstring
  Unregister an additional action scope.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     QgsActionScope actionScope( const QString &id );
 %Docstring
  Get an action scope by its id.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
   signals:
@@ -75,7 +75,7 @@ class QgsActionScopeRegistry : QObject
  Emitted whenever a new action scope is registered or an action scope
  is unregistered.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
 };

diff --git a/python/core/qgsanimatedicon.sip b/python/core/qgsanimatedicon.sip
@@ -50,29 +50,29 @@ class QgsAnimatedIcon : QObject
  Connect to the frame changed signal with this method and not directly. This method
  makes sure the annimation is started.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     bool disconnectFrameChanged( const QObject *receiver, const char *method );
 %Docstring
  Convenience function to disconnect the same style that the frame change connection was established.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
 
     int width() const;
 %Docstring
  The native width of the icon.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     int height() const;
 %Docstring
  The native height of the icon.
 
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
   signals:

diff --git a/python/core/qgsclipper.sip b/python/core/qgsclipper.sip
@@ -58,7 +58,7 @@ class QgsClipper
 
 .. note::
 
-   not available in python bindings on android
+   not available in Python bindings on android
 %End
 
 %End

diff --git a/python/core/qgsconditionalstyle.sip b/python/core/qgsconditionalstyle.sip
@@ -32,7 +32,7 @@ class QgsConditionalLayerStyles
  Set the conditional styles that apply to full rows of data in the attribute table.
  Each row will check be checked against each rule.
  @param styles The styles to assign to all the rows
-.. versionadded:: 2.12
+ \since QGIS 2.12
 %End
 
     void setFieldStyles( const QString &fieldName, const QList<QgsConditionalStyle> &styles );

diff --git a/python/core/qgsfeature.sip b/python/core/qgsfeature.sip
@@ -182,7 +182,7 @@ class QgsFeature
  @link attributes @endlink method.
  @returns list of feature's attributes
  @see setAttributes
-.. versionadded:: 2.9
+ \since QGIS 2.9
 .. note::
 
    Alternatively in Python: iterate feature, eg. @code [attr for attr in feature] @endcode
@@ -280,7 +280,7 @@ class QgsFeature
 %Docstring
  Returns true if the feature has an associated geometry.
  @see geometry()
-.. versionadded:: 3.0.
+ \since QGIS 3.0.
 %End
 
     QgsGeometry geometry() const;
@@ -304,7 +304,7 @@ class QgsFeature
  Removes any geometry associated with the feature.
  @see setGeometry()
  @see hasGeometry()
-.. versionadded:: 3.0
+ \since QGIS 3.0
 %End
 
     void setFields( const QgsFields &fields, bool initAttributes = true  );
@@ -314,7 +314,7 @@ class QgsFeature
   @param initAttributes If true, attributes are initialized. Clears any data previously assigned.
                         C++: Defaults to false
                         Python: Defaults to true
-.. versionadded:: 2.9
+ \since QGIS 2.9
  @see fields
 %End