MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

ExternalAnnotator: Javadoc cleanup

Browse Source 
GitOrigin-RevId: f233e4415fe847b783194b735ced2affc648db74
This commit is contained in:
Yann Cébron
2019-06-14 19:03:02 +03:00
committed by intellij-monorepo-bot
parent b468a89f0d
commit 1729ef59a6
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
platform/analysis-api/src/com/intellij/lang/annotation/ExternalAnnotator.java
+10 -6
View File
@@ -8,20 +8,24 @@ import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* <p>Implemented by a custom language plugin to process the files in a language by an
* Implemented by a custom language plugin to process the files in a language by an
* external annotation tool ("linter"). External annotators are expected to be (relatively) slow and are started
* after regular annotators have completed their work.</p>
*
* <p>Annotators work in three steps: first, {@link #collectInformation(PsiFile, Editor, boolean)} is called
* for the annotator to collect some data about a file needed for launching a tool; then collected data
* is passed to {@link #doAnnotate} which executes a tool and collect highlighting data; finally, highlighting data
* is applied to a file by {@link #apply}.</p>
* <p>Annotators work in three steps:
* <ol>
* <li>{@link #collectInformation(PsiFile, Editor, boolean)} is called for the annotator to collect some data about a file needed for launching a tool</li>
* <li>collected data is passed to {@link #doAnnotate} which executes a tool and collect highlighting data</li>
* <li>highlighting data is applied to a file by {@link #apply}</li>
* </ol>
*
* @author ven
* @see com.intellij.lang.ExternalLanguageAnnotators
*/
public abstract class ExternalAnnotator<InitialInfoType, AnnotationResultType> {
/** @see ExternalAnnotator#collectInformation(PsiFile, Editor, boolean) */
/**
* @see ExternalAnnotator#collectInformation(PsiFile, Editor, boolean)
*/
@Nullable
public InitialInfoType collectInformation(@NotNull PsiFile file) {
return null;