diff options
| author | Andreas Buhr <andreas.buhr@qt.io> | 2021-01-27 10:10:10 +0100 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2021-03-07 07:56:13 +0000 |
| commit | 218b7c8a5bbc540324d45bad752f328799f97b95 (patch) | |
| tree | 0542456cc099a6b0723c3999269eb44f0600d310 /src/corelib | |
| parent | 542f2036e7e3aadd2bb144125250c22a7a6509b4 (diff) | |
Add documentation for Q_OBJECT_BINDABLE_PROPERTY
The duo Q_OBJECT_BINDABLE_PROPERTY and QObjectBindableProperty
can only be documented together. The documentation is now with
QObjectBindableProperty. This patch adds a documentation entry
for Q_OBJECT_BINDABLE_PROPERTY which links the user to
QObjectBindableProperty.
Task-number: QTBUG-90511
Change-Id: I9af4a99d49f4b02ee9645a2cc9a9a024a6a1a552
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
(cherry picked from commit 89cc39a894dddaa0347ecf08438ea31b4880961c)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'src/corelib')
| -rw-r--r-- | src/corelib/kernel/qproperty.cpp | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/src/corelib/kernel/qproperty.cpp b/src/corelib/kernel/qproperty.cpp index b009699a6d..ea748d0784 100644 --- a/src/corelib/kernel/qproperty.cpp +++ b/src/corelib/kernel/qproperty.cpp @@ -1151,6 +1151,29 @@ QString QPropertyBindingError::description() const */ /*! + \macro Q_OBJECT_BINDABLE_PROPERTY(containingClass, type, name, signal) + \since 6.0 + \relates QObjectBindableProperty + \brief Declares a \l QObjectBindableProperty inside \a containingClass + of type \a type with name \a name. If the optional argument \a signal is given, + this signal will be emitted when the property is marked dirty. + + \sa {Qt's Property System}, {Qt Bindable Properties} +*/ + +/*! + \macro Q_OBJECT_BINDABLE_PROPERTY_WITH_ARGS(containingClass, type, name, initialvalue, signal) + \since 6.0 + \relates QObjectBindableProperty + \brief Declares a \l QObjectBindableProperty inside \a containingClass + of type \a type with name \a name which is initialized to \a initialvalue. + If the optional argument \a signal is given, this signal will be emitted when + the property is marked dirty. + + \sa {Qt's Property System}, {Qt Bindable Properties} +*/ + +/*! \fn template <typename Class, typename T, auto offset, auto Callback> QObjectBindableProperty<Class, T, offset, Callback>::QObjectBindableProperty() Constructs a property with a default constructed instance of T. |