diff --git a/langtools/src/share/classes/com/sun/javadoc/package.html b/langtools/src/share/classes/com/sun/javadoc/package-info.java similarity index 68% rename from langtools/src/share/classes/com/sun/javadoc/package.html rename to langtools/src/share/classes/com/sun/javadoc/package-info.java index b44dd461906..15a0fd1af36 100644 --- a/langtools/src/share/classes/com/sun/javadoc/package.html +++ b/langtools/src/share/classes/com/sun/javadoc/package-info.java @@ -1,54 +1,49 @@ - - -Doclet API Package - - - +/* + * Copyright (c) 1998, 2013, 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. + */ +/** The Doclet API (also called the Javadoc API) provides a mechanism -for clients to inspect the source-level structure of programs and +for clients to inspect the source-level structure of programs and libraries, including javadoc comments embedded in the source. This is useful for documentation, program checking, automatic code generation and many other tools.

-Doclets are invoked by javadoc and use this API to write out +Doclets are invoked by javadoc and use this API to write out program information to files. For example, the standard doclet is called by default and writes out documentation to HTML files.

-The invocation is defined by the abstract {@link com.sun.javadoc.Doclet} class +The invocation is defined by the abstract {@link com.sun.javadoc.Doclet} class -- the entry point is the {@link com.sun.javadoc.Doclet#start(RootDoc) start} method: 

     public static boolean start(RootDoc root)
The {@link com.sun.javadoc.RootDoc} instance holds the root of the program structure -information. From this root all other program structure -information can be extracted. +information. From this root all other program structure +information can be extracted.

@@ -56,28 +51,28 @@ information can be extracted. When calling javadoc, you pass in package names and source file names -- -these are called the specified packages and classes. -You also pass in Javadoc options; the access control Javadoc options -(-public, -protected, -package, -and -private) filter program elements, producing a +these are called the specified packages and classes. +You also pass in Javadoc options; the access control Javadoc options +(-public, -protected, -package, +and -private) filter program elements, producing a result set, called the included set, or "documented" set. -(The unfiltered set is also available through +(The unfiltered set is also available through {@link com.sun.javadoc.PackageDoc#allClasses(boolean) allClasses(false)}.)

Throughout this API, the term class is normally a -shorthand for "class or interface", as in: {@link com.sun.javadoc.ClassDoc}, +shorthand for "class or interface", as in: {@link com.sun.javadoc.ClassDoc}, {@link com.sun.javadoc.PackageDoc#allClasses() allClasses()}, and {@link com.sun.javadoc.PackageDoc#findClass(String) findClass(String)}. -In only a couple of other places, it means "class, as opposed to interface", +In only a couple of other places, it means "class, as opposed to interface", as in: {@link com.sun.javadoc.Doc#isClass()}. In the second sense, this API calls out four kinds of classes: -{@linkplain com.sun.javadoc.Doc#isOrdinaryClass() ordinary classes}, +{@linkplain com.sun.javadoc.Doc#isOrdinaryClass() ordinary classes}, {@linkplain com.sun.javadoc.Doc#isEnum() enums}, -{@linkplain com.sun.javadoc.Doc#isError() errors} and +{@linkplain com.sun.javadoc.Doc#isError() errors} and {@linkplain com.sun.javadoc.Doc#isException() exceptions}. -Throughout the API, the detailed description of each program element +Throughout the API, the detailed description of each program element describes explicitly which meaning is being used.

@@ -89,8 +84,8 @@ name has no package name, such as String.

Example

- -The following is an example doclet that + +The following is an example doclet that displays information in the @param tags of the processed classes: 
@@ -117,17 +112,17 @@ public class ListParams extends Doclet
                     + " - " + params[j].parameterComment());
             }
         }
-    }        
+    }
 }
-Interfaces and methods from the Javadoc API are marked in -red. -{@link com.sun.javadoc.Doclet Doclet} is an abstract class that specifies -the invocation interface for doclets, -{@link com.sun.javadoc.Doclet Doclet} holds class or interface information, +Interfaces and methods from the Javadoc API are marked in +red. +{@link com.sun.javadoc.Doclet Doclet} is an abstract class that specifies +the invocation interface for doclets, +{@link com.sun.javadoc.Doclet Doclet} holds class or interface information, {@link com.sun.javadoc.ExecutableMemberDoc} is a -superinterface of {@link com.sun.javadoc.MethodDoc} and -{@link com.sun.javadoc.ConstructorDoc}, +superinterface of {@link com.sun.javadoc.MethodDoc} and +{@link com.sun.javadoc.ConstructorDoc}, and {@link com.sun.javadoc.ParamTag} holds information from "@param" tags.

@@ -148,5 +143,6 @@ producing output like: @see com.sun.javadoc.Doclet @see com.sun.javadoc.RootDoc - - +*/ +@jdk.Exported +package com.sun.javadoc; diff --git a/langtools/src/share/classes/com/sun/tools/classfile/package-info.java b/langtools/src/share/classes/com/sun/tools/classfile/package-info.java new file mode 100644 index 00000000000..588ae3b88b4 --- /dev/null +++ b/langtools/src/share/classes/com/sun/tools/classfile/package-info.java @@ -0,0 +1,37 @@ +/* + * Copyright (c) 2007, 2013, 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. + */ + +/** + A minimalist library to read and write class files into objects closely + based on the corresponding definitions in + The Java™ Virtual Machine Specification (JVMS). + +

This is NOT part of any supported API. + If you write code that depends on this, you do so at your own risk. + This code and its internal interfaces are subject to change or + deletion without notice. +*/ +@jdk.Exported(false) +package com.sun.tools.classfile; diff --git a/langtools/src/share/classes/com/sun/tools/classfile/package.html b/langtools/src/share/classes/com/sun/tools/classfile/package.html deleted file mode 100644 index 765dfb1acbe..00000000000 --- a/langtools/src/share/classes/com/sun/tools/classfile/package.html +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - A minimalist library to read and write class files into objects closely - based on the corresponding definitions in - The Java™ Virtual Machine Specification (JVMS). - - diff --git a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/package-info.java b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/package-info.java new file mode 100644 index 00000000000..3503e95467a --- /dev/null +++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/package-info.java @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2007, 2013, 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 classes that write HTML markup tags. + +

This is NOT part of any supported API. + If you write code that depends on this, you do so at your own risk. + This code and its internal interfaces are subject to change or + deletion without notice. + */ +@jdk.Exported(false) +package com.sun.tools.doclets.formats.html.markup; diff --git a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/package.html b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/package.html deleted file mode 100644 index 7030fae017a..00000000000 --- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/package.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - -com.sun.tools.doclets.formats.html.markup package - - This package contains classes that write HTML markup tags. - - diff --git a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/package-info.java b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/package-info.java new file mode 100644 index 00000000000..e4d51f6793a --- /dev/null +++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/package-info.java @@ -0,0 +1,40 @@ +/* + * Copyright (c) 2003, 2013, 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 is the default doclet provided with JDK that produces Javadoc's + default HTML-formatted API output. For more documentation + on this doclet, please refer to the link below. + + @see + http://www.java.sun.com/javadoc/standard-doclet.html + +

This is NOT part of any supported API. + If you write code that depends on this, you do so at your own risk. + This code and its internal interfaces are subject to change or + deletion without notice. +*/ +@jdk.Exported(false) +package com.sun.tools.doclets.formats.html; diff --git a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/package.html b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/package.html deleted file mode 100644 index ef2bcd224af..00000000000 --- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/package.html +++ /dev/null @@ -1,38 +0,0 @@ - - - - -com.sun.tools.doclets.formats.html package - - - This is the default doclet provided with JDK that produces Javadoc's - default HTML-formatted API output. For more documentation - on this doclet, please refer to the link below. - - @see - http://www.java.sun.com/javadoc/standard-doclet.html - - diff --git a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/package-info.java b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/package-info.java new file mode 100644 index 00000000000..a5e2db3e137 --- /dev/null +++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/package-info.java @@ -0,0 +1,41 @@ +/* + * Copyright (c) 2003, 2013, 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 doclet-independent package has a set of classes and + interfaces that are the building blocks for doclets. They + define the basic structure of doclets and make doclet + writing much easier because they provide the content generation + code to be shared among different doclets. Builders only provide + the structure and content of API documentation. + They will not provide any style markup. + +

This is NOT part of any supported API. + If you write code that depends on this, you do so at your own risk. + This code and its internal interfaces are subject to change or + deletion without notice. +*/ +@jdk.Exported(false) +package com.sun.tools.doclets.internal.toolkit.builders; diff --git a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/package.html b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/package.html deleted file mode 100644 index ab9d7ada62b..00000000000 --- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/package.html +++ /dev/null @@ -1,43 +0,0 @@ - - - - -com.sun.tools.doclets.internal.toolkit.builders package - - - This doclet-independent package has a set of classes and - interfaces that are the building blocks for doclets. They - define the basic structure of doclets and make doclet - writing much easier because they provide the content generation - code to be shared among different doclets. Builders only provide - the structure and content of API documentation. - They will not provide any style markup. -

- This code is not part of an API. - It is implementation that is subject to change. - Do not use it as an API. - - diff --git a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/package-info.java b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/package-info.java new file mode 100644 index 00000000000..5e3f61f4cde --- /dev/null +++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/package-info.java @@ -0,0 +1,57 @@ +/* + * Copyright (c) 2003, 2013, 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. + */ + +/** + Contains the base classes that make up a doclet. Doclets that reuse + the functionality provided by the toolkit should have the following + characteristics: +

+ +

This is NOT part of any supported API. + If you write code that depends on this, you do so at your own risk. + This code and its internal interfaces are subject to change or + deletion without notice. +*/ +@jdk.Exported(false) +package com.sun.tools.doclets.internal.toolkit; diff --git a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/package.html b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/package.html deleted file mode 100644 index 65d21d5b8b1..00000000000 --- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/package.html +++ /dev/null @@ -1,55 +0,0 @@ - - - - -com.sun.tools.doclets.internal.toolkit package - - - - Contains the base classes that make up a doclet. Doclets that reuse - the functionality provided by the toolkit should have the following - characteristics: -

+