6909538: Clarify meaning of "element" in javax.lang.model.element API

Thu, 10 Dec 2009 20:35:31 -0800

author
darcy
date
Thu, 10 Dec 2009 20:35:31 -0800
changeset 449
ff823a039e16
parent 444
ea89c5d4af08
child 450
4011f49b4af8

6909538: Clarify meaning of "element" in javax.lang.model.element API
Reviewed-by: ahe

src/share/classes/javax/lang/model/element/package-info.java file | annotate | diff | comparison | revisions
     1.1 --- a/src/share/classes/javax/lang/model/element/package-info.java	Mon Dec 07 14:35:07 2009 -0800
     1.2 +++ b/src/share/classes/javax/lang/model/element/package-info.java	Thu Dec 10 20:35:31 2009 -0800
     1.3 @@ -26,6 +26,16 @@
     1.4  /**
     1.5   * Interfaces used to model elements of the Java programming language.
     1.6   *
     1.7 + * The term "element" in this package is used to refer to program
     1.8 + * elements, the declared entities that make up a program.  Elements
     1.9 + * include classes, interfaces, methods, constructors, and fields.
    1.10 + * The interfaces in this package do not model the structure of a
    1.11 + * program inside a method body; for example there is no
    1.12 + * representation of a {@code for} loop or {@code try}-{@code finally}
    1.13 + * block.  However, the interfaces can model some structures only
    1.14 + * appearing inside method bodies, such as local variables and
    1.15 + * anonymous classes.
    1.16 + *
    1.17   * <p>When used in the context of annotation processing, an accurate
    1.18   * model of the element being represented must be returned.  As this
    1.19   * is a language model, the source code provides the fiducial

mercurial