run sipify

qgis · Dec 19, 2017 · 90e5196 · 90e5196
1 parent 36a05a3
commit 90e5196
Show file tree

Hide file tree

Showing 161 changed files with 310 additions and 310 deletions.
diff --git a/python/analysis/network/qgsgraphbuilder.sip b/python/analysis/network/qgsgraphbuilder.sip
@@ -40,7 +40,7 @@ MANDATORY BUILDER PROPERTY DECLARATION
 
     QgsGraph *graph() /Factory/;
 %Docstring
-Returns generated QgsGraph
+Returns generated :py:class:`QgsGraph`
 %End
 
 };

diff --git a/python/analysis/network/qgsgraphdirector.sip b/python/analysis/network/qgsgraphdirector.sip
@@ -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

diff --git a/python/analysis/network/qgsnetworkstrategy.sip b/python/analysis/network/qgsnetworkstrategy.sip
@@ -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;

diff --git a/python/analysis/vector/qgsgeometrysnapper.sip b/python/analysis/vector/qgsgeometrysnapper.sip
@@ -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.
 

diff --git a/python/core/annotations/qgsannotationmanager.sip b/python/core/annotations/qgsannotationmanager.sip
@@ -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.

diff --git a/python/core/auth/qgsauthmanager.sip b/python/core/auth/qgsauthmanager.sip
@@ -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
 
@@ -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)

diff --git a/python/core/auth/qgsauthmethod.sip b/python/core/auth/qgsauthmethod.sip
@@ -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

diff --git a/python/core/composer/qgscomposerattributetablemodelv2.sip b/python/core/composer/qgscomposerattributetablemodelv2.sip
@@ -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
@@ -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
 
@@ -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
@@ -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
 
@@ -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
@@ -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
@@ -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
 

diff --git a/python/core/composer/qgscomposermapgrid.sip b/python/core/composer/qgscomposermapgrid.sip
@@ -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
 
@@ -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
 

diff --git a/python/core/composer/qgscomposermapitem.sip b/python/core/composer/qgscomposermapitem.sip
@@ -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
@@ -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
 

diff --git a/python/core/composer/qgscomposermapoverview.sip b/python/core/composer/qgscomposermapoverview.sip
@@ -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
 
@@ -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
 

diff --git a/python/core/composer/qgscomposermodel.sip b/python/core/composer/qgscomposermodel.sip
@@ -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
@@ -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:

diff --git a/python/core/composer/qgscomposermultiframe.sip b/python/core/composer/qgscomposermultiframe.sip
@@ -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

diff --git a/python/core/composer/qgscomposerscalebar.sip b/python/core/composer/qgscomposerscalebar.sip
@@ -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
 
 

diff --git a/python/core/composer/qgscomposershape.sip b/python/core/composer/qgscomposershape.sip
@@ -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
 

diff --git a/python/core/composer/qgscomposertablecolumn.sip b/python/core/composer/qgscomposertablecolumn.sip
@@ -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::
 
-   only applicable when used in a QgsComposerAttributeTable
+   only applicable when used in a :py:class:`QgsComposerAttributeTable`
 
 .. seealso:: :py:func:`setAttribute`
 %End
 
     void setAttribute( const QString &attribute );
 %Docstring
 Sets 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`.
 
 :param attribute: attribute name or expression text for column
 
 .. versionadded:: 2.3
 
 .. note::
 
-   only applicable when used in a QgsComposerAttributeTable
+   only applicable when used in a :py:class:`QgsComposerAttributeTable`
 
 .. seealso:: :py:func:`attribute`
 %End
@@ -198,7 +198,7 @@ is part of a QgsComposerAttributeTable and when sortByRank is > 0.
 
 .. note::
 
-   only applicable when used in a QgsComposerAttributeTable
+   only applicable when used in a :py:class:`QgsComposerAttributeTable`
 
 .. seealso:: :py:func:`setSortOrder`
 
@@ -216,7 +216,7 @@ is part of a QgsComposerAttributeTable and when sortByRank is > 0.
 
 .. note::
 
-   only applicable when used in a QgsComposerAttributeTable
+   only applicable when used in a :py:class:`QgsComposerAttributeTable`
 
 .. seealso:: :py:func:`sortOrder`
 
@@ -229,7 +229,7 @@ Returns the sort rank for the column. If the sort rank is > 0 then the column
 will be sorted in the table. The sort rank specifies the priority given to the
 column when the table is sorted by multiple columns, with lower sort ranks
 having higher priority. This property is only used when the column
-is part of a QgsComposerAttributeTable.
+is part of a :py:class:`QgsComposerAttributeTable`.
 
 :return: sort rank for column. If sort rank is <= 0 then the column is not being
 sorted.
@@ -238,7 +238,7 @@ sorted.
 
 .. note::
 
-   only applicable when used in a QgsComposerAttributeTable
+   only applicable when used in a :py:class:`QgsComposerAttributeTable`
 
 .. seealso:: :py:func:`setSortByRank`
 
@@ -251,7 +251,7 @@ Sets the sort rank for the column. If the sort rank is > 0 then the column
 will be sorted in the table. The sort rank specifies the priority given to the
 column when the table is sorted by multiple columns, with lower sort ranks
 having higher priority. This property is only used when the column
-is part of a QgsComposerAttributeTable.
+is part of a :py:class:`QgsComposerAttributeTable`.
 
 :param sortByRank: sort rank for column. If sort rank is <= 0 then the column is not being
 sorted.
@@ -260,7 +260,7 @@ sorted.
 
 .. note::
 
-   only applicable when used in a QgsComposerAttributeTable
+   only applicable when used in a :py:class:`QgsComposerAttributeTable`
 
 .. seealso:: :py:func:`sortByRank`
 

diff --git a/python/core/composer/qgscomposertablev2.sip b/python/core/composer/qgscomposertablev2.sip
@@ -543,7 +543,7 @@ Returns a pointer to the list of QgsComposerTableColumns shown in the table
 
     void setColumns( const QgsComposerTableColumns &columns /Transfer/ );
 %Docstring
-Replaces the columns in the table with a specified list of QgsComposerTableColumns.
+Replaces the columns in the table with a specified list of :py:class:`QgsComposerTableColumns`.
 
 :param columns: list of QgsComposerTableColumns to show in table. Ownership of columns
 is transferred to the table.

diff --git a/python/core/composer/qgscomposerutils.sip b/python/core/composer/qgscomposerutils.sip
@@ -346,7 +346,7 @@ painter device.
 %Docstring
 Creates a render context suitable for the specified ``composition`` and ``painter`` destination.
 This method returns a new QgsRenderContext which matches the scale and settings from the composition's
-QgsComposition.referenceMap().
+:py:func:`QgsComposition.referenceMap()`
 
 .. versionadded:: 3.0
 

diff --git a/python/core/composer/qgscomposition.sip b/python/core/composer/qgscomposition.sip
@@ -568,11 +568,11 @@ Add items from XML representation to the graphics scene (for project file readin
 
     void addItemToZList( QgsComposerItem *item );
 %Docstring
-Adds item to z list. Usually called from constructor of QgsComposerItem
+Adds item to z list. Usually called from constructor of :py:class:`QgsComposerItem`
 %End
     void removeItemFromZList( QgsComposerItem *item );
 %Docstring
-Removes item from z list. Usually called from destructor of QgsComposerItem
+Removes item from z list. Usually called from destructor of :py:class:`QgsComposerItem`
 %End
 
     void raiseSelectedItems();
@@ -742,7 +742,7 @@ Remove item from the graphics scene. Additionally to QGraphicsScene.removeItem,
 
     void pushAddRemoveCommand( QgsComposerItem *item, const QString &text, const QgsAddRemoveItemCommand::State state = QgsAddRemoveItemCommand::Added );
 %Docstring
-Convenience function to create a QgsAddRemoveItemCommand, connect its signals and push it to the undo stack
+Convenience function to create a :py:class:`QgsAddRemoveItemCommand`, connect its signals and push it to the undo stack
 %End
 
     void setPreventCursorChange( const bool preventChange );
@@ -914,7 +914,7 @@ Return pages in the correct order
 
 .. note::
 
-   composerItems(QList< QgsPaperItem* > &) may not return pages in the correct order
+   composerItems(QList< :py:class:`QgsPaperItem`* > &) may not return pages in the correct order
 
 .. versionadded:: 2.4
 %End

diff --git a/python/core/composer/qgslayoutmanager.sip b/python/core/composer/qgslayoutmanager.sip
@@ -20,7 +20,7 @@ class QgsLayoutManager : QObject
 
 QgsLayoutManager handles the storage, serializing and deserializing
 of QgsLayouts. Usually this class is not constructed directly, but
-rather accessed through a QgsProject via QgsProject.layoutManager().
+rather accessed through a QgsProject via :py:func:`QgsProject.layoutManager()`
 
 QgsLayoutManager retains ownership of all the layouts contained
 in the manager.