Skip to content

Commit 53a717a

Browse files
DelazJ3nids
authored andcommitted
Fix formatting in pyqgis documentation (#9396)
* Fix API documentation * Fix sip doc
1 parent 288b5c1 commit 53a717a

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

python/gui/auto_generated/qgisinterface.sip.in

+3-2
Original file line numberDiff line numberDiff line change
@@ -615,8 +615,9 @@ status bar (do not use the native Qt statusBar() method).
615615
virtual void takeAppScreenShots( const QString &saveDirectory, const int categories = 0 );
616616
%Docstring
617617
Take screenshots for user documentation
618-
@param saveDirectory path where the screenshots will be saved
619-
@param categories an int as a flag value of QgsAppScreenShots.Categories
618+
619+
:param saveDirectory: path where the screenshots will be saved
620+
:param categories: an int as a flag value of QgsAppScreenShots.Categories
620621

621622
.. versionadded:: 3.4
622623
%End

src/gui/qgisinterface.h

+3-2
Original file line numberDiff line numberDiff line change
@@ -543,8 +543,9 @@ class GUI_EXPORT QgisInterface : public QObject
543543

544544
/**
545545
* Take screenshots for user documentation
546-
* @param saveDirectory path where the screenshots will be saved
547-
* @param categories an int as a flag value of QgsAppScreenShots::Categories
546+
*
547+
* \param saveDirectory path where the screenshots will be saved
548+
* \param categories an int as a flag value of QgsAppScreenShots::Categories
548549
* \since QGIS 3.4
549550
*/
550551
virtual void takeAppScreenShots( const QString &saveDirectory, const int categories = 0 ) {Q_UNUSED( saveDirectory ); Q_UNUSED( categories );}

0 commit comments

Comments
 (0)