Skip to content

Commit 046f915

Browse files
committed
more doc
1 parent 2b4de28 commit 046f915

File tree

3 files changed

+11
-3
lines changed

3 files changed

+11
-3
lines changed

python/gui/auto_generated/qgisinterface.sip.in

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -602,7 +602,9 @@ status bar (do not use the native Qt statusBar() method).
602602

603603
virtual void takeAppScreenShots( const QString &saveDirectory, const int categories = 0 );
604604
%Docstring
605-
Take screenshots for the user documentation
605+
Take screenshots for user documentation
606+
@param saveDirectory path were the screenshots will be saved
607+
@param categories an int as a flag value of QgsAppScreenShots.Categories
606608

607609
.. versionadded:: 3.4
608610
%End

src/app/qgisapp.h

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -696,7 +696,11 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
696696
//! Returns pointer to the identify map tool - used by identify tool in 3D view
697697
QgsMapToolIdentifyAction *identifyMapTool() const { return mMapTools.mIdentify; }
698698

699-
//! Take screenshots for user documentation
699+
/**
700+
* Take screenshots for user documentation
701+
* @param saveDirectory path were the screenshots will be saved
702+
* @param categories an int as a flag value of QgsAppScreenShots::Categories
703+
*/
700704
void takeAppScreenShots( const QString &saveDirectory, const int categories = 0 );
701705

702706
public slots:

src/gui/qgisinterface.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -529,7 +529,9 @@ class GUI_EXPORT QgisInterface : public QObject
529529
virtual QgsStatusBar *statusBarIface() = 0;
530530

531531
/**
532-
* Take screenshots for the user documentation
532+
* Take screenshots for user documentation
533+
* @param saveDirectory path were the screenshots will be saved
534+
* @param categories an int as a flag value of QgsAppScreenShots::Categories
533535
* \since QGIS 3.4
534536
*/
535537
virtual void takeAppScreenShots( const QString &saveDirectory, const int categories = 0 ) {Q_UNUSED( saveDirectory ); Q_UNUSED( categories );}

0 commit comments

Comments
 (0)