Skip to content

Commit c012ad0

Browse files
Reword examples
1 parent 84f9ed4 commit c012ad0

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

src/app/cluster-building-blocks/QuieterReporting.h

+9-7
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,6 @@
2828
namespace chip {
2929
namespace app {
3030

31-
// - If it has changed due to a change in the CurrentPhase or OperationalState attributes, or
32-
// - When it changes from 0 to any other value and vice versa, or
33-
// - When it changes from null to any other value and vice versa, or
34-
// - When it increases, or
35-
// - When there is any increase or decrease in the estimated time remaining that was due to progressing insight of the server's control logic, or
36-
// - When it changes at a rate significantly different from one unit per second.
37-
3831
enum class QuieterReportingPolicyEnum
3932
{
4033
kMarkDirtyOnChangeToFromZero = (1u << 0),
@@ -75,6 +68,15 @@ using Nullable = chip::app::DataModel::Nullable<T>;
7568
* method most suitable at the call site (e.g. `MatterReportingAttributeChangeCallback` call
7669
* or similar methods).
7770
*
71+
* Example of situations that require dirty, which are possible to support with this class:
72+
*
73+
* - If attribute has changed due to a change in the X or Y attributes, or
74+
* - When it changes from 0 to any other value and vice versa, or
75+
* - When it changes from null to any other value and vice versa, or
76+
* - When it increases, or
77+
* - When there is any increase or decrease in the estimated time remaining that was due to progressing insight of the server's control logic, or
78+
* - When it changes at a rate significantly different from one unit per second.
79+
*
7880
* @tparam T - the type of underlying numerical value that will be held by the class.
7981
*/
8082
template <typename T>

0 commit comments

Comments
 (0)