stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8199902: {@docRoot} references need to be updated to reflect new module/package structure

Browse Source 
Reviewed-by: ksrini
This commit is contained in:
Jonathan Gibbons 2018-03-23 17:28:02 -07:00
parent 6670f60a21
commit c003e3af3b
8 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/jdk.compiler/share/classes/com/sun/source/doctree/package-info.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2011, 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2011, 2018, 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
@ -30,7 +30,7 @@
* @author Jonathan Gibbons
* @since 1.8
*
* @see <a href="{@docRoot}/../specs/doc-comment-spec.html">
* @see <a href="{@docRootParent}/specs/doc-comment-spec.html">
* Documentation Comment Specification for the Standard Doclet</a>
*/
package com.sun.source.doctree;

4
src/jdk.compiler/share/classes/com/sun/tools/javac/Main.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1999, 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1999, 2018, 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
@ -30,7 +30,7 @@ import java.io.PrintWriter;
/**
* A legacy programmatic interface for the Java Programming Language
* compiler, javac.
* See the <a href="{@docRoot}/jdk.compiler-summary.html">{@code jdk.compiler}</a>
* See the <a href="{@docRoot}/jdk.compiler/module-summary.html">{@code jdk.compiler}</a>
* module for details on replacement APIs.
*/
public class Main {

4
src/jdk.compiler/share/classes/com/sun/tools/javac/package-info.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2015, 2018, 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
@ -25,7 +25,7 @@
/**
* This package provides a legacy entry point for the <em>javac</em> tool.
* See the <a href="{@docRoot}/jdk.compiler-summary.html">{@code jdk.compiler}</a>
* See the <a href="{@docRoot}/jdk.compiler/module-summary.html">{@code jdk.compiler}</a>
* module for details on replacement APIs.
*/
package com.sun.tools.javac;

16
src/jdk.javadoc/share/classes/com/sun/javadoc/ClassDoc.java
View File

@ -201,7 +201,7 @@ public interface ClassDoc extends ProgramElementDoc, Type {
/**
* Return
* <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">included</a>
* <a href="{@docRoot}/jdk.javadoc/com/sun/javadoc/package-summary.html#included">included</a>
* fields in this class or interface.
* Excludes enum constants if this is an enum type.
*
@ -212,7 +212,7 @@ public interface ClassDoc extends ProgramElementDoc, Type {
/**
* Return fields in this class or interface, filtered to the specified
* <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">access
* <a href="{@docRoot}/jdk.javadoc/com/sun/javadoc/package-summary.html#included">access
* modifier option</a>.
* Excludes enum constants if this is an enum type.
*
@ -236,7 +236,7 @@ public interface ClassDoc extends ProgramElementDoc, Type {
/**
* Return
* <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">included</a>
* <a href="{@docRoot}/jdk.javadoc/com/sun/javadoc/package-summary.html#included">included</a>
* methods in this class or interface.
* Same as {@code methods(true)}.
*
@ -248,7 +248,7 @@ public interface ClassDoc extends ProgramElementDoc, Type {
/**
* Return methods in this class or interface, filtered to the specified
* <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">access
* <a href="{@docRoot}/jdk.javadoc/com/sun/javadoc/package-summary.html#included">access
* modifier option</a>. Does not include constructors or annotation
* type elements.
*
@ -264,7 +264,7 @@ public interface ClassDoc extends ProgramElementDoc, Type {
/**
* Return
* <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">included</a>
* <a href="{@docRoot}/jdk.javadoc/com/sun/javadoc/package-summary.html#included">included</a>
* constructors in this class. An array containing the default
* no-arg constructor is returned if no other constructors exist.
* Return empty array if this is an interface.
@ -276,7 +276,7 @@ public interface ClassDoc extends ProgramElementDoc, Type {
/**
* Return constructors in this class, filtered to the specified
* <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">access
* <a href="{@docRoot}/jdk.javadoc/com/sun/javadoc/package-summary.html#included">access
* modifier option</a>. Return an array containing the default
* no-arg constructor if no other constructors exist.
*
@ -292,7 +292,7 @@ public interface ClassDoc extends ProgramElementDoc, Type {
/**
* Return
* <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">included</a>
* <a href="{@docRoot}/jdk.javadoc/com/sun/javadoc/package-summary.html#included">included</a>
* nested classes and interfaces within this class or interface.
* This includes both static and non-static nested classes.
* (This method should have been named {@code nestedClasses()},
@ -307,7 +307,7 @@ public interface ClassDoc extends ProgramElementDoc, Type {
/**
* Return nested classes and interfaces within this class or interface
* filtered to the specified
* <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">access
* <a href="{@docRoot}/jdk.javadoc/com/sun/javadoc/package-summary.html#included">access
* modifier option</a>.
* This includes both static and non-static nested classes.
* Anonymous and local classes are not included.

8
src/jdk.javadoc/share/classes/com/sun/javadoc/Doc.java
View File

@ -241,7 +241,7 @@ public interface Doc extends Comparable<Object> {
/**
* Is this Doc item an
* <a href="{@docRoot}/com/sun/javadoc/package-summary.html#class">ordinary
* <a href="{@docRoot}/jdk.javadoc/com/sun/javadoc/package-summary.html#class">ordinary
* class</a>?
* (i.e. not an interface, annotation type, enum, exception, or error)?
*
@ -251,7 +251,7 @@ public interface Doc extends Comparable<Object> {
/**
* Is this Doc item a
* <a href="{@docRoot}/com/sun/javadoc/package-summary.html#class">class</a>
* <a href="{@docRoot}/jdk.javadoc/com/sun/javadoc/package-summary.html#class">class</a>
* (and not an interface or annotation type)?
* This includes ordinary classes, enums, errors and exceptions.
*
@ -261,11 +261,11 @@ public interface Doc extends Comparable<Object> {
/**
* Return true if this Doc item is
* <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">included</a>
* <a href="{@docRoot}/jdk.javadoc/com/sun/javadoc/package-summary.html#included">included</a>
* in the result set.
*
* @return true if this Doc item is
* <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">included</a>
* <a href="{@docRoot}/jdk.javadoc/com/sun/javadoc/package-summary.html#included">included</a>
* in the result set.
*/
boolean isIncluded();

6
src/jdk.javadoc/share/classes/com/sun/javadoc/PackageDoc.java
View File

@ -48,7 +48,7 @@ public interface PackageDoc extends Doc {
/**
* Get all classes and interfaces in the package, filtered to the specified
* <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">access
* <a href="{@docRoot}/jdk.javadoc/com/sun/javadoc/package-summary.html#included">access
* modifier option</a>.
*
* @return filtered classes and interfaces in this package
@ -62,7 +62,7 @@ public interface PackageDoc extends Doc {
/**
* Get all
* <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">included</a>
* <a href="{@docRoot}/jdk.javadoc/com/sun/javadoc/package-summary.html#included">included</a>
* classes and interfaces in the package. Same as allClasses(true).
*
* @return all included classes and interfaces in this package.
@ -71,7 +71,7 @@ public interface PackageDoc extends Doc {
/**
* Get included
* <a href="{@docRoot}/com/sun/javadoc/package-summary.html#class">ordinary</a>
* <a href="{@docRoot}/jdk.javadoc/com/sun/javadoc/package-summary.html#class">ordinary</a>
* classes (that is, exclude exceptions, errors, enums, interfaces, and
* annotation types)
* in this package.

4
src/jdk.javadoc/share/classes/jdk/javadoc/doclet/StandardDoclet.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2018, 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
@ -36,7 +36,7 @@ import jdk.javadoc.internal.doclets.formats.html.HtmlDoclet;
* This doclet generates HTML-formatted documentation for the specified modules,
* packages and types.
*
* @see <a href="{@docRoot}/../specs/doc-comment-spec.html">
* @see <a href="{@docRootParent}/specs/doc-comment-spec.html">
* Documentation Comment Specification for the Standard Doclet</a>
*/
public class StandardDoclet implements Doclet {

4
src/jdk.javadoc/share/classes/module-info.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2014, 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2014, 2018, 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
@ -51,7 +51,7 @@
* @provides javax.tools.DocumentationTool
* @provides javax.tools.Tool
*
* @see <a href="{@docRoot}/../specs/doc-comment-spec.html">
* @see <a href="{@docRootParent}/specs/doc-comment-spec.html">
* Documentation Comment Specification for the Standard Doclet</a>
*
* @moduleGraph