changeset 376:2ce3597237f0

6871291: Please clarify javax.tools.JavaCompiler.getTask() "classes" parameter Reviewed-by: jjg
author darcy
date Wed, 19 Aug 2009 17:12:36 -0700
parents 2aa3a1cdb094
children 61c1f735df67
files src/share/classes/javax/tools/JavaCompiler.java
diffstat 1 files changed, 8 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/src/share/classes/javax/tools/JavaCompiler.java	Wed Aug 19 20:44:22 2009 +0100
+++ b/src/share/classes/javax/tools/JavaCompiler.java	Wed Aug 19 17:12:36 2009 -0700
@@ -228,6 +228,12 @@
      * <p>If a file manager is provided, it must be able to handle all
      * locations defined in {@link StandardLocation}.
      *
+     * <p>Note that annotation processing can process both the
+     * compilation units of source code to be compiled, passed with
+     * the {@code compilationUnits} parameter, as well as class
+     * files, whose names are passed with the {@code classes}
+     * parameter.
+     *
      * @param out a Writer for additional output from the compiler;
      * use {@code System.err} if {@code null}
      * @param fileManager a file manager; if {@code null} use the
@@ -236,8 +242,8 @@
      * null} use the compiler's default method for reporting
      * diagnostics
      * @param options compiler options, {@code null} means no options
-     * @param classes class names (for annotation processing), {@code
-     * null} means no class names
+     * @param classes names of classes to be processed by annotation
+     * processing, {@code null} means no class names
      * @param compilationUnits the compilation units to compile, {@code
      * null} means no compilation units
      * @return an object representing the compilation