Skip to content

Commit

Permalink
more doc
Browse files Browse the repository at this point in the history
  • Loading branch information
3nids committed Oct 4, 2018
1 parent 2b4de28 commit 046f915
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 3 deletions.
4 changes: 3 additions & 1 deletion python/gui/auto_generated/qgisinterface.sip.in
Expand Up @@ -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
Expand Down
6 changes: 5 additions & 1 deletion src/app/qgisapp.h
Expand Up @@ -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:
Expand Down
4 changes: 3 additions & 1 deletion src/gui/qgisinterface.h
Expand Up @@ -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 );}
Expand Down

0 comments on commit 046f915

Please sign in to comment.