Updated comments for listeners

benpollarduk · Nov 8, 2023 · 5dcf9ae · 5dcf9ae
1 parent 0836d95
commit 5dcf9ae
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/ktvn/src/main/kotlin/com/github/benpollarduk/ktvn/logic/structure/ChapterListener.kt b/ktvn/src/main/kotlin/com/github/benpollarduk/ktvn/logic/structure/ChapterListener.kt
@@ -5,12 +5,12 @@ package com.github.benpollarduk.ktvn.logic.structure
  */
 public interface ChapterListener {
     /**
-     * Enter a [chapter].
+     * Invoke the listener to notify entry of a specified [chapter].
      */
     public fun enter(chapter: Chapter)
 
     /**
-     * Exit a [chapter].
+     * Invoke the listener to notify exit of a specified [chapter].
      */
     public fun exit(chapter: Chapter)
 }
diff --git a/ktvn/src/main/kotlin/com/github/benpollarduk/ktvn/logic/structure/SceneListener.kt b/ktvn/src/main/kotlin/com/github/benpollarduk/ktvn/logic/structure/SceneListener.kt
@@ -5,12 +5,12 @@ package com.github.benpollarduk.ktvn.logic.structure
  */
 public interface SceneListener {
     /**
-     * Enter a [scene].
+     * Invoke the listener to notify entry of a specified [scene].
      */
     public fun enter(scene: Scene)
 
     /**
-     * Exit a [scene].
+     * Invoke the listener to notify exit of a specified [scene].
      */
     public fun exit(scene: Scene)
 }