Skip to content
Permalink
Browse files

More doxy nonsense, pt 2

(cherry picked from commit 7b2fc4c)
  • Loading branch information
elpaso authored and nyalldawson committed Feb 19, 2021
1 parent 6155c11 commit 5d701acbccbaa7f8506fc9824ac5e61007363c42
Showing 561 changed files with 846 additions and 818 deletions.
@@ -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
@@ -13,7 +13,7 @@
class QgsCubicRasterResampler: QgsRasterResamplerV2
{
%Docstring
Cubic Raster Resampler
Cubic Raster Resampler.
%End

%TypeHeaderCode
@@ -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.
@@ -15,7 +15,9 @@
class QgsSvgCache : QgsAbstractContentCacheBase
{
%Docstring
A cache for images / pictures derived from svg files. This class supports parameter replacement in svg files
A cache for images / pictures derived from svg files.

This class supports parameter replacement in svg files
according to the svg params specification (http://www.w3.org/TR/2009/WD-SVGParamPrimer-20090616/). Supported are
the parameters 'fill-color', 'pen-color', 'outline-width', 'stroke-width'. E.g. <circle fill="param(fill-color red)" stroke="param(pen-color black)" stroke-width="param(outline-width 1)"

@@ -13,7 +13,6 @@
class QgsProcessingContextGenerator
{
%Docstring

An interface for objects which can create Processing contexts.

.. versionadded:: 3.4
@@ -14,7 +14,7 @@ class QgsDoubleValidator : QRegularExpressionValidator
%Docstring

QgsDoubleValidator is a QLineEdit Validator that combines QDoubleValidator
and QRegularExpressionValidator to allow user to enter double with both
and QRegularExpressionValidator to allow users to enter doubles with both
local and C interpretation as a fallback.

.. versionadded:: 3.14
@@ -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
@@ -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
*/
@@ -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
@@ -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
{
@@ -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
{
@@ -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
@@ -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
@@ -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
@@ -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
*/

@@ -26,7 +26,7 @@ class QgsTemporalController;

/**
* \ingroup app
* The QgsTemporalControllerDockWidget class
* \brief The QgsTemporalControllerDockWidget class
*
* \since QGIS 3.14
*/
@@ -3106,7 +3106,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
*/
@@ -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
@@ -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
*/
@@ -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
@@ -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
@@ -33,7 +33,7 @@ class QVariant;
/**
* \ingroup core
*
* Closes a sqlite3 database.
* \brief Closes a sqlite3 database.
*
* \since QGIS 3.0
*/
@@ -61,7 +61,7 @@ struct CORE_EXPORT QgsSqlite3StatementFinalizer
/**
* \ingroup core
*
* Unique pointer for sqlite3 prepared statements, which automatically finalizes
* \brief Unique pointer for sqlite3 prepared statements, which automatically finalizes
* the statement when the pointer goes out of scope or is reset.
*
* \since QGIS 3.0
@@ -110,7 +110,7 @@ class CORE_EXPORT sqlite3_statement_unique_ptr : public std::unique_ptr< sqlite3
/**
* \ingroup core
*
* Unique pointer for sqlite3 databases, which automatically closes
* \brief Unique pointer for sqlite3 databases, which automatically closes
* the database when the pointer goes out of scope or is reset.
*
* \since QGIS 3.0
@@ -212,8 +212,8 @@ void QgsSQLStatement::RecursiveVisitor::visit( const QgsSQLStatement::NodeJoin &

/**
* \ingroup core
* Internal use.
* \note not available in Python bindings
* \brief Internal use.
* \note not available in Python bindings
*/
class QgsSQLStatementCollectTableNames: public QgsSQLStatement::RecursiveVisitor
{

0 comments on commit 5d701ac

Please sign in to comment.