Skip to content

Commit 90e5196

Browse files
committed
run sipify
1 parent 36a05a3 commit 90e5196

161 files changed

Lines changed: 310 additions & 310 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

python/analysis/network/qgsgraphbuilder.sip

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ MANDATORY BUILDER PROPERTY DECLARATION
4040

4141
QgsGraph *graph() /Factory/;
4242
%Docstring
43-
Returns generated QgsGraph
43+
Returns generated :py:class:`QgsGraph`
4444
%End
4545

4646
};

python/analysis/network/qgsgraphdirector.sip

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ using "builder" design patter.
3737
QVector< QgsPointXY > &snappedPoints /Out/,
3838
QgsFeedback *feedback = 0 ) const;
3939
%Docstring
40-
Make a graph using QgsGraphBuilder
40+
Make a graph using :py:class:`QgsGraphBuilder`
4141

4242
:param builder: the graph builder
4343
:param additionalPoints: list of points that should be snapped to the graph

python/analysis/network/qgsnetworkstrategy.sip

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Default constructor
4949
virtual QSet< int > requiredAttributes() const;
5050
%Docstring
5151
Returns a list of the source layer attributes needed for cost calculation.
52-
This is method called by QgsGraphDirector.
52+
This is method called by :py:class:`QgsGraphDirector`.
5353
%End
5454

5555
virtual QVariant cost( double distance, const QgsFeature &f ) const = 0;

python/analysis/vector/qgsgeometrysnapper.sip

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ class QgsInternalGeometrySnapper
7777
%Docstring
7878
QgsInternalGeometrySnapper allows a set of geometries to be snapped to each other. It can be used to close gaps in layers.
7979

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

python/core/annotations/qgsannotationmanager.sip

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class QgsAnnotationManager : QObject
2020

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

2525
QgsAnnotationManager retains ownership of all the annotations contained
2626
in the manager.

python/core/auth/qgsauthmanager.sip

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ Provider call to update a QNetworkReply with an authentication config (used to s
352352
%Docstring
353353
Provider call to update a QgsDataSourceUri with an authentication config
354354

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

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

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

750750
:param message: Message to send
751751
:param tag: Associated tag (title)

python/core/auth/qgsauthmethod.sip

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ for custom updater code specific to the provider
101101
%Docstring
102102
Update data source connection items with authentication components
103103

104-
:param connectionItems: QStringlist of 'key=value' pairs, as utilized in QgsDataSourceUri.connectionInfo()
104+
:param connectionItems: QStringlist of 'key=value' pairs, as utilized in :py:func:`QgsDataSourceUri.connectionInfo()`
105105
:param authcfg: Authentication configuration ID
106106
:param dataprovider: Textual key for a data provider, e.g. 'postgres', that allows
107107
for custom updater code specific to the provider

python/core/composer/qgscomposerattributetablemodelv2.sip

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ A model for displaying columns shown in a QgsComposerAttributeTableV2
3131

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

3636
:param composerTable: QgsComposerAttributeTable the model is attached to
3737
:param parent: optional parent
@@ -96,9 +96,9 @@ Returns the QgsComposerTableColumn corresponding to an index in the model.
9696
%Docstring
9797
Returns a QModelIndex corresponding to a QgsComposerTableColumn in the model.
9898

99-
:return: QModelIndex for specified QgsComposerTableColumn
99+
:return: QModelIndex for specified :py:class:`QgsComposerTableColumn`
100100

101-
:param column: a QgsComposerTableColumn
101+
:param column: a :py:class:`QgsComposerTableColumn`
102102

103103
.. versionadded:: 2.3
104104

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

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

113-
:param column: a QgsComposerTableColumn
113+
:param column: a :py:class:`QgsComposerTableColumn`
114114
:param order: sort order for column
115115

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

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

128-
:param column: a QgsComposerTableColumn
128+
:param column: a :py:class:`QgsComposerTableColumn`
129129

130130
.. versionadded:: 2.3
131131

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

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

139-
:param column: a QgsComposerTableColumn
139+
:param column: a :py:class:`QgsComposerTableColumn`
140140
:param direction: direction to move the column in the sort rank list
141141

142142
.. versionadded:: 2.3
@@ -167,7 +167,7 @@ Allows for filtering QgsComposerAttributeTable columns by columns which are sort
167167

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

172172
:param composerTable: QgsComposerAttributeTable the model is attached to
173173
: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.
220220
Returns the QgsComposerTableColumn corresponding to an index from the source
221221
QgsComposerAttributeTableColumnModel model.
222222

223-
:return: QgsComposerTableColumn for specified index from QgsComposerAttributeTableColumnModel
223+
:return: QgsComposerTableColumn for specified index from :py:class:`QgsComposerAttributeTableColumnModel`
224224

225225
:param sourceIndex: a QModelIndex
226226

python/core/composer/qgscomposermapgrid.sip

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ should be called for the QgsComposerMap to prevent rendering artifacts
5252

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

5757
:param gridId: id for the QgsComposerMapGrid to remove
5858

@@ -179,7 +179,7 @@ class QgsComposerMapGrid : QgsComposerMapItem
179179
{
180180
%Docstring
181181
An individual grid which is drawn above the map content in a
182-
QgsComposerMap.
182+
:py:class:`QgsComposerMap`.
183183

184184
.. versionadded:: 2.5
185185

python/core/composer/qgscomposermapitem.sip

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ class QgsComposerMapItemStack
139139
{
140140
%Docstring
141141
A collection of map items which are drawn above the map content in a
142-
QgsComposerMap. The item stack controls which items are drawn and the
142+
:py:class:`QgsComposerMap`. The item stack controls which items are drawn and the
143143
order they are drawn in.
144144

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

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

232232
:param itemId: id for the QgsComposerMapItem to remove
233233

0 commit comments

Comments
 (0)