1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add documentation for Q_OBJECT_BINDABLE_PROPERTY

Browse Source 
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>
This commit is contained in:
Andreas Buhr 2021-01-27 10:10:10 +01:00 committed by Qt Cherry-pick Bot
parent 081eb5d636
commit 920ecea06a
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/corelib/kernel/qproperty.cpp
View File

@ -947,6 +947,29 @@ QString QPropertyBindingError::description() const
of the Q_OBJECT_BINDABLE_PROPERTY macro.
*/
/*!
\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()