Skip to content

Commit 3d017b4

Browse files
committed
tweak on prop docs content
1 parent 54b4c9f commit 3d017b4

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

src/core/flux_base/flxCoreProps.h

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -721,11 +721,16 @@ class _flxPropertyTypedRW : public _flxPropertyBase<T, HIDDEN, SECURE>
721721
*/
722722

723723
/**
724-
* @brief A boolean read/write property object that takes a getter and a setter method and the target object.
724+
* @brief A boolean property object that calls provided methods to set/get the property value
725725
*
726-
* @tparam Object The containing object of this property
727-
* @tparam (Object::*_getter)() The method of Object to call when the property is read
728-
* @tparam (Object::*_setter)(bool) The method of Object to call when the property is set
726+
* The value of the property is set and read via methods provided during instantiation of the property object.
727+
* The setter method is called when the value is set on the property. The getter method is called to retrieve the
728+
* value of the property. Using methods to set/get the property value allows for dynamic behavior of the property.
729+
*
730+
* @tparam Object The containing object of this property - implementor of the getter/setter methods
731+
* @tparam (Object::*_getter)() A pointer to the method of Object to call when the property is read.
732+
* The method must return a boolean value
733+
* @tparam (Object::*_setter)(bool) A pointer to the method of Object to call when the property is set
729734
*/
730735
template <class Object, bool (Object::*_getter)(), void (Object::*_setter)(bool)>
731736
class flxPropertyRWBool : public _flxPropertyTypedRW<bool, Object, _getter, _setter>

0 commit comments

Comments
 (0)