From b90554f06bc4a9aa1b2a6672a900e38b0a4b3afb Mon Sep 17 00:00:00 2001
From: "Vladislav.Soroka" <Vladislav.Soroka@jetbrains.com>
Date: Mon, 1 Jul 2019 15:30:20 +0300
Subject: [PATCH] IDEA-CR-49349: skip hotswap flag javadoc

GitOrigin-RevId: b17122635b4d49939f44bb684fd3e6b66c9f6d11
---
 .../impl/src/com/intellij/debugger/ui/HotSwapUIImpl.java | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/java/debugger/impl/src/com/intellij/debugger/ui/HotSwapUIImpl.java b/java/debugger/impl/src/com/intellij/debugger/ui/HotSwapUIImpl.java
index f46359a06c2b..6107e3614b88 100644
--- a/java/debugger/impl/src/com/intellij/debugger/ui/HotSwapUIImpl.java
+++ b/java/debugger/impl/src/com/intellij/debugger/ui/HotSwapUIImpl.java
@@ -39,6 +39,15 @@ import java.util.*;
 import java.util.stream.Collectors;
 
 public class HotSwapUIImpl extends HotSwapUI {
+  /**
+   * There are cases when the hotswap of the changed classes is not needed.
+   * E.g. for a tomcat application redeploy there's no need to even try reloading classes and it's only can cause hotswap failure UX issue.
+   * <p>
+   * The flag can be used to skip hotswap after the ProjectTaskManager run session finish.
+   * To apply the flag one should add it to {@link ProjectTaskContext} user data.
+   *
+   * @see ProjectTaskContext#withUserData(Key, Object)
+   */
   public static final Key<Boolean> SKIP_HOT_SWAP_KEY = KeyWithDefaultValue.create("skip_hotswap_after_this_compilation", false);
   private static final Key<HotSwapStatusListener> HOT_SWAP_CALLBACK_KEY = Key.create("hot_swap_callback");