Added doc to SkateConfigUI

slackhq · Jul 7, 2023 · 7cc88fd · 7cc88fd
1 parent fd03bf1
commit 7cc88fd
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/skate-plugin/src/main/kotlin/com/slack/sgp/intellij/ui/SkateConfigUI.kt b/skate-plugin/src/main/kotlin/com/slack/sgp/intellij/ui/SkateConfigUI.kt
@@ -26,6 +26,10 @@ import com.slack.sgp.intellij.SkateBundle
 import com.slack.sgp.intellij.SkatePluginSettings
 import java.io.File
 
+/**
+ * This class represents the UI display of the Skate Plugin Settings. Right now, it allows users to
+ * choose a .md file and check if the panel should be displayed or not.
+ */
 internal class SkateConfigUI(
   private val settings: SkatePluginSettings,
   private val project: Project,