sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-12-01 00:03:42 -05:00
Code Issues Packages Projects Releases Wiki Activity

Fix malformed enum documentation

Browse Source 
Fixes #50176
This commit is contained in:
Nyall Dawson 2024-09-04 16:10:26 +10:00
parent 440539389d
commit 561961a11d
15 changed files with 91 additions and 85 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
python/PyQt6/core/auto_additions/qgis.py
View File

@ -1055,14 +1055,14 @@ Qgis.SettingsType.baseClass = Qgis
# monkey patching scoped based enum
Qgis.SettingsTreeNodeType.Root.__doc__ = "Root Node"
Qgis.SettingsTreeNodeType.Standard.__doc__ = "Normal Node"
Qgis.SettingsTreeNodeType.NamedList.__doc__ = ""
Qgis.SettingsTreeNodeType.NamedList.__doc__ = "Named List Node"
Qgis.SettingsTreeNodeType.__doc__ = """Type of tree node
.. versionadded:: 3.30
* ``Root``: Root Node
* ``Standard``: Normal Node
* ``NamedList``:
* ``NamedList``: Named List Node
"""
# --
@ -1161,14 +1161,14 @@ Qgis.SldExportVendorExtension.__doc__ = """SLD export vendor extensions, allow t
# --
Qgis.SldExportVendorExtension.baseClass = Qgis
# monkey patching scoped based enum
Qgis.SettingsOption.SaveFormerValue.__doc__ = ""
Qgis.SettingsOption.SaveEnumFlagAsInt.__doc__ = ""
Qgis.SettingsOption.SaveFormerValue.__doc__ = "Save the former value of the settings"
Qgis.SettingsOption.SaveEnumFlagAsInt.__doc__ = "The enum/flag will be saved as an integer value instead of text"
Qgis.SettingsOption.__doc__ = """Settings options
.. versionadded:: 3.26
* ``SaveFormerValue``:
* ``SaveEnumFlagAsInt``:
* ``SaveFormerValue``: Save the former value of the settings
* ``SaveEnumFlagAsInt``: The enum/flag will be saved as an integer value instead of text
"""
# --
@ -7935,7 +7935,7 @@ QgsRasterDataProvider.ReloadData.is_monkey_patched = True
QgsRasterDataProvider.ReloadData.__doc__ = "Is able to force reload data / clear local caches. Since QGIS 3.18, see QgsDataProvider.reloadProviderData()"
QgsRasterDataProvider.DpiDependentData = Qgis.RasterProviderCapability.DpiDependentData
QgsRasterDataProvider.DpiDependentData.is_monkey_patched = True
QgsRasterDataProvider.DpiDependentData.__doc__ = ""
QgsRasterDataProvider.DpiDependentData.__doc__ = "Provider's rendering is dependent on requested pixel size of the viewport \n.. versionadded:: 3.20"
QgsRasterDataProvider.NativeRasterAttributeTable = Qgis.RasterProviderCapability.NativeRasterAttributeTable
QgsRasterDataProvider.NativeRasterAttributeTable.is_monkey_patched = True
QgsRasterDataProvider.NativeRasterAttributeTable.__doc__ = "Indicates that the provider supports native raster attribute table \n.. versionadded:: 3.30"
@ -7962,7 +7962,10 @@ Qgis.RasterProviderCapability.__doc__ = """Raster data provider capabilities.
.. versionadded:: 3.16
* ``ReloadData``: Is able to force reload data / clear local caches. Since QGIS 3.18, see QgsDataProvider.reloadProviderData()
* ``DpiDependentData``:
* ``DpiDependentData``: Provider's rendering is dependent on requested pixel size of the viewport
.. versionadded:: 3.20
* ``NativeRasterAttributeTable``: Indicates that the provider supports native raster attribute table
.. versionadded:: 3.30

4
python/PyQt6/core/auto_additions/qgsmaplayerelevationproperties.py
View File

@ -2,7 +2,7 @@
# monkey patching scoped based enum
QgsMapLayerElevationProperties.ZOffset = QgsMapLayerElevationProperties.Property.ZOffset
QgsMapLayerElevationProperties.ZOffset.is_monkey_patched = True
QgsMapLayerElevationProperties.ZOffset.__doc__ = ""
QgsMapLayerElevationProperties.ZOffset.__doc__ = "Z offset"
QgsMapLayerElevationProperties.ExtrusionHeight = QgsMapLayerElevationProperties.Property.ExtrusionHeight
QgsMapLayerElevationProperties.ExtrusionHeight.is_monkey_patched = True
QgsMapLayerElevationProperties.ExtrusionHeight.__doc__ = "Extrusion height"
@ -16,7 +16,7 @@ QgsMapLayerElevationProperties.Property.__doc__ = """Data definable properties.
.. versionadded:: 3.26
* ``ZOffset``:
* ``ZOffset``: Z offset
* ``ExtrusionHeight``: Extrusion height
* ``RasterPerBandLowerElevation``: Lower elevation for each raster band

20
python/PyQt6/server/auto_additions/qgsserverquerystringparameter.py
View File

@ -1,17 +1,17 @@
# The following has been generated automatically from src/server/qgsserverquerystringparameter.h
# monkey patching scoped based enum
QgsServerQueryStringParameter.Type.String.__doc__ = ""
QgsServerQueryStringParameter.Type.Integer.__doc__ = ""
QgsServerQueryStringParameter.Type.Double.__doc__ = ""
QgsServerQueryStringParameter.Type.Boolean.__doc__ = ""
QgsServerQueryStringParameter.Type.List.__doc__ = ""
QgsServerQueryStringParameter.Type.String.__doc__ = "Parameter is a string"
QgsServerQueryStringParameter.Type.Integer.__doc__ = "Parameter is an integer"
QgsServerQueryStringParameter.Type.Double.__doc__ = "Parameter is a double"
QgsServerQueryStringParameter.Type.Boolean.__doc__ = "Parameter is a boolean"
QgsServerQueryStringParameter.Type.List.__doc__ = "Parameter is a (comma separated) list of strings, the handler will perform any further required conversion of the list values"
QgsServerQueryStringParameter.Type.__doc__ = """The Type enum represents the parameter type
* ``String``:
* ``Integer``:
* ``Double``:
* ``Boolean``:
* ``List``:
* ``String``: Parameter is a string
* ``Integer``: Parameter is an integer
* ``Double``: Parameter is a double
* ``Boolean``: Parameter is a boolean
* ``List``: Parameter is a (comma separated) list of strings, the handler will perform any further required conversion of the list values
"""
# --

19
python/core/auto_additions/qgis.py
View File

@ -1044,14 +1044,14 @@ Qgis.SettingsType.baseClass = Qgis
# monkey patching scoped based enum
Qgis.SettingsTreeNodeType.Root.__doc__ = "Root Node"
Qgis.SettingsTreeNodeType.Standard.__doc__ = "Normal Node"
Qgis.SettingsTreeNodeType.NamedList.__doc__ = ""
Qgis.SettingsTreeNodeType.NamedList.__doc__ = "Named List Node"
Qgis.SettingsTreeNodeType.__doc__ = """Type of tree node
.. versionadded:: 3.30
* ``Root``: Root Node
* ``Standard``: Normal Node
* ``NamedList``:
* ``NamedList``: Named List Node
"""
# --
@ -1148,14 +1148,14 @@ Qgis.SldExportVendorExtension.__doc__ = """SLD export vendor extensions, allow t
# --
Qgis.SldExportVendorExtension.baseClass = Qgis
# monkey patching scoped based enum
Qgis.SettingsOption.SaveFormerValue.__doc__ = ""
Qgis.SettingsOption.SaveEnumFlagAsInt.__doc__ = ""
Qgis.SettingsOption.SaveFormerValue.__doc__ = "Save the former value of the settings"
Qgis.SettingsOption.SaveEnumFlagAsInt.__doc__ = "The enum/flag will be saved as an integer value instead of text"
Qgis.SettingsOption.__doc__ = """Settings options
.. versionadded:: 3.26
* ``SaveFormerValue``:
* ``SaveEnumFlagAsInt``:
* ``SaveFormerValue``: Save the former value of the settings
* ``SaveEnumFlagAsInt``: The enum/flag will be saved as an integer value instead of text
"""
# --
@ -7863,7 +7863,7 @@ QgsRasterDataProvider.ReloadData.is_monkey_patched = True
QgsRasterDataProvider.ReloadData.__doc__ = "Is able to force reload data / clear local caches. Since QGIS 3.18, see QgsDataProvider.reloadProviderData()"
QgsRasterDataProvider.DpiDependentData = Qgis.RasterProviderCapability.DpiDependentData
QgsRasterDataProvider.DpiDependentData.is_monkey_patched = True
QgsRasterDataProvider.DpiDependentData.__doc__ = ""
QgsRasterDataProvider.DpiDependentData.__doc__ = "Provider's rendering is dependent on requested pixel size of the viewport \n.. versionadded:: 3.20"
QgsRasterDataProvider.NativeRasterAttributeTable = Qgis.RasterProviderCapability.NativeRasterAttributeTable
QgsRasterDataProvider.NativeRasterAttributeTable.is_monkey_patched = True
QgsRasterDataProvider.NativeRasterAttributeTable.__doc__ = "Indicates that the provider supports native raster attribute table \n.. versionadded:: 3.30"
@ -7890,7 +7890,10 @@ Qgis.RasterProviderCapability.__doc__ = """Raster data provider capabilities.
.. versionadded:: 3.16
* ``ReloadData``: Is able to force reload data / clear local caches. Since QGIS 3.18, see QgsDataProvider.reloadProviderData()
* ``DpiDependentData``:
* ``DpiDependentData``: Provider's rendering is dependent on requested pixel size of the viewport
.. versionadded:: 3.20
* ``NativeRasterAttributeTable``: Indicates that the provider supports native raster attribute table
.. versionadded:: 3.30

4
python/core/auto_additions/qgsmaplayerelevationproperties.py
View File

@ -2,7 +2,7 @@
# monkey patching scoped based enum
QgsMapLayerElevationProperties.ZOffset = QgsMapLayerElevationProperties.Property.ZOffset
QgsMapLayerElevationProperties.ZOffset.is_monkey_patched = True
QgsMapLayerElevationProperties.ZOffset.__doc__ = ""
QgsMapLayerElevationProperties.ZOffset.__doc__ = "Z offset"
QgsMapLayerElevationProperties.ExtrusionHeight = QgsMapLayerElevationProperties.Property.ExtrusionHeight
QgsMapLayerElevationProperties.ExtrusionHeight.is_monkey_patched = True
QgsMapLayerElevationProperties.ExtrusionHeight.__doc__ = "Extrusion height"
@ -16,7 +16,7 @@ QgsMapLayerElevationProperties.Property.__doc__ = """Data definable properties.
.. versionadded:: 3.26
* ``ZOffset``:
* ``ZOffset``: Z offset
* ``ExtrusionHeight``: Extrusion height
* ``RasterPerBandLowerElevation``: Lower elevation for each raster band

20
python/server/auto_additions/qgsserverquerystringparameter.py
View File

@ -1,17 +1,17 @@
# The following has been generated automatically from src/server/qgsserverquerystringparameter.h
# monkey patching scoped based enum
QgsServerQueryStringParameter.Type.String.__doc__ = ""
QgsServerQueryStringParameter.Type.Integer.__doc__ = ""
QgsServerQueryStringParameter.Type.Double.__doc__ = ""
QgsServerQueryStringParameter.Type.Boolean.__doc__ = ""
QgsServerQueryStringParameter.Type.List.__doc__ = ""
QgsServerQueryStringParameter.Type.String.__doc__ = "Parameter is a string"
QgsServerQueryStringParameter.Type.Integer.__doc__ = "Parameter is an integer"
QgsServerQueryStringParameter.Type.Double.__doc__ = "Parameter is a double"
QgsServerQueryStringParameter.Type.Boolean.__doc__ = "Parameter is a boolean"
QgsServerQueryStringParameter.Type.List.__doc__ = "Parameter is a (comma separated) list of strings, the handler will perform any further required conversion of the list values"
QgsServerQueryStringParameter.Type.__doc__ = """The Type enum represents the parameter type
* ``String``:
* ``Integer``:
* ``Double``:
* ``Boolean``:
* ``List``:
* ``String``: Parameter is a string
* ``Integer``: Parameter is an integer
* ``Double``: Parameter is a double
* ``Boolean``: Parameter is a boolean
* ``List``: Parameter is a (comma separated) list of strings, the handler will perform any further required conversion of the list values
"""
# --

8
src/core/mesh/qgsmeshdataset.h
View File

@ -599,10 +599,10 @@ class CORE_EXPORT QgsMeshDatasetGroup
*/
enum Type
{
Unknown, //! Generic type used for non typed dataset group
Persistent, //! Dataset group store in a file
Memory, //! Temporary dataset group in memory
Virtual, //! Virtual Dataset group defined by a formula
Unknown, //!< Generic type used for non typed dataset group
Persistent, //!< Dataset group store in a file
Memory, //!< Temporary dataset group in memory
Virtual, //!< Virtual Dataset group defined by a formula
};
QgsMeshDatasetGroup() = default;

8
src/core/qgis.h
View File

@ -544,7 +544,7 @@ class CORE_EXPORT Qgis
{
Root, //!< Root Node
Standard, //!< Normal Node
NamedList, //! Named List Node
NamedList, //!< Named List Node
};
Q_ENUM( SettingsTreeNodeType )
@ -612,8 +612,8 @@ class CORE_EXPORT Qgis
*/
enum class SettingsOption : int SIP_ENUM_BASETYPE( IntFlag )
{
SaveFormerValue = 1 << 1, //<! Save the former value of the settings
SaveEnumFlagAsInt = 1 << 2, //! The enum/flag will be saved as an integer value instead of text
SaveFormerValue = 1 << 1, //!< Save the former value of the settings
SaveEnumFlagAsInt = 1 << 2, //!< The enum/flag will be saved as an integer value instead of text
};
Q_ENUM( SettingsOption )
Q_DECLARE_FLAGS( SettingsOptions, SettingsOption )
@ -4386,7 +4386,7 @@ class CORE_EXPORT Qgis
ProviderHintBenefitsFromResampling = 1 << 3, //!< Provider benefits from resampling and should apply user default resampling settings \since QGIS 3.10
ProviderHintCanPerformProviderResampling = 1 << 4, //!< Provider can perform resampling (to be opposed to post rendering resampling) \since QGIS 3.16
ReloadData = 1 << 5, //!< Is able to force reload data / clear local caches. Since QGIS 3.18, see QgsDataProvider::reloadProviderData()
DpiDependentData = 1 << 6, //! Provider's rendering is dependent on requested pixel size of the viewport (since QGIS 3.20)
DpiDependentData = 1 << 6, //!< Provider's rendering is dependent on requested pixel size of the viewport \since QGIS 3.20
NativeRasterAttributeTable = 1 << 7, //!< Indicates that the provider supports native raster attribute table \since QGIS 3.30
BuildPyramids = 1 << 8, //!< Supports building of pyramids (overviews) (since QGIS 3.38 -- this is a replacement for RasterInterfaceCapability::BuildPyramids)
};

4
src/core/qgsapplication.h
View File

@ -158,8 +158,8 @@ class CORE_EXPORT QgsApplication : public QApplication
*/
enum StyleSheetType
{
Qt, //! StyleSheet for Qt GUI widgets (based on QLabel or QTextBrowser), supports basic CSS and Qt extensions
WebBrowser, //! StyleSheet for embedded browsers (QtWebKit), supports full standard CSS
Qt, //!< StyleSheet for Qt GUI widgets (based on QLabel or QTextBrowser), supports basic CSS and Qt extensions
WebBrowser, //!< StyleSheet for embedded browsers (QtWebKit), supports full standard CSS
};
static const char *QGIS_ORGANIZATION_NAME;

2
src/core/qgsmaplayerelevationproperties.h
View File

@ -92,7 +92,7 @@ class CORE_EXPORT QgsMapLayerElevationProperties : public QObject
*/
enum class Property SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsMapLayerElevationProperties, Property ) : int
{
ZOffset, //! Z offset
ZOffset, //!< Z offset
ExtrusionHeight, //!< Extrusion height
RasterPerBandLowerElevation, //!< Lower elevation for each raster band \since QGIS 3.38
RasterPerBandUpperElevation, //!< Upper elevation for each raster band \since QGIS 3.38

6
src/core/qgsmaplayerref.h
View File

@ -41,9 +41,9 @@ struct _LayerRef
*/
enum MatchType
{
Name = 1 << 2, //! Match layer name
Provider = 1 << 3, //! Match layer provider name
Source = 1 << 4, //! Match layer source
Name = 1 << 2, //!< Match layer name
Provider = 1 << 3, //!< Match layer provider name
Source = 1 << 4, //!< Match layer source
All = Provider | Source //!< Match all
};

12
src/core/qgsogcutils.h
View File

@ -602,12 +602,12 @@ class CORE_EXPORT QgsOgcCrsUtils
//! CRS flavor
enum class CRSFlavor
{
UNKNOWN, //! unknown/unhandled flavor
AUTH_CODE, //! e.g EPSG:4326
HTTP_EPSG_DOT_XML, //! e.g. http://www.opengis.net/gml/srs/epsg.xml#4326 (called "OGC HTTP URL" in GeoServer WFS configuration panel)
OGC_URN, //! e.g. urn:ogc:def:crs:EPSG::4326
X_OGC_URN, //! e.g. urn:x-ogc:def:crs:EPSG::4326
OGC_HTTP_URI, //! e.g. http://www.opengis.net/def/crs/EPSG/0/4326
UNKNOWN, //!< Unknown/unhandled flavor
AUTH_CODE, //!< E.g EPSG:4326
HTTP_EPSG_DOT_XML, //!< E.g. http://www.opengis.net/gml/srs/epsg.xml#4326 (called "OGC HTTP URL" in GeoServer WFS configuration panel)
OGC_URN, //!< E.g. urn:ogc:def:crs:EPSG::4326
X_OGC_URN, //!< E.g. urn:x-ogc:def:crs:EPSG::4326
OGC_HTTP_URI, //!< E.g. http://www.opengis.net/def/crs/EPSG/0/4326
};
/**

28
src/server/qgsserverogcapi.h
View File

@ -57,20 +57,20 @@ class SERVER_EXPORT QgsServerOgcApi : public QgsServerApi
enum Rel
{
// The following registered link relation types are used
alternate, //! Refers to a substitute for this context.
describedBy, //! Refers to a resource providing information about the link’s context.
collection, //! The target IRI points to a resource that is a member of the collection represented by the context IRI.
item, //! The target IRI points to a resource that is a member of the collection represented by the context IRI.
self, //! Conveys an identifier for the link’s context.
service_desc, //! Identifies service description for the context that is primarily intended for consumption by machines.
service_doc, //! Identifies service documentation for the context that is primarily intended for human consumption.
prev, //! Indicates that the link’s context is a part of a series, and that the previous in the series is the link targe
next, //! Indicates that the link’s context is a part of a series, and that the next in the series is the link target.
license, //! Refers to a license associated with this context.
alternate, //!< Refers to a substitute for this context.
describedBy, //!< Refers to a resource providing information about the link’s context.
collection, //!< The target IRI points to a resource that is a member of the collection represented by the context IRI.
item, //!< The target IRI points to a resource that is a member of the collection represented by the context IRI.
self, //!< Conveys an identifier for the link’s context.
service_desc, //!< Identifies service description for the context that is primarily intended for consumption by machines.
service_doc, //!< Identifies service documentation for the context that is primarily intended for human consumption.
prev, //!< Indicates that the link’s context is a part of a series, and that the previous in the series is the link targe
next, //!< Indicates that the link’s context is a part of a series, and that the next in the series is the link target.
license, //!< Refers to a license associated with this context.
// In addition the following link relation types are used for which no applicable registered link relation type could be identified:
items, //! Refers to a resource that is comprised of members of the collection represented by the link’s context.
conformance, //! The target IRI points to a resource which represents the collection resource for the context IRI.
data //! The target IRI points to resource data
items, //!< Refers to a resource that is comprised of members of the collection represented by the link’s context.
conformance, //!< The target IRI points to a resource which represents the collection resource for the context IRI.
data //!< The target IRI points to resource data
};
Q_ENUM( Rel )
@ -79,7 +79,7 @@ class SERVER_EXPORT QgsServerOgcApi : public QgsServerApi
enum ContentType
{
GEOJSON,
OPENAPI3, //! "application/openapi+json;version=3.0"
OPENAPI3, //!< "application/openapi+json;version=3.0"
JSON,
HTML,
XML

10
src/server/qgsserverquerystringparameter.h
View File

@ -59,11 +59,11 @@ class SERVER_EXPORT QgsServerQueryStringParameter
*/
enum class Type
{
String = QMetaType::Type::QString, //! parameter is a string
Integer = QMetaType::Type::LongLong, //! parameter is an integer
Double = QMetaType::Type::Double, //! parameter is a double
Boolean = QMetaType::Type::Bool, //! parameter is a boolean
List = QMetaType::Type::QStringList, //! parameter is a (comma separated) list of strings, the handler will perform any further required conversion of the list values
String = QMetaType::Type::QString, //!< Parameter is a string
Integer = QMetaType::Type::LongLong, //!< Parameter is an integer
Double = QMetaType::Type::Double, //!< Parameter is a double
Boolean = QMetaType::Type::Bool, //!< Parameter is a boolean
List = QMetaType::Type::QStringList, //!< Parameter is a (comma separated) list of strings, the handler will perform any further required conversion of the list values
};
Q_ENUM( Type )

12
src/server/qgsserversettings.h
View File

@ -76,12 +76,12 @@ class SERVER_EXPORT QgsServerSettingsEnv : public QObject
QGIS_SERVER_WFS_SERVICE_URL, //!< To set the WFS service URL if it's not present in the project. \since QGIS 3.20
QGIS_SERVER_WCS_SERVICE_URL, //!< To set the WCS service URL if it's not present in the project. \since QGIS 3.20
QGIS_SERVER_WMTS_SERVICE_URL, //!< To set the WMTS service URL if it's not present in the project. \since QGIS 3.20
QGIS_SERVER_LANDING_PAGE_PREFIX, //! Prefix of the path component of the landing page base URL, default is empty (since QGIS 3.20).
QGIS_SERVER_PROJECT_CACHE_CHECK_INTERVAL, //! Set the interval in milliseconds for cache invalidation strategy 'interval', default to 0 which select the legacy File system watcher (since QGIS 3.26).
QGIS_SERVER_PROJECT_CACHE_STRATEGY, //! Set the project cache strategy. Possible values are 'filesystem', 'periodic' or 'off' (since QGIS 3.26).
QGIS_SERVER_ALLOWED_EXTRA_SQL_TOKENS, //! Adds these tokens to the list of allowed tokens that the services accept when filtering features (since QGIS 3.28).
QGIS_SERVER_APPLICATION_NAME, //! Define the QGIS Server application name (since QGIS 3.30).
QGIS_SERVER_CAPABILITIES_CACHE_SIZE, //! Define the QGIS Server capabilities cache size (since QGIS 3.31)
QGIS_SERVER_LANDING_PAGE_PREFIX, //!< Prefix of the path component of the landing page base URL, default is empty \since QGIS 3.20
QGIS_SERVER_PROJECT_CACHE_CHECK_INTERVAL, //!< Set the interval in milliseconds for cache invalidation strategy 'interval', default to 0 which select the legacy File system watcher \since QGIS 3.26
QGIS_SERVER_PROJECT_CACHE_STRATEGY, //!< Set the project cache strategy. Possible values are 'filesystem', 'periodic' or 'off' \since QGIS 3.26
QGIS_SERVER_ALLOWED_EXTRA_SQL_TOKENS, //!< Adds these tokens to the list of allowed tokens that the services accept when filtering features \since QGIS 3.28
QGIS_SERVER_APPLICATION_NAME, //!< Define the QGIS Server application name \since QGIS 3.30
QGIS_SERVER_CAPABILITIES_CACHE_SIZE, //!< Define the QGIS Server capabilities cache size \since QGIS 3.31
};
Q_ENUM( EnvVar )
};