Skip to content

Commit

Permalink
Fix broken see also links
Browse files Browse the repository at this point in the history
  • Loading branch information
nyalldawson committed May 25, 2018
1 parent a3c543d commit 2cb8a33
Show file tree
Hide file tree
Showing 95 changed files with 142 additions and 247 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ of removing an annotation which is not contained in the manager).

.. seealso:: :py:func:`addAnnotation`

.. seealso:: :py:func:`compositionRemoved`
.. seealso:: :py:func:`annotationRemoved`

.. seealso:: :py:func:`compositionAboutToBeRemoved`
.. seealso:: :py:func:`annotationAboutToBeRemoved`

.. seealso:: :py:func:`clear`
%End
Expand Down
2 changes: 1 addition & 1 deletion python/core/auto_generated/effects/qgscoloreffect.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ setColorizeOn() is set to true.

:return: colorization strength, between 0 and 100

.. seealso:: :py:func:`setColorizeStrengths`
.. seealso:: :py:func:`setColorizeStrength`

.. seealso:: :py:func:`colorizeOn`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,14 @@ Sets the ``uri`` for the GeoNode connection.
%Docstring
Adds uri parameters relating to the settings for a WMS layer on the connection to a :py:class:`QgsDataSourceUri` ``uri``.

.. seealso:: :py:func:`addWmsWcsConnectionSettings`
.. seealso:: :py:func:`addWfsConnectionSettings`
%End

QgsDataSourceUri &addWfsConnectionSettings( QgsDataSourceUri &uri ) const;
%Docstring
Adds uri parameters relating to the settings for a WFS layer on the connection to a :py:class:`QgsDataSourceUri` ``uri``.

.. seealso:: :py:func:`addWmsWcsConnectionSettings`
.. seealso:: :py:func:`addWmsConnectionSettings`
%End

};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -182,9 +182,9 @@ Returns a WKB representation of the geometry.

.. seealso:: :py:func:`asWkt`

.. seealso:: :py:func:`asGML2`
.. seealso:: :py:func:`asGml2`

.. seealso:: :py:func:`asGML3`
.. seealso:: :py:func:`asGml3`

.. seealso:: :py:func:`asJson`

Expand Down
4 changes: 0 additions & 4 deletions python/core/auto_generated/geometry/qgscurve.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -166,8 +166,6 @@ Returns the x-coordinate of the specified node in the line string.
:param index: index of node, where the first node in the line is 0

:return: x-coordinate of node, or 0.0 if index is out of bounds

.. seealso:: :py:func:`setXAt`
%End

virtual double yAt( int index ) const = 0;
Expand All @@ -177,8 +175,6 @@ Returns the y-coordinate of the specified node in the line string.
:param index: index of node, where the first node in the line is 0

:return: y-coordinate of node, or 0.0 if index is out of bounds

.. seealso:: :py:func:`setYAt`
%End

QPolygonF asQPolygonF() const;
Expand Down
2 changes: 1 addition & 1 deletion python/core/auto_generated/geometry/qgsgeometry.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ Sets the underlying geometry store. Ownership of geometry is transferred.
Returns true if the geometry is null (ie, contains no underlying geometry
accessible via geometry() ).

.. seealso:: :py:func:`geometry`
.. seealso:: :py:func:`get`

.. versionadded:: 2.10

Expand Down
4 changes: 0 additions & 4 deletions python/core/auto_generated/layout/qgslayout.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -441,8 +441,6 @@ layout is exported. If no map was explicitly set via setReferenceMap(), the larg
map in the layout will be returned (or None if there are no maps in the layout).

.. seealso:: :py:func:`setReferenceMap`

.. seealso:: :py:func:`generateWorldFile`
%End

void setReferenceMap( QgsLayoutItemMap *map );
Expand All @@ -451,8 +449,6 @@ Sets the ``map`` item which will be used to generate corresponding world files w
layout is exported.

.. seealso:: :py:func:`referenceMap`

.. seealso:: :py:func:`setGenerateWorldFile`
%End

QgsLayoutPageCollection *pageCollection();
Expand Down
4 changes: 2 additions & 2 deletions python/core/auto_generated/layout/qgslayoutexporter.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Renders a full page to a destination ``painter``.
The ``page`` argument specifies the page number to render. Page numbers
are 0 based, such that the first page in a layout is page 0.

.. seealso:: :py:func:`renderRect`
.. seealso:: :py:func:`renderRegion`
%End

QImage renderPageToImage( int page, QSize imageSize = QSize(), double dpi = 0 ) const;
Expand Down Expand Up @@ -331,7 +331,7 @@ Similarly, the ``dpi`` can be set to the actual DPI of exported file, or left as

The function will return true if the output was successfully georeferenced.

.. seealso:: :py:func:`computeGeoTransform`
.. seealso:: :py:func:`computeWorldFileParameters`
%End

void computeWorldFileParameters( double &a, double &b, double &c, double &d, double &e, double &f, double dpi = -1 ) const;
Expand Down
4 changes: 0 additions & 4 deletions python/core/auto_generated/layout/qgslayoutitemmapgrid.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -85,15 +85,11 @@ Moves a grid with matching ``gridId`` down the stack, causing it to be rendered
QgsLayoutItemMapGrid *grid( const QString &gridId ) const;
%Docstring
Returns a reference to a grid with matching ``gridId`` within the stack.

.. seealso:: :py:func:`constGrid`
%End

QgsLayoutItemMapGrid *grid( int index ) const;
%Docstring
Returns a reference to a grid at the specified ``index`` within the stack.

.. seealso:: :py:func:`constGrid`
%End

QgsLayoutItemMapGrid &operator[]( int index );
Expand Down
4 changes: 0 additions & 4 deletions python/core/auto_generated/layout/qgslayoutitemmapitem.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -246,15 +246,11 @@ Moves an item which matching ``itemId`` up the stack, causing it to be rendered
QgsLayoutItemMapItem *item( const QString &itemId ) const;
%Docstring
Returns a reference to an item which matching ``itemId`` within the stack.

.. seealso:: :py:func:`constItem`
%End

QgsLayoutItemMapItem *item( int index ) const;
%Docstring
Returns a reference to the item at the specified ``index`` within the stack.

.. seealso:: :py:func:`constItem`
%End


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,15 +86,11 @@ Moves an overview with matching overviewId down the stack, causing it to be rend
QgsLayoutItemMapOverview *overview( const QString &overviewId ) const;
%Docstring
Returns a reference to an overview with matching overviewId within the stack.

.. seealso:: :py:func:`constOverview`
%End

QgsLayoutItemMapOverview *overview( const int index ) const;
%Docstring
Returns a reference to an overview at the specified ``index`` within the stack.

.. seealso:: :py:func:`constOverview`
%End

QgsLayoutItemMapOverview &operator[]( int index );
Expand Down
6 changes: 2 additions & 4 deletions python/core/auto_generated/layout/qgslayoutitempicture.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,6 @@ this value. The path can either be a local path or a remote (http) path.

:return: path for the source image

.. seealso:: :py:func:`usePictureExpression`

.. seealso:: :py:func:`setPicturePath`
%End

Expand All @@ -90,7 +88,7 @@ in degrees clockwise.

.. seealso:: :py:func:`setPictureRotation`

.. seealso:: :py:func:`rotationMap`
.. seealso:: :py:func:`linkedMap`
%End

void setLinkedMap( QgsLayoutItemMap *map );
Expand Down Expand Up @@ -218,7 +216,7 @@ Sets the stroke ``color`` used for parametrized SVG files.
This setting only has an effect on parametrized SVG files, and is ignored for
non-parametrized SVG files.

.. seealso:: :py:func:`svgStrokelColor`
.. seealso:: :py:func:`svgStrokeColor`

.. seealso:: :py:func:`setSvgFillColor`
%End
Expand Down
10 changes: 2 additions & 8 deletions python/core/auto_generated/layout/qgslayoutitemscalebar.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,9 @@ Returns the size mode for the scale bar segments.

.. seealso:: :py:func:`setSegmentSizeMode`

.. seealso:: :py:func:`minBarWidth`
.. seealso:: :py:func:`minimumBarWidth`

.. seealso:: :py:func:`maxBarWidth`
.. seealso:: :py:func:`maximumBarWidth`
%End

void setSegmentSizeMode( QgsScaleBarSettings::SegmentSizeMode mode );
Expand Down Expand Up @@ -318,8 +318,6 @@ Sets the line ``width`` in millimeters for lines in the scalebar.
%Docstring
Returns the pen used for drawing outlines in the scalebar.

.. seealso:: :py:func:`setPen`

.. seealso:: :py:func:`brush`
%End

Expand All @@ -329,8 +327,6 @@ Returns the primary brush for the scalebar.

:return: QBrush used for filling the scalebar

.. seealso:: :py:func:`setBrush`

.. seealso:: :py:func:`brush2`

.. seealso:: :py:func:`pen`
Expand All @@ -343,8 +339,6 @@ as single and double box styles.

:return: QBrush used for secondary color areas

.. seealso:: :py:func:`setBrush2`

.. seealso:: :py:func:`brush`
%End

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ first page.
it does not consider x coordinates and vertical coordinates before the first page or
after the last page will still return the nearest page.

.. seealso:: :py:func:`predicatePageNumberForPoint`
.. seealso:: :py:func:`predictPageNumberForPoint`

.. seealso:: :py:func:`pageAtPoint`

Expand Down
2 changes: 0 additions & 2 deletions python/core/auto_generated/layout/qgslayouttable.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -528,8 +528,6 @@ Returns the current contents of the table. Excludes header cells.
Refreshes the contents shown in the table by querying for new data.
This also causes the column widths and size of the table to change to accommodate the
new data.

.. seealso:: :py:func:`adjustFrameToSize`
%End

virtual void recalculateFrameSizes();
Expand Down
2 changes: 1 addition & 1 deletion python/core/auto_generated/locator/qgslocatorfilter.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ Sets whether the filter is ``enabled``.
%Docstring
Should return true if the filter has a configuration widget.

.. seealso:: :py:func:`createConfigWidget`
.. seealso:: :py:func:`openConfigWidget`
%End

virtual void openConfigWidget( QWidget *parent = 0 );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1029,7 +1029,7 @@ effect if hasFixedNumberRows() is true.

.. seealso:: :py:func:`setNumberRows`

.. seealso:: :py:func:`setFixedNumberRows`
.. seealso:: :py:func:`setHasFixedNumberRows`
%End

void setNumberRows( int rows );
Expand All @@ -1039,7 +1039,7 @@ effect if hasFixedNumberRows() is true.

.. seealso:: :py:func:`numberRows`

.. seealso:: :py:func:`setFixedNumberRows`
.. seealso:: :py:func:`setHasFixedNumberRows`
%End

bool hasFixedNumberRows() const;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ parameter value.
%Docstring
Returns a session specific processing temporary folder for use in processing algorithms.

.. seealso:: :py:func:`generateTempFileName`
.. seealso:: :py:func:`generateTempFilename`
%End

static QString generateTempFilename( const QString &basename );
Expand Down
4 changes: 2 additions & 2 deletions python/core/auto_generated/qgsapplication.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -779,7 +779,7 @@ in a widget or sending it to a web browser.
Custom expression variables for this application.
This does not include generated variables (like system name, user name etc.)

.. seealso:: :py:func:`QgsExpressionContextUtils.globalVariables`
.. seealso:: :py:func:`QgsExpressionContextUtils.globalScope`

.. versionadded:: 3.0
%End
Expand All @@ -789,7 +789,7 @@ This does not include generated variables (like system name, user name etc.)
Custom expression variables for this application.
Do not include generated variables (like system name, user name etc.)

.. seealso:: :py:func:`QgsExpressionContextUtils.globalVariables`
.. seealso:: :py:func:`QgsExpressionContextUtils.globalScope`

.. versionadded:: 3.0
%End
Expand Down
8 changes: 0 additions & 8 deletions python/core/auto_generated/qgscoordinatetransform.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -290,8 +290,6 @@ but can be manually overwritten by a call to setSourceDatumTransformId().
.. seealso:: :py:func:`setSourceDatumTransformId`

.. seealso:: :py:func:`destinationDatumTransformId`

.. seealso:: :py:func:`datumTransformInfo`
%End

void setSourceDatumTransformId( int datumId );
Expand All @@ -307,8 +305,6 @@ Calling this method will overwrite any automatically calculated datum transform.
.. seealso:: :py:func:`sourceDatumTransformId`

.. seealso:: :py:func:`setDestinationDatumTransformId`

.. seealso:: :py:func:`datumTransformInfo`
%End

int destinationDatumTransformId() const;
Expand All @@ -324,8 +320,6 @@ but can be manually overwritten by a call to setDestinationDatumTransformId().
.. seealso:: :py:func:`setDestinationDatumTransformId`

.. seealso:: :py:func:`sourceDatumTransformId`

.. seealso:: :py:func:`datumTransformInfo`
%End

void setDestinationDatumTransformId( int datumId );
Expand All @@ -341,8 +335,6 @@ Calling this method will overwrite any automatically calculated datum transform.
.. seealso:: :py:func:`destinationDatumTransformId`

.. seealso:: :py:func:`setSourceDatumTransformId`

.. seealso:: :py:func:`datumTransformInfo`
%End

static void invalidateCache();
Expand Down
6 changes: 1 addition & 5 deletions python/core/auto_generated/qgsdiagramrenderer.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ is set to a line type.

:param flags: placement value

.. seealso:: :py:func:`getPlacement`
.. seealso:: :py:func:`linePlacementFlags`

.. versionadded:: 2.16
%End
Expand Down Expand Up @@ -550,8 +550,6 @@ Returns true if renderer will show legend items for diagram attributes.
.. versionadded:: 2.16

.. seealso:: :py:func:`setAttributeLegend`

.. seealso:: :py:func:`sizeLegend`
%End

void setAttributeLegend( bool enabled );
Expand All @@ -563,8 +561,6 @@ Sets whether the renderer will show legend items for diagram attributes.