diff graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/InlinableCallSite.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/InlinableCallSite.java	Sat Aug 17 13:55:44 2013 +0200
+++ b/graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/InlinableCallSite.java	Sat Aug 17 14:03:28 2013 +0200
@@ -26,15 +26,44 @@
 
 import com.oracle.truffle.api.*;
 
+/**
+ * Denotes a call node that can inline the tree of its associated call target.
+ * 
+ * @see InlinedCallSite
+ */
 public interface InlinableCallSite {
 
+    /**
+     * Returns the number of calls since the last reset of the call count.
+     * 
+     * @return the current call count.
+     */
     int getCallCount();
 
+    /**
+     * Resets the call count to 0.
+     */
     void resetCallCount();
 
+    /**
+     * Returns the tree that would be inlined by a call to {@link #inline(FrameFactory)}.
+     * 
+     * @return the node tree to be inlined.
+     */
     Node getInlineTree();
 
+    /**
+     * Returns the call target associated with this call site.
+     * 
+     * @return the inlinable {@link CallTarget}.
+     */
     CallTarget getCallTarget();
 
+    /**
+     * Instructs the call node to inline the associated call target.
+     * 
+     * @param factory Frame factory for creating new virtual frames for inlined calls.
+     * @return {@code true} if call target was inlined; {@code false} otherwise.
+     */
     boolean inline(FrameFactory factory);
 }