fix PyQGIS API docs building

The current building of the PyQGIS API doc relies on the fact that the first line is a signature. If not given, it should be empty.
qgis · May 25, 2021 · 71e5e5c · 71e5e5c
1 parent 615bbd8
commit 71e5e5c
Showing 1 changed file with 12 additions and 17 deletions.
diff --git a/python/core/additions/qgssettingsentry.py b/python/core/additions/qgssettingsentry.py
@@ -23,16 +23,15 @@
 
 
 class PyQgsSettingsEntryEnumFlag(QgsSettingsEntryBase):
-    """ class PyQgsSettingsEntryEnumFlag
-    ingroup core
+    """ 
+    class PyQgsSettingsEntryEnumFlag
     An enum settings entry.
     since QGIS 3.20
     """
 
     def __init__(self, key, pluginName, defaultValue, description=str()):
-        """ Constructor for PyQgsSettingsEntryEnumFlag.
-
-        :param self: the PyQgsSettingsEntryEnumFlag object
+        """
+        Constructor for PyQgsSettingsEntryEnumFlag.
         :param key: argument specifies the final part of the settings key.
         :param pluginName: argument is inserted in the key after the section.
         :param defaultValue: argument specifies the default value for the settings entry.
@@ -53,9 +52,8 @@ def __init__(self, key, pluginName, defaultValue, description=str()):
         super().__init__(key, pluginName, defaultValueStr, description)
 
     def value(self, dynamicKeyPart=None, useDefaultValueOverride=False, defaultValueOverride=None):
-        """ Get settings value.
-
-        :param self: the PyQgsSettingsEntryEnumFlag object
+        """
+        Get settings value.
         :param dynamicKeyPart: argument specifies the dynamic part of the settings key.
         :param useDefaultValueOverride: argument specifies if defaultValueOverride should be used.
         :param defaultValueOverride: argument if valid is used instead of the normal default value.
@@ -75,9 +73,8 @@ def value(self, dynamicKeyPart=None, useDefaultValueOverride=False, defaultValue
                                            self.section())
 
     def defaultValue(self):
-        """ Get settings default value.
-
-        :param self: the PyQgsSettingsEntryEnumFlag object
+        """
+        Get settings default value.
         """
 
         if self.__metaEnum is None or not self.__metaEnum.isValid():
@@ -98,9 +95,8 @@ def defaultValue(self):
         return defaultValue
 
     def setValue(self, value, dynamicKeyPart=None):
-        """ Set settings value.
-
-        :param self: the PyQgsSettingsEntryEnumFlag object
+        """
+        Set settings value.
         :param dynamicKeyPart: argument specifies the dynamic part of the settings key.
         """
 
@@ -120,9 +116,8 @@ def setValue(self, value, dynamicKeyPart=None):
         return super().setVariantValue(enumFlagKey, dynamicKeyPart)
 
     def settingsType(self):
-        """ Get the settings entry type.
-
-        :param self: the PyQgsSettingsEntryEnumFlag object
+        """
+        Get the settings entry type.
         """
 
         return self.SettingsType.EnumFlag