StatusBarWidgetFactory: fix javadoc formatting
authorYann Cébron <yann.cebron@jetbrains.com>
Wed, 12 Aug 2020 15:58:47 +0000 (17:58 +0200)
committerintellij-monorepo-bot <intellij-monorepo-bot-no-reply@jetbrains.com>
Wed, 12 Aug 2020 16:17:56 +0000 (16:17 +0000)
GitOrigin-RevId: 3824709c8983db2c6d77e5e39a54c0bd288a3a88

platform/platform-api/src/com/intellij/openapi/wm/StatusBarWidgetFactory.java

index 090e062322eda5e90fcb6fa9fcc344da0b7e0dfc..a4877de7682199c09fa5215401624d1be75403b3 100644 (file)
@@ -56,8 +56,10 @@ public interface StatusBarWidgetFactory {
    * Once the method is invoked on project initialization, the widget won't be recreated or disposed implicitly.
    * <p>
    * You may need to recreate it if:
+   * <ul>
    * <li>its availability has changed. See {@link #isAvailable(Project)}</li>
    * <li>its visibility has changed. See {@link com.intellij.openapi.wm.impl.status.widget.StatusBarWidgetSettings}</li>
+   * </ul>
    * <p>
    * To do this, you need to explicitly invoke {@link com.intellij.openapi.wm.impl.status.widget.StatusBarWidgetsManager#updateWidget(StatusBarWidgetFactory)}
    * to recreate the widget and re-add it to the status bar.
@@ -72,8 +74,8 @@ public interface StatusBarWidgetFactory {
    * Status bar's context menu with enable/disable action depends on the result of this method.
    * <p>
    * It's better to have this method aligned with {@link com.intellij.openapi.wm.impl.status.EditorBasedStatusBarPopup.WidgetState#HIDDEN},
-   * whenever state is HIDDEN, this method should return false.
-   * Otherwise enabling widget via context menu won't take any visual effect.
+   * whenever state is {@code HIDDEN}, this method should return {@code false}.
+   * Otherwise, enabling widget via context menu will not have any visual effect.
    * <p>
    * E.g. {@link com.intellij.openapi.wm.impl.status.EditorBasedWidget} are available if editor is opened in a frame that given status bar is attached to
    * <p>