Skip to content

Commit a5c6ce7

Browse files
committed
Add minor 'usage notes'
1 parent c2468a9 commit a5c6ce7

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

Diff for: kotlinx-coroutines-core/jvm/src/debug/internal/DebugCoroutineInfoImpl.kt

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ internal const val SUSPENDED = "SUSPENDED"
1111
/**
1212
* Internal implementation class where debugger tracks details it knows about each coroutine.
1313
* Its mutable fields can be updated concurrently, thus marked with `@Volatile`
14+
*
15+
* Usage Note: IntelliJ/Coroutines Debugger: Reflection
1416
*/
1517
@PublishedApi
1618
internal class DebugCoroutineInfoImpl internal constructor(

Diff for: kotlinx-coroutines-core/jvm/src/debug/internal/DebugProbesImpl.kt

+12
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,16 @@ import kotlin.coroutines.jvm.internal.CoroutineStackFrame
1414
import kotlin.synchronized
1515
import _COROUTINE.ArtificialStackFrames
1616

17+
/**
18+
* Usage Note: IntelliJ @SuppressWarnings({"KotlinInternalInJava"}): CoroutineDumpState
19+
* call to 'install'
20+
*
21+
* Usage Note: IntelliJ @SuppressWarnings({"KotlinInternalInJava"}): DebugProbesKt
22+
* Custom 'DebugProbesKt' class providing 'probeCoroutineCreated', 'probeCoroutineResumed', 'probeCoroutineSuspended'
23+
* calling into DebugProbesImpl (similar to our DebugProbesKt)
24+
*
25+
* Usage Note: IntelliJ/Coroutines Debugger: Reflection
26+
*/
1727
@PublishedApi
1828
internal object DebugProbesImpl {
1929
private val ARTIFICIAL_FRAME = ArtificialStackFrames().coroutineCreation()
@@ -527,6 +537,8 @@ internal object DebugProbesImpl {
527537
/**
528538
* This class is injected as completion of all continuations in [probeCoroutineCompleted].
529539
* It is owning the coroutine info and responsible for managing all its external info related to debug agent.
540+
*
541+
* Usage Note: IntelliJ/Coroutines Debugger: Reflection
530542
*/
531543
public class CoroutineOwner<T> internal constructor(
532544
@JvmField internal val delegate: Continuation<T>,

0 commit comments

Comments
 (0)