Skip to content
Permalink
Browse files

Newer doxygen versions don't auto convert the first line in a class'

documentation to a brief note, so we have to do it explicitly...

(cherry picked from commit 7dfef3a)
  • Loading branch information
nyalldawson committed Feb 19, 2021
1 parent 6768520 commit 6155c116643b4553231ee06b1874773d05800288
Showing 575 changed files with 1,105 additions and 861 deletions.
@@ -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
@@ -18,7 +18,7 @@
class Qgs3DMapSettings : QObject, QgsTemporalRangeObject
{
%Docstring
Definition of the world
Definition of the world.

.. versionadded:: 3.0
%End
@@ -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
@@ -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
@@ -17,7 +17,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::

@@ -33,7 +33,9 @@ Constructor for 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
@@ -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
@@ -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
@@ -11,6 +11,9 @@

class QgsHillshadeFilter: QgsDerivativeFilter
{
%Docstring
A hillshade filter.
%End

%TypeHeaderCode
#include "qgshillshadefilter.h"
@@ -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
@@ -12,6 +12,9 @@

class QgsRasterCalcNode
{
%Docstring
Represents a node in a raster calculator.
%End

%TypeHeaderCode
#include "qgsrastercalcnode.h"
@@ -11,6 +11,9 @@

class QgsRasterMatrix
{
%Docstring
Represents a matrix in a raster calculator operation.
%End

%TypeHeaderCode
#include "qgsrastermatrix.h"
@@ -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).
@@ -13,6 +13,9 @@

class QgsHistogramDiagram: QgsDiagram /NoDefaultCtors/
{
%Docstring
A histogram style diagram.
%End

%TypeHeaderCode
#include "qgshistogramdiagram.h"
@@ -11,6 +11,9 @@

class QgsPieDiagram: QgsDiagram /NoDefaultCtors/
{
%Docstring
A pie chart diagram.
%End

%TypeHeaderCode
#include "qgspiediagram.h"
@@ -11,6 +11,9 @@

class QgsTextDiagram: QgsDiagram /NoDefaultCtors/
{
%Docstring
A text based diagram.
%End

%TypeHeaderCode
#include "qgstextdiagram.h"
@@ -16,6 +16,9 @@

class QgsDxfExport
{
%Docstring
Exports QGIS layers to the DXF format.
%End

%TypeHeaderCode
#include "qgsdxfexport.h"
@@ -11,6 +11,7 @@ class QgsDateTimeFieldFormatter : QgsFieldFormatter
{
%Docstring
Field formatter for a date time field.

This represents a date, time or datetime value based on
the field configuration.

@@ -11,6 +11,7 @@ class QgsFallbackFieldFormatter : QgsFieldFormatter
{
%Docstring
A default fallback field formatter in case no specialized field formatter is defined.

The values will be returned unmodified.

.. versionadded:: 3.0
@@ -11,6 +11,7 @@ class QgsKeyValueFieldFormatter : QgsFieldFormatter
{
%Docstring
Field formatter for a key value field.

This represents a list type value.
Values will be represented as a colon-delimited and
comma-separated list.
@@ -11,6 +11,7 @@ class QgsListFieldFormatter : QgsFieldFormatter
{
%Docstring
Field formatter for a list field.

This represents a list type value.
Values will be represented as a comma-separated list.

@@ -10,7 +10,7 @@
class QgsRangeFieldFormatter : QgsFieldFormatter
{
%Docstring
Field formatter for a range (double) field with precision and locale
Field formatter for a range (double) field with precision and locale.

.. versionadded:: 3.0
%End
@@ -11,6 +11,7 @@ class QgsRelationReferenceFieldFormatter : QgsFieldFormatter
{
%Docstring
Field formatter for a relation reference field.

A value relation field formatter looks up the values from
features on another layer.

@@ -11,6 +11,7 @@ class QgsValueMapFieldFormatter : QgsFieldFormatter
{
%Docstring
Field formatter for a ValueMap field.

A value relation field formatter looks up the values a map.

The map is defined in the configuration as dictionary under the key "map".
@@ -13,6 +13,7 @@ class QgsValueRelationFieldFormatter : QgsFieldFormatter
{
%Docstring
Field formatter for a value relation field.

A value relation field formatter looks up the values from
features on another layer.

@@ -1960,6 +1960,9 @@ and the interior rings in a counter-clockwise direction.

class Error
{
%Docstring
A geometry error.
%End

%TypeHeaderCode
#include "qgsgeometry.h"
@@ -14,6 +14,7 @@ class QgsQuadrilateral
{
%Docstring
Quadrilateral geometry type.

A quadrilateral is a polygon with four edges (or sides) and four vertices or corners.
This class allows the creation of simple quadrilateral (which does not self-intersect).

@@ -12,6 +12,9 @@

class QgsSurface: QgsAbstractGeometry
{
%Docstring
Surface geometry type.
%End

%TypeHeaderCode
#include "qgssurface.h"
@@ -11,6 +11,9 @@

class QgsWkbPtr
{
%Docstring
WKB pointer handler.
%End

%TypeHeaderCode
#include "qgswkbptr.h"
@@ -30,6 +33,9 @@ class QgsWkbPtr

class QgsConstWkbPtr
{
%Docstring
A const WKB pointer.
%End

%TypeHeaderCode
#include "qgswkbptr.h"
@@ -18,6 +18,7 @@
class QgsQtLocationConnection: QgsGpsConnection
{
%Docstring
A GPS connection subclass based on the Qt Location libraries.

.. note::

@@ -14,6 +14,9 @@

class QgsLabelPosition
{
%Docstring
Represents the calculated placement of a map label.
%End

%TypeHeaderCode
#include "qgspallabeling.h"
@@ -79,6 +82,9 @@ Constructor for QgsLabelPosition

class QgsPalLayerSettings
{
%Docstring
Contains settings for how a map layer will be labeled.
%End

%TypeHeaderCode
#include "qgspallabeling.h"
@@ -723,6 +729,9 @@ Returns a pixmap preview for label ``settings``.

class QgsLabelCandidate
{
%Docstring
Represents a label candidate.
%End

%TypeHeaderCode
#include "qgspallabeling.h"
@@ -775,6 +784,9 @@ Sets the map ``settings`` associated with the labeling run.

class QgsPalLabeling
{
%Docstring
PAL labeling utilities.
%End

%TypeHeaderCode
#include "qgspallabeling.h"
@@ -13,6 +13,7 @@
class QgsRuleBasedLabeling : QgsAbstractVectorLayerLabeling
{
%Docstring
Rule based labeling for a vector layer.

.. versionadded:: 3.0
%End
@@ -27,6 +28,7 @@ class QgsRuleBasedLabeling : QgsAbstractVectorLayerLabeling
class Rule
{
%Docstring
A child rule for QgsRuleBasedLabeling.

.. versionadded:: 3.0
%End
@@ -14,6 +14,7 @@ class QgsLayerTreeFilterProxyModel : QSortFilterProxyModel
{
%Docstring
QgsLayerTreeFilterProxyModel is a sort filter proxy model to easily reproduce the legend/layer tree in a tree view.

Layers are checkable by default.
Symbology nodes will not be shown.
Layers can be filtered by their type.
@@ -14,6 +14,7 @@ class QgsLayerTreeModel : QAbstractItemModel
{
%Docstring
The QgsLayerTreeModel class is model implementation for Qt item views framework.

The model can be used in any QTreeView, it is however recommended to use it
with QgsLayerTreeView which brings additional functionality specific to layer tree handling.

@@ -15,6 +15,7 @@ class QgsLayerTreeNode : QObject
{
%Docstring
This class is a base class for nodes in a layer tree.

Layer tree is a hierarchical structure consisting of group and layer nodes:

- group nodes are containers and may contain children (layer and group nodes)
@@ -14,6 +14,7 @@ class QgsLayoutTableColumn
{
%Docstring
Stores properties of a column for a QgsLayoutTable.

Some properties of a QgsLayoutTableColumn are applicable only in certain contexts.
For instance, the attribute and setAttribute methods only have an effect
for QgsLayoutItemAttributeTables, and have no effect for QgsLayoutItemTextTables.

0 comments on commit 6155c11

Please sign in to comment.