Apply documentation suggestions from code review

Co-authored-by: Boris Zbarsky <bzbarsky@apple.com>
project-chip · Jul 25, 2023 · 9095d32 · 9095d32
1 parent 885d240
commit 9095d32
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/examples/all-clusters-app/linux/main-common.cpp b/examples/all-clusters-app/linux/main-common.cpp
@@ -192,7 +192,7 @@ void ApplicationInit()
 
 void ApplicationShutdown()
 {
-    // These have been initialised via the emberAfXxxClusterInitCallback methods. We need to destroy them before shutdown.
+    // These may have been initialised via the emberAfXxxClusterInitCallback methods. We need to destroy them before shutdown.
     Clusters::DishwasherMode::Shutdown();
     Clusters::LaundryWasherMode::Shutdown();
     Clusters::RvcCleanMode::Shutdown();

diff --git a/src/app/clusters/mode-base-server/mode-base-server.h b/src/app/clusters/mode-base-server/mode-base-server.h
@@ -241,7 +241,9 @@ class Delegate
 // todo change once there is a clear public interface for the OnOff cluster data dependencies (#27508)
 static IntrusiveList<Instance> gModeBaseAliasesInstances;
 
-// This does not return a const of gModeBaseAliasesInstances since the caller might need to call the element's UpdateXxx methods.
+// This does not return a refernce to const IntrusiveList, because the caller might need
+// to change the state of the instances in the list and const IntrusiveList only allows
+// access to const Instance.
 IntrusiveList<Instance> & GetModeBaseInstanceList();
 
 } // namespace ModeBase