Apply suggestions from code review

This commit is contained in:
Andrei Yankovich 2021-11-18 11:56:03 +03:00 committed by GitHub
parent 53d5cd4ff2
commit dc54e2bbc3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -37,8 +37,12 @@ class QUASARAPPSHARED_EXPORT ISettings : public QObject
public:
/**
* @brief init This method return instance of the settings object
* @brief init This method return instance of the settings object and initialize new settings model if object not exists.
* @code{cpp}
auto settingsObject = ISettings::init<SettingsModelClass>(arg...)
* @endcode
* @return pointer to a settings object;
* @see ISettings::instance
*/
template <class SettingsType, class... Args>
static ISettings* init(Args&&... args) {
@ -53,8 +57,9 @@ public:
}
/**
* @brief instance
* @return
* @brief instance This method return pointer to current settings model. if this model not initialized then return nullptr.
* @return pointer to current settings model if object initialized else nullptr.
* @see ISettings::init
*/
static const ISettings* instance();