More doxy nonsense, pt 2

qgis · Feb 18, 2021 · 7b2fc4c · 7b2fc4c
1 parent 7dfef3a
commit 7b2fc4c
Show file tree

Hide file tree

Showing 593 changed files with 906 additions and 849 deletions.
diff --git a/python/3d/auto_generated/qgs3dmapexportsettings.sip.in b/python/3d/auto_generated/qgs3dmapexportsettings.sip.in
@@ -12,7 +12,6 @@
 class Qgs3DMapExportSettings
 {
 %Docstring
-The Qgs3DMapExportSettings class
 Manages the various settings the user can choose from when exporting a 3D scene
 
 .. versionadded:: 3.16

diff --git a/python/3d/auto_generated/qgs3dmapsettings.sip.in b/python/3d/auto_generated/qgs3dmapsettings.sip.in
@@ -18,7 +18,7 @@
 class Qgs3DMapSettings : QObject, QgsTemporalRangeObject
 {
 %Docstring
-Definition of the world
+Definition of the world.
 
 .. versionadded:: 3.0
 %End

diff --git a/python/3d/auto_generated/qgscamerapose.sip.in b/python/3d/auto_generated/qgscamerapose.sip.in
@@ -14,7 +14,9 @@
 class QgsCameraPose
 {
 %Docstring
-Class that encapsulates camera pose in a 3D scene. The pose is defined with the following parameters:
+Class that encapsulates camera pose in a 3D scene.
+
+The pose is defined with the following parameters:
 
 - center point - towards which point the camera is looking
 - distance from the center point - how far is the camera from the point towards which it is looking

diff --git a/python/3d/auto_generated/qgsrulebased3drenderer.sip.in b/python/3d/auto_generated/qgsrulebased3drenderer.sip.in
@@ -65,6 +65,7 @@ Similar to rule-based 2D renderer and rule-based labeling, it allows specificati
     class Rule
 {
 %Docstring
+A child rule for a QgsRuleBased3DRenderer
 
 .. versionadded:: 3.6
 %End

diff --git a/python/3d/auto_generated/qgsvectorlayer3drenderer.sip.in b/python/3d/auto_generated/qgsvectorlayer3drenderer.sip.in
@@ -16,7 +16,7 @@
 class QgsVectorLayer3DRendererMetadata : Qgs3DRendererAbstractMetadata
 {
 %Docstring
-Metadata for vector layer 3D renderer to allow creation of its instances from XML
+Metadata for vector layer 3D renderer to allow creation of its instances from XML.
 
 .. warning::
 

diff --git a/python/analysis/auto_generated/interpolation/qgsinterpolator.sip.in b/python/analysis/auto_generated/interpolation/qgsinterpolator.sip.in
@@ -33,7 +33,9 @@ Constructor for :py:class:`QgsInterpolatorVertexData`
 class QgsInterpolator
 {
 %Docstring
-Interface class for interpolations. Interpolators take
+Interface class for interpolations.
+
+Interpolators take
 the vertices of a vector layer as base data. The z-Value
 can be an attribute or the z-coordinates in case of 3D types.
 %End

diff --git a/python/analysis/auto_generated/raster/qgsaspectfilter.sip.in b/python/analysis/auto_generated/raster/qgsaspectfilter.sip.in
@@ -12,7 +12,9 @@
 class QgsAspectFilter: QgsDerivativeFilter
 {
 %Docstring
-Calculates aspect values in a window of 3x3 cells based on first order derivatives in x- and y- directions. Direction is clockwise starting from north.
+Calculates aspect values in a window of 3x3 cells based on first order derivatives in x- and y- directions.
+
+Direction is clockwise starting from north.
 %End
 
 %TypeHeaderCode

diff --git a/python/analysis/auto_generated/raster/qgsderivativefilter.sip.in b/python/analysis/auto_generated/raster/qgsderivativefilter.sip.in
@@ -12,7 +12,9 @@
 class QgsDerivativeFilter : QgsNineCellFilter
 {
 %Docstring
-Adds the ability to calculate derivatives in x- and y-directions. Needs to be subclassed (e.g. for slope and aspect).
+Adds the ability to calculate derivatives in x- and y-directions.
+
+Needs to be subclassed (e.g. for slope and aspect).
 %End
 
 %TypeHeaderCode

diff --git a/python/analysis/auto_generated/raster/qgshillshadefilter.sip.in b/python/analysis/auto_generated/raster/qgshillshadefilter.sip.in
@@ -11,6 +11,9 @@
 
 class QgsHillshadeFilter: QgsDerivativeFilter
 {
+%Docstring
+A hillshade filter.
+%End
 
 %TypeHeaderCode
 #include "qgshillshadefilter.h"

diff --git a/python/analysis/auto_generated/raster/qgsninecellfilter.sip.in b/python/analysis/auto_generated/raster/qgsninecellfilter.sip.in
@@ -10,13 +10,13 @@
 
 
 
-
 class QgsNineCellFilter
 {
 %Docstring
 Base class for raster analysis methods that work with a 3x3 cell filter and calculate the value of each cell based on
-the cell value and the eight neighbour cells. Common examples are slope and aspect calculation in DEMs. Subclasses only implement
-the method that calculates the new value from the nine values. Everything else (reading file, writing file) is done by this subclass*
+the cell value and the eight neighbour cells.
+Common examples are slope and aspect calculation in DEMs. Subclasses only implement
+the method that calculates the new value from the nine values. Everything else (reading file, writing file) is done by this subclass
 %End
 
 %TypeHeaderCode

diff --git a/python/analysis/auto_generated/raster/qgsrastercalcnode.sip.in b/python/analysis/auto_generated/raster/qgsrastercalcnode.sip.in
@@ -12,6 +12,9 @@
 
 class QgsRasterCalcNode
 {
+%Docstring
+Represents a node in a raster calculator.
+%End
 
 %TypeHeaderCode
 #include "qgsrastercalcnode.h"

diff --git a/python/analysis/auto_generated/raster/qgsrastermatrix.sip.in b/python/analysis/auto_generated/raster/qgsrastermatrix.sip.in
@@ -11,6 +11,9 @@
 
 class QgsRasterMatrix
 {
+%Docstring
+Represents a matrix in a raster calculator operation.
+%End
 
 %TypeHeaderCode
 #include "qgsrastermatrix.h"

diff --git a/python/analysis/auto_generated/vector/qgsgeometrysnappersinglesource.sip.in b/python/analysis/auto_generated/vector/qgsgeometrysnappersinglesource.sip.in
@@ -14,6 +14,7 @@ class QgsGeometrySnapperSingleSource
 %Docstring
 
 Makes sure that any two vertices of the vector layer are at least at distance given by the threshold value.
+
 The algorithm moves nearby vertices to one location and adds vertices to segments that are passing around other
 vertices within the threshold. It does not remove any vertices. Also, it does not modify geometries unless
 needed (it does not snap coordinates to a grid).

diff --git a/python/core/auto_generated/diagram/qgshistogramdiagram.sip.in b/python/core/auto_generated/diagram/qgshistogramdiagram.sip.in
@@ -13,6 +13,9 @@
 
 class QgsHistogramDiagram: QgsDiagram /NoDefaultCtors/
 {
+%Docstring
+A histogram style diagram.
+%End
 
 %TypeHeaderCode
 #include "qgshistogramdiagram.h"

diff --git a/python/core/auto_generated/diagram/qgspiediagram.sip.in b/python/core/auto_generated/diagram/qgspiediagram.sip.in
@@ -11,6 +11,9 @@
 
 class QgsPieDiagram: QgsDiagram /NoDefaultCtors/
 {
+%Docstring
+A pie chart diagram.
+%End
 
 %TypeHeaderCode
 #include "qgspiediagram.h"

diff --git a/python/core/auto_generated/diagram/qgstextdiagram.sip.in b/python/core/auto_generated/diagram/qgstextdiagram.sip.in
@@ -11,6 +11,9 @@
 
 class QgsTextDiagram: QgsDiagram /NoDefaultCtors/
 {
+%Docstring
+A text based diagram.
+%End
 
 %TypeHeaderCode
 #include "qgstextdiagram.h"

diff --git a/python/core/auto_generated/dxf/qgsdxfexport.sip.in b/python/core/auto_generated/dxf/qgsdxfexport.sip.in
@@ -16,6 +16,9 @@
 
 class QgsDxfExport
 {
+%Docstring
+Exports QGIS layers to the DXF format.
+%End
 
 %TypeHeaderCode
 #include "qgsdxfexport.h"

diff --git a/python/core/auto_generated/editform/qgseditformconfig.sip.in b/python/core/auto_generated/editform/qgseditformconfig.sip.in
@@ -13,6 +13,9 @@
 
 class QgsEditFormConfig
 {
+%Docstring
+Contains configuration settings for an editor form.
+%End
 
 %TypeHeaderCode
 #include "qgseditformconfig.h"

diff --git a/python/core/auto_generated/qgstiles.sip.in b/python/core/auto_generated/qgstiles.sip.in
@@ -94,7 +94,7 @@ Returns index of the last row in the range
 class QgsTileMatrix
 {
 %Docstring
-Defines a matrix of tiles for a single zoom level: it is defined by its size (width * height)
+Defines a matrix of tiles for a single zoom level: it is defined by its size (width * \brief height)
 and map extent that it covers.
 
 Please note that we follow the XYZ convention of X/Y axes, i.e. top-left tile has [0,0] coordinate

diff --git a/python/core/auto_generated/raster/qgscubicrasterresampler.sip.in b/python/core/auto_generated/raster/qgscubicrasterresampler.sip.in
@@ -13,7 +13,7 @@
 class QgsCubicRasterResampler: QgsRasterResamplerV2
 {
 %Docstring
-Cubic Raster Resampler
+Cubic Raster Resampler.
 %End
 
 %TypeHeaderCode

diff --git a/python/core/auto_generated/symbology/qgsrulebasedrenderer.sip.in b/python/core/auto_generated/symbology/qgsrulebasedrenderer.sip.in
@@ -14,6 +14,8 @@
 class QgsRuleBasedRenderer : QgsFeatureRenderer
 {
 %Docstring
+Rule based renderer.
+
 When drawing a vector layer with rule-based renderer, it goes through
 the rules and draws features with symbols from rules that match.
 %End
@@ -72,6 +74,7 @@ Feature to render
 {
 %Docstring
 This class keeps data about a rules for rule-based renderer.
+
 A rule consists of a symbol, filter expression and range of scales.
 If filter is empty, it matches all features.
 If scale range has both values zero, it matches all scales.

diff --git a/python/gui/auto_generated/processing/qgsprocessingwidgetwrapper.sip.in b/python/gui/auto_generated/processing/qgsprocessingwidgetwrapper.sip.in
@@ -13,7 +13,6 @@
 class QgsProcessingContextGenerator
 {
 %Docstring
-
 An interface for objects which can create Processing contexts.
 
 .. versionadded:: 3.4

diff --git a/python/gui/auto_generated/symbology/qgsrendererwidget.sip.in b/python/gui/auto_generated/symbology/qgsrendererwidget.sip.in
@@ -11,7 +11,7 @@
 class QgsRendererWidget : QgsPanelWidget
 {
 %Docstring
-Base class for renderer settings widgets
+Base class for renderer settings widgets.
 
 WORKFLOW:
 - open renderer dialog with some RENDERER  (never null!)
@@ -161,7 +161,7 @@ This can be overwritten in subclasses.
 class QgsDataDefinedValueDialog : QDialog
 {
 %Docstring
-Utility classes for "en masse" size definition
+Utility classes for "en masse" size definition.
 %End
 
 %TypeHeaderCode

diff --git a/src/3d/qgsrulebased3drenderer.h b/src/3d/qgsrulebased3drenderer.h
@@ -68,7 +68,6 @@ class _3D_EXPORT QgsRuleBased3DRenderer : public QgsAbstractVectorLayer3DRendere
 
     /**
      * \ingroup 3d
-     * \class QgsRuleBased3DRenderer::Rule
      * \brief A child rule for a QgsRuleBased3DRenderer
      * \since QGIS 3.6
      */

diff --git a/src/app/devtools/qgsappdevtoolutils.h b/src/app/devtools/qgsappdevtoolutils.h
@@ -22,7 +22,7 @@ class QgsDevToolWidgetFactory;
 /**
  * \ingroup app
  *
- * Manages lifetime of a QgsDevToolWidgetFactory, automatically
+ * \brief Manages lifetime of a QgsDevToolWidgetFactory, automatically
  * registering and unregistering it as required.
  *
  * \since QGIS 3.14

diff --git a/src/app/gps/qgsgpsbearingitem.h b/src/app/gps/qgsgpsbearingitem.h
@@ -25,7 +25,7 @@ class QgsLineSymbol;
 
 /**
  * \ingroup app
- * A canvas item for showing the bearing of the GPS device
+ * \brief A canvas item for showing the bearing of the GPS device
  */
 class QgsGpsBearingItem : public QObject, public QgsMapCanvasLineSymbolItem
 {

diff --git a/src/app/gps/qgsgpsmarker.h b/src/app/gps/qgsgpsmarker.h
@@ -25,7 +25,7 @@ class QPainter;
 
 /**
  * \ingroup app
- * A class for marking the position of a gps pointer.
+ * \brief A class for marking the position of a gps pointer.
  */
 class QgsGpsMarker : public QgsMapCanvasItem
 {

diff --git a/src/app/locator/qgslocatoroptionswidget.h b/src/app/locator/qgslocatoroptionswidget.h
@@ -55,7 +55,7 @@ class QgsLocatorOptionsWidget : public QTreeView
 /**
  * \class QgsLocatorFiltersModel
  * \ingroup app
- * An list model for displaying available filters and configuring them.
+ * \brief An list model for displaying available filters and configuring them.
  * \since QGIS 3.0
  */
 class QgsLocatorFiltersModel : public QAbstractTableModel

diff --git a/src/app/options/qgsoptionsutils.h b/src/app/options/qgsoptionsutils.h
@@ -21,7 +21,7 @@ class QgsOptionsWidgetFactory;
 /**
  * \ingroup app
  *
- * Manages lifetime of a QgsOptionsWidgetFactory, automatically
+ * \brief Manages lifetime of a QgsOptionsWidgetFactory, automatically
  * registering and unregistering it as required.
  *
  * \since QGIS 3.16

diff --git a/src/app/pluginmanager/qgsapppluginmanagerinterface.h b/src/app/pluginmanager/qgsapppluginmanagerinterface.h
@@ -23,7 +23,7 @@ class QgsPluginManager;
 
 /**
  * \ingroup gui
- * QgsPluginManagerInterface
+ * \brief QgsPluginManagerInterface
  * Abstract base class to make QgsPluginManager available to pyplugin_installer.
  */
 class QgsAppPluginManagerInterface : public QgsPluginManagerInterface

diff --git a/src/app/qgsselectbyformdialog.h b/src/app/qgsselectbyformdialog.h
@@ -28,7 +28,7 @@ class QgsMapCanvas;
 /**
  * \ingroup app
  * \class QgsSelectByFormDialog
- * A dialog for selecting features from a layer, using a form based off the layer's editor widgets.
+ * \brief A dialog for selecting features from a layer, using a form based off the layer's editor widgets.
  * \since QGIS 2.16
  */
 

diff --git a/src/app/qgstemporalcontrollerdockwidget.h b/src/app/qgstemporalcontrollerdockwidget.h
@@ -26,7 +26,7 @@ class QgsTemporalController;
 
 /**
  * \ingroup app
- * The QgsTemporalControllerDockWidget class
+ * \brief The QgsTemporalControllerDockWidget class
  *
  * \since QGIS 3.14
  */

diff --git a/src/core/network/qgsnetworkaccessmanager.h b/src/core/network/qgsnetworkaccessmanager.h
@@ -143,7 +143,7 @@ class QgsNetworkAccessManager;
  * \brief SSL error handler, used for responding to SSL errors encountered during network requests.
  * \ingroup core
  *
- * QgsSslErrorHandler responds to SSL errors encountered during network requests. The
+ * \brief QgsSslErrorHandler responds to SSL errors encountered during network requests. The
  * base QgsSslErrorHandler class responds to SSL errors only by logging the errors,
  * and uses the default Qt response, which is to abort the request.
  *
@@ -192,7 +192,7 @@ class CORE_EXPORT QgsSslErrorHandler
  * \brief Network authentication handler, used for responding to network authentication requests during network requests.
  * \ingroup core
  *
- * QgsNetworkAuthenticationHandler responds to authentication requests encountered during network requests. The
+ * \brief QgsNetworkAuthenticationHandler responds to authentication requests encountered during network requests. The
  * base QgsNetworkAuthenticationHandler class responds to requests only by logging the request,
  * but does not provide any username or password to allow the request to proceed.
  *
@@ -236,7 +236,7 @@ class CORE_EXPORT QgsNetworkAuthenticationHandler
  * \brief network access manager for QGIS
  * \ingroup core
  *
- * This class implements the QGIS network access manager.  It's a singleton
+ * \brief This class implements the QGIS network access manager.  It's a singleton
  * that can be used across QGIS.
  *
  * Plugins can insert proxy factories and thereby redirect requests to

diff --git a/src/core/processing/qgsprocessingparameters.h b/src/core/processing/qgsprocessingparameters.h
@@ -3163,7 +3163,7 @@ class CORE_EXPORT QgsProcessingParameterVectorDestination : public QgsProcessing
 /**
  * \class QgsProcessingParameterRasterDestination
  * \ingroup core
- * A raster layer destination parameter, for specifying the destination path for a raster layer
+ * \brief A raster layer destination parameter, for specifying the destination path for a raster layer
  * created by the algorithm.
   * \since QGIS 3.0
  */

diff --git a/src/core/qgsspatialindexkdbushdata.h b/src/core/qgsspatialindexkdbushdata.h
@@ -25,7 +25,7 @@
  * \class QgsSpatialIndexKDBushData
  * \ingroup core
  *
- * A container for data stored inside a QgsSpatialIndexKDBush index.
+ * \brief A container for data stored inside a QgsSpatialIndexKDBush index.
  *
  * \since QGIS 3.4
 */

diff --git a/src/core/qgsspatialindexutils.h b/src/core/qgsspatialindexutils.h
@@ -41,7 +41,7 @@ namespace SpatialIndex
  * \ingroup core
  * \class QgsSpatialIndexUtils
  *
- * Contains utility functions for working with spatial indexes.
+ * \brief Contains utility functions for working with spatial indexes.
  *
  * \note Not available in Python bindings.
  * \since QGIS 3.12

diff --git a/src/core/qgsspatialiteutils.h b/src/core/qgsspatialiteutils.h
@@ -27,7 +27,7 @@
 /**
  * \ingroup core
  *
- * Closes a spatialite database.
+ * \brief Closes a spatialite database.
  *
  * \since QGIS 3.0
  */
@@ -48,7 +48,7 @@ struct CORE_EXPORT QgsSpatialiteCloser
 /**
  * \ingroup core
  *
- * Unique pointer for spatialite databases, which automatically closes
+ * \brief Unique pointer for spatialite databases, which automatically closes
  * the database when the pointer goes out of scope or is reset.
  *
  * \since QGIS 3.0