Fix formatting in pyqgis documentation (#9396)

* Fix API documentation * Fix sip doc
qgis · Mar 6, 2019 · 53a717a · 53a717a
1 parent 288b5c1
commit 53a717a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/python/gui/auto_generated/qgisinterface.sip.in b/python/gui/auto_generated/qgisinterface.sip.in
@@ -615,8 +615,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 user documentation
-@param saveDirectory path where the screenshots will be saved
-@param categories an int as a flag value of QgsAppScreenShots.Categories
+
+:param saveDirectory: path where the screenshots will be saved
+:param categories: an int as a flag value of QgsAppScreenShots.Categories
 
 .. versionadded:: 3.4
 %End

diff --git a/src/gui/qgisinterface.h b/src/gui/qgisinterface.h
@@ -543,8 +543,9 @@ class GUI_EXPORT QgisInterface : public QObject
 
     /**
      * Take screenshots for user documentation
-     * @param saveDirectory path where the screenshots will be saved
-     * @param categories an int as a flag value of QgsAppScreenShots::Categories
+     *
+     * \param saveDirectory path where 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 );}