SleepingPolicy: fix javadoc formatting
authorYann Cébron <yann.cebron@jetbrains.com>
Wed, 12 Aug 2020 15:31:54 +0000 (17:31 +0200)
committerintellij-monorepo-bot <intellij-monorepo-bot-no-reply@jetbrains.com>
Wed, 12 Aug 2020 16:17:54 +0000 (16:17 +0000)
GitOrigin-RevId: 9fc001666f0ff90f377304ae2ba6137fcd926d20

platform/util/src/com/intellij/util/io/BaseDataReader.java

index fba0b99bb362aaaa02ab3d78ac97b8c3041bc013..d00dd0f4ee289b3eefd089a9efd000b23ea7fbd8 100644 (file)
@@ -1,4 +1,4 @@
-// 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.
+// Copyright 2000-2020 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.util.io;
 
 import com.intellij.ReviseWhenPortedToJDK;
@@ -87,8 +87,7 @@ public abstract class BaseDataReader {
   protected abstract Future<?> executeOnPooledThread(@NotNull Runnable runnable);
 
   /**
-   * <p>
-   *   <h2>Blocking</h2>
+   * <h2>Blocking</h2>
    * In Java you can only read data from child process's stdout/stderr using blocking {@link InputStream#read()}.
    * (Async approach like {@link java.nio.channels.SelectableChannel} is not supported for process's streams,
    * although some native api may be used).
@@ -98,13 +97,12 @@ public abstract class BaseDataReader {
    * This approach is good for short-living processes.
    * If you know for sure that process will end soon (i.e. helper process) you can enable this behaviour using {@link #BLOCKING} policy.
    * It is implemented in {@link #readAvailableBlocking()}
-   * </p>
-   * <p>
-   *   <h2>Non-blocking</h2>
+   *
+   * <h2>Non-blocking</h2>
    * Before reading data, you can call {@link InputStream#available()} to see how much data can be read without of blocking.
    * This gives us ability to use simple loop
    * <ol>
-   * <li>Check <{@link InputStream#available()}</li>
+   * <li>Check {@link InputStream#available()}</li>
    * <li>If not zero then {@link InputStream#read()}} which is guaranteed not to block </li>
    * <li>If <code>processTerminated</code> flag set then exit loop</li>
    * <li>Sleep for a while</li>
@@ -114,14 +112,12 @@ public abstract class BaseDataReader {
    * user process and used by {@link #NON_BLOCKING} (aka non-blocking) policy. Drawback is that process may finish (when {@link Process#waitFor()} returns)
    * leaving some data unread.
    * It is implemented in {@link #readAvailableNonBlocking()}}
-   * </p>
-   * <p>
+   *
    * <h2>Conclusion</h2>
-   * For helper (simple script that is guaranteed to finish soon) and should never be left after Idea is closed use {@link #BLOCKING}.
+   * For helper (simple script that is guaranteed to finish soon) and should never be left after IDE is closed use {@link #BLOCKING}.
    * For user process that may run forever, even after idea is closed, and user should have ability to disconnect from it
    * use {@link #NON_BLOCKING}.
    * If you see some data lost in stdout/stderr try switching to {@link #BLOCKING}.
-   * </p>
    */
   @ReviseWhenPortedToJDK("Loom")
   public interface SleepingPolicy {