doc [completion]: more docs for completion APIs

GitOrigin-RevId: ebff21633c6ed52d14f2b38f1521cf005799b121
This commit is contained in:
Max Medvedev
2025-11-25 16:22:42 +00:00
committed by intellij-monorepo-bot
parent 35960ceefa
commit 473e007508
3 changed files with 15 additions and 0 deletions
@@ -1,6 +1,16 @@
// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
package com.intellij.codeInsight.completion;
/**
* Represents a completion process from the point of view of the completion framework.
* It is started when the user types in the editor or invokes completion explicitly (e.g., by a shortcut).
* It ends when the completion is finished successfully or canceled.
*
* @see CompletionService#getCurrentCompletion
*/
public interface CompletionProcess {
/**
* @return {@code true} if completion is triggered by typing in the editor, {@code false} if it's invoked by explicit action (e.g., by a shortcut)
*/
boolean isAutopopupCompletion();
}
@@ -60,6 +60,8 @@ import kotlin.math.max
* * [EmptyAutoPopup] - completion was triggered by typing, but no completion items were found, and the lookup is not shown
* * [InsertedSingleItem] - a single item was found, and it was inserted into the document
* * [NoSuggestionsHint] - candidate inference has finished, but no candidates were found and a warning "no suggestions found" is shown.
*
* @See CompletionServiceImpl.completionPhase
*/
sealed class CompletionPhase @ApiStatus.Internal constructor(
@JvmField
@@ -81,6 +81,9 @@ import static com.intellij.codeInsight.completion.CompletionPhase.CUSTOM_CODE_CO
/**
* See cancellation logic in {@link CompletionPhase.BgCalculation#restartOnWriteAction)}
*
* @see CompletionService#getCurrentCompletion
* @see CompletionServiceImpl#getCurrentCompletionProgressIndicator()
*/
@ApiStatus.Internal
public final class CompletionProgressIndicator extends ProgressIndicatorBase implements CompletionProcessEx, Disposable {