changeset 18156:b5a594acff7c

Document FrameMapBuilder.
author Josef Eisl <josef.eisl@jku.at>
date Wed, 22 Oct 2014 18:30:22 +0200
parents 115c9fac7542
children 95f8dd398214
files graal/com.oracle.graal.lir/src/com/oracle/graal/lir/FrameMapBuilder.java
diffstat 1 files changed, 5 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/graal/com.oracle.graal.lir/src/com/oracle/graal/lir/FrameMapBuilder.java	Wed Oct 22 18:04:46 2014 +0200
+++ b/graal/com.oracle.graal.lir/src/com/oracle/graal/lir/FrameMapBuilder.java	Wed Oct 22 18:30:22 2014 +0200
@@ -27,6 +27,10 @@
 import com.oracle.graal.api.code.*;
 import com.oracle.graal.api.meta.*;
 
+/**
+ * A {@link FrameMapBuilder} is used to collect all information necessary to
+ * {@linkplain #buildFrameMap() create} a {@link FrameMap}.
+ */
 public interface FrameMapBuilder {
 
     /**
@@ -75,4 +79,4 @@
      * {@linkplain FrameMapBuilder}.
      */
     FrameMap buildFrameMap();
-}
\ No newline at end of file
+}