Navigation Menu

Skip to content

Commit

Permalink
[sipify] fix bad handling of \see within sentences
Browse files Browse the repository at this point in the history 
and other docstrings improvements
  • Loading branch information
@3nids
3nids committed Jan 10, 2018
1 parent 0a3f9f6 commit d87c605
Show file tree
Hide file tree
Showing 312 changed files with 4,438 additions and 4,437 deletions.
4 changes: 2 additions & 2 deletions python/analysis/interpolation/qgsidwinterpolator.sip
View file
Expand Up @@ -35,7 +35,7 @@ weighted with distance. Smaller values mean sharper peaks at the data points.

Point values are weighted by 1 / ( distance ^ coefficient ).

.. seealso:: :py:func:`distanceCoefficient()`
.. seealso:: :py:func:`distanceCoefficient`

.. versionadded:: 3.0
%End
Expand All @@ -48,7 +48,7 @@ The default is a coefficient of 2.

Point values are weighted by 1 / ( distance ^ coefficient ).

.. seealso:: :py:func:`setDistanceCoefficient()`
.. seealso:: :py:func:`setDistanceCoefficient`

.. versionadded:: 3.0
%End
Expand Down
4 changes: 2 additions & 2 deletions python/analysis/interpolation/qgstininterpolator.sip
View file
Expand Up @@ -46,7 +46,7 @@ Returns the fields output by features when saving the triangulation.
These fields should be used when creating
a suitable feature sink for setTriangulationSink()

.. seealso:: :py:func:`setTriangulationSink()`
.. seealso:: :py:func:`setTriangulationSink`

.. versionadded:: 3.0
%End
Expand All @@ -58,7 +58,7 @@ Sets the optional ``sink`` for saving the triangulation features.
The sink must be setup to accept LineString features, with fields matching
those returned by triangulationFields().

.. seealso:: :py:func:`triangulationFields()`
.. seealso:: :py:func:`triangulationFields`

.. versionadded:: 3.0
%End
Expand Down
8 changes: 4 additions & 4 deletions python/analysis/network/qgsgraph.sip
View file
Expand Up @@ -45,14 +45,14 @@ Returns array of available strategies
%Docstring
Returns the index of the vertex at the end of this edge.

.. seealso:: :py:func:`fromVertex()`
.. seealso:: :py:func:`fromVertex`
%End

int fromVertex() const;
%Docstring
Returns the index of the vertex at the start of this edge.

.. seealso:: :py:func:`toVertex()`
.. seealso:: :py:func:`toVertex`
%End

};
Expand Down Expand Up @@ -88,14 +88,14 @@ This constructor initializes QgsGraphVertex object and associates a vertex with
%Docstring
Returns the incoming edge ids, i.e. edges which end at this node.

.. seealso:: :py:func:`outgoingEdges()`
.. seealso:: :py:func:`outgoingEdges`
%End

QgsGraphEdgeIds outgoingEdges() const;
%Docstring
Returns outgoing edge ids, i.e. edges which start at this node.

.. seealso:: :py:func:`incomingEdges()`
.. seealso:: :py:func:`incomingEdges`
%End

QgsPointXY point() const;
Expand Down
12 changes: 6 additions & 6 deletions python/analysis/raster/qgskde.sip
View file
Expand Up @@ -85,27 +85,27 @@ call run(), addFeature() and finalise() separately.
Prepares the output file for writing and setups up the surface calculation. This must be called
before adding features via addFeature().

.. seealso:: :py:func:`addFeature()`
.. seealso:: :py:func:`addFeature`

.. seealso:: :py:func:`finalise()`
.. seealso:: :py:func:`finalise`
%End

Result addFeature( const QgsFeature &feature );
%Docstring
Adds a single feature to the KDE surface. prepare() must be called before adding features.

.. seealso:: :py:func:`prepare()`
.. seealso:: :py:func:`prepare`

.. seealso:: :py:func:`finalise()`
.. seealso:: :py:func:`finalise`
%End

Result finalise();
%Docstring
Finalises the output file. Must be called after adding all features via addFeature().

.. seealso:: :py:func:`prepare()`
.. seealso:: :py:func:`prepare`

.. seealso:: :py:func:`addFeature()`
.. seealso:: :py:func:`addFeature`
%End

private:
Expand Down
72 changes: 36 additions & 36 deletions python/core/annotations/qgsannotation.sip
View file
Expand Up @@ -58,14 +58,14 @@ reflecting the annotation's current state.
%Docstring
Returns true if the annotation is visible and should be rendered.

.. seealso:: :py:func:`setVisible()`
.. seealso:: :py:func:`setVisible`
%End

void setVisible( bool visible );
%Docstring
Sets whether the annotation is visible and should be rendered.

.. seealso:: :py:func:`isVisible()`
.. seealso:: :py:func:`isVisible`
%End

bool hasFixedMapPosition() const;
Expand All @@ -74,54 +74,54 @@ Returns true if the annotation is attached to a fixed map position, or
false if the annotation uses a position relative to the current map
extent.

.. seealso:: :py:func:`setHasFixedMapPosition()`
.. seealso:: :py:func:`setHasFixedMapPosition`

.. seealso:: :py:func:`mapPosition()`
.. seealso:: :py:func:`mapPosition`

.. seealso:: :py:func:`relativePosition()`
.. seealso:: :py:func:`relativePosition`
%End

void setHasFixedMapPosition( bool fixed );
%Docstring
Sets whether the annotation is attached to a fixed map position, or
uses a position relative to the current map extent.

.. seealso:: :py:func:`hasFixedMapPosition()`
.. seealso:: :py:func:`hasFixedMapPosition`
%End

QgsPointXY mapPosition() const;
%Docstring
Returns the map position of the annotation, if it is attached to a fixed map
position.

.. seealso:: :py:func:`setMapPosition()`
.. seealso:: :py:func:`setMapPosition`

.. seealso:: :py:func:`hasFixedMapPosition()`
.. seealso:: :py:func:`hasFixedMapPosition`

.. seealso:: :py:func:`mapPositionCrs()`
.. seealso:: :py:func:`mapPositionCrs`
%End

void setMapPosition( const QgsPointXY &position );
%Docstring
Sets the map position of the annotation, if it is attached to a fixed map
position.

.. seealso:: :py:func:`mapPosition()`
.. seealso:: :py:func:`mapPosition`
%End

QgsCoordinateReferenceSystem mapPositionCrs() const;
%Docstring
Returns the CRS of the map position, or an invalid CRS if the annotation does
not have a fixed map position.

.. seealso:: :py:func:`setMapPositionCrs()`
.. seealso:: :py:func:`setMapPositionCrs`
%End

void setMapPositionCrs( const QgsCoordinateReferenceSystem &crs );
%Docstring
Sets the CRS of the map position.

.. seealso:: :py:func:`mapPositionCrs()`
.. seealso:: :py:func:`mapPositionCrs`
%End

QPointF relativePosition() const;
Expand All @@ -130,7 +130,7 @@ Returns the relative position of the annotation, if it is not attached to a fixe
position. The coordinates in the return point should be between 0 and 1, and represent
the relative percentage for the position compared to the map width and height.

.. seealso:: :py:func:`setRelativePosition()`
.. seealso:: :py:func:`setRelativePosition`
%End

void setRelativePosition( QPointF position );
Expand All @@ -139,68 +139,68 @@ Sets the relative position of the annotation, if it is not attached to a fixed m
position. The coordinates in the return point should be between 0 and 1, and represent
the relative percentage for the position compared to the map width and height.

.. seealso:: :py:func:`relativePosition()`
.. seealso:: :py:func:`relativePosition`
%End

void setFrameOffsetFromReferencePoint( QPointF offset );
%Docstring
Sets the annotation's frame's offset from the mapPosition() reference point.

.. seealso:: :py:func:`frameOffsetFromReferencePoint()`
.. seealso:: :py:func:`frameOffsetFromReferencePoint`
%End

QPointF frameOffsetFromReferencePoint() const;
%Docstring
Returns the annotation's frame's offset from the mapPosition() reference point.

.. seealso:: :py:func:`setFrameOffsetFromReferencePoint()`
.. seealso:: :py:func:`setFrameOffsetFromReferencePoint`
%End

void setFrameSize( QSizeF size );
%Docstring
Sets the size of the annotation's frame (the main area in which
the annotation's content is drawn).

.. seealso:: :py:func:`frameSize()`
.. seealso:: :py:func:`frameSize`
%End

QSizeF frameSize() const;
%Docstring
Returns the size of the annotation's frame (the main area in which
the annotation's content is drawn).

.. seealso:: :py:func:`setFrameSize()`
.. seealso:: :py:func:`setFrameSize`
%End

void setContentsMargin( const QgsMargins &margins );
%Docstring
Sets the margins (in millimeters) between the outside of the frame and the annotation
content.

.. seealso:: :py:func:`contentsMargin()`
.. seealso:: :py:func:`contentsMargin`
%End

QgsMargins contentsMargin() const;
%Docstring
Returns the margins (in millimeters) between the outside of the frame and the annotation
content.

.. seealso:: :py:func:`setContentsMargin()`
.. seealso:: :py:func:`setContentsMargin`
%End

void setFillSymbol( QgsFillSymbol *symbol /Transfer/ );
%Docstring
Sets the fill symbol used for rendering the annotation frame. Ownership
of the symbol is transferred to the annotation.

.. seealso:: :py:func:`fillSymbol()`
.. seealso:: :py:func:`fillSymbol`
%End

QgsFillSymbol *fillSymbol() const;
%Docstring
Returns the symbol that is used for rendering the annotation frame.

.. seealso:: :py:func:`setFillSymbol()`
.. seealso:: :py:func:`setFillSymbol`
%End

void render( QgsRenderContext &context ) const;
Expand All @@ -213,34 +213,34 @@ Renders the annotation to a target render context.
Writes the annotation state to a DOM element. Derived classes should
call _writeXml() within their implementation of this method.

.. seealso:: :py:func:`readXml()`
.. seealso:: :py:func:`readXml`

.. seealso:: _writeXml()
.. seealso:: _writeXml
%End

virtual void readXml( const QDomElement &itemElem, const QgsReadWriteContext &context ) = 0;
%Docstring
Restores the annotation's state from a DOM element. Derived classes should
call _readXml() within their implementation of this method.

.. seealso:: :py:func:`writeXml()`
.. seealso:: :py:func:`writeXml`

.. seealso:: _readXml()
.. seealso:: _readXml
%End

void setMarkerSymbol( QgsMarkerSymbol *symbol /Transfer/ );
%Docstring
Sets the symbol that is drawn at the annotation's map position. Ownership
of the symbol is transferred to the annotation.

.. seealso:: :py:func:`markerSymbol()`
.. seealso:: :py:func:`markerSymbol`
%End

QgsMarkerSymbol *markerSymbol() const;
%Docstring
Returns the symbol that is drawn at the annotation's map position.

.. seealso:: :py:func:`setMarkerSymbol()`
.. seealso:: :py:func:`setMarkerSymbol`
%End

QgsMapLayer *mapLayer() const;
Expand All @@ -249,7 +249,7 @@ Returns the map layer associated with the annotation. Annotations can be
associated with a map layer if their visibility should be synchronized
with the layer's visibility.

.. seealso:: :py:func:`setMapLayer()`
.. seealso:: :py:func:`setMapLayer`
%End

void setMapLayer( QgsMapLayer *layer );
Expand All @@ -258,22 +258,22 @@ Sets the map layer associated with the annotation. Annotations can be
associated with a map layer if their visibility should be synchronized
with the layer's visibility.

.. seealso:: :py:func:`mapLayer()`
.. seealso:: :py:func:`mapLayer`
%End

QgsFeature associatedFeature() const;
%Docstring
Returns the feature associated with the annotation, or an invalid
feature if none has been set.

.. seealso:: :py:func:`setAssociatedFeature()`
.. seealso:: :py:func:`setAssociatedFeature`
%End

virtual void setAssociatedFeature( const QgsFeature &feature );
%Docstring
Sets the feature associated with the annotation.

.. seealso:: :py:func:`associatedFeature()`
.. seealso:: :py:func:`associatedFeature`
%End

signals:
Expand Down Expand Up @@ -313,19 +313,19 @@ cannot be resized smaller than a certain minimum size.
Writes common annotation properties to a DOM element.
This method should be called from subclasses in their writeXml method.

.. seealso:: :py:func:`writeXml()`
.. seealso:: :py:func:`writeXml`

.. seealso:: _readXml()
.. seealso:: _readXml
%End

void _readXml( const QDomElement &annotationElem, const QgsReadWriteContext &context );
%Docstring
Reads common annotation properties from a DOM element.
This method should be called from subclasses in their readXml method.

.. seealso:: :py:func:`readXml()`
.. seealso:: :py:func:`readXml`

.. seealso:: _writeXml()
.. seealso:: _writeXml
%End

void copyCommonProperties( QgsAnnotation *target ) const;
Expand Down

0 comments on commit d87c605

Please sign in to comment.