more doc

qgis · Oct 4, 2018 · 046f915 · 046f915
1 parent 2b4de28
commit 046f915
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/python/gui/auto_generated/qgisinterface.sip.in b/python/gui/auto_generated/qgisinterface.sip.in
@@ -602,7 +602,9 @@ status bar (do not use the native Qt statusBar() method).
 
     virtual void takeAppScreenShots( const QString &saveDirectory, const int categories = 0 );
 %Docstring
-Take screenshots for the user documentation
+Take screenshots for user documentation
+@param saveDirectory path were the screenshots will be saved
+@param categories an int as a flag value of QgsAppScreenShots.Categories
 
 .. versionadded:: 3.4
 %End

diff --git a/src/app/qgisapp.h b/src/app/qgisapp.h
@@ -696,7 +696,11 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
     //! Returns pointer to the identify map tool - used by identify tool in 3D view
     QgsMapToolIdentifyAction *identifyMapTool() const { return mMapTools.mIdentify; }
 
-    //! Take screenshots for user documentation
+    /**
+     * Take screenshots for user documentation
+     * @param saveDirectory path were the screenshots will be saved
+     * @param categories an int as a flag value of QgsAppScreenShots::Categories
+     */
     void takeAppScreenShots( const QString &saveDirectory, const int categories = 0 );
 
   public slots:

diff --git a/src/gui/qgisinterface.h b/src/gui/qgisinterface.h
@@ -529,7 +529,9 @@ class GUI_EXPORT QgisInterface : public QObject
     virtual QgsStatusBar *statusBarIface() = 0;
 
     /**
-     * Take screenshots for the user documentation
+     * Take screenshots for user documentation
+     * @param saveDirectory path were the screenshots will be saved
+     * @param categories an int as a flag value of QgsAppScreenShots::Categories
      * \since QGIS 3.4
      */
     virtual void takeAppScreenShots( const QString &saveDirectory, const int categories = 0 ) {Q_UNUSED( saveDirectory ); Q_UNUSED( categories );}