Mercurial > hg > truffle

changeset 22428:240bf5edb172

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Migrate package.html to package-info.java. To fix problems in the javadoc tool.
author Christian Humer <christian.humer@oracle.com>
date Wed, 02 Dec 2015 17:09:36 +0100
parents 6b4d0b2f93f4
children 5692953272eb
files truffle/com.oracle.truffle.api.test/src/com/oracle/truffle/api/package-info.java truffle/com.oracle.truffle.api.test/src/com/oracle/truffle/api/package.html
diffstat 2 files changed, 73 insertions(+), 68 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/truffle/com.oracle.truffle.api.test/src/com/oracle/truffle/api/package-info.java	Wed Dec 02 17:09:36 2015 +0100
@@ -0,0 +1,73 @@
+/*
+ * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ @ApiInfo(
+ group="Test"
+ )
+ */
+
+/**
+ * <p>
+ * This package contains basic tests of the Truffle API and serves at the same time as an
+ * introduction to the Truffle API for language implementors. Every test gives an example on how to
+ * use the construct explained in the class description.
+ * </p>
+ *
+ * <p>
+ * Truffle is a language implementation framework. A guest language method is represented as a tree
+ * of executable nodes. The framework provides mechanisms for those trees to call each other.
+ * Additionally it contains dedicated data structures for storing data local to a tree invocation.
+ * </p>
+ *
+ * <p>
+ * This introduction to Truffle contains items in the following recommended order:
+ *
+ * <ul>
+ * <li>How to get access to the Truffle runtime?
+ * {@link com.oracle.truffle.api.TruffleRuntimeTest}</li>
+ * <li>How to create a root node? {@link com.oracle.truffle.api.RootNodeTest}</li>
+ * <li>How to create a child node and link it with its parent?
+ * {@link com.oracle.truffle.api.ChildNodeTest}</li>
+ * <li>How to create an array of child nodes? {@link com.oracle.truffle.api.ChildrenNodesTest}</li>
+ * <li>Why are final fields in node classes important?
+ * {@link com.oracle.truffle.api.FinalFieldTest}</li>
+ * <li>How to replace one node with another node and what for?
+ * {@link com.oracle.truffle.api.ReplaceTest}</li>
+ * <li>How to let one Truffle tree invoke another one? {@link com.oracle.truffle.api.CallTest}</li>
+ * <li>How to pass arguments when executing a tree?
+ * {@link com.oracle.truffle.api.ArgumentsTest}</li>
+ * <li>How to use frames and frame slots to store values local to an activation?
+ * {@link com.oracle.truffle.api.FrameTest}</li>
+ * <li>How to use type specialization and speculation for frame slots?
+ * {@link com.oracle.truffle.api.FrameSlotTypeSpecializationTest}</li>
+ * <li>How to use type specialization and speculation for node return values?
+ * {@link com.oracle.truffle.api.ReturnTypeSpecializationTest}</li>
+ * <li>How to "instrument" an AST with nodes that can provide access to runtime state from external
+ * tools {@code com.oracle.truffle.api.instrument.InstrumentationTest}</li>
+ * </ul>
+ */
+package com.oracle.truffle.api;
+
--- a/truffle/com.oracle.truffle.api.test/src/com/oracle/truffle/api/package.html	Wed Dec 02 16:24:09 2015 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,68 +0,0 @@
-<!DOCTYPE html>
-<!--
-
-Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
-DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
-
-This code is free software; you can redistribute it and/or modify it
-under the terms of the GNU General Public License version 2 only, as
-published by the Free Software Foundation.  Oracle designates this
-particular file as subject to the "Classpath" exception as provided
-by Oracle in the LICENSE file that accompanied this code.
-
-This code is distributed in the hope that it will be useful, but WITHOUT
-ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
-version 2 for more details (a copy is included in the LICENSE file that
-accompanied this code).
-
-You should have received a copy of the GNU General Public License version
-2 along with this work; if not, write to the Free Software Foundation,
-Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
-
-Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
-or visit www.oracle.com if you need additional information or have any
-questions.
--->
-<html>
-    <p>
-    This package contains basic tests of the Truffle API and serves at the same time as an
-    introduction to the Truffle API for language implementors. Every test gives an example on how to
-    use the construct explained in the class description.
-    </p>
-
-    <p>
-    Truffle is a language implementation framework. A guest language method is represented as a tree
-    of executable nodes. The framework provides mechanisms for those trees to call each other.
-    Additionally it contains dedicated data structures for storing data local to a tree invocation.
-    </p>
-
-    <p>
-    This introduction to Truffle contains items in the following recommended order:
-
-    <ul>
-    <li>How to get access to the Truffle runtime?
-    {@link com.oracle.truffle.api.test.TruffleRuntimeTest}</li>
-    <li>How to create a root node? {@link com.oracle.truffle.api.test.RootNodeTest}</li>
-    <li>How to create a child node and link it with its parent?
-    {@link com.oracle.truffle.api.test.ChildNodeTest}</li>
-    <li>How to create an array of child nodes? {@link com.oracle.truffle.api.test.ChildrenNodesTest}
-    </li>
-    <li>Why are final fields in node classes important?
-    {@link com.oracle.truffle.api.test.FinalFieldTest}</li>
-    <li>How to replace one node with another node and what for?
-    {@link com.oracle.truffle.api.test.ReplaceTest}</li>
-    <li>How to let one Truffle tree invoke another one? {@link com.oracle.truffle.api.test.CallTest}
-    </li>
-    <li>How to pass arguments when executing a tree?
-    {@link com.oracle.truffle.api.test.ArgumentsTest}</li>
-    <li>How to use frames and frame slots to store values local to an activation?
-    {@link com.oracle.truffle.api.test.FrameTest}</li>
-    <li>How to use type specialization and speculation for frame slots?
-    {@link com.oracle.truffle.api.test.FrameSlotTypeSpecializationTest}</li>
-    <li>How to use type specialization and speculation for node return values?
-    {@link com.oracle.truffle.api.test.ReturnTypeSpecializationTest}</li>
-    <li>How to "instrument" an AST with nodes that can provide access to runtime state from external
-    tools {@code com.oracle.truffle.api.test.instrument.InstrumentationTest}</li>
-    </ul>
-</html>