From a5c7d4f1fdf380608a26a35fd106bd71e7efdb24 Mon Sep 17 00:00:00 2001
From: Valentin Kipyatkov <valentin@jetbrains.com>
Date: Fri, 12 Aug 2016 16:15:31 +0300
Subject: [PATCH] Added comment

---
 .../kotlin/idea/intentions/loopToCallChain/interfaces.kt      | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/idea/src/org/jetbrains/kotlin/idea/intentions/loopToCallChain/interfaces.kt b/idea/src/org/jetbrains/kotlin/idea/intentions/loopToCallChain/interfaces.kt
index 07acb4abed3..bb43c9444dc 100644
--- a/idea/src/org/jetbrains/kotlin/idea/intentions/loopToCallChain/interfaces.kt
+++ b/idea/src/org/jetbrains/kotlin/idea/intentions/loopToCallChain/interfaces.kt
@@ -116,6 +116,10 @@ data class MatchingState(
 interface TransformationMatcher {
     fun match(state: MatchingState): TransformationMatch?
 
+    /**
+     * If false then this matcher won't be run when there is an index variable and it's used in the rest part of loop.
+     * Matchers that return true should be able to handle code using the index variable properly.
+     */
     val indexVariableAllowed: Boolean
 
     /**