Mercurial > hg > truffle

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 f879b1fe3773
line wrap: on
line diff
--- a/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/debug/Breakpoint.java	Wed Jul 22 13:07:02 2015 +0200
+++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/debug/Breakpoint.java	Wed Jul 22 14:25:03 2015 +0200
@@ -26,12 +26,20 @@
 
 import com.oracle.truffle.api.instrument.*;
 import com.oracle.truffle.api.source.*;
+import com.oracle.truffle.api.vm.TruffleVM;
 import java.io.IOException;
 
+/**
+ * Breakpoint in a {@link TruffleVM} with {@link com.oracle.truffle.api.debug debugging turned on}.
+ * You can ask
+ * {@link Debugger#setLineBreakpoint(int, com.oracle.truffle.api.source.LineLocation, boolean)} or
+ * {@link Debugger#setTagBreakpoint(int, com.oracle.truffle.api.instrument.SyntaxTag, boolean)} to
+ * create an instance of {@link Breakpoint}.
+ */
 public abstract class Breakpoint {
 
     /**
-     * A general model of the states occupied by a breakpoint during its lifetime.
+     * A general model of the states occupied by a {@link Breakpoint} during its lifetime.
      */
     public enum State {