Added doc

kotest · Dec 8, 2024 · e0ff526 · e0ff526
1 parent 629217b
commit e0ff526
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/main/kotlin/io/kotest/plugin/intellij/structure/KotestStructureViewExtension.kt b/src/main/kotlin/io/kotest/plugin/intellij/structure/KotestStructureViewExtension.kt
@@ -14,6 +14,10 @@ import io.kotest.plugin.intellij.TestElement
 import io.kotest.plugin.intellij.psi.specStyle
 import org.jetbrains.kotlin.psi.KtClassOrObject
 
+/**
+ * This adds Kotest nodes to the Structure view in intellij (note structure view is not the project view).
+ * This is used to display the tests in the structure view which are navigable.
+ */
 class KotestStructureViewExtension : StructureViewExtension {
 
    override fun getType(): Class<out PsiElement> {