6865399: some javac files are missing Sun internal API comment

Mon, 27 Jul 2009 19:52:42 -0700

author
jjg
date
Mon, 27 Jul 2009 19:52:42 -0700
changeset 333
7c2d6da61646
parent 332
cf08b64e87da
child 334
e4ce529b2249
child 338
777a3efad0d5

6865399: some javac files are missing Sun internal API comment
Reviewed-by: darcy

src/share/classes/com/sun/tools/javac/api/DiagnosticFormatter.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/api/Formattable.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/api/Messages.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/code/BoundKind.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/code/Printer.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/file/BaseFileObject.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/file/CacheFSInfo.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/file/FSInfo.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/file/JavacFileManager.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/file/RegularFileObject.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/file/RelativePath.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/file/SymbolArchive.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/file/ZipArchive.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/file/ZipFileIndex.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/file/ZipFileIndexArchive.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/parser/ParserFactory.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/util/AbstractDiagnosticFormatter.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/util/BasicDiagnosticFormatter.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/util/ForwardingDiagnosticFormatter.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/util/RawDiagnosticFormatter.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/util/RichDiagnosticFormatter.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/javac/util/Warner.java file | annotate | diff | comparison | revisions
     1.1 --- a/src/share/classes/com/sun/tools/javac/api/DiagnosticFormatter.java	Mon Jul 27 15:20:03 2009 -0700
     1.2 +++ b/src/share/classes/com/sun/tools/javac/api/DiagnosticFormatter.java	Mon Jul 27 19:52:42 2009 -0700
     1.3 @@ -32,6 +32,11 @@
     1.4  /**
     1.5   * Provides simple functionalities for javac diagnostic formatting.
     1.6   * @param <D> type of diagnostic handled by this formatter
     1.7 + *
     1.8 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
     1.9 + * If you write code that depends on this, you do so at your own risk.
    1.10 + * This code and its internal interfaces are subject to change or
    1.11 + * deletion without notice.</b>
    1.12   */
    1.13  public interface DiagnosticFormatter<D extends Diagnostic<?>> {
    1.14  
     2.1 --- a/src/share/classes/com/sun/tools/javac/api/Formattable.java	Mon Jul 27 15:20:03 2009 -0700
     2.2 +++ b/src/share/classes/com/sun/tools/javac/api/Formattable.java	Mon Jul 27 19:52:42 2009 -0700
     2.3 @@ -31,6 +31,11 @@
     2.4   * This interface must be implemented by any javac class that has non-trivial
     2.5   * formatting needs (e.g. where toString() does not apply because of localization).
     2.6   *
     2.7 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
     2.8 + * If you write code that depends on this, you do so at your own risk.
     2.9 + * This code and its internal interfaces are subject to change or
    2.10 + * deletion without notice.</b>
    2.11 + *
    2.12   * @author Maurizio Cimadamore
    2.13   */
    2.14  public interface Formattable {
     3.1 --- a/src/share/classes/com/sun/tools/javac/api/Messages.java	Mon Jul 27 15:20:03 2009 -0700
     3.2 +++ b/src/share/classes/com/sun/tools/javac/api/Messages.java	Mon Jul 27 19:52:42 2009 -0700
     3.3 @@ -32,6 +32,11 @@
     3.4   * This interface defines the minimum requirements in order to provide support
     3.5   * for localized formatted strings.
     3.6   *
     3.7 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
     3.8 + * If you write code that depends on this, you do so at your own risk.
     3.9 + * This code and its internal interfaces are subject to change or
    3.10 + * deletion without notice.</b>
    3.11 + *
    3.12   * @author Maurizio Cimadamore
    3.13   */
    3.14  public interface Messages {
     4.1 --- a/src/share/classes/com/sun/tools/javac/code/BoundKind.java	Mon Jul 27 15:20:03 2009 -0700
     4.2 +++ b/src/share/classes/com/sun/tools/javac/code/BoundKind.java	Mon Jul 27 19:52:42 2009 -0700
     4.3 @@ -25,7 +25,13 @@
     4.4  
     4.5  package com.sun.tools.javac.code;
     4.6  
     4.7 -
     4.8 +/**
     4.9 + *
    4.10 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
    4.11 + * If you write code that depends on this, you do so at your own risk.
    4.12 + * This code and its internal interfaces are subject to change or
    4.13 + * deletion without notice.</b>
    4.14 + */
    4.15  public enum BoundKind {
    4.16      EXTENDS("? extends "),
    4.17      SUPER("? super "),
     5.1 --- a/src/share/classes/com/sun/tools/javac/code/Printer.java	Mon Jul 27 15:20:03 2009 -0700
     5.2 +++ b/src/share/classes/com/sun/tools/javac/code/Printer.java	Mon Jul 27 19:52:42 2009 -0700
     5.3 @@ -40,6 +40,11 @@
     5.4  /**
     5.5   * A combined type/symbol visitor for generating non-trivial localized string
     5.6   * representation of types and symbols.
     5.7 + *
     5.8 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
     5.9 + * If you write code that depends on this, you do so at your own risk.
    5.10 + * This code and its internal interfaces are subject to change or
    5.11 + * deletion without notice.</b>
    5.12   */
    5.13  public abstract class Printer implements Type.Visitor<String, Locale>, Symbol.Visitor<String, Locale> {
    5.14  
     6.1 --- a/src/share/classes/com/sun/tools/javac/file/BaseFileObject.java	Mon Jul 27 15:20:03 2009 -0700
     6.2 +++ b/src/share/classes/com/sun/tools/javac/file/BaseFileObject.java	Mon Jul 27 19:52:42 2009 -0700
     6.3 @@ -36,6 +36,12 @@
     6.4  
     6.5  import static javax.tools.JavaFileObject.Kind.*;
     6.6  
     6.7 +/**
     6.8 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
     6.9 + * If you write code that depends on this, you do so at your own risk.
    6.10 + * This code and its internal interfaces are subject to change or
    6.11 + * deletion without notice.</b>
    6.12 +*/
    6.13  public abstract class BaseFileObject implements JavaFileObject {
    6.14      protected BaseFileObject(JavacFileManager fileManager) {
    6.15          this.fileManager = fileManager;
     7.1 --- a/src/share/classes/com/sun/tools/javac/file/CacheFSInfo.java	Mon Jul 27 15:20:03 2009 -0700
     7.2 +++ b/src/share/classes/com/sun/tools/javac/file/CacheFSInfo.java	Mon Jul 27 19:52:42 2009 -0700
     7.3 @@ -34,7 +34,12 @@
     7.4  import java.util.concurrent.ConcurrentHashMap;
     7.5  
     7.6  /**
     7.7 - * Caching implementation of FSInfo
     7.8 + * Caching implementation of FSInfo.
     7.9 + *
    7.10 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
    7.11 + * If you write code that depends on this, you do so at your own risk.
    7.12 + * This code and its internal interfaces are subject to change or
    7.13 + * deletion without notice.</b>
    7.14   */
    7.15  public class CacheFSInfo extends FSInfo {
    7.16  
     8.1 --- a/src/share/classes/com/sun/tools/javac/file/FSInfo.java	Mon Jul 27 15:20:03 2009 -0700
     8.2 +++ b/src/share/classes/com/sun/tools/javac/file/FSInfo.java	Mon Jul 27 19:52:42 2009 -0700
     8.3 @@ -16,6 +16,11 @@
     8.4  /**
     8.5   * Get meta-info about files. Default direct (non-caching) implementation.
     8.6   * @see CacheFSInfo
     8.7 + *
     8.8 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
     8.9 + * If you write code that depends on this, you do so at your own risk.
    8.10 + * This code and its internal interfaces are subject to change or
    8.11 + * deletion without notice.</b>
    8.12   */
    8.13  public class FSInfo {
    8.14  
     9.1 --- a/src/share/classes/com/sun/tools/javac/file/JavacFileManager.java	Mon Jul 27 15:20:03 2009 -0700
     9.2 +++ b/src/share/classes/com/sun/tools/javac/file/JavacFileManager.java	Mon Jul 27 19:52:42 2009 -0700
     9.3 @@ -82,6 +82,11 @@
     9.4  /**
     9.5   * This class provides access to the source, class and other files
     9.6   * used by the compiler and related tools.
     9.7 + *
     9.8 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
     9.9 + * If you write code that depends on this, you do so at your own risk.
    9.10 + * This code and its internal interfaces are subject to change or
    9.11 + * deletion without notice.</b>
    9.12   */
    9.13  public class JavacFileManager implements StandardJavaFileManager {
    9.14  
    10.1 --- a/src/share/classes/com/sun/tools/javac/file/RegularFileObject.java	Mon Jul 27 15:20:03 2009 -0700
    10.2 +++ b/src/share/classes/com/sun/tools/javac/file/RegularFileObject.java	Mon Jul 27 19:52:42 2009 -0700
    10.3 @@ -42,6 +42,11 @@
    10.4  
    10.5  /**
    10.6   * A subclass of JavaFileObject representing regular files.
    10.7 + *
    10.8 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
    10.9 + * If you write code that depends on this, you do so at your own risk.
   10.10 + * This code and its internal interfaces are subject to change or
   10.11 + * deletion without notice.</b>
   10.12   */
   10.13  class RegularFileObject extends BaseFileObject {
   10.14  
    11.1 --- a/src/share/classes/com/sun/tools/javac/file/RelativePath.java	Mon Jul 27 15:20:03 2009 -0700
    11.2 +++ b/src/share/classes/com/sun/tools/javac/file/RelativePath.java	Mon Jul 27 19:52:42 2009 -0700
    11.3 @@ -34,6 +34,11 @@
    11.4   * Used to represent a platform-neutral path within a platform-specific
    11.5   * container, such as a directory or zip file.
    11.6   * Internally, the file separator is always '/'.
    11.7 + *
    11.8 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
    11.9 + * If you write code that depends on this, you do so at your own risk.
   11.10 + * This code and its internal interfaces are subject to change or
   11.11 + * deletion without notice.</b>
   11.12   */
   11.13  public abstract class RelativePath implements Comparable<RelativePath> {
   11.14      /**
    12.1 --- a/src/share/classes/com/sun/tools/javac/file/SymbolArchive.java	Mon Jul 27 15:20:03 2009 -0700
    12.2 +++ b/src/share/classes/com/sun/tools/javac/file/SymbolArchive.java	Mon Jul 27 19:52:42 2009 -0700
    12.3 @@ -35,6 +35,12 @@
    12.4  import com.sun.tools.javac.file.RelativePath.RelativeFile;
    12.5  import com.sun.tools.javac.util.List;
    12.6  
    12.7 +/**
    12.8 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
    12.9 + * If you write code that depends on this, you do so at your own risk.
   12.10 + * This code and its internal interfaces are subject to change or
   12.11 + * deletion without notice.</b>
   12.12 +*/
   12.13  public class SymbolArchive extends ZipArchive {
   12.14  
   12.15      final File origFile;
    13.1 --- a/src/share/classes/com/sun/tools/javac/file/ZipArchive.java	Mon Jul 27 15:20:03 2009 -0700
    13.2 +++ b/src/share/classes/com/sun/tools/javac/file/ZipArchive.java	Mon Jul 27 19:52:42 2009 -0700
    13.3 @@ -48,6 +48,12 @@
    13.4  import com.sun.tools.javac.file.RelativePath.RelativeFile;
    13.5  import com.sun.tools.javac.util.List;
    13.6  
    13.7 +/**
    13.8 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
    13.9 + * If you write code that depends on this, you do so at your own risk.
   13.10 + * This code and its internal interfaces are subject to change or
   13.11 + * deletion without notice.</b>
   13.12 + */
   13.13  public class ZipArchive implements Archive {
   13.14  
   13.15      public ZipArchive(JavacFileManager fm, ZipFile zdir) throws IOException {
    14.1 --- a/src/share/classes/com/sun/tools/javac/file/ZipFileIndex.java	Mon Jul 27 15:20:03 2009 -0700
    14.2 +++ b/src/share/classes/com/sun/tools/javac/file/ZipFileIndex.java	Mon Jul 27 19:52:42 2009 -0700
    14.3 @@ -67,6 +67,11 @@
    14.4   * If nonBatchMode option is specified (-XDnonBatchMode) the compiler will use timestamp
    14.5   * checking to reindex the zip files if it is needed. In batch mode the timestamps are not checked
    14.6   * and the compiler uses the cached indexes.
    14.7 + *
    14.8 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
    14.9 + * If you write code that depends on this, you do so at your own risk.
   14.10 + * This code and its internal interfaces are subject to change or
   14.11 + * deletion without notice.</b>
   14.12   */
   14.13  public class ZipFileIndex {
   14.14      private static final String MIN_CHAR = String.valueOf(Character.MIN_VALUE);
    15.1 --- a/src/share/classes/com/sun/tools/javac/file/ZipFileIndexArchive.java	Mon Jul 27 15:20:03 2009 -0700
    15.2 +++ b/src/share/classes/com/sun/tools/javac/file/ZipFileIndexArchive.java	Mon Jul 27 19:52:42 2009 -0700
    15.3 @@ -44,6 +44,12 @@
    15.4  import com.sun.tools.javac.file.RelativePath.RelativeFile;
    15.5  import com.sun.tools.javac.util.List;
    15.6  
    15.7 +/**
    15.8 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
    15.9 + * If you write code that depends on this, you do so at your own risk.
   15.10 + * This code and its internal interfaces are subject to change or
   15.11 + * deletion without notice.</b>
   15.12 + */
   15.13  public class ZipFileIndexArchive implements Archive {
   15.14  
   15.15      private final ZipFileIndex zfIndex;
    16.1 --- a/src/share/classes/com/sun/tools/javac/parser/ParserFactory.java	Mon Jul 27 15:20:03 2009 -0700
    16.2 +++ b/src/share/classes/com/sun/tools/javac/parser/ParserFactory.java	Mon Jul 27 19:52:42 2009 -0700
    16.3 @@ -34,6 +34,11 @@
    16.4  
    16.5  /**
    16.6   * A factory for creating parsers.
    16.7 + *
    16.8 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
    16.9 + * If you write code that depends on this, you do so at your own risk.
   16.10 + * This code and its internal interfaces are subject to change or
   16.11 + * deletion without notice.</b>
   16.12   */
   16.13  public class ParserFactory {
   16.14  
    17.1 --- a/src/share/classes/com/sun/tools/javac/util/AbstractDiagnosticFormatter.java	Mon Jul 27 15:20:03 2009 -0700
    17.2 +++ b/src/share/classes/com/sun/tools/javac/util/AbstractDiagnosticFormatter.java	Mon Jul 27 19:52:42 2009 -0700
    17.3 @@ -57,6 +57,10 @@
    17.4   *  <li> Provides the formatting logic for rendering the arguments of a JCDiagnostic object.
    17.5   * <ul>
    17.6   *
    17.7 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
    17.8 + * If you write code that depends on this, you do so at your own risk.
    17.9 + * This code and its internal interfaces are subject to change or
   17.10 + * deletion without notice.</b>
   17.11   */
   17.12  public abstract class AbstractDiagnosticFormatter implements DiagnosticFormatter<JCDiagnostic> {
   17.13  
    18.1 --- a/src/share/classes/com/sun/tools/javac/util/BasicDiagnosticFormatter.java	Mon Jul 27 15:20:03 2009 -0700
    18.2 +++ b/src/share/classes/com/sun/tools/javac/util/BasicDiagnosticFormatter.java	Mon Jul 27 19:52:42 2009 -0700
    18.3 @@ -57,6 +57,11 @@
    18.4   * <li>%m: the text or the diagnostic, including any appropriate arguments
    18.5   * <li>%_: space delimiter, useful for formatting purposes
    18.6   * </ul>
    18.7 + *
    18.8 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
    18.9 + * If you write code that depends on this, you do so at your own risk.
   18.10 + * This code and its internal interfaces are subject to change or
   18.11 + * deletion without notice.</b>
   18.12   */
   18.13  public class BasicDiagnosticFormatter extends AbstractDiagnosticFormatter {
   18.14  
    19.1 --- a/src/share/classes/com/sun/tools/javac/util/ForwardingDiagnosticFormatter.java	Mon Jul 27 15:20:03 2009 -0700
    19.2 +++ b/src/share/classes/com/sun/tools/javac/util/ForwardingDiagnosticFormatter.java	Mon Jul 27 19:52:42 2009 -0700
    19.3 @@ -37,6 +37,11 @@
    19.4  /**
    19.5   * A delegated diagnostic formatter delegates all formatting
    19.6   * actions to an underlying formatter (aka the delegated formatter).
    19.7 + *
    19.8 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
    19.9 + * If you write code that depends on this, you do so at your own risk.
   19.10 + * This code and its internal interfaces are subject to change or
   19.11 + * deletion without notice.</b>
   19.12   */
   19.13  public class ForwardingDiagnosticFormatter<D extends Diagnostic<?>, F extends DiagnosticFormatter<D>>
   19.14          implements DiagnosticFormatter<D> {
    20.1 --- a/src/share/classes/com/sun/tools/javac/util/RawDiagnosticFormatter.java	Mon Jul 27 15:20:03 2009 -0700
    20.2 +++ b/src/share/classes/com/sun/tools/javac/util/RawDiagnosticFormatter.java	Mon Jul 27 19:52:42 2009 -0700
    20.3 @@ -39,6 +39,11 @@
    20.4   * The raw formatter will format a diagnostic according to one of two format patterns, depending on whether
    20.5   * or not the source name and position are set. This formatter provides a standardized, localize-independent
    20.6   * implementation of a diagnostic formatter; as such, this formatter is best suited for testing purposes.
    20.7 + *
    20.8 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
    20.9 + * If you write code that depends on this, you do so at your own risk.
   20.10 + * This code and its internal interfaces are subject to change or
   20.11 + * deletion without notice.</b>
   20.12   */
   20.13  public final class RawDiagnosticFormatter extends AbstractDiagnosticFormatter {
   20.14  
    21.1 --- a/src/share/classes/com/sun/tools/javac/util/RichDiagnosticFormatter.java	Mon Jul 27 15:20:03 2009 -0700
    21.2 +++ b/src/share/classes/com/sun/tools/javac/util/RichDiagnosticFormatter.java	Mon Jul 27 19:52:42 2009 -0700
    21.3 @@ -58,6 +58,11 @@
    21.4   * formatted and (iii) type-variable disambiguation - when the diagnostic refers
    21.5   * to two different type-variables with the same name, their representation is
    21.6   * disambiguated by appending an index to the type variable name.
    21.7 + *
    21.8 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
    21.9 + * If you write code that depends on this, you do so at your own risk.
   21.10 + * This code and its internal interfaces are subject to change or
   21.11 + * deletion without notice.</b>
   21.12   */
   21.13  public class RichDiagnosticFormatter extends
   21.14          ForwardingDiagnosticFormatter<JCDiagnostic, AbstractDiagnosticFormatter> {
    22.1 --- a/src/share/classes/com/sun/tools/javac/util/Warner.java	Mon Jul 27 15:20:03 2009 -0700
    22.2 +++ b/src/share/classes/com/sun/tools/javac/util/Warner.java	Mon Jul 27 19:52:42 2009 -0700
    22.3 @@ -31,10 +31,10 @@
    22.4   * An interface to support optional warnings, needed for support of
    22.5   * unchecked conversions and unchecked casts.
    22.6   *
    22.7 - * <p>Nothing described in this source file is part of any supported
    22.8 - * API.  If you write code that depends on this, you do so at your own
    22.9 - * risk.  This code and its internal interfaces are subject to change
   22.10 - * or deletion without notice.
   22.11 + * <p><b>This is NOT part of any API supported by Sun Microsystems.
   22.12 + * If you write code that depends on this, you do so at your own risk.
   22.13 + * This code and its internal interfaces are subject to change or
   22.14 + * deletion without notice.</b>
   22.15   */
   22.16  public class Warner {
   22.17      public static final Warner noWarnings = new Warner();

mercurial