Document purpose of createDeprecatedSceneChannels.

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>
openhab · Dec 5, 2021 · aaf4a18 · aaf4a18
1 parent a777f02
commit aaf4a18
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/...src/main/java/org/openhab/binding/hdpowerview/internal/handler/HDPowerViewHubHandler.java b/...src/main/java/org/openhab/binding/hdpowerview/internal/handler/HDPowerViewHubHandler.java
@@ -347,6 +347,11 @@ private Channel createSceneChannel(Scene scene) {
         return channel;
     }
 
+    /**
+     * Create backwards compatible scene channels if any items configured before release 3.2
+     * are still linked. Users should have a reasonable amount of time to migrate to the new
+     * scene channels that are connected to a channel group.
+     */
     private void createDeprecatedSceneChannels(List<Scene> scenes) {
         if (deprecatedChannelsCreated) {
             // Only do this once.