Add comment

JetBrains · Jul 11, 2024 · 5923b3b · 5923b3b
1 parent ef35572
commit 5923b3b
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/vim-engine/src/main/kotlin/com/maddyhome/idea/vim/api/VimCommandLine.kt b/vim-engine/src/main/kotlin/com/maddyhome/idea/vim/api/VimCommandLine.kt
@@ -13,6 +13,14 @@ import com.maddyhome.idea.vim.diagnostic.vimLogger
 import javax.swing.KeyStroke
 import kotlin.math.min
 
+/**
+ * This interface is not supposed to have any implementation logic.
+ * The reason why we have implementation details here is
+ * that this class extended by [ExEntryPanel] that already extends [JPanel]
+ * and can't extend a base implementation of [VimCommandLine].
+ * It will also be hard to wrap [ExEntryPanel] into some other class that extends [VimCommandLine],
+ * because [ExEntryPanel] has a listener that should use the [actualText] field, so it must implement [VimCommandLine]
+ */
 interface VimCommandLine {
   companion object {
     private val logger = vimLogger<VimCommandLine>()