Address PR comment

project-chip · Oct 12, 2023 · 7cd9038 · 7cd9038
1 parent 0a58760
commit 7cd9038
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 31 deletions.
diff --git a/src/app/common/templates/config-data.yaml b/src/app/common/templates/config-data.yaml
@@ -12,7 +12,7 @@ WeakEnums:
     - RadioFaultEnum
     - StepMode
 
-EnumsNotUsedInDataModelStruct:
+EnumsNotUsedAsTypeInXML:
     # List of enums that are not used in a DataModel Struct. By adding an enum
     # to this list you prevent incorrectly assuming from code that you are
     # able to use kUnknownEnumValue safely. This happens for derivate clusters

diff --git a/src/app/zap-templates/templates/app/cluster-enums-check.zapt b/src/app/zap-templates/templates/app/cluster-enums-check.zapt
@@ -9,7 +9,7 @@ namespace app {
 namespace Clusters {
 {{#zcl_clusters}}
 {{#zcl_enums}}
-{{#unless (isInConfigList (concat (asUpperCamelCase ../name) "::" label) "EnumsNotUsedInDataModelStruct")}}
+{{#unless (isInConfigList (concat (asUpperCamelCase ../name) "::" label) "EnumsNotUsedAsTypeInXML")}}
 static auto __attribute__((unused)) EnsureKnownEnumValue({{asUpperCamelCase ../name}}::{{asType label}} val)
 {
     using EnumType = {{asUpperCamelCase ../name}}::{{asType label}};

diff --git a/src/app/zap-templates/templates/app/cluster-enums.zapt b/src/app/zap-templates/templates/app/cluster-enums.zapt
@@ -24,17 +24,18 @@ enum class {{asType label}} : {{asUnderlyingZclType name}} {
 {{#zcl_enum_items}}
 k{{asUpperCamelCase label}} = {{asHex value 2}},
 {{/zcl_enum_items}}
-{{#unless (isInConfigList (concat (asUpperCamelCase ../name) "::" label) "EnumsNotUsedInDataModelStruct")}}
+{{#unless (isInConfigList (concat (asUpperCamelCase ../name) "::" label) "EnumsNotUsedAsTypeInXML")}}
 // All received enum values that are not listed above will be mapped
 // to kUnknownEnumValue. This is a helper enum value that should only
 // be used by code to process how it handles receiving and unknown
 // enum value. This specific should never be transmitted.
 kUnknownEnumValue = {{first_unused_enum_value mode="first_unused"}},
 {{else}}
-// kUnknownEnumValue intentionally not defined. This enum is not used
-// in a DataModel struct, likely because it is a part of a derivative
+// kUnknownEnumValue intentionally not defined. This enum never goes
+// through DataModel::Decode, likely because it is a part of a derived
 // cluster. As a result having kUnknownEnumValue in this enum is error
-// prone, and was removed.
+// prone, and was removed. See
+// src/app/common/templates/config-data.yaml.
 {{/unless}}
 };
 {{#if (isInConfigList label "WeakEnums")}}

diff --git a/src/controller/python/chip/clusters/Objects.py b/src/controller/python/chip/clusters/Objects.py
diff --git a/src/controller/python/templates/python-cluster-Objects-py.zapt b/src/controller/python/templates/python-cluster-Objects-py.zapt
@@ -54,17 +54,18 @@ class {{asUpperCamelCase name}}(Cluster):
 {{#zcl_enum_items}}
             k{{asUpperCamelCase label}} = {{asHex value 2}}
 {{/zcl_enum_items}}
-{{#unless (isInConfigList (concat (asUpperCamelCase ../name) "::" label) "EnumsNotUsedInDataModelStruct")}}
+{{#unless (isInConfigList (concat (asUpperCamelCase ../name) "::" label) "EnumsNotUsedAsTypeInXML")}}
             # All received enum values that are not listed above will be mapped
             # to kUnknownEnumValue. This is a helper enum value that should only
             # be used by code to process how it handles receiving and unknown
             # enum value. This specific should never be transmitted.
             kUnknownEnumValue = {{first_unused_enum_value mode="first_unused"}},
 {{else}}
-            # kUnknownEnumValue intentionally not defined. This enum is not used
-            # in a DataModel struct, likely because it is a part of a derivative
+            # kUnknownEnumValue intentionally not defined. This enum never goes
+            # through DataModel::Decode, likely because it is a part of a derived
             # cluster. As a result having kUnknownEnumValue in this enum is error
-            # prone, and was removed.
+            # prone, and was removed. See
+            # src/app/common/templates/config-data.yaml.
 {{/unless}}
 
 {{#last}}