diff graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/FrameFactory.java @ 11343:75d9b7aedcfd

Truffle: added some missing javadoc.
author Andreas Woess <andreas.woess@jku.at>
date Sat, 17 Aug 2013 14:03:28 +0200
parents 494b818b527c
children
line wrap: on
line diff
--- a/graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/FrameFactory.java	Sat Aug 17 13:55:44 2013 +0200
+++ b/graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/FrameFactory.java	Sat Aug 17 14:03:28 2013 +0200
@@ -27,8 +27,18 @@
 import com.oracle.truffle.api.*;
 import com.oracle.truffle.api.frame.*;
 
+/**
+ * Factory for virtual frame creation.
+ */
 public interface FrameFactory {
 
+    /**
+     * Creates a new virtual frame from the given frame descriptor and arguments.
+     * 
+     * @param descriptor describes the frame to be created
+     * @param caller the packed caller frame or {@code null}
+     * @param args {@link Arguments} object to be stored in the frame
+     * @return a new virtual frame
+     */
     VirtualFrame create(FrameDescriptor descriptor, PackedFrame caller, Arguments args);
-
 }