Skip to content

Commit f1c6f1f

Browse files
Apply suggestions from code review
Co-authored-by: Boris Zbarsky <bzbarsky@apple.com>
1 parent 78003be commit f1c6f1f

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

src/app/icd/server/ICDManager.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -458,7 +458,7 @@ void ICDManager::UpdateOperationState(OperationalState state)
458458
DeviceLayer::SystemLayer().StartTimer(activeModeDuration, OnActiveModeDone, this);
459459

460460
Milliseconds32 activeModeJitterInterval = Milliseconds32(ICD_ACTIVE_TIME_JITTER_MS);
461-
// TODO(#33074): Edge case when we transition to IdleMode with this conditio being true
461+
// TODO(#33074): Edge case when we transition to IdleMode with this condition being true
462462
// (activeModeDuration == kZero && !mKeepActiveFlags.HasAny())
463463
activeModeJitterInterval =
464464
(activeModeDuration >= activeModeJitterInterval) ? activeModeDuration - activeModeJitterInterval : kZero;

src/app/icd/server/ICDManager.h

+5-5
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ class ICDManager : public ICDListener, public TestEventTriggerHandler
108108
* @param[in] feature FeatureMap bit to verify
109109
*
110110
* @return true: if the FeatureMap bit is enabled in the ICDM cluster attribute.
111-
* false: ff the FeatureMap bit is not enabled in the ICDM cluster attribute.
111+
* false: if the FeatureMap bit is not enabled in the ICDM cluster attribute.
112112
* if we failed to read the FeatureMap attribute.
113113
*/
114114
bool SupportsFeature(Clusters::IcdManagement::Feature feature);
@@ -186,21 +186,21 @@ class ICDManager : public ICDListener, public TestEventTriggerHandler
186186
/**
187187
* @brief UpdateICDMode checks in which ICDMode (SIT or LIT) the ICD can go to and updates the mode if necessary.
188188
* For a SIT ICD, the function does nothing.
189-
* For a LIT ICD, the function checks if the ICD has a registration in the ICDMonitoringTable to determine in which
189+
* For a LIT ICD, the function checks if the ICD has a registration in the ICDMonitoringTable to determine which
190190
* ICDMode the ICD must be in.
191191
*/
192192
void UpdateICDMode();
193193

194194
/**
195195
* @brief UpdateOperationState updates the OperationState of the ICD to the requested one.
196196
* IdleMode -> IdleMode : No actions are necessary, do nothing.
197-
* IdleMode -> ActiveMode : Transition the device to ActiveMode, start the ActiveMode timer and triggers all necessary
197+
* IdleMode -> ActiveMode : Transition the device to ActiveMode, start the ActiveMode timer and trigger all necessary
198198
* operations. These operations could be : Send Check-In messages
199199
* Send subscription reports
200200
* Process user actions
201201
* ActiveMode -> ActiveMode : Increase remaining ActiveMode timer to one ActiveModeThreshold.
202202
* If ActiveModeThreshold is 0, do nothing.
203-
* ActiveMode -> IdleMode : Transition ICD to IdleMode and starts the IdleMode timer.
203+
* ActiveMode -> IdleMode : Transition ICD to IdleMode and start the IdleMode timer.
204204
*
205205
* @param state requested OperationalState for the ICD to transition to
206206
*/
@@ -209,7 +209,7 @@ class ICDManager : public ICDListener, public TestEventTriggerHandler
209209
/**
210210
* @brief Set or Remove a keep ActiveMode requirement for the given flag
211211
* If state is true and the ICD is in IdleMode, transition the ICD to ActiveMode
212-
* If state is false and the ICD is in ActiveMode, verifies if we can transition the ICD to IdleMode.
212+
* If state is false and the ICD is in ActiveMode, check whether we can transition the ICD to IdleMode.
213213
* If we can, transition the ICD to IdleMode.
214214
*
215215
* @param flag KeepActiveFlag to remove or add

src/app/icd/server/ICDStateObserver.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ namespace chip {
2828
namespace app {
2929

3030
/**
31-
* @brief Public API used my the ICDManager to expose when different events occurs.
32-
* ICDManager::RegisterObserver can be used to register as an Observer to be notified when these events occurs.
31+
* @brief Public API used by the ICDManager to expose when different events occur.
32+
* ICDManager::RegisterObserver can be used to register as an Observer to be notified when these events occur.
3333
* These functions are called synchronously.
3434
*/
3535
class ICDStateObserver

0 commit comments

Comments
 (0)