Skip to content

Commit 8b5bf3c

Browse files
committed
Remove some redundant dox from QgisAppInterface
1 parent 9050319 commit 8b5bf3c

File tree

3 files changed

+44
-303
lines changed

3 files changed

+44
-303
lines changed

python/gui/auto_generated/qgisinterface.sip.in

+13-12
Original file line numberDiff line numberDiff line change
@@ -614,51 +614,51 @@ Take screenshots for user documentation
614614

615615
virtual void zoomFull() = 0;
616616
%Docstring
617-
Zoom to full extent of map layers
617+
Zooms to the full extent of all map layers.
618618
%End
619619

620620
virtual void zoomToPrevious() = 0;
621621
%Docstring
622-
Zoom to previous view extent
622+
Zooms to the previous view extent.
623623
%End
624624

625625
virtual void zoomToNext() = 0;
626626
%Docstring
627-
Zoom to next view extent
627+
Zooms to the next view extent.
628628
%End
629629

630630
virtual void zoomToActiveLayer() = 0;
631631
%Docstring
632-
Zoom to extent of the active layer
632+
Zooms to extent of the active layer.
633633
%End
634634

635635
virtual QgsVectorLayer *addVectorLayer( const QString &vectorLayerPath, const QString &baseName, const QString &providerKey ) = 0;
636636
%Docstring
637-
Add a vector layer
637+
Adds a vector layer to the current project.
638638
%End
639639

640640
virtual QgsRasterLayer *addRasterLayer( const QString &rasterLayerPath, const QString &baseName = QString() ) = 0;
641641
%Docstring
642-
Add a raster layer given a raster layer file name
642+
Adds a raster layer to the current project, given a raster layer file name.
643643
%End
644644

645645
virtual QgsRasterLayer *addRasterLayer( const QString &url, const QString &layerName, const QString &providerKey ) = 0;
646646
%Docstring
647-
Add a WMS layer
647+
Adds a raster layer to the current project, from the specified raster data provider.
648648
%End
649649

650650
virtual QgsMeshLayer *addMeshLayer( const QString &url, const QString &baseName, const QString &providerKey ) = 0;
651651
%Docstring
652-
Add a mesh layer
652+
Adds a mesh layer to the current project.
653653
%End
654654

655655
virtual bool addProject( const QString &project ) = 0;
656656
%Docstring
657-
Add a project
657+
Adds (opens) a project
658658
%End
659659
virtual void newProject( bool promptToSaveFlag = false ) = 0;
660660
%Docstring
661-
Start a blank project
661+
Starts a new blank project
662662
%End
663663

664664
virtual void reloadConnections( ) = 0;
@@ -810,7 +810,7 @@ Add a toolbar
810810

811811
virtual void openMessageLog() = 0;
812812
%Docstring
813-
Open the message log dock widget *
813+
Opens the message log dock widget.
814814
%End
815815

816816
virtual void addUserInputWidget( QWidget *widget ) = 0;
@@ -1065,7 +1065,8 @@ QGIS documentation, set useQgisDocDirectory to false.
10651065

10661066
virtual bool openFeatureForm( QgsVectorLayer *l, QgsFeature &f, bool updateFeatureOnly = false, bool showModal = true ) = 0;
10671067
%Docstring
1068-
Open feature form
1068+
Open feature form.
1069+
Returns true if dialog was accepted (if shown modal, true otherwise).
10691070

10701071
:param l: vector layer
10711072
:param f: feature to show/modify

0 commit comments

Comments
 (0)