changeset 22526:a5e58793bbca

BranchProfile Javadoc sample was uncompilable. Fixed with the help of codesnippet tag.
author Jaroslav Tulach <jaroslav.tulach@oracle.com>
date Wed, 30 Dec 2015 11:06:33 +0100
parents 89db2519ef18
children 114a6a77b440
files truffle/com.oracle.truffle.api.profiles/src/com/oracle/truffle/api/profiles/BranchProfile.java truffle/com.oracle.truffle.api.test/src/com/oracle/truffle/api/profiles/BranchProfileTest.java
diffstat 2 files changed, 15 insertions(+), 16 deletions(-) [+]
line wrap: on
line diff
--- a/truffle/com.oracle.truffle.api.profiles/src/com/oracle/truffle/api/profiles/BranchProfile.java	Wed Dec 23 07:43:06 2015 +0100
+++ b/truffle/com.oracle.truffle.api.profiles/src/com/oracle/truffle/api/profiles/BranchProfile.java	Wed Dec 30 11:06:33 2015 +0100
@@ -36,22 +36,7 @@
  * </p>
  *
  * <p>
- * <b> Usage example: </b>
- *
- * <pre>
- * class SampleNode extends Node {
- * 
- *     final BranchProfile errorProfile = BranchProfile.create();
- * 
- *     void execute(int value) {
- *         if (value == Integer.MAX_VALUE) {
- *             errorProfile.enter();
- *             throw new Error(&quot;Invalid input value&quot;)
- *         }
- *         return value;
- *     }
- * }
- * </pre>
+ * <b> Usage example: </b> {@codesnippet BranchProfileSample}
  *
  * {@inheritDoc}
  *
--- a/truffle/com.oracle.truffle.api.test/src/com/oracle/truffle/api/profiles/BranchProfileTest.java	Wed Dec 23 07:43:06 2015 +0100
+++ b/truffle/com.oracle.truffle.api.test/src/com/oracle/truffle/api/profiles/BranchProfileTest.java	Wed Dec 30 11:06:33 2015 +0100
@@ -22,6 +22,7 @@
  */
 package com.oracle.truffle.api.profiles;
 
+import com.oracle.truffle.api.nodes.Node;
 import static org.junit.Assert.assertTrue;
 
 import org.junit.Test;
@@ -47,4 +48,17 @@
         assertTrue(profile.toString().contains(Integer.toHexString(profile.hashCode())));
     }
 
+    // BEGIN: BranchProfileSample
+    class SampleNode extends Node {
+        final BranchProfile errorProfile = BranchProfile.create();
+
+        int execute(int value) {
+            if (value == Integer.MAX_VALUE) {
+                errorProfile.enter();
+                throw new Error("Invalid input value");
+            }
+            return value;
+        }
+    }
+    // END: BranchProfileSample
 }