sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-10-17 00:09:36 -04:00
Code Issues Packages Projects Releases Wiki Activity

Apply suggestions from code review

Browse Source 
Co-authored-by: Harrissou Sant-anna <delazj@gmail.com>
This commit is contained in:
Denis Rouzaud 2022-02-28 18:32:30 +01:00
parent 87d0f518ff
commit a648dc9fa7
4 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/core/qgis.h
View File

@ -211,7 +211,7 @@ class CORE_EXPORT Qgis
StringList, //!< List of strings
Bool, //!< Boolean
Integer, //!< Integer
Double, //!< Double precision numer
Double, //!< Double precision number
EnumFlag, //!< Enum or Flag
Color //!< Color
};
@ -1919,7 +1919,7 @@ template<class T> QString qgsFlagValueToKeys( const T &value, bool *returnOk = n
/**
* Returns the value corresponding to the given \a keys of a flag.
* If the keys are invalid, it will return the \a defaultValue.
* If \a tryValueAsKey is TRUE, it will try to convert the string key to an enum value
* If \a tryValueAsKey is TRUE, it will try to convert the string key to an enum value.
* If \a returnOk is given, it defines if the key could be converted to the value or if it had returned the default
* \since QGIS 3.16
*/

2
src/core/qgssnappingconfig.h
View File

@ -76,7 +76,7 @@ class CORE_EXPORT QgsSnappingConfig
static QString snappingTypeToString( Qgis::SnappingType type );
/**
* Convenient method to returns the translated name of the enum type
* Convenient method to return the translated name of the enum type
* Qgis::SnappingTypes.
* \since QGIS 3.12
* \deprecated since QGIS 3.26 use Qgis::snappingTypeToString instead

8
src/core/settings/qgssettingsentry.h
View File

@ -70,7 +70,7 @@ class CORE_EXPORT QgsSettingsEntryBase
* The \a section argument specifies the section.
* The \a defaultValue argument specifies the default value for the settings entry.
* The \a description argument specifies a description for the settings entry.
* The \a options arguments specifies the options for the settings entry.
* The \a options argument specifies the options for the settings entry.
*/
QgsSettingsEntryBase( const QString &key,
QgsSettings::Section section,
@ -237,7 +237,7 @@ class CORE_EXPORT QgsSettingsEntryBase
QString description() const;
/**
* Returns the former value of the settings if it has been enabled in the options
* Returns the former value of the settings if it has been enabled in the options.
* Returns the current value (or default) if there is no former value.
* \since QGIS 3.26
*/
@ -253,7 +253,7 @@ class CORE_EXPORT QgsSettingsEntryBase
protected:
/**
* Sets the settings value with a variant value
* Sets the settings value with a variant value.
* This should be called from any implementation as it takes care of actually calling QSettings
* \since QGIS 3.26
*/
@ -390,7 +390,7 @@ class CORE_EXPORT QgsSettingsEntryByReference : public QgsSettingsEntryBase
T defaultValue() const {return convertFromVariant( defaultValueAsVariant() );}
/**
* Returns the former value
* Returns the former value.
* Returns the current value (or default) if there is no former value.
*/
T formerValue( const QString &dynamicKeyPart = QString() ) const {return convertFromVariant( formerValueAsVariant( dynamicKeyPart ) );}

2
src/core/settings/qgssettingsentryimpl.h
View File

@ -39,7 +39,7 @@ class CORE_EXPORT QgsSettingsEntryVariant : public QgsSettingsEntryByReference<Q
* The \a section argument specifies the section.
* The \a defaultValue argument specifies the default value for the settings entry.
* The \a description argument specifies a description for the settings entry.
* The \a options arguments specifies the options for the settings entry.
* The \a options argument specifies the options for the settings entry.
*/
QgsSettingsEntryVariant( const QString &key,
QgsSettings::Section section,