fix dox

qgis · Jan 16, 2023 · 552684c · 552684c
1 parent e088ea4
commit 552684c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 8 deletions.
diff --git a/python/core/auto_generated/settings/qgssettingsentry.sip.in b/python/core/auto_generated/settings/qgssettingsentry.sip.in
@@ -337,20 +337,22 @@ Returns the current value (or default) if there is no former value.
 
     bool copyValueFromKey( const QString &key, const QStringList &dynamicKeyPartList = QStringList(), bool removeSettingAtKey = false ) const;
 %Docstring
-Copies the value from a given ``key`` if it exists.
+Copies the value from a given key if it exists.
 
+:param key: the key to copy the setting value from.
 :param dynamicKeyPartList: is the optional dynamic key part to determine the key. It must be the same for origin and destination keys.
-:param removeSettingAtKey: if ``True``, the setting at the old key will be removed
+:param removeSettingAtKey: if ``True``, the setting at the old key will be removed.
 
-:return: ``True`` if the key exists and the setting value could be copied
+:return: ``True`` if the key exists and the setting value could be copied.
 
 .. versionadded:: 3.30
 %End
 
     void copyValueToKey( const QString &key, const QStringList &dynamicKeyPartList = QStringList() ) const;
 %Docstring
-Copies the settings to the given ``key``
+Copies the settings to the given key.
 
+:param key: the key to copy the setting value to.
 :param dynamicKeyPartList: is the optional dynamic key part to determine the key. It must be the same for origin and destination keys.
 
 .. versionadded:: 3.30

diff --git a/src/core/settings/qgssettingsentry.h b/src/core/settings/qgssettingsentry.h
@@ -343,16 +343,18 @@ class CORE_EXPORT QgsSettingsEntryBase
     QVariant formerValueAsVariant( const QStringList &dynamicKeyPartList ) const;
 
     /**
-     * Copies the value from a given \a key if it exists.
+     * Copies the value from a given key if it exists.
+     * \param key the key to copy the setting value from.
      * \param dynamicKeyPartList is the optional dynamic key part to determine the key. It must be the same for origin and destination keys.
-     * \param removeSettingAtKey if TRUE, the setting at the old key will be removed
-     * \returns TRUE if the key exists and the setting value could be copied
+     * \param removeSettingAtKey if TRUE, the setting at the old key will be removed.
+     * \returns TRUE if the key exists and the setting value could be copied.
      * \since QGIS 3.30
      */
     bool copyValueFromKey( const QString &key, const QStringList &dynamicKeyPartList = QStringList(), bool removeSettingAtKey = false ) const;
 
     /**
-     * Copies the settings to the given \a key
+     * Copies the settings to the given key.
+     * \param key the key to copy the setting value to.
      * \param dynamicKeyPartList is the optional dynamic key part to determine the key. It must be the same for origin and destination keys.
      * \since QGIS 3.30
      */