Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Fix a bunch of doc issues
  • Loading branch information
m-kuhn committed Oct 22, 2020
1 parent d1a1875 commit 42af1ef
Show file tree
Hide file tree
Showing 21 changed files with 40 additions and 31 deletions.
3 changes: 2 additions & 1 deletion cmake_templates/Doxyfile.in
Expand Up @@ -2062,7 +2062,8 @@ EXPAND_AS_DEFINED = "SIP_ABSTRACT" \
"SIP_VIRTUALERRORHANDLER" \
"SIP_WHEN_FEATURE" \
"SIP_MONKEYPATCH_SCOPEENUM" \
"SIP_MONKEYPATCH_SCOPEENUM_UNNEST"
"SIP_MONKEYPATCH_SCOPEENUM_UNNEST" \
"Q_DECL_DEPRECATED"

# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
# remove all references to function-like macros that are alone on a line, have
Expand Down
6 changes: 4 additions & 2 deletions python/core/auto_generated/mesh/qgsmeshlayer.sip.in
Expand Up @@ -361,7 +361,7 @@ See :py:func:`QgsMeshDatasetMetadata.isVector()` to check if the returned value
returns invalid block for DataOnFaces and DataOnVertices.

:param index: index of the dataset
:param valueIndex: index of the value
:param faceIndex: index of the face
:param count: number of values to return

.. note::
Expand All @@ -387,7 +387,7 @@ returns invalid block for DataOnFaces and DataOnVertices.
Returns whether the faces are active for particular dataset

:param index: index of the dataset
:param valueIndex: index of the value
:param faceIndex: index of the face
:param count: number of values to return

.. note::
Expand Down Expand Up @@ -495,6 +495,7 @@ Returns dataset index from datasets group depending on the time range.
If the temporal properties is not active, returns invalid dataset index. This method is used for rendering mesh layer.

:param timeRange: the time range
:param datasetGroupIndex: the index of the dataset group

:return: dataset index

Expand All @@ -518,6 +519,7 @@ Returns dataset index from datasets group depending on the relative time from th
Dataset index is valid even the temporal properties is inactive. This method is used for calculation on mesh layer.

:param relativeTime: the relative from the mesh layer reference time
:param datasetGroupIndex: the index of the dataset group

:return: dataset index

Expand Down
2 changes: 1 addition & 1 deletion python/core/auto_generated/qgsdataitem.sip.in
Expand Up @@ -1002,7 +1002,7 @@ Constructor for QgsFieldsItem, with the specified ``parent`` item.

The ``path`` argument gives the item path in the browser tree. The ``path`` string can take any form,
but QgsDataItem items pointing to different logical locations should always use a different item ``path``.
The \connectionUri argument is the connection part of the layer URI that it is used internally to create
The ``connectionUri`` argument is the connection part of the layer URI that it is used internally to create
a connection and retrieve fields information.
The ``providerKey`` string can be used to specify the key for the QgsDataItemProvider that created this item.
The ``schema`` and ``tableName`` are used to retrieve the layer and field information from the ``connectionUri``.
Expand Down
1 change: 1 addition & 0 deletions python/core/auto_generated/qgsmapclippingutils.sip.in
Expand Up @@ -67,6 +67,7 @@ The returned coordinates are in painter coordinates for the destination ``contex
:param regions: list of clip regions which apply to the layer
:param context: a render context
:param shouldClip: will be set to ``True`` if the clipping path should be applied
:param layerType: the layer type to filter

:return: combined painter clipping region for use when rendering maps
%End
Expand Down
4 changes: 2 additions & 2 deletions python/core/auto_generated/qgsproject.sip.in
Expand Up @@ -527,7 +527,7 @@ Reads a double from the specified ``scope`` and ``key``.

:param scope: entry scope (group) name
:param key: entry key name. Keys are '/'-delimited entries, implying a hierarchy of keys and corresponding values.
:param default: value to return if the specified ``key`` does not exist within the ``scope``.
:param def: default value to return if the specified ``key`` does not exist within the ``scope``.

:return: - entry value as double from ``scope`` given its ``key``
- ok: set to ``True`` if key exists and has been successfully retrieved as a double
Expand All @@ -539,7 +539,7 @@ Reads a boolean from the specified ``scope`` and ``key``.

:param scope: entry scope (group) name
:param key: entry key name. Keys are '/'-delimited entries, implying a hierarchy of keys and corresponding values.
:param default: value to return if the specified ``key`` does not exist within the ``scope``.
:param def: default value to return if the specified ``key`` does not exist within the ``scope``.

:return: - entry value as boolean from ``scope`` given its ``key``
- ok: set to ``True`` if key exists and has been successfully retrieved as a boolean
Expand Down
5 changes: 2 additions & 3 deletions python/core/auto_generated/qgsruntimeprofiler.sip.in
Expand Up @@ -67,9 +67,8 @@ Returns a list of all child groups with the specified ``parent``.
void start( const QString &name, const QString &group = "startup" );
%Docstring
Start a profile event with the given name.

:param name: The name of the profile event. Will have the name of
the active group appended after ending.
The ``name`` of the profile event. Will have the name of
the active ``group`` appended after ending.
%End

void end( const QString &group = "startup" );
Expand Down
Expand Up @@ -446,9 +446,9 @@ Interpolates a list which starts with the interpolate function.
%Docstring
Parses a ``color`` in one of these supported formats:

- #fff or #ffffff
- hsl(30, 19%, 90%) or hsla(30, 19%, 90%, 0.4)
- rgb(10, 20, 30) or rgba(10, 20, 30, 0.5)
- ``#fff`` or ``#ffffff``
- ``hsl(30, 19%, 90%)`` or ``hsla(30, 19%, 90%, 0.4)``
- ``rgb(10, 20, 30)`` or ``rgba(10, 20, 30, 0.5)``

Returns an invalid color if the color could not be parsed.

Expand Down
Expand Up @@ -53,7 +53,7 @@ Returns a list of the :py:func:`QgsCodeEditorColorScheme.id()` values for all re
%Docstring
Returns the color scheme with matching ``id``.

If the specified scheme \id does not exist then the default scheme will be returned instead.
If the specified scheme ``id`` does not exist then the default scheme will be returned instead.
%End

};
Expand Down
3 changes: 3 additions & 0 deletions python/gui/auto_generated/qgsdoublevalidator.sip.in
Expand Up @@ -36,6 +36,7 @@ Constructor for QgsDoubleValidator.

:param bottom: the minimal range limit accepted by the validator
:param top: the maximal range limit accepted by the validator
:param parent: parent object
%End

QgsDoubleValidator( double bottom, double top, QObject *parent );
Expand All @@ -44,6 +45,7 @@ Constructor for QgsDoubleValidator.

:param bottom: the minimal range limit accepted by the validator
:param top: the maximal range limit accepted by the validator
:param parent: parent object
%End

QgsDoubleValidator( double bottom, double top, int decimal, QObject *parent );
Expand All @@ -53,6 +55,7 @@ Constructor for QgsDoubleValidator.
:param bottom: the minimal range limit accepted by the validator
:param top: the maximal range limit accepted by the validator
:param decimal: the number of decimal accepted by the validator
:param parent: parent object
%End


Expand Down
2 changes: 1 addition & 1 deletion python/gui/auto_generated/qgsnewvectortabledialog.sip.in
Expand Up @@ -35,7 +35,7 @@ The actual creation of the table is delegated to the connections API method
%Docstring
QgsNewVectorTableDialog constructor

:param connection: DB connection, ownership is NOT transferred
:param conn: DB connection, ownership is NOT transferred
:param parent: optional parent
%End

Expand Down
5 changes: 1 addition & 4 deletions src/3d/qgs3dexportobject.h
Expand Up @@ -52,10 +52,7 @@ class _3D_EXPORT Qgs3DExportObject
/**
* \brief Qgs3DExportObject
* Constructs an export object that will be filled with coordinates later
* \param parentName
* The name of the parent (Will be useful to define scene hierarchy)
* \param parent
* The parent QObject (we use this to delete the Qgs3DExportObject instance once the exporter instance is deallocated)
* \param name The name of the parent (Will be useful to define scene hierarchy)
*/
Qgs3DExportObject( const QString &name ) : mName( name ) { }

Expand Down
6 changes: 4 additions & 2 deletions src/core/mesh/qgsmeshlayer.h
Expand Up @@ -397,7 +397,7 @@ class CORE_EXPORT QgsMeshLayer : public QgsMapLayer
* returns invalid block for DataOnFaces and DataOnVertices.
*
* \param index index of the dataset
* \param valueIndex index of the value
* \param faceIndex index of the face
* \param count number of values to return
*
* \note indexes are used to distinguish all the dataset groups handled by the layer (from dataprovider, extra dataset group,...)
Expand All @@ -420,7 +420,7 @@ class CORE_EXPORT QgsMeshLayer : public QgsMapLayer
* Returns whether the faces are active for particular dataset
*
* \param index index of the dataset
* \param valueIndex index of the value
* \param faceIndex index of the face
* \param count number of values to return
*
* \note indexes are used to distinguish all the dataset groups handled by the layer (from dataprovider, extra dataset group,...)
Expand Down Expand Up @@ -501,6 +501,7 @@ class CORE_EXPORT QgsMeshLayer : public QgsMapLayer
* If the temporal properties is not active, returns invalid dataset index. This method is used for rendering mesh layer.
*
* \param timeRange the time range
* \param datasetGroupIndex the index of the dataset group
* \returns dataset index
*
* \note the returned dataset index depends on the matching method, see setTemporalMatchingMethod()
Expand All @@ -517,6 +518,7 @@ class CORE_EXPORT QgsMeshLayer : public QgsMapLayer
* Dataset index is valid even the temporal properties is inactive. This method is used for calculation on mesh layer.
*
* \param relativeTime the relative from the mesh layer reference time
* \param datasetGroupIndex the index of the dataset group
* \returns dataset index
*
* \note the returned dataset index depends on the matching method, see setTemporalMatchingMethod()
Expand Down
2 changes: 1 addition & 1 deletion src/core/qgsdataitem.h
Expand Up @@ -984,7 +984,7 @@ class CORE_EXPORT QgsFieldsItem : public QgsDataItem
*
* The \a path argument gives the item path in the browser tree. The \a path string can take any form,
* but QgsDataItem items pointing to different logical locations should always use a different item \a path.
* The \connectionUri argument is the connection part of the layer URI that it is used internally to create
* The \a connectionUri argument is the connection part of the layer URI that it is used internally to create
* a connection and retrieve fields information.
* The \a providerKey string can be used to specify the key for the QgsDataItemProvider that created this item.
* The \a schema and \a tableName are used to retrieve the layer and field information from the \a connectionUri.
Expand Down
1 change: 1 addition & 0 deletions src/core/qgsmapclippingutils.h
Expand Up @@ -82,6 +82,7 @@ class CORE_EXPORT QgsMapClippingUtils
* \param regions list of clip regions which apply to the layer
* \param context a render context
* \param shouldClip will be set to TRUE if the clipping path should be applied
* \param layerType the layer type to filter
*
* \returns combined painter clipping region for use when rendering maps
*/
Expand Down
4 changes: 2 additions & 2 deletions src/core/qgsproject.h
Expand Up @@ -543,7 +543,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
*
* \param scope entry scope (group) name
* \param key entry key name. Keys are '/'-delimited entries, implying a hierarchy of keys and corresponding values.
* \param default value to return if the specified \a key does not exist within the \a scope.
* \param def default value to return if the specified \a key does not exist within the \a scope.
* \param ok set to TRUE if key exists and has been successfully retrieved as a double
*
* \returns entry value as double from \a scope given its \a key
Expand All @@ -555,7 +555,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
*
* \param scope entry scope (group) name
* \param key entry key name. Keys are '/'-delimited entries, implying a hierarchy of keys and corresponding values.
* \param default value to return if the specified \a key does not exist within the \a scope.
* \param def default value to return if the specified \a key does not exist within the \a scope.
* \param ok set to TRUE if key exists and has been successfully retrieved as a boolean
*
* \returns entry value as boolean from \a scope given its \a key
Expand Down
4 changes: 2 additions & 2 deletions src/core/qgsruntimeprofiler.h
Expand Up @@ -209,8 +209,8 @@ class CORE_EXPORT QgsRuntimeProfiler : public QAbstractItemModel

/**
* \brief Start a profile event with the given name.
* \param name The name of the profile event. Will have the name of
* the active group appended after ending.
* The \a name of the profile event. Will have the name of
* the active \a group appended after ending.
*/
void start( const QString &name, const QString &group = "startup" );

Expand Down
6 changes: 3 additions & 3 deletions src/core/vectortile/qgsmapboxglstyleconverter.h
Expand Up @@ -441,9 +441,9 @@ class CORE_EXPORT QgsMapBoxGlStyleConverter
/**
* Parses a \a color in one of these supported formats:
*
* - #fff or #ffffff
* - hsl(30, 19%, 90%) or hsla(30, 19%, 90%, 0.4)
* - rgb(10, 20, 30) or rgba(10, 20, 30, 0.5)
* - ``#fff`` or ``#ffffff``
* - ``hsl(30, 19%, 90%)`` or ``hsla(30, 19%, 90%, 0.4)``
* - ``rgb(10, 20, 30)`` or ``rgba(10, 20, 30, 0.5)``
*
* Returns an invalid color if the color could not be parsed.
*
Expand Down
2 changes: 1 addition & 1 deletion src/gui/codeeditors/qgscodeeditorcolorschemeregistry.h
Expand Up @@ -64,7 +64,7 @@ class GUI_EXPORT QgsCodeEditorColorSchemeRegistry
/**
* Returns the color scheme with matching \a id.
*
* If the specified scheme \id does not exist then the default scheme will be returned instead.
* If the specified scheme \a id does not exist then the default scheme will be returned instead.
*/
QgsCodeEditorColorScheme scheme( const QString &id ) const;

Expand Down
3 changes: 3 additions & 0 deletions src/gui/qgsdoublevalidator.h
Expand Up @@ -51,6 +51,7 @@ class GUI_EXPORT QgsDoubleValidator : public QRegularExpressionValidator
*
* \param bottom the minimal range limit accepted by the validator
* \param top the maximal range limit accepted by the validator
* \param parent parent object
*/
QgsDoubleValidator( const QRegularExpression &expression, double bottom, double top, QObject *parent );

Expand All @@ -59,6 +60,7 @@ class GUI_EXPORT QgsDoubleValidator : public QRegularExpressionValidator
*
* \param bottom the minimal range limit accepted by the validator
* \param top the maximal range limit accepted by the validator
* \param parent parent object
*/
QgsDoubleValidator( double bottom, double top, QObject *parent );

Expand All @@ -68,6 +70,7 @@ class GUI_EXPORT QgsDoubleValidator : public QRegularExpressionValidator
* \param bottom the minimal range limit accepted by the validator
* \param top the maximal range limit accepted by the validator
* \param decimal the number of decimal accepted by the validator
* \param parent parent object
*/
QgsDoubleValidator( double bottom, double top, int decimal, QObject *parent );

Expand Down
2 changes: 1 addition & 1 deletion src/gui/qgsnewvectortabledialog.h
Expand Up @@ -50,7 +50,7 @@ class GUI_EXPORT QgsNewVectorTableDialog : public QDialog, private Ui_QgsNewVect

/**
* QgsNewVectorTableDialog constructor
* \param connection DB connection, ownership is NOT transferred
* \param conn DB connection, ownership is NOT transferred
* \param parent optional parent
*/
QgsNewVectorTableDialog( QgsAbstractDatabaseProviderConnection *conn, QWidget *parent SIP_TRANSFERTHIS = nullptr );
Expand Down
2 changes: 1 addition & 1 deletion src/quickgui/qgsquickmapsettings.cpp
Expand Up @@ -130,7 +130,7 @@ QgsMapSettings QgsQuickMapSettings::mapSettings() const
return mMapSettings;
}

void QgsQuickMapSettings::QgsQuickMapSettings::setTransformContext( const QgsCoordinateTransformContext &ctx )
void QgsQuickMapSettings::setTransformContext( const QgsCoordinateTransformContext &ctx )
{
mMapSettings.setTransformContext( ctx );
}
Expand Down

0 comments on commit 42af1ef

Please sign in to comment.