Skip to content

Commit 401c05c

Browse files
authored
Updated the docs on IDEA debugging (#2244)
1 parent 2554f56 commit 401c05c

File tree

3 files changed

+8
-9
lines changed

3 files changed

+8
-9
lines changed

docs/coroutine-context-and-dispatchers.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -165,22 +165,21 @@ The Coroutine Debugger of the Kotlin plugin simplifies debugging coroutines in I
165165

166166
> Debugging works for versions 1.3.8 or later of `kotlinx-coroutines-core`.
167167
168-
The **Debug Tool Window** contains a **Coroutines** tab. In this tab, you can find information about both currently
169-
running and suspended coroutines. The coroutines are grouped by the dispatcher they are running on.
168+
The **Debug** tool window contains the **Coroutines** tab. In this tab, you can find information about both currently running and suspended coroutines.
169+
The coroutines are grouped by the dispatcher they are running on.
170170

171-
![Debugging coroutines](images/coroutine-debugger.png)
171+
![Debugging coroutines](images/coroutine-idea-debugging-1.png)
172172

173-
You can:
174-
* Easily check the state of each coroutine.
173+
With the coroutine debugger, you can:
174+
* Check the state of each coroutine.
175175
* See the values of local and captured variables for both running and suspended coroutines.
176176
* See a full coroutine creation stack, as well as a call stack inside the coroutine. The stack includes all frames with
177177
variable values, even those that would be lost during standard debugging.
178+
* Get a full report that contains the state of each coroutine and its stack. To obtain it, right-click inside the **Coroutines** tab, and then click **Get Coroutines Dump**.
178179

179-
If you need a full report containing the state of each coroutine and its stack, right-click inside the **Coroutines** tab, and then
180-
click **Get Coroutines Dump**.
180+
To start coroutine debugging, you just need to set breakpoints and run the application in debug mode.
181181

182-
Learn more about debugging coroutines in [this blog post](https://blog.jetbrains.com/kotlin/2020/07/kotlin-1-4-rc-debugging-coroutines/)
183-
and [IntelliJ IDEA documentation](https://www.jetbrains.com/help/idea/debug-kotlin-coroutines.html).
182+
Learn more about coroutines debugging in the [tutorial](https://kotlinlang.org/docs/tutorials/coroutines/debug-coroutines-with-idea.html).
184183

185184
#### Debugging using logging
186185

docs/images/coroutine-debugger.png

-382 KB
Binary file not shown.
243 KB
Loading

0 commit comments

Comments
 (0)