From 1729ef59a6bd11d9bae71fe233a9beee4c293f77 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Yann=20C=C3=A9bron?= <yann.cebron@jetbrains.com>
Date: Fri, 14 Jun 2019 17:05:25 +0200
Subject: [PATCH] ExternalAnnotator: Javadoc cleanup

GitOrigin-RevId: f233e4415fe847b783194b735ced2affc648db74
---
 .../lang/annotation/ExternalAnnotator.java       | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

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;
 
 /**
- * <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;