From 920ecea06aec2e87d1fa2270a4023def84024c63 Mon Sep 17 00:00:00 2001 From: Andreas Buhr Date: Wed, 27 Jan 2021 10:10:10 +0100 Subject: 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 Reviewed-by: Paul Wicking Reviewed-by: Edward Welbourne (cherry picked from commit 89cc39a894dddaa0347ecf08438ea31b4880961c) Reviewed-by: Qt Cherry-pick Bot --- src/corelib/kernel/qproperty.cpp | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/src/corelib/kernel/qproperty.cpp b/src/corelib/kernel/qproperty.cpp index 21eb7789af..e6fb25c6b5 100644 --- a/src/corelib/kernel/qproperty.cpp +++ b/src/corelib/kernel/qproperty.cpp @@ -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 QObjectBindableProperty::QObjectBindableProperty() -- cgit v1.2.3