diff --git a/python/PyQt6/core/auto_additions/qgis.py b/python/PyQt6/core/auto_additions/qgis.py index 510065f3496..d136a2da239 100644 --- a/python/PyQt6/core/auto_additions/qgis.py +++ b/python/PyQt6/core/auto_additions/qgis.py @@ -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 diff --git a/python/PyQt6/core/auto_additions/qgsmaplayerelevationproperties.py b/python/PyQt6/core/auto_additions/qgsmaplayerelevationproperties.py index e4c431b0ef8..b197c683ac0 100644 --- a/python/PyQt6/core/auto_additions/qgsmaplayerelevationproperties.py +++ b/python/PyQt6/core/auto_additions/qgsmaplayerelevationproperties.py @@ -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 diff --git a/python/PyQt6/server/auto_additions/qgsserverquerystringparameter.py b/python/PyQt6/server/auto_additions/qgsserverquerystringparameter.py index cadfb665403..9b3961c9595 100644 --- a/python/PyQt6/server/auto_additions/qgsserverquerystringparameter.py +++ b/python/PyQt6/server/auto_additions/qgsserverquerystringparameter.py @@ -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 """ # -- diff --git a/python/core/auto_additions/qgis.py b/python/core/auto_additions/qgis.py index 61736503b87..c53b9080f89 100644 --- a/python/core/auto_additions/qgis.py +++ b/python/core/auto_additions/qgis.py @@ -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 diff --git a/python/core/auto_additions/qgsmaplayerelevationproperties.py b/python/core/auto_additions/qgsmaplayerelevationproperties.py index f33a7c11910..22eeba51b54 100644 --- a/python/core/auto_additions/qgsmaplayerelevationproperties.py +++ b/python/core/auto_additions/qgsmaplayerelevationproperties.py @@ -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 diff --git a/python/server/auto_additions/qgsserverquerystringparameter.py b/python/server/auto_additions/qgsserverquerystringparameter.py index cadfb665403..9b3961c9595 100644 --- a/python/server/auto_additions/qgsserverquerystringparameter.py +++ b/python/server/auto_additions/qgsserverquerystringparameter.py @@ -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 """ # -- diff --git a/src/core/mesh/qgsmeshdataset.h b/src/core/mesh/qgsmeshdataset.h index 3027b58bbbf..bd674a7679c 100644 --- a/src/core/mesh/qgsmeshdataset.h +++ b/src/core/mesh/qgsmeshdataset.h @@ -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; diff --git a/src/core/qgis.h b/src/core/qgis.h index bd2d2c088ac..dee5e6f88ed 100644 --- a/src/core/qgis.h +++ b/src/core/qgis.h @@ -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, //