diff truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/debug/Debugger.java @ 22008:02e4cf046653

Providing a bit more meaningful documentation to our recent debugging improvements
author Jaroslav Tulach <jaroslav.tulach@oracle.com>
date Wed, 22 Jul 2015 14:25:03 +0200
parents 5bc7f7b867ab
children 95d5d6a93968
line wrap: on
line diff
--- a/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/debug/Debugger.java	Wed Jul 22 13:07:02 2015 +0200
+++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/debug/Debugger.java	Wed Jul 22 14:25:03 2015 +0200
@@ -37,7 +37,9 @@
 import com.oracle.truffle.api.vm.TruffleVM;
 
 /**
- * Language-agnostic engine for running Truffle languages under debugging control.
+ * Represents debugging related state of a {@link TruffleVM}. Instance of this class is delivered
+ * via {@link SuspendedEvent#getDebugger()} and {@link ExecutionEvent#getDebugger()} events, once
+ * {@link com.oracle.truffle.api.debug debugging is turned on}.
  */
 public final class Debugger {