Mercurial > hg > truffle
changeset 21972:ff6f34159b8a
Providing package-info for most of API packages. Feel free to provide your package-info.java for anything that has API in its name.
line wrap: on
line diff
--- a/truffle/com.oracle.truffle.api.test/src/com/oracle/truffle/api/test/package-info.java Tue Jun 23 12:07:02 2015 +0200 +++ b/truffle/com.oracle.truffle.api.test/src/com/oracle/truffle/api/test/package-info.java Tue Jun 23 12:44:41 2015 +0200 @@ -44,7 +44,7 @@ * <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 {@link com.oracle.truffle.api.test.instrument.InstrumentationTest}</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> * *
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/frame/package-info.java Tue Jun 23 12:44:41 2015 +0200 @@ -0,0 +1,35 @@ +/* + * 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. + */ + +/** + * Representation of a {@link com.oracle.truffle.api.frame.Frame stack frame}. While + * {@link com.oracle.truffle.api.TruffleLanguage based language} + * is executing its stack parameters + * and local variables are represented by {@link com.oracle.truffle.api.frame.VirtualFrame}. Such a frame + * can be converted into {@link com.oracle.truffle.api.frame.MaterializedFrame} stored on a heap for + * later access when the actual stack is elsewhere. + */ +package com.oracle.truffle.api.frame; +
--- a/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/Instrument.java Tue Jun 23 12:07:02 2015 +0200 +++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/Instrument.java Tue Jun 23 12:44:41 2015 +0200 @@ -77,10 +77,11 @@ * <li>When a probed AST is cloned, the instrumentation chain associated with each Probe is cloned * along with the rest of the AST.</li> * - * <li>When a new Instrument (for example an instance of {@link SimpleInstrument} is attached to a - * Probe, the Instrument inserts a new instance of its private Node type, - * {@link SimpleInstrument.SimpleInstrumentNode}, into <em>each of the instrument chains</em> - * managed by the Probe, i.e. one node instance per existing clone of the AST.</li> + * <li>When a new Instrument (for example an instance created by + * {@link Instrument#create(com.oracle.truffle.api.instrument.SimpleInstrumentListener, java.lang.String)} + * is attached to a Probe, the Instrument inserts a new instance of its private Node type into + * <em>each of the instrument chains</em> managed by the Probe, i.e. one node instance per existing + * clone of the AST.</li> * * <li>If an Instrument is attached to a Probe in an AST that subsequently gets cloned, then the * Instrument's private Node type will be cloned along with the rest of the the AST.</li>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/package-info.java Tue Jun 23 12:44:41 2015 +0200 @@ -0,0 +1,30 @@ +/* + * 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. + */ + +/** + * Advanced node manipulation instruments. + */ +package com.oracle.truffle.api.instrument; +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/package-info.java Tue Jun 23 12:44:41 2015 +0200 @@ -0,0 +1,31 @@ +/* + * 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. + */ + +/** + * Abstract syntax tree {@link com.oracle.truffle.api.nodes.Node nodes} are the basic building block + * for your {@link com.oracle.truffle.api.TruffleLanguage}. + */ +package com.oracle.truffle.api.nodes; +
--- a/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/package-info.java Tue Jun 23 12:07:02 2015 +0200 +++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/package-info.java Tue Jun 23 12:44:41 2015 +0200 @@ -24,8 +24,8 @@ */ /** - * Do you want to implement your own {@link TruffleLanguage Truffle based language}? - * In such case start {@link TruffleLanguage here}. + * Do you want to implement your own {@link com.oracle.truffle.api.TruffleLanguage Truffle based language}? + * In such case start {@link com.oracle.truffle.api.TruffleLanguage here}. */ package com.oracle.truffle.api;
--- a/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/source/Source.java Tue Jun 23 12:07:02 2015 +0200 +++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/source/Source.java Tue Jun 23 12:44:41 2015 +0200 @@ -650,7 +650,7 @@ /** * Creates a representation of a contiguous region of text in the source. Computes the - * {@code charIndex} value by building a {@linkplain TextMap map} of lines in the source. + * {@code charIndex} value by building a {@code TextMap map} of lines in the source. * <p> * Checks the position arguments for consistency with the source. * <p> @@ -676,8 +676,8 @@ /** * Creates a representation of a contiguous region of text in the source. Computes the - * {@code (startLine, startColumn)} values by building a {@linkplain TextMap map} of lines in - * the source. + * {@code (startLine, startColumn)} values by building a {@code TextMap map} of lines in the + * source. * <p> * Checks the position arguments for consistency with the source. * <p>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/source/package-info.java Tue Jun 23 12:44:41 2015 +0200 @@ -0,0 +1,30 @@ +/* + * 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. + */ + +/** + * Represents a {@link com.oracle.truffle.api.source.Source source file}. + */ +package com.oracle.truffle.api.source; +
--- a/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/vm/package-info.java Tue Jun 23 12:07:02 2015 +0200 +++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/vm/package-info.java Tue Jun 23 12:44:41 2015 +0200 @@ -24,7 +24,7 @@ */ /** - * Central place to create and control {@link TruffleVM Truffle Virtual Machine} + * Central place to create and control {@link com.oracle.truffle.api.vm.TruffleVM Truffle Virtual Machine} * and all languages hosted in it. */ package com.oracle.truffle.api.vm;