Skip to content

Commit

Permalink
run sipify
Browse files Browse the repository at this point in the history
  • Loading branch information
3nids committed Dec 19, 2017
1 parent 36a05a3 commit 90e5196
Show file tree
Hide file tree
Showing 161 changed files with 310 additions and 310 deletions.
2 changes: 1 addition & 1 deletion python/analysis/network/qgsgraphbuilder.sip
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ MANDATORY BUILDER PROPERTY DECLARATION

QgsGraph *graph() /Factory/;
%Docstring
Returns generated QgsGraph
Returns generated :py:class:`QgsGraph`
%End

};
Expand Down
2 changes: 1 addition & 1 deletion python/analysis/network/qgsgraphdirector.sip
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ using "builder" design patter.
QVector< QgsPointXY > &snappedPoints /Out/,
QgsFeedback *feedback = 0 ) const;
%Docstring
Make a graph using QgsGraphBuilder
Make a graph using :py:class:`QgsGraphBuilder`

:param builder: the graph builder
:param additionalPoints: list of points that should be snapped to the graph
Expand Down
2 changes: 1 addition & 1 deletion python/analysis/network/qgsnetworkstrategy.sip
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Default constructor
virtual QSet< int > requiredAttributes() const;
%Docstring
Returns a list of the source layer attributes needed for cost calculation.
This is method called by QgsGraphDirector.
This is method called by :py:class:`QgsGraphDirector`.
%End

virtual QVariant cost( double distance, const QgsFeature &f ) const = 0;
Expand Down
2 changes: 1 addition & 1 deletion python/analysis/vector/qgsgeometrysnapper.sip
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ class QgsInternalGeometrySnapper
%Docstring
QgsInternalGeometrySnapper allows a set of geometries to be snapped to each other. It can be used to close gaps in layers.

To use QgsInternalGeometrySnapper, first construct the snapper using the desired snap parameters. Then,
To use :py:class:`QgsInternalGeometrySnapper`, first construct the snapper using the desired snap parameters. Then,
features are fed to to the snapper one-by-one by calling snapFeature(). Each feature passed by calling
snapFeature() will be snapped to any features which have already been processed by the snapper.

Expand Down
2 changes: 1 addition & 1 deletion python/core/annotations/qgsannotationmanager.sip
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class QgsAnnotationManager : QObject

QgsAnnotationManager handles the storage, serializing and deserializing
of QgsAnnotations. Usually this class is not constructed directly, but
rather accessed through a QgsProject via QgsProject.annotationManager().
rather accessed through a QgsProject via :py:func:`QgsProject.annotationManager()`

QgsAnnotationManager retains ownership of all the annotations contained
in the manager.
Expand Down
4 changes: 2 additions & 2 deletions python/core/auth/qgsauthmanager.sip
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ Provider call to update a QNetworkReply with an authentication config (used to s
%Docstring
Provider call to update a QgsDataSourceUri with an authentication config

:param connectionItems: The connection items, e.g. username=myname, of QgsDataSourceUri
:param connectionItems: The connection items, e.g. username=myname, of :py:class:`QgsDataSourceUri`
:param authcfg: Associated authentication config id
:param dataprovider: Provider key filter, offering logic branching in authentication method

Expand Down Expand Up @@ -745,7 +745,7 @@ mainly used in the tests to exit main application loop

void messageOut( const QString &message, const QString &tag = QgsAuthManager::AUTH_MAN_TAG, QgsAuthManager::MessageLevel level = QgsAuthManager::INFO ) const;
%Docstring
Custom logging signal to relay to console output and QgsMessageLog
Custom logging signal to relay to console output and :py:class:`QgsMessageLog`

:param message: Message to send
:param tag: Associated tag (title)
Expand Down
2 changes: 1 addition & 1 deletion python/core/auth/qgsauthmethod.sip
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ for custom updater code specific to the provider
%Docstring
Update data source connection items with authentication components

:param connectionItems: QStringlist of 'key=value' pairs, as utilized in QgsDataSourceUri.connectionInfo()
:param connectionItems: QStringlist of 'key=value' pairs, as utilized in :py:func:`QgsDataSourceUri.connectionInfo()`
:param authcfg: Authentication configuration ID
:param dataprovider: Textual key for a data provider, e.g. 'postgres', that allows
for custom updater code specific to the provider
Expand Down
22 changes: 11 additions & 11 deletions python/core/composer/qgscomposerattributetablemodelv2.sip
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ A model for displaying columns shown in a QgsComposerAttributeTableV2

QgsComposerAttributeTableColumnModelV2( QgsComposerAttributeTableV2 *composerTable, QObject *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsComposerAttributeTableColumnModel.
Constructor for :py:class:`QgsComposerAttributeTableColumnModel`.

:param composerTable: QgsComposerAttributeTable the model is attached to
:param parent: optional parent
Expand Down Expand Up @@ -96,9 +96,9 @@ Returns the QgsComposerTableColumn corresponding to an index in the model.
%Docstring
Returns a QModelIndex corresponding to a QgsComposerTableColumn in the model.

:return: QModelIndex for specified QgsComposerTableColumn
:return: QModelIndex for specified :py:class:`QgsComposerTableColumn`

:param column: a QgsComposerTableColumn
:param column: a :py:class:`QgsComposerTableColumn`

.. versionadded:: 2.3

Expand All @@ -107,10 +107,10 @@ Returns a QModelIndex corresponding to a QgsComposerTableColumn in the model.

void setColumnAsSorted( QgsComposerTableColumn *column, Qt::SortOrder order );
%Docstring
Sets a specified column as a sorted column in the QgsComposerAttributeTable. The column will be
Sets a specified column as a sorted column in the :py:class:`QgsComposerAttributeTable`. The column will be
added to the end of the sort rank list, ie it will take the next largest available sort rank.

:param column: a QgsComposerTableColumn
:param column: a :py:class:`QgsComposerTableColumn`
:param order: sort order for column

.. versionadded:: 2.3
Expand All @@ -122,10 +122,10 @@ added to the end of the sort rank list, ie it will take the next largest availab

void setColumnAsUnsorted( QgsComposerTableColumn *column );
%Docstring
Sets a specified column as an unsorted column in the QgsComposerAttributeTable. The column will be
Sets a specified column as an unsorted column in the :py:class:`QgsComposerAttributeTable`. The column will be
removed from the sort rank list.

:param column: a QgsComposerTableColumn
:param column: a :py:class:`QgsComposerTableColumn`

.. versionadded:: 2.3

Expand All @@ -134,9 +134,9 @@ removed from the sort rank list.

bool moveColumnInSortRank( QgsComposerTableColumn *column, ShiftDirection direction );
%Docstring
Moves a column up or down in the sort rank for the QgsComposerAttributeTable.
Moves a column up or down in the sort rank for the :py:class:`QgsComposerAttributeTable`.

:param column: a QgsComposerTableColumn
:param column: a :py:class:`QgsComposerTableColumn`
:param direction: direction to move the column in the sort rank list

.. versionadded:: 2.3
Expand Down Expand Up @@ -167,7 +167,7 @@ Allows for filtering QgsComposerAttributeTable columns by columns which are sort

QgsComposerTableSortColumnsProxyModelV2( QgsComposerAttributeTableV2 *composerTable, ColumnFilterType filterType, QObject *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsComposerTableSortColumnsProxyModel.
Constructor for :py:class:`QgsComposerTableSortColumnsProxyModel`.

:param composerTable: QgsComposerAttributeTable the model is attached to
:param filterType: filter for columns, controls whether sorted or unsorted columns are shown
Expand Down Expand Up @@ -220,7 +220,7 @@ Returns the QgsComposerTableColumn corresponding to an index in the proxy model.
Returns the QgsComposerTableColumn corresponding to an index from the source
QgsComposerAttributeTableColumnModel model.

:return: QgsComposerTableColumn for specified index from QgsComposerAttributeTableColumnModel
:return: QgsComposerTableColumn for specified index from :py:class:`QgsComposerAttributeTableColumnModel`

:param sourceIndex: a QModelIndex

Expand Down
4 changes: 2 additions & 2 deletions python/core/composer/qgscomposermapgrid.sip
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ should be called for the QgsComposerMap to prevent rendering artifacts

void removeGrid( const QString &gridId );
%Docstring
Removes a grid from the stack and deletes the corresponding QgsComposerMapGrid
Removes a grid from the stack and deletes the corresponding :py:class:`QgsComposerMapGrid`

:param gridId: id for the QgsComposerMapGrid to remove

Expand Down Expand Up @@ -179,7 +179,7 @@ class QgsComposerMapGrid : QgsComposerMapItem
{
%Docstring
An individual grid which is drawn above the map content in a
QgsComposerMap.
:py:class:`QgsComposerMap`.

.. versionadded:: 2.5

Expand Down
4 changes: 2 additions & 2 deletions python/core/composer/qgscomposermapitem.sip
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ class QgsComposerMapItemStack
{
%Docstring
A collection of map items which are drawn above the map content in a
QgsComposerMap. The item stack controls which items are drawn and the
:py:class:`QgsComposerMap`. The item stack controls which items are drawn and the
order they are drawn in.

.. versionadded:: 2.5
Expand Down Expand Up @@ -227,7 +227,7 @@ should be called for the QgsComposerMap to prevent rendering artifacts

void removeItem( const QString &itemId );
%Docstring
Removes an item from the stack and deletes the corresponding QgsComposerMapItem
Removes an item from the stack and deletes the corresponding :py:class:`QgsComposerMapItem`

:param itemId: id for the QgsComposerMapItem to remove

Expand Down
4 changes: 2 additions & 2 deletions python/core/composer/qgscomposermapoverview.sip
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ should be called for the QgsComposerMap to prevent rendering artifacts

void removeOverview( const QString &overviewId );
%Docstring
Removes an overview from the stack and deletes the corresponding QgsComposerMapOverview
Removes an overview from the stack and deletes the corresponding :py:class:`QgsComposerMapOverview`

:param overviewId: id for the QgsComposerMapOverview to remove

Expand Down Expand Up @@ -153,7 +153,7 @@ class QgsComposerMapOverview : QgsComposerMapItem
{
%Docstring
An individual overview which is drawn above the map content in a
QgsComposerMap, and shows the extent of another QgsComposerMap.
:py:class:`QgsComposerMap`, and shows the extent of another :py:class:`QgsComposerMap`.

.. versionadded:: 2.5

Expand Down
4 changes: 2 additions & 2 deletions python/core/composer/qgscomposermodel.sip
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ Must be called when an item's selection status changes

QModelIndex indexForItem( QgsComposerItem *item, const int column = 0 );
%Docstring
Returns the QModelIndex corresponding to a QgsComposerItem, if possible
Returns the QModelIndex corresponding to a :py:class:`QgsComposerItem`, if possible

:param item: QgsComposerItem to find index for
:param column: column number for created QModelIndex
Expand Down Expand Up @@ -414,7 +414,7 @@ QgsComposerModel model.

:param sourceIndex: a QModelIndex

:return: QgsComposerItem for specified index from QgsComposerModel
:return: QgsComposerItem for specified index from :py:class:`QgsComposerModel`
%End

protected:
Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgscomposermultiframe.sip
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ and general frame properties (e.g., frame style, background, rendering settings)
:param pos: position of top-left corner of the new frame
:param size: size of the new frame

:return: new QgsComposerFrame
:return: new :py:class:`QgsComposerFrame`

.. versionadded:: 2.3
%End
Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgscomposerscalebar.sip
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@ Sets box size suitable to content

void update();
%Docstring
Adjusts box size and calls QgsComposerItem.update()
Adjusts box size and calls :py:func:`QgsComposerItem.update()`
%End


Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgscomposershape.sip
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Note: added in version 2.1*

void setUseSymbol( bool useSymbol );
%Docstring
Controls whether the shape should be drawn using a QgsFillSymbol.
Controls whether the shape should be drawn using a :py:class:`QgsFillSymbol`.
Note: Added in v2.1 *
%End

Expand Down
20 changes: 10 additions & 10 deletions python/core/composer/qgscomposertablecolumn.sip
Original file line number Diff line number Diff line change
Expand Up @@ -158,31 +158,31 @@ used for drawing column values within cells.
QString attribute() const;
%Docstring
Returns the attribute name or expression used for the column's values. This property
is only used when the column is part of a QgsComposerAttributeTable.
is only used when the column is part of a :py:class:`QgsComposerAttributeTable`.

:return: attribute name or expression text for column

.. versionadded:: 2.3

.. note::