Documentation update

home-climate-control · Aug 4, 2024 · 7855793 · 7855793
1 parent b02a3b5
commit 7855793
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/modules/hcc-config/src/main/java/net/sf/dz3r/runtime/config/model/UnitDirectorConfig.java b/modules/hcc-config/src/main/java/net/sf/dz3r/runtime/config/model/UnitDirectorConfig.java
@@ -12,7 +12,7 @@
  * Configuration for {@link net.sf.dz3r.model.UnitDirector}.
  *
  * @param connectors A set of both {@link net.sf.dz3r.view.Connector} and {@link net.sf.dz3r.view.MetricsCollector} IDs.
- * @param sensorFeedMapping
+ * @param sensorFeedMapping Mapping from the sensor to the zone it serves. TODO: Make this explicit with a Java record, the order is confusing and it easy to mix the key and the value.
  */
 @JsonNaming(PropertyNamingStrategies.KebabCaseStrategy.class)
 public record UnitDirectorConfig(