diff options
Diffstat (limited to 'depends/settings/setting.h')
| -rw-r--r-- | depends/settings/setting.h | 27 |
1 files changed, 8 insertions, 19 deletions
diff --git a/depends/settings/setting.h b/depends/settings/setting.h index 179fa3bb..a73474d2 100644 --- a/depends/settings/setting.h +++ b/depends/settings/setting.h @@ -31,19 +31,18 @@ class LIBSETTINGS_EXPORT Setting : public QObject { Q_OBJECT public: - /*! - * \brief Constructs a new Setting object with the given parent. - * \param parent The Setting's parent object. + /** + * Construct a Setting + * + * Synonyms are all the possible names used in the settings object, in order of preference. + * First synonym is the ID, which identifies the setting in MultiMC. + * + * defVal is the default value that will be returned when the settings object + * doesn't have any value for this setting. */ explicit Setting(QStringList synonyms, QVariant defVal = QVariant()); /*! - * \brief Constructs a new Setting object with the given parent. - * \param parent The Setting's parent object. - */ - explicit Setting(QString id, QVariant defVal = QVariant()); - - /*! * \brief Gets this setting's ID. * This is used to refer to the setting within the application. * \warning Changing the ID while the setting is registered with a SettingsObject results in @@ -76,16 +75,6 @@ public: virtual QVariant get() const; /*! - * \brief Gets this setting's actual value (I.E. not as a QVariant). - * This function is just shorthand for get().value<T>() - * \return The setting's actual value. - */ - template <typename T> inline T value() const - { - return get().value<T>(); - } - - /*! * \brief Gets this setting's default value. * \return The default value of this setting. */ |