From dc54e2bbc3d719be62dc4c8d836d7a77394267d1 Mon Sep 17 00:00:00 2001 From: Andrei Yankovich Date: Thu, 18 Nov 2021 11:56:03 +0300 Subject: [PATCH] Apply suggestions from code review --- isettings.h | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/isettings.h b/isettings.h index 855f58d..e55c05d 100644 --- a/isettings.h +++ b/isettings.h @@ -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(arg...) + * @endcode * @return pointer to a settings object; + * @see ISettings::instance */ template 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();