summaryrefslogtreecommitdiffstats
path: root/src/corelib
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2021-02-26 13:41:36 +0100
committerKai Köhne <kai.koehne@qt.io>2021-05-06 15:56:54 +0200
commit3d7bc9ab84bd14adbd9c879730f7650be830ee24 (patch)
tree7a9d6a911c99a11fedd4487011074d2c89029103 /src/corelib
parent4f5c8fecaca5d875b19bc62fd8d8264f16eaedcd (diff)
Doc: Fix warnings on qproperty.cpp
Task-number: QTBUG-90662 Change-Id: I91f8b83c68c3692dc620063c93be9ddea64685a6 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Paul Wicking <paul.wicking@qt.io> (cherry picked from commit 4916255445f3b64a57683c0ef6bd5d80ad3b6359)
Diffstat (limited to 'src/corelib')
-rw-r--r--src/corelib/kernel/qproperty.cpp40
1 files changed, 22 insertions, 18 deletions
diff --git a/src/corelib/kernel/qproperty.cpp b/src/corelib/kernel/qproperty.cpp
index 81fe0992b9..3e6595758b 100644
--- a/src/corelib/kernel/qproperty.cpp
+++ b/src/corelib/kernel/qproperty.cpp
@@ -723,21 +723,21 @@ QString QPropertyBindingError::description() const
*/
/*!
- \fn bool QUntypedBindble::isValid()
+ \fn bool QUntypedBindable::isValid() const
Returns true if the QUntypedBindable is valid. Methods called on an invalid
QUntypedBindable generally have no effect, unless otherwise noted.
*/
/*!
- \fn bool QUntypedBindble::isReadOnly()
+ \fn bool QUntypedBindable::isReadOnly() const
\since 6.1
Returns true if the QUntypedBindable is read-only.
*/
/*!
- \fn bool QUntypedBindable::isBindable()
+ \fn bool QUntypedBindable::isBindable() const
\internal
Returns true if the underlying property's binding can be queried
@@ -749,9 +749,9 @@ QString QPropertyBindingError::description() const
*/
/*!
- \fn QUntypedPropertyBinding QUntypedBindable::makeBinding()
+ \fn QUntypedPropertyBinding QUntypedBindable::makeBinding(const QPropertyBindingSourceLocation &location)
- Creates a binding returning the underlying properties' value.
+ Creates a binding returning the underlying properties' value, using a specified source \a location.
*/
/*!
@@ -771,15 +771,15 @@ QString QPropertyBindingError::description() const
*/
/*!
- template<typename Functor> QPropertyChangeHandler<Functor> QUntypedBindable::subscribe(Functor f)
+ \fn template<typename Functor> QPropertyChangeHandler<Functor> QUntypedBindable::subscribe(Functor f)
Behaves like a call to \a f followed by \c onValueChanged(f),
- \sa onValueChanged
+ \sa onValueChanged()
*/
/*!
- \fn QUntypedPropertyBinding QUntypedBindable::binding()
+ \fn QUntypedPropertyBinding QUntypedBindable::binding() const
Returns the underlying property's binding if there is any, or a default
constructed QUntypedPropertyBinding otherwise.
@@ -809,9 +809,9 @@ QString QPropertyBindingError::description() const
*/
/*!
- \fn bool QUntypedBindable::hasBinding()
+ \fn bool QUntypedBindable::hasBinding() const
- Returns true if the underlying property has a binding.
+ Returns \c true if the underlying property has a binding.
*/
/*!
@@ -834,22 +834,24 @@ QString QPropertyBindingError::description() const
\snippet code/src_corelib_kernel_qproperty.cpp 0
\snippet code/src_corelib_kernel_qproperty.cpp 3
- \sa QMetaProperty::isBindable, template <typename T> QProperty<T>, QObjectBindableProperty
+ \sa QMetaProperty::isBindable, QProperty, QObjectBindableProperty
*/
/*!
\fn template<typename T> QPropertyBinding<T> QBindable<T>::makeBinding(const QPropertyBindingSourceLocation &location)
- Constructs a binding evaluating to the underlying property's value.
+ Constructs a binding evaluating to the underlying property's value, using a specified source
+ \a location.
*/
/*!
- \fn template <typename T> QPropertyBinding<T> QBindable<T>::binding()
+ \fn template <typename T> QPropertyBinding<T> QBindable<T>::binding() const
- Returns the currently set binding of the underlying property. If the property does not
+ Returns the currently set binding of the underlying property. If the property does not
have a binding, the returned \c QPropertyBinding<T> will be invalid.
- \sa setBinding, QPropertyBinding<T>::isValid(), hasBinding
+ \sa setBinding, hasBinding
+ //! \sa QPropertyBinding::isValid()
*/
/*!
@@ -858,7 +860,8 @@ QString QPropertyBindingError::description() const
Removes the currently set binding of the underlying property and returns it.
If the property does not have a binding, the returned \c QPropertyBinding<T> will be invalid.
- \sa setBinding, getBinding, QPropertyBinding<T>::isValid(), hasBinding
+ \sa binding, setBinding, hasBinding
+ //! \sa QPropertyBinding::isValid()
*/
@@ -868,7 +871,8 @@ QString QPropertyBindingError::description() const
Sets the underlying property's binding to \a binding. Does nothing if the QBindable is
read-only or invalid.
- \sa binding, QPropertyBinding<T>::isValid(), isReadOnly(), isValid()
+ \sa binding, isReadOnly(), isValid()
+ //! \sa QPropertyBinding::isValid()
*/
/*!
@@ -888,7 +892,7 @@ QString QPropertyBindingError::description() const
*/
/*!
- \fn template <typename T> void QBindable<T>::setValue(const T & value) const
+ \fn template <typename T> void QBindable<T>::setValue(const T &value)
Sets the underlying property's value to \a value. This removes any currenltly set
binding from it. This function has no effect if the QBindable is read-only or invalid.