[sipify] seealso

qgis · Apr 30, 2017 · 28a2120 · 28a2120
1 parent 897e2f0
commit 28a2120
Show file tree

Hide file tree

Showing 71 changed files with 1,189 additions and 1,139 deletions.
diff --git a/python/auto_sip.blacklist b/python/auto_sip.blacklist
@@ -401,7 +401,6 @@ gui/qgstreewidgetitem.sip
 gui/qgsunitselectionwidget.sip
 gui/qgsuserinputdockwidget.sip
 gui/qgsvariableeditorwidget.sip
-gui/qgsvertexmarker.sip
 gui/attributetable/qgsattributetabledelegate.sip
 gui/attributetable/qgsattributetablefiltermodel.sip
 gui/attributetable/qgsattributetablemodel.sip

diff --git a/python/core/annotations/qgsannotationmanager.sip b/python/core/annotations/qgsannotationmanager.sip
@@ -42,8 +42,8 @@ class QgsAnnotationManager : QObject
 %Docstring
  Adds an annotation to the manager. Ownership of the annotation is transferred to the manager.
  Returns true if the addition was successful, or false if the annotation could not be added.
- \see removeAnnotation()
- \see annotationAdded()
+.. seealso:: removeAnnotation()
+.. seealso:: annotationAdded()
  :rtype: bool
 %End
 
@@ -52,23 +52,23 @@ class QgsAnnotationManager : QObject
  Removes an annotation from the manager. The annotation is deleted.
  Returns true if the removal was successful, or false if the removal failed (eg as a result
  of removing an annotation which is not contained in the manager).
- \see addAnnotation()
- \see compositionRemoved()
- \see compositionAboutToBeRemoved()
- \see clear()
+.. seealso:: addAnnotation()
+.. seealso:: compositionRemoved()
+.. seealso:: compositionAboutToBeRemoved()
+.. seealso:: clear()
  :rtype: bool
 %End
 
     void clear();
 %Docstring
  Removes and deletes all annotations from the manager.
- \see removeAnnotation()
+.. seealso:: removeAnnotation()
 %End
 
     QList< QgsAnnotation * > annotations() const;
 %Docstring
  Returns a list of all annotations contained in the manager.
- \see cloneAnnotations()
+.. seealso:: cloneAnnotations()
  :rtype: list of QgsAnnotation
 %End
 
@@ -77,22 +77,22 @@ class QgsAnnotationManager : QObject
  Returns a list containing clones of all annotations contained
  in the manager. The caller takes responsibility for deleting
  all returned annotations.
- \see annotations()
+.. seealso:: annotations()
  :rtype: list of QgsAnnotation
 %End
 
     bool readXml( const QDomElement &element, const QDomDocument &doc );
 %Docstring
  Reads the manager's state from a DOM element, restoring all annotations
  present in the XML document.
- \see writeXml()
+.. seealso:: writeXml()
  :rtype: bool
 %End
 
     QDomElement writeXml( QDomDocument &doc ) const;
 %Docstring
  Returns a DOM element representing the state of the manager.
- \see readXml()
+.. seealso:: readXml()
  :rtype: QDomElement
 %End
 

diff --git a/python/core/annotations/qgshtmlannotation.sip b/python/core/annotations/qgshtmlannotation.sip
@@ -40,13 +40,13 @@ class QgsHtmlAnnotation: QgsAnnotation
     void setSourceFile( const QString &htmlFile );
 %Docstring
  Sets the file path for the source HTML file.
- \see sourceFile()
+.. seealso:: sourceFile()
 %End
 
     QString sourceFile() const;
 %Docstring
  Returns the file path for the source HTML file.
- \see setSourceFile()
+.. seealso:: setSourceFile()
  :rtype: str
 %End
 

diff --git a/python/core/annotations/qgssvgannotation.sip b/python/core/annotations/qgssvgannotation.sip
@@ -35,13 +35,13 @@ class QgsSvgAnnotation: QgsAnnotation
     void setFilePath( const QString &file );
 %Docstring
  Sets the file path for the source SVG file.
- \see filePath()
+.. seealso:: filePath()
 %End
 
     QString filePath() const;
 %Docstring
  Returns the file path for the source SVG file.
- \see setFilePath()
+.. seealso:: setFilePath()
  :rtype: str
 %End
 

diff --git a/python/core/annotations/qgstextannotation.sip b/python/core/annotations/qgstextannotation.sip
@@ -33,15 +33,15 @@ class QgsTextAnnotation: QgsAnnotation
 %Docstring
  Returns the text document which will be rendered
  within the annotation.
- \see setDocument()
+.. seealso:: setDocument()
  :rtype: QTextDocument
 %End
 
     void setDocument( const QTextDocument *doc );
 %Docstring
  Sets the text document which will be rendered
  within the annotation. Ownership is not transferred.
- \see document()
+.. seealso:: document()
 %End
 
     virtual void writeXml( QDomElement &elem, QDomDocument &doc ) const;

diff --git a/python/core/geometry/qgsabstractgeometry.sip b/python/core/geometry/qgsabstractgeometry.sip
@@ -95,38 +95,38 @@ class QgsAbstractGeometry
     virtual QString geometryType() const = 0;
 %Docstring
  Returns a unique string representing the geometry type.
- \see wkbType
- \see wktTypeStr
+.. seealso:: wkbType
+.. seealso:: wktTypeStr
  :rtype: str
 %End
 
     QgsWkbTypes::Type wkbType() const;
 %Docstring
  Returns the WKB type of the geometry.
- \see geometryType
- \see wktTypeStr
+.. seealso:: geometryType
+.. seealso:: wktTypeStr
  :rtype: QgsWkbTypes.Type
 %End
 
     QString wktTypeStr() const;
 %Docstring
  Returns the WKT type string of the geometry.
- \see geometryType
- \see wkbType
+.. seealso:: geometryType
+.. seealso:: wkbType
  :rtype: str
 %End
 
     bool is3D() const;
 %Docstring
  Returns true if the geometry is 3D and contains a z-value.
- \see isMeasure
+.. seealso:: isMeasure
  :rtype: bool
 %End
 
     bool isMeasure() const;
 %Docstring
  Returns true if the geometry contains m values.
- \see is3D
+.. seealso:: is3D
  :rtype: bool
 %End
 
@@ -145,25 +145,25 @@ class QgsAbstractGeometry
 %Docstring
  Sets the geometry from a WKB string.
  After successful read the wkb argument will be at the position where the reading has stopped.
- \see fromWkt
+.. seealso:: fromWkt
  :rtype: bool
 %End
 
     virtual bool fromWkt( const QString &wkt ) = 0;
 %Docstring
  Sets the geometry from a WKT string.
- \see fromWkb
+.. seealso:: fromWkb
  :rtype: bool
 %End
 
 
     virtual QByteArray asWkb() const = 0;
 %Docstring
  Returns a WKB representation of the geometry.
- \see asWkt
- \see asGML2
- \see asGML3
- \see asJSON
+.. seealso:: asWkt
+.. seealso:: asGML2
+.. seealso:: asGML3
+.. seealso:: asJSON
 .. versionadded:: 3.0
  :rtype: QByteArray
 %End
@@ -172,10 +172,10 @@ class QgsAbstractGeometry
 %Docstring
  Returns a WKT representation of the geometry.
  \param precision number of decimal places for coordinates
- \see asWkb
- \see asGML2
- \see asGML3
- \see asJSON
+.. seealso:: asWkb
+.. seealso:: asGML2
+.. seealso:: asGML3
+.. seealso:: asJSON
  :rtype: str
 %End
 
@@ -185,10 +185,10 @@ class QgsAbstractGeometry
  \param doc DOM document
  \param precision number of decimal places for coordinates
  \param ns XML namespace
- \see asWkb
- \see asWkt
- \see asGML3
- \see asJSON
+.. seealso:: asWkb
+.. seealso:: asWkt
+.. seealso:: asGML3
+.. seealso:: asJSON
  :rtype: QDomElement
 %End
 
@@ -198,21 +198,21 @@ class QgsAbstractGeometry
  \param doc DOM document
  \param precision number of decimal places for coordinates
  \param ns XML namespace
- \see asWkb
- \see asWkt
- \see asGML2
- \see asJSON
+.. seealso:: asWkb
+.. seealso:: asWkt
+.. seealso:: asGML2
+.. seealso:: asJSON
  :rtype: QDomElement
 %End
 
     virtual QString asJSON( int precision = 17 ) const = 0;
 %Docstring
  Returns a GeoJSON representation of the geometry.
  \param precision number of decimal places for coordinates
- \see asWkb
- \see asWkt
- \see asGML2
- \see asGML3
+.. seealso:: asWkb
+.. seealso:: asWkt
+.. seealso:: asGML2
+.. seealso:: asGML3
  :rtype: str
 %End
 
@@ -295,8 +295,8 @@ class QgsAbstractGeometry
  \param position vertex id for position of inserted vertex
  \param vertex vertex to insert
  :return: true if insert was successful
- \see moveVertex
- \see deleteVertex
+.. seealso:: moveVertex
+.. seealso:: deleteVertex
  :rtype: bool
 %End
 
@@ -306,8 +306,8 @@ class QgsAbstractGeometry
  \param position vertex id for vertex to move
  \param newPos new position of vertex
  :return: true if move was successful
- \see insertVertex
- \see deleteVertex
+.. seealso:: insertVertex
+.. seealso:: deleteVertex
  :rtype: bool
 %End
 
@@ -316,32 +316,32 @@ class QgsAbstractGeometry
  Deletes a vertex within the geometry
  \param position vertex id for vertex to delete
  :return: true if delete was successful
- \see insertVertex
- \see moveVertex
+.. seealso:: insertVertex
+.. seealso:: moveVertex
  :rtype: bool
 %End
 
     virtual double length() const;
 %Docstring
  Returns the length of the geometry.
- \see area()
- \see perimeter()
+.. seealso:: area()
+.. seealso:: perimeter()
  :rtype: float
 %End
 
     virtual double perimeter() const;
 %Docstring
  Returns the perimeter of the geometry.
- \see area()
- \see length()
+.. seealso:: area()
+.. seealso:: length()
  :rtype: float
 %End
 
     virtual double area() const;
 %Docstring
  Returns the area of the geometry.
- \see length()
- \see perimeter()
+.. seealso:: length()
+.. seealso:: perimeter()
  :rtype: float
 %End
 
@@ -406,8 +406,8 @@ QgsMultiLineString -> QgsMultiCurve, QgsMultiPolygonV2 -> QgsMultiSurface
     virtual int partCount() const = 0;
 %Docstring
  Returns count of parts contained in the geometry.
- \see vertexCount
- \see ringCount
+.. seealso:: vertexCount
+.. seealso:: ringCount
  :rtype: int
 %End
 
@@ -417,8 +417,8 @@ QgsMultiLineString -> QgsMultiCurve, QgsMultiPolygonV2 -> QgsMultiSurface
  \param zValue initial z-value for all nodes
  :return: true on success
 .. versionadded:: 2.12
- \see dropZValue()
- \see addMValue()
+.. seealso:: dropZValue()
+.. seealso:: addMValue()
  :rtype: bool
 %End
 
@@ -428,17 +428,17 @@ QgsMultiLineString -> QgsMultiCurve, QgsMultiPolygonV2 -> QgsMultiSurface
  \param mValue initial m-value for all nodes
  :return: true on success
 .. versionadded:: 2.12
- \see dropMValue()
- \see addZValue()
+.. seealso:: dropMValue()
+.. seealso:: addZValue()
  :rtype: bool
 %End
 
     virtual bool dropZValue() = 0;
 %Docstring
  Drops any z-dimensions which exist in the geometry.
  :return: true if Z values were present and have been removed
- \see addZValue()
- \see dropMValue()
+.. seealso:: addZValue()
+.. seealso:: dropMValue()
 .. versionadded:: 2.14
  :rtype: bool
 %End
@@ -447,8 +447,8 @@ QgsMultiLineString -> QgsMultiCurve, QgsMultiPolygonV2 -> QgsMultiSurface
 %Docstring
  Drops any measure values which exist in the geometry.
  :return: true if m-values were present and have been removed
- \see addMValue()
- \see dropZValue()
+.. seealso:: addMValue()
+.. seealso:: dropZValue()
 .. versionadded:: 2.14
  :rtype: bool
 %End