+ +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 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. +
-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
+{@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}, +{@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", +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#isEnum() enums}, +{@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 +describes explicitly which meaning is being used. +
+
+
+A qualified class or interface name is one that has its package
+name prepended to it, such as java.lang.String. A non-qualified
+name has no package name, such as String.
+
@param tags of the processed
+classes:
+
+import com.sun.javadoc.*;
+
+public class ListParams extends Doclet {
+
+ public static boolean start(RootDoc root) {
+ ClassDoc[] classes = root.classes();
+ for (int i = 0; i < classes.length; ++i) {
+ ClassDoc cd = classes[i];
+ printMembers(cd.constructors());
+ printMembers(cd.methods());
+ }
+ return true;
+ }
+
+ static void printMembers(ExecutableMemberDoc[] mems) {
+ for (int i = 0; i < mems.length; ++i) {
+ ParamTag[] params = mems[i].paramTags();
+ System.out.println(mems[i].qualifiedName());
+ for (int j = 0; j < params.length; ++j) {
+ System.out.println(" " + params[j].parameterName()
+ + " - " + 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,
+{@link com.sun.javadoc.ExecutableMemberDoc} is a
+superinterface of {@link com.sun.javadoc.MethodDoc} and
+{@link com.sun.javadoc.ConstructorDoc},
+and {@link com.sun.javadoc.ParamTag} holds information
+from "@param" tags.
++This doclet when invoked with a command line like: +
+ javadoc -doclet ListParams -sourcepath <source-location> java.util ++producing output like: +
+ ... + java.util.ArrayList.add + index - index at which the specified element is to be inserted. + element - element to be inserted. + java.util.ArrayList.remove + index - the index of the element to removed. + ... + ++@see com.sun.javadoc.Doclet +@see com.sun.javadoc.RootDoc +*/ +@jdk.Exported +package com.sun.javadoc; diff -r 95d225149128 -r ce43db751581 langtools/src/share/classes/com/sun/javadoc/package.html --- a/langtools/src/share/classes/com/sun/javadoc/package.html Mon Oct 14 22:11:09 2013 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,152 +0,0 @@ - - -
- -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 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. -
-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
-{@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}, -{@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", -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#isEnum() enums}, -{@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 -describes explicitly which meaning is being used. -
-
-
-A qualified class or interface name is one that has its package
-name prepended to it, such as java.lang.String. A non-qualified
-name has no package name, such as String.
-
@param tags of the processed
-classes:
-
-import com.sun.javadoc.*;
-
-public class ListParams extends Doclet {
-
- public static boolean start(RootDoc root) {
- ClassDoc[] classes = root.classes();
- for (int i = 0; i < classes.length; ++i) {
- ClassDoc cd = classes[i];
- printMembers(cd.constructors());
- printMembers(cd.methods());
- }
- return true;
- }
-
- static void printMembers(ExecutableMemberDoc[] mems) {
- for (int i = 0; i < mems.length; ++i) {
- ParamTag[] params = mems[i].paramTags();
- System.out.println(mems[i].qualifiedName());
- for (int j = 0; j < params.length; ++j) {
- System.out.println(" " + params[j].parameterName()
- + " - " + 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,
-{@link com.sun.javadoc.ExecutableMemberDoc} is a
-superinterface of {@link com.sun.javadoc.MethodDoc} and
-{@link com.sun.javadoc.ConstructorDoc},
-and {@link com.sun.javadoc.ParamTag} holds information
-from "@param" tags.
--This doclet when invoked with a command line like: -
- javadoc -doclet ListParams -sourcepath <source-location> java.util --producing output like: -
- ... - java.util.ArrayList.add - index - index at which the specified element is to be inserted. - element - element to be inserted. - java.util.ArrayList.remove - index - the index of the element to removed. - ... - --@see com.sun.javadoc.Doclet -@see com.sun.javadoc.RootDoc - - diff -r 95d225149128 -r ce43db751581 langtools/src/share/classes/com/sun/tools/classfile/package-info.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/langtools/src/share/classes/com/sun/tools/classfile/package-info.java Mon Oct 14 16:28:44 2013 -0700 @@ -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 -r 95d225149128 -r ce43db751581 langtools/src/share/classes/com/sun/tools/classfile/package.html --- a/langtools/src/share/classes/com/sun/tools/classfile/package.html Mon Oct 14 22:11:09 2013 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,12 +0,0 @@ - - -
-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 -r 95d225149128 -r ce43db751581 langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/package.html --- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/package.html Mon Oct 14 22:11:09 2013 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,32 +0,0 @@ - - - -
-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 -r 95d225149128 -r ce43db751581 langtools/src/share/classes/com/sun/tools/doclets/formats/html/package.html --- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/package.html Mon Oct 14 22:11:09 2013 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,38 +0,0 @@ - - - -
-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 -r 95d225149128 -r ce43db751581 langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/package.html --- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/package.html Mon Oct 14 22:11:09 2013 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,43 +0,0 @@ - - - -
-- This code is not part of an API. - It is implementation that is subject to change. - Do not use it as an API. - - diff -r 95d225149128 -r ce43db751581 langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/package-info.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/package-info.java Mon Oct 14 16:28:44 2013 -0700 @@ -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 -r 95d225149128 -r ce43db751581 langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/package.html --- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/package.html Mon Oct 14 22:11:09 2013 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,55 +0,0 @@ - - - -
-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.taglets; diff -r 95d225149128 -r ce43db751581 langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/package.html --- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/package.html Mon Oct 14 22:11:09 2013 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,54 +0,0 @@ - - - -
-- This code is not part of an API. - It is implementation that is subject to change. - Do not use it as an API. - - diff -r 95d225149128 -r ce43db751581 langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/links/package-info.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/links/package-info.java Mon Oct 14 16:28:44 2013 -0700 @@ -0,0 +1,35 @@ +/* + * 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. + */ + +/** + Provides a factory for constructing links. + +
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.util.links; diff -r 95d225149128 -r ce43db751581 langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/links/package.html --- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/links/package.html Mon Oct 14 22:11:09 2013 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,33 +0,0 @@ - - - -
-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.util; diff -r 95d225149128 -r ce43db751581 langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/package.html --- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/package.html Mon Oct 14 22:11:09 2013 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,38 +0,0 @@ - - - -
-- This code is not part of an API. - It is implementation that is subject to change. - Do not use it as an API. - - diff -r 95d225149128 -r ce43db751581 langtools/src/share/classes/com/sun/tools/doclets/package-info.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/langtools/src/share/classes/com/sun/tools/doclets/package-info.java Mon Oct 14 16:28:44 2013 -0700 @@ -0,0 +1,36 @@ +/* + * 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. + */ + +/** + As of JDK version 1.5, replaced by + {@code com.sun.tools.doclets.internal.toolkit.util}. + +
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; diff -r 95d225149128 -r ce43db751581 langtools/src/share/classes/com/sun/tools/doclets/package.html --- a/langtools/src/share/classes/com/sun/tools/doclets/package.html Mon Oct 14 22:11:09 2013 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,34 +0,0 @@ - - - -
-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.javap; diff -r 95d225149128 -r ce43db751581 langtools/src/share/classes/com/sun/tools/javap/package.html --- a/langtools/src/share/classes/com/sun/tools/javap/package.html Mon Oct 14 22:11:09 2013 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ - - -
-@@ -21,3 +51,4 @@