Skip to content
Permalink
Browse files

Fix numeric list formatting in dox

  • Loading branch information
nyalldawson committed Jun 15, 2020
1 parent 81a9db9 commit 1ef12a0c7f830e1d5772b1031899081d5679b935
@@ -55,9 +55,9 @@ class Qgs3DMapSettings;
* Index zero is used for primitive restart (to separate two linestrings).
*
* It is expected that client code:
* 1. calls init()
* 2. calls addLineString() many times
* 3. calls createGeometry()
* # calls init()
* # calls addLineString() many times
* # calls createGeometry()
*/
struct QgsLineVertexData
{
@@ -51,9 +51,10 @@ namespace QgsOverlayUtils
/**
* Copies features from the source to the sink and resolves overlaps: for each pair of overlapping features A and B
* it will produce:
* 1. a feature with geometry A - B with A's attributes
* 2. a feature with geometry B - A with B's attributes
* 3. two features with geometry intersection(A, B) - one with A's attributes, one with B's attributes.
*
* # a feature with geometry A - B with A's attributes
* # a feature with geometry B - A with B's attributes
* # two features with geometry intersection(A, B) - one with A's attributes, one with B's attributes.
*
* As a result, for all pairs of features in the output, a pair either has no common interior or their interior is the same.
*/
@@ -663,9 +663,9 @@ class CORE_EXPORT QgsGeometry
*
* This function takes into account the following factors:
*
* 1. If the given vertex index is at the end of a linestring,
* # If the given vertex index is at the end of a linestring,
* the adjacent index will be -1 (for "no adjacent vertex")
* 2. If the given vertex index is at the end of a linear ring
* # If the given vertex index is at the end of a linear ring
* (such as in a polygon), the adjacent index will take into
* account the first vertex is equal to the last vertex (and will
* skip equal vertex positions).
@@ -374,8 +374,8 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel
/**
* Structure that stores tree representation of map layer's legend.
* This structure is used only when the following requirements are met:
* 1. tree legend representation is enabled in model (ShowLegendAsTree flag)
* 2. some legend nodes have non-null parent rule key (accessible via data(ParentRuleKeyRole) method)
* # tree legend representation is enabled in model (ShowLegendAsTree flag)
* # some legend nodes have non-null parent rule key (accessible via data(ParentRuleKeyRole) method)
* The tree structure (parents and children of each node) is extracted by analyzing nodes' parent rules.
* \note not available in Python bindings
*/
@@ -180,11 +180,11 @@ class CORE_EXPORT QgsTriangularMesh // TODO rename to QgsRendererMesh in QGIS 4

/**
* Returns the corresponding index of level of detail on which this mesh is associated
* 0 : base mesh
* 1 : first simplified mesh
* 2 : second simplified mesh (lower level of detail)
* ...
* ...
*
* - 0: base mesh
* - 1: first simplified mesh
* - 2: second simplified mesh (lower level of detail)
* - ...
*
* \since QGIS 3.14
*/
@@ -75,10 +75,10 @@ typedef void ( *CUSTOM_CRS_VALIDATION )( QgsCoordinateReferenceSystem & ) SIP_SK
*
* Most commonly one comes across two types of coordinate systems:
*
* 1. **Geographic coordinate systems** - based on a geodetic datum, normally with coordinates being
* # **Geographic coordinate systems** - based on a geodetic datum, normally with coordinates being
* latitude/longitude in degrees. The most common one is World Geodetic System 84 (WGS84).
*
* 2. **Projected coordinate systems** - based on a geodetic datum with coordinates projected to a plane,
* # **Projected coordinate systems** - based on a geodetic datum with coordinates projected to a plane,
* typically using meters or feet as units. Common projected coordinate systems are Universal
* Transverse Mercator or Albers Equal Area.
*
@@ -114,7 +114,7 @@ typedef void ( *CUSTOM_CRS_VALIDATION )( QgsCoordinateReferenceSystem & ) SIP_SK
*
* This section gives an overview of various supported CRS definition formats:
*
* 1. **Authority and Code.** Also referred to as OGC WMS format within QGIS as they have been widely
* # **Authority and Code.** Also referred to as OGC WMS format within QGIS as they have been widely
* used in OGC standards. These are encoded as `<auth>:<code>`, for example `EPSG:4326` refers
* to WGS84 system. EPSG is the most commonly used authority that covers a wide range
* of coordinate systems around the world.
@@ -130,7 +130,7 @@ typedef void ( *CUSTOM_CRS_VALIDATION )( QgsCoordinateReferenceSystem & ) SIP_SK
* \see authid()
* \see createFromOgcWmsCrs()
*
* 2. **PROJ string.** This is a string consisting of a series of key/value pairs in the following
* # **PROJ string.** This is a string consisting of a series of key/value pairs in the following
* format: `+param1=value1 +param2=value2 [...]`. This is the format natively used by the
* underlying proj library. For example, the definition of WGS84 looks like this:
*
@@ -141,7 +141,7 @@ typedef void ( *CUSTOM_CRS_VALIDATION )( QgsCoordinateReferenceSystem & ) SIP_SK
* \see toProj()
* \see createFromProj()
*
* 3. **Well-known text (WKT).** Defined by Open Geospatial Consortium (OGC), this is another common
* # **Well-known text (WKT).** Defined by Open Geospatial Consortium (OGC), this is another common
* format to define CRS. For WGS84 the OGC WKT definition is the following:
*
* GEOGCS["WGS 84",
@@ -34,8 +34,8 @@ typedef bool handlesDirectoryPath_t( const QString &path ) SIP_SKIP;
*
* The method createDataItem() is ever called only if capabilities() return non-zero value.
* There are two occasions when createDataItem() is called:
* 1. to create root items (passed path is empty, parent item is NULLPTR).
* 2. to create items in directory structure. For this capabilities have to return at least
* # to create root items (passed path is empty, parent item is NULLPTR).
* # to create items in directory structure. For this capabilities have to return at least
* of the following: QgsDataProvider::Dir or QgsDataProvider::File. Passed path is the file
* or directory being inspected, parent item is a valid QgsDirectoryItem
*
@@ -50,13 +50,13 @@
* that can be viewed anywhere.
*
* Currently we recognize these kinds of events:
* 1. Duration events - they provide a way to mark a duration of work within a thread.
* # Duration events - they provide a way to mark a duration of work within a thread.
* Their duration is specified by begin and end timestamps. They can be nested
* and the viewer will stack them. If you need durations that do not nest properly
* (i.e. they only partially overlap), you should use Async events instead.
* 2. Instant events - they correspond to something that happens but has no duration
* # Instant events - they correspond to something that happens but has no duration
* associated with it.
* 3. Async events - they are used to specify asynchronous operations. They also require
* # Async events - they are used to specify asynchronous operations. They also require
* additional "id" parameter to group them into the same event tree.
*
* Duration events are for example to record run of a single function. Async events
@@ -70,9 +70,9 @@
* https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/preview
*
* The intended usage:
* 1. call startTracing()
* 2. repeatedly call addEvent()
* 3. call stopTracing() and writeTrace() to export the data to JSON
* # call startTracing()
* # repeatedly call addEvent()
* # call stopTracing() and writeTrace() to export the data to JSON
*
* \note not available in Python bindings
* \since QGIS 3.12
@@ -36,13 +36,13 @@ class QgsRenderContext;
* Qt containers and various Qt classes use implicit sharing.
*
* The scenario will be:
* 1. renderer job (doing preparation in the GUI thread) calls
* # renderer job (doing preparation in the GUI thread) calls
* QgsMapLayer::createMapRenderer() and gets instance of this class.
* The instance is initialized at that point and should not need
* additional calls to QgsVectorLayer.
* 2. renderer job (still in GUI thread) stores the renderer for later use.
* 3. renderer job (in worker thread) calls QgsMapLayerRenderer::render()
* 4. renderer job (again in GUI thread) will check errors() and report them
* # renderer job (still in GUI thread) stores the renderer for later use.
* # renderer job (in worker thread) calls QgsMapLayerRenderer::render()
* # renderer job (again in GUI thread) will check errors() and report them
*
* \since QGIS 2.4
*/
@@ -167,11 +167,11 @@ struct LabelRenderJob
*
* Common use case:
*
* 0. prepare QgsMapSettings with rendering configuration (extent, layer, map size, ...)
* 1. create QgsMapRendererJob subclass with QgsMapSettings instance
* 2. connect to job's finished() signal
* 3. call start(). Map rendering will start in background, the function immediately returns
* 4. at some point, slot connected to finished() signal is called, map rendering is done
* # prepare QgsMapSettings with rendering configuration (extent, layer, map size, ...)
* # create QgsMapRendererJob subclass with QgsMapSettings instance
* # connect to job's finished() signal
* # call start(). Map rendering will start in background, the function immediately returns
* # at some point, slot connected to finished() signal is called, map rendering is done
*
* It is possible to cancel the rendering job while it is active by calling cancel() function.
*
@@ -37,10 +37,10 @@ class QgsFields;
*
* QgsVectorLayerExporter can be used in two ways:
*
* 1. Using a static call to QgsVectorLayerExporter::exportLayer(...) which exports the
* # Using a static call to QgsVectorLayerExporter::exportLayer(...) which exports the
* entire layer to the destination provider.
*
* 2. Create an instance of the class and issue calls to addFeature(...)
* # Create an instance of the class and issue calls to addFeature(...)
*
* \since QGIS 3.0
*/
@@ -30,9 +30,9 @@ class QgsSymbol;
/**
* \ingroup core
* Definition of map rendering of a subset of vector tile data. The subset of data is defined by:
* 1. sub-layer name
* 2. geometry type (a single sub-layer may have multiple geometry types)
* 3. filter expression
* # sub-layer name
* # geometry type (a single sub-layer may have multiple geometry types)
* # filter expression
*
* Renering is determined by the associated symbol (QgsSymbol). Symbol has to be of the same
* type as the chosen geometryType() - i.e. QgsMarkerSymbol for points, QgsLineSymbol for linestrings
@@ -30,9 +30,9 @@ class QgsVectorTileLabelProvider;
* \ingroup core
* This class provides map rendering functionality for vector tile layers.
* In render() function (assumed to be run in a worker thread) it will:
* 1. fetch vector tiles using QgsVectorTileLoader
* 2. decode raw tiles into QgsFeature objects using QgsVectorTileDecoder
* 3. render tiles using a class derived from QgsVectorTileRenderer
* # fetch vector tiles using QgsVectorTileLoader
* # decode raw tiles into QgsFeature objects using QgsVectorTileDecoder
* # render tiles using a class derived from QgsVectorTileRenderer
*
* \since QGIS 3.14
*/
@@ -78,9 +78,9 @@ class CORE_EXPORT QgsVectorTileRendererData
* Abstract base class for all vector tile renderer implementations.
*
* For rendering it is expected that client code calls:
* 1. startRender() to prepare renderer
* 2. renderTile() for each tile
* 3. stopRender() to clean up renderer and free resources
* # startRender() to prepare renderer
* # renderTile() for each tile
* # stopRender() to clean up renderer and free resources
*
* \since QGIS 3.14
*/
@@ -49,9 +49,9 @@
/**
* Attempts to find the best guess at a map item to link \a referenceItem to,
* by:
* 1. Prioritizing a selected map
* 2. If no selection, prioritizing the topmost map the item was drawn over
* 3. If still none, use the layout's reference map (or biggest map)
* # Prioritizing a selected map
* # If no selection, prioritizing the topmost map the item was drawn over
* # If still none, use the layout's reference map (or biggest map)
*/
QgsLayoutItemMap *findSensibleDefaultLinkedMapItem( QgsLayoutItem *referenceItem )
{
@@ -27,16 +27,16 @@ class QgsMapCanvas;
*
* Implementations have three approaches they can use to handle drops.
*
* 1. The simplest approach is to implement handeFileDrop() when they need to handle
* # The simplest approach is to implement handeFileDrop() when they need to handle
* dropped files (i.e. with mime type "text/uri-list").
*
* 2. Reimplement handleCustomUriDrop() when they want to handle dropped custom
* # Reimplement handleCustomUriDrop() when they want to handle dropped custom
* QgsMimeDataUtils::Uri entries, for instance handling dropping custom entries
* from the browser tree (with mime type "application/x-vnd.qgis.qgis.uri"). In
* this case the implementation's customUriProviderKey() must match the uri
* entry's providerKey.
*
* 3. Reimplement handleMimeData() to directly handle dropped QMimeData.
* # Reimplement handleMimeData() to directly handle dropped QMimeData.
* Subclasses should take care when overriding this method. When a drop event
* occurs, Qt will lock the source application of the drag for the duration
* of the drop event handling via handleMimeData() (e.g. dragging files from
@@ -49,8 +49,8 @@ class QgsOptionsDialogHighlightWidget;
* and connecting QDialogButtonBox's accepted/rejected signals to dialog's accept/reject slots
*
* To use:
* 1) Start with copy of qgsoptionsdialog_template.ui and build options/properties dialog.
* 2) In source file for dialog, inherit this class instead of QDialog, then in constructor:
* # Start with copy of qgsoptionsdialog_template.ui and build options/properties dialog.
* # In source file for dialog, inherit this class instead of QDialog, then in constructor:
* ...
* setupUi( this ); // set up .ui file objects
* initOptionsBase( FALSE ); // set up this class to use .ui objects, optionally restoring base ui

0 comments on commit 1ef12a0

Please sign in to comment.
You can’t perform that action at this time.