diff --git a/platform/analysis-api/src/com/intellij/lang/annotation/ExternalAnnotator.java b/platform/analysis-api/src/com/intellij/lang/annotation/ExternalAnnotator.java index 116d8e862dc4..aea837439289 100644 --- a/platform/analysis-api/src/com/intellij/lang/annotation/ExternalAnnotator.java +++ b/platform/analysis-api/src/com/intellij/lang/annotation/ExternalAnnotator.java @@ -8,20 +8,24 @@ import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; /** - *

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.

* - *

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}.

+ *

Annotators work in three steps: + *

    + *
  1. {@link #collectInformation(PsiFile, Editor, boolean)} is called for the annotator to collect some data about a file needed for launching a tool
  2. + *
  3. collected data is passed to {@link #doAnnotate} which executes a tool and collect highlighting data
  4. + *
  5. highlighting data is applied to a file by {@link #apply}
  6. + *
* * @author ven * @see com.intellij.lang.ExternalLanguageAnnotators */ public abstract class ExternalAnnotator { - /** @see ExternalAnnotator#collectInformation(PsiFile, Editor, boolean) */ + /** + * @see ExternalAnnotator#collectInformation(PsiFile, Editor, boolean) + */ @Nullable public InitialInfoType collectInformation(@NotNull PsiFile file) { return null;