From 7053c8fcd932346c45be967b705da03360c2ba5d Mon Sep 17 00:00:00 2001
From: "Roman.Ivanov" <Roman.Ivanov@jetbrains.com>
Date: Fri, 30 Mar 2018 13:05:31 +0700
Subject: [PATCH] ElementProcessingHintPass: add kdoc

---
 .../codeInsight/hints/ElementProcessingHintPass.kt       | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/java/java-impl/src/com/intellij/codeInsight/hints/ElementProcessingHintPass.kt b/java/java-impl/src/com/intellij/codeInsight/hints/ElementProcessingHintPass.kt
index 1372ce7ff7b0..07374c430333 100644
--- a/java/java-impl/src/com/intellij/codeInsight/hints/ElementProcessingHintPass.kt
+++ b/java/java-impl/src/com/intellij/codeInsight/hints/ElementProcessingHintPass.kt
@@ -41,12 +41,21 @@ abstract class ElementProcessingHintPass(
     }
   }
 
+  /**
+   * Returns true if this pass should be applied for current [virtualFile]
+   */
   abstract fun isAvailable(virtualFile: VirtualFile): Boolean
 
+  /**
+   * For current [element] collect hints information if it is possible
+   */
   abstract fun collectElementHints(element: PsiElement)
 
   abstract fun applyHintsToEditor()
 
+  /**
+   * Clear collected hint information
+   */
   abstract fun clearCollected()
 
   abstract val modificationStampHolder: ModificationStampHolder