# HG changeset patch # User Jaroslav Tulach # Date 1438777044 -7200 # Node ID c0d4ec7e69c04f32c6e32cf85302cb5ba17cc178 # Parent cc84642d989f4358d60603b3e3691a039216d9ec Properly classifying the API packages diff -r cc84642d989f -r c0d4ec7e69c0 truffle/com.oracle.truffle.api.test/src/com/oracle/truffle/api/test/package-info.java --- a/truffle/com.oracle.truffle.api.test/src/com/oracle/truffle/api/test/package-info.java Tue Aug 04 22:50:40 2015 -0700 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,68 +0,0 @@ -/* - * Copyright (c) 2012, 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. - * - * 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. - */ -/** - *

- * 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. - *

- * - *

- * 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. - *

- * - *

- * This introduction to Truffle contains items in the following recommended order: - * - *

- * - * - */ -package com.oracle.truffle.api.test; - diff -r cc84642d989f -r c0d4ec7e69c0 truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/debug/package-info.java --- a/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/debug/package-info.java Tue Aug 04 22:50:40 2015 -0700 +++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/debug/package-info.java Wed Aug 05 14:17:24 2015 +0200 @@ -23,6 +23,12 @@ * questions. */ +/* + @ApiInfo( + group="Stable" + ) + */ + /** * Control over {@link com.oracle.truffle.api.debug.Debugger debugging} of your {@link com.oracle.truffle.api.vm.TruffleVM}. Each {@link com.oracle.truffle.api.vm.TruffleVM} * is inherently capable to run in debugging mode - there is just one thing diff -r cc84642d989f -r c0d4ec7e69c0 truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/frame/package-info.java --- a/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/frame/package-info.java Tue Aug 04 22:50:40 2015 -0700 +++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/frame/package-info.java Wed Aug 05 14:17:24 2015 +0200 @@ -23,6 +23,12 @@ * questions. */ +/* + @ApiInfo( + group="To Review" + ) + */ + /** * 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 diff -r cc84642d989f -r c0d4ec7e69c0 truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/package-info.java --- a/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/package-info.java Tue Aug 04 22:50:40 2015 -0700 +++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/package-info.java Wed Aug 05 14:17:24 2015 +0200 @@ -23,6 +23,12 @@ * questions. */ +/* + @ApiInfo( + group="To Review" + ) + */ + /** * Abstract syntax tree {@link com.oracle.truffle.api.nodes.Node nodes} are the basic building block * for your {@link com.oracle.truffle.api.TruffleLanguage}. diff -r cc84642d989f -r c0d4ec7e69c0 truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/package-info.java --- a/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/package-info.java Tue Aug 04 22:50:40 2015 -0700 +++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/package-info.java Wed Aug 05 14:17:24 2015 +0200 @@ -23,6 +23,12 @@ * questions. */ +/* + @ApiInfo( + group="To Review" + ) + */ + /** * 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}. diff -r cc84642d989f -r c0d4ec7e69c0 truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/source/package-info.java --- a/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/source/package-info.java Tue Aug 04 22:50:40 2015 -0700 +++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/source/package-info.java Wed Aug 05 14:17:24 2015 +0200 @@ -23,6 +23,12 @@ * questions. */ +/* + @ApiInfo( + group="Stable" + ) + */ + /** * Represents a {@link com.oracle.truffle.api.source.Source source file}. */ diff -r cc84642d989f -r c0d4ec7e69c0 truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/vm/package-info.java --- a/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/vm/package-info.java Tue Aug 04 22:50:40 2015 -0700 +++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/vm/package-info.java Wed Aug 05 14:17:24 2015 +0200 @@ -23,6 +23,12 @@ * questions. */ +/* + @ApiInfo( + group="Stable" + ) + */ + /** * Central place to create and control {@link com.oracle.truffle.api.vm.TruffleVM Truffle Virtual * Machine} and all languages hosted in it. diff -r cc84642d989f -r c0d4ec7e69c0 truffle/com.oracle.truffle.tools.debug.shell/src/com/oracle/truffle/tools/debug/shell/package-info.java --- a/truffle/com.oracle.truffle.tools.debug.shell/src/com/oracle/truffle/tools/debug/shell/package-info.java Tue Aug 04 22:50:40 2015 -0700 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,59 +0,0 @@ -/* - * 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. - */ - -/** - * This package contains an experimental framework for building simple command-line oriented - * debuggers that work with Truffle-implemented languages; it is used mainly for testing Truffle's - * built-in , which actually provides the - * debugging services. - *

- * Truffle debugging is made possible by the general purpose Instrumentation Framework built into - * the Truffle platform. Some online documentation for the Instrumentation Framework is available - * online: - * https://wiki. - * openjdk.java.net/display/Graal/Instrumentation+API - *

- * Building one of these command line debuggers requires creating language-specific instances of: - *

    - *
  1. DebugEngine, noting that this instance also - * depends on related services provided by the language implementation,
    2. - *
  2. {@link com.oracle.truffle.tools.debug.shell.REPLServer}, best accomplished by copying the - * implementation for Truffle's demonstration language "Simple" (a.k.a. "SL").
    3. - *
- * - * Disclaimer: although these command line debuggers are useful, they are not - * intended, and will not be maintained as, fully functioning debuggers. They should be considered - * valuable tools for the maintainers of the - * DebugEngine, as well as for Truffle language - * implementors for whom concurrent access to any kind debugging services can be quite helpful. - *

- * Note: Both the functionality and API for this package are under active - * development. - *

- * - * @see com.oracle.truffle.api.instrument - */ -package com.oracle.truffle.tools.debug.shell; -