fix(docs): correct Frame KDoc — StatusBar stays visible in simulation mode

Copilot · bedaHovorka · web-flow · commit 9a313456b492 · 2026-05-07T13:36:26.000Z
Agent-Logs-Url: https://github.com/bedaHovorka/interlockSim/sessions/6e672e3d-f6ab-46a6-8bfc-2d330c2698c0 Co-authored-by: bedaHovorka <5263405+bedaHovorka@users.noreply.github.com>
diff --git a/desktop-ui/src/main/kotlin/cz/vutbr/fit/interlockSim/gui/Frame.kt b/desktop-ui/src/main/kotlin/cz/vutbr/fit/interlockSim/gui/Frame.kt
@@ -34,7 +34,7 @@ import javax.swing.Timer
  *
  * Provides dynamic layout that adapts based on context type:
  * - **Editing Mode** ([EditingContext]): StatusBar visible, ControlPanel hidden
- * - **Simulation Mode** ([SimulationContext]): ControlPanel and EventTimelinePanel visible, StatusBar hidden
+ * - **Simulation Mode** ([SimulationContext]): ControlPanel and EventTimelinePanel visible, StatusBar remains visible (speed indicator shown)
  *
  * ## Layout Structure
  *
@@ -78,7 +78,7 @@ import javax.swing.Timer
  * 1. Creates [EventTimelinePanel] (lazy, reused across simulations)
  * 2. Wires EventTimelinePanel to [RailwayNetGridCanvas] → [cz.vutbr.fit.interlockSim.gui.animation.AnimationController]
  * 3. Starts 10 Hz timer for [ControlPanel] time updates
- * 4. Shows ControlPanel and EventTimelinePanel, hides StatusBar
+ * 4. Shows ControlPanel and EventTimelinePanel (above StatusBar); StatusBar remains visible
  *
  * When an [EditingContext] is set, the frame:
  * 1. Hides ControlPanel and EventTimelinePanel

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ import javax.swing.Timer`
`34`	`34`	`*`
`35`	`35`	`* Provides dynamic layout that adapts based on context type:`
`36`	`36`	`* - Editing Mode ([EditingContext]): StatusBar visible, ControlPanel hidden`
`37`		`- * - Simulation Mode ([SimulationContext]): ControlPanel and EventTimelinePanel visible, StatusBar hidden`
	`37`	`+ * - Simulation Mode ([SimulationContext]): ControlPanel and EventTimelinePanel visible, StatusBar remains visible (speed indicator shown)`
`38`	`38`	`*`
`39`	`39`	`* ## Layout Structure`
`40`	`40`	`*`
`@@ -78,7 +78,7 @@ import javax.swing.Timer`
`78`	`78`	`* 1. Creates [EventTimelinePanel] (lazy, reused across simulations)`
`79`	`79`	`* 2. Wires EventTimelinePanel to [RailwayNetGridCanvas] → [cz.vutbr.fit.interlockSim.gui.animation.AnimationController]`
`80`	`80`	`* 3. Starts 10 Hz timer for [ControlPanel] time updates`
`81`		`- * 4. Shows ControlPanel and EventTimelinePanel, hides StatusBar`
	`81`	`+ * 4. Shows ControlPanel and EventTimelinePanel (above StatusBar); StatusBar remains visible`
`82`	`82`	`*`
`83`	`83`	`* When an [EditingContext] is set, the frame:`
`84`	`84`	`* 1. Hides ControlPanel and EventTimelinePanel`