From c65ae380a16cfc8c001370fbd5a4c12656e1e9c9 Mon Sep 17 00:00:00 2001 From: peter Date: Wed, 21 Aug 2013 12:52:55 +0200 Subject: [PATCH] CompletionConfidence.shouldSkipAutopopup javadoc --- .../intellij/codeInsight/completion/CompletionConfidence.java | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/platform/lang-api/src/com/intellij/codeInsight/completion/CompletionConfidence.java b/platform/lang-api/src/com/intellij/codeInsight/completion/CompletionConfidence.java index 6ba89a9eaf9f..ab7b43c07cc8 100644 --- a/platform/lang-api/src/com/intellij/codeInsight/completion/CompletionConfidence.java +++ b/platform/lang-api/src/com/intellij/codeInsight/completion/CompletionConfidence.java @@ -31,6 +31,10 @@ public abstract class CompletionConfidence { @NotNull public abstract ThreeState shouldFocusLookup(@NotNull CompletionParameters parameters); + /** + * This method is invoked first when a completion autopopup is scheduled. Extensions are able to cancel this completion process based on location. + * For example, in string literals or comments completion autopopup may do more harm than good. + */ @NotNull public ThreeState shouldSkipAutopopup(@NotNull PsiElement contextElement, @NotNull PsiFile psiFile, int offset) { return ThreeState.UNSURE;