Skip to content
This repository was archived by the owner on Mar 4, 2023. It is now read-only.

Commit 872a44a

Browse files
committed
completed core doc update
1 parent 27acfbc commit 872a44a

29 files changed

+1086
-146
lines changed

doc/Doxyfile

+2-1
Original file line numberDiff line numberDiff line change
@@ -2169,7 +2169,8 @@ INCLUDE_FILE_PATTERNS = *.h \
21692169
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
21702170

21712171
PREDEFINED = __cplusplus=201402L \
2172-
DOXYGEN_RUN
2172+
DOXYGEN_RUN \
2173+
QTMVVM_REVISION_1
21732174

21742175
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
21752176
# tag can be used to specify a list of macro names that should be expanded. The

doc/isettingsaccessor.dox

+45
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,51 @@ Currently, the following backends are supported:
5353
AndroidSettingsAccessor, SettingsViewModel, DataSyncSettingsViewModel, @ref settings_generator
5454
*/
5555

56+
/*!
57+
@fn QtMvvm::ISettingsAccessor::setDefaultAccessor()
58+
59+
@tparam T The type to be registered as the default type. Must implement ISettingsAccessor
60+
61+
After setting the type via this method, createDefaultAccessor() will create instances of that
62+
type when called.
63+
64+
@note In order for this to work, the passed type must have an invokable constructor, i.e.
65+
@code{.cpp}
66+
Q_INVOKABLE MySettingsAccessor(QObject *parent = nullptr);
67+
@endcode
68+
69+
@sa ISettingsAccessor::createDefaultAccessor
70+
*/
71+
72+
/*!
73+
@fn QtMvvm::ISettingsAccessor::setDefaultAccessor(int)
74+
75+
@param typeId The typeId to be registered as the default type. Must implement ISettingsAccessor
76+
77+
After setting the type via this method, createDefaultAccessor() will create instances of that
78+
type when called.
79+
80+
@note In order for this to work, the passed type must have an invokable constructor, i.e.
81+
@code{.cpp}
82+
Q_INVOKABLE MySettingsAccessor(QObject *parent = nullptr);
83+
@endcode
84+
85+
@sa ISettingsAccessor::createDefaultAccessor
86+
*/
87+
88+
/*!
89+
@fn QtMvvm::ISettingsAccessor::createDefaultAccessor
90+
91+
@param parent The parent object to be passed to to accessor constructor
92+
@returns A newly created instance of the default accessor type, or nullptr
93+
94+
Constructs and returns a new instance of the default accessor type. The default type is
95+
QSettingsAccessor, but can be overwritten via setDefaultAccessor(). If the type set like that
96+
is invalid or cannot be dynamically constructor, nullptr can be returned.
97+
98+
@sa ISettingsAccessor::setDefaultAccessor
99+
*/
100+
56101
/*!
57102
@fn QtMvvm::ISettingsAccessor::contains
58103

0 commit comments

Comments
 (0)