From 5a11edf754ca8eae16fdb2f221fb5146b59de46c Mon Sep 17 00:00:00 2001
From: Konstantin Ulitin <konstantin.ulitin@jetbrains.com>
Date: Tue, 20 Jan 2015 20:35:53 +0300
Subject: [PATCH] add javadoc

---
 .../src/com/intellij/psi/search/UseScopeOptimizer.java         | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/platform/indexing-impl/src/com/intellij/psi/search/UseScopeOptimizer.java b/platform/indexing-impl/src/com/intellij/psi/search/UseScopeOptimizer.java
index 58849a3f6fca..44255d467870 100644
--- a/platform/indexing-impl/src/com/intellij/psi/search/UseScopeOptimizer.java
+++ b/platform/indexing-impl/src/com/intellij/psi/search/UseScopeOptimizer.java
@@ -6,6 +6,9 @@ import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 /**
+ * Excludes scope from use scope of PSI element. The extension should be used only for optimization, i.e. it should throw off scopes
+ * which can't contain references to provided PSI element.
+ *
  * @author Konstantin.Ulitin
  */
 public abstract class UseScopeOptimizer {