changeset 16762:ea9903f9684f

Truffle-DSL: added some javadoc
author Christian Humer <christian.humer@gmail.com>
date Mon, 11 Aug 2014 15:57:47 +0200
parents e5e1013c04fd
children e6d15134ca86
files graal/com.oracle.truffle.api.dsl/src/com/oracle/truffle/api/dsl/Specialization.java
diffstat 1 files changed, 20 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/graal/com.oracle.truffle.api.dsl/src/com/oracle/truffle/api/dsl/Specialization.java	Mon Aug 11 15:57:47 2014 +0200
+++ b/graal/com.oracle.truffle.api.dsl/src/com/oracle/truffle/api/dsl/Specialization.java	Mon Aug 11 15:57:47 2014 +0200
@@ -30,15 +30,34 @@
 @Target({ElementType.METHOD})
 public @interface Specialization {
 
-    int DEFAULT_ORDER = -1;
+    /**
+     * @deprecated do not use anymore. Will get removed in the next release.
+     */
+    @Deprecated int DEFAULT_ORDER = -1;
 
+    /**
+     * The order has no effect anymore. The declaration order specialization methods is used
+     * instead.
+     *
+     * @deprecated use declaration order instead. Will get removed in the next release.
+     */
     @Deprecated
     int order() default DEFAULT_ORDER;
 
+    /**
+     * Inserts this and all specializations that are declared after this specialization before a
+     * specialization in the superclass. By default all specializations of the subclass are appended
+     * to the specializations of the superclass.
+     */
     String insertBefore() default "";
 
     Class<? extends Throwable>[] rewriteOn() default {};
 
+    /**
+     * The contains attribute declares all specializations that are contained by this
+     * specialization. A containing specialization must be strictly generic as the contained
+     * specialization.
+     */
     String[] contains() default {};
 
     String[] guards() default {};