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...
  • Loading branch information
nyalldawson committed Feb 18, 2021
1 parent bc55339 commit 7dfef3a0b12b489db6b9cda97a84790a03985aa6
Showing 606 changed files with 1,141 additions and 925 deletions.
@@ -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
:py:class:`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 :py:class:`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 :py:class:`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 :py:class:`QgsLayoutTable`.

Some properties of a :py:class:`QgsLayoutTableColumn` are applicable only in certain contexts.
For instance, the attribute and setAttribute methods only have an effect
for :py:class:`QgsLayoutItemAttributeTables`, and have no effect for :py:class:`QgsLayoutItemTextTables`.
@@ -54,9 +54,9 @@ class QgsMeshDatasetValue
{
%Docstring

:py:class:`QgsMeshDatasetValue` represents single dataset value
:py:class:`QgsMeshDatasetValue` represents single dataset value.

could be scalar or vector. Nodata values are represented by NaNs.
Values may be scalar or vector. Nodata values are represented by NaNs.

.. note::

@@ -249,7 +249,7 @@ class QgsMesh3dDataBlock
:py:class:`QgsMesh3dDataBlock` is a block of 3d stacked mesh data related N
faces defined on base mesh frame.

data are implicitly shared, so the class can be quickly copied
Data are implicitly shared, so the class can be quickly copied
std.numeric_limits<double>.quiet_NaN() represents NODATA value

.. note::
@@ -11,7 +11,8 @@
class QgsProcessingParameterMeshDatasetGroups : QgsProcessingParameterDefinition
{
%Docstring
A parameter for processing algorithms that need a list of mesh dataset groups
A parameter for processing algorithms that need a list of mesh dataset groups.

A valid value for this parameter is a list (QVariantList) of dataset groups index in the mesh layer scope
Dataset group index can be evaluated with the method :py:func:`~valueAsDatasetGroup`

@@ -81,7 +82,8 @@ Returns the ``value`` as a list if dataset group indexes
class QgsProcessingParameterMeshDatasetTime : QgsProcessingParameterDefinition
{
%Docstring
A parameter for processing algorithms that need a list of mesh dataset index from time parameter
A parameter for processing algorithms that need a list of mesh dataset index from time parameter.

A valid value for this parameter is a map (QVariantMap) with in this form:

- "type" : the type of time settings "current-context-time", "defined-date-time", "dataset-time-step" or "none" if all the dataset groups are static
@@ -3476,7 +3476,6 @@ class QgsProcessingParameterFolderDestination : QgsProcessingDestinationParamete
%Docstring
A folder destination parameter, for specifying the destination path for a folder created
by the algorithm or used for creating new files within the algorithm.
A folder output parameter.

.. versionadded:: 3.0
%End
@@ -11,7 +11,8 @@
class QgsProcessingParameterTinInputLayers: QgsProcessingParameterDefinition
{
%Docstring
A parameter for processing algorithms that need a list of input vector layers to construct a TIN
A parameter for processing algorithms that need a list of input vector layers to construct a TIN.

A valid value for this parameter is a list (QVariantList), where each item is a map (QVariantMap) in this form:
{
'source': string that represents identification of the vector layer,
@@ -12,8 +12,9 @@
class QgsProcessingProvider : QObject
{
%Docstring
Abstract base class for processing providers. An algorithm provider is a set of
related algorithms, typically from the same external application or related
Abstract base class for processing providers.

An algorithm provider is a set of related algorithms, typically from the same external application or related
to a common area of analysis.

.. versionadded:: 3.0
@@ -11,10 +11,15 @@





class QgsProjectFileTransform
{
%Docstring
Class to convert from older project file versions to newer.

This class provides possibility to store a project file as a QDomDocument,
and provides the ability to specify version of the project file, and
perform upgrades to a more recent version
%End

%TypeHeaderCode
#include "qgsprojectfiletransform.h"
@@ -14,6 +14,7 @@ class QgsProjectStorageRegistry
{
%Docstring
Registry of storage backends that :py:class:`QgsProject` may use.

This is a singleton that should be accessed through :py:func:`QgsApplication.projectStorageRegistry()`.

.. versionadded:: 3.2
@@ -13,6 +13,7 @@ class QgsProjectVersion
{
%Docstring
A class to describe the version of a project.

Used in places where you need to check if the current version
of QGIS is greater than the one used to create a project file.
%End
@@ -12,6 +12,7 @@ class QgsActionScope
%Docstring
An action scope defines a "place" for an action to be shown and may add
additional expression variables.

Each :py:class:`QgsAction` can be available in one or several action scopes.

Examples:
@@ -12,6 +12,7 @@ class QgsActionScopeRegistry : QObject
%Docstring
The action scope registry is an application wide registry that
contains a list of available action scopes.

Some scopes are available by default, additional ones can be registered
at runtime by plugins or custom applications.

@@ -18,6 +18,7 @@ class QgsClipper
{
%Docstring
A class to trim lines and polygons to within a rectangular region.

The functions in this class are likely to be called from within a
render loop and hence need to as CPU efficient as possible.
The main purpose of the functions in this class are to trim lines
@@ -14,6 +14,7 @@ class QgsCredentials
{
%Docstring
Interface for requesting credentials in QGIS in GUI independent way.

This class provides abstraction of a dialog for requesting credentials to the user.
By default :py:class:`QgsCredentials` will be used if not overridden with other
credential creator function.
@@ -15,6 +15,7 @@ class QgsDataDefinedSizeLegend
{
%Docstring
Object that keeps configuration of appearance of marker symbol's data-defined size in legend.

For example: the list of classes (size values), whether the classes should appear in separate
legend nodes or whether to collapse them into one legend node.

@@ -15,6 +15,7 @@ class QgsDataItem : QObject
{
%Docstring
Base class for all items in the model.

Parent/children hierarchy is not based on QObject.
%End

@@ -17,6 +17,7 @@ class QgsFeatureFilterProvider
{
%Docstring
Abstract interface for use by classes that filter the features of a layer.

A :py:class:`QgsFeatureFilterProvider` provides a method for modifying a :py:class:`QgsFeatureRequest` in place to apply
additional filters to the request.

@@ -12,6 +12,7 @@ class QgsFeaturePickerModelBase : QAbstractItemModel /Abstract/
{
%Docstring
Provides a list of features based on filter conditions.

Features are fetched asynchronously.

.. versionadded:: 3.14
@@ -14,6 +14,7 @@ class QgsFeatureRequest
{
%Docstring
This class wraps a request for features to a vector layer (or directly its vector data provider).

The request may apply a filter to fetch only a particular subset of features. Currently supported filters:

- no filter - all features are returned
@@ -13,6 +13,7 @@ class QgsFeedback : QObject
{
%Docstring
Base class for feedback objects to be used for cancellation of something running in a worker thread.

The class may be used as is or it may be subclassed for extended functionality
for a particular operation (e.g. report progress or pass some data for preview).

0 comments on commit 7dfef3a

Please sign in to comment.