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

Reviewed-by: ahe
This commit is contained in:
Joe Darcy 2009-12-10 20:35:31 -08:00
parent 3d3790d91c
commit 82e58a7b13

@ -26,6 +26,16 @@
/**
* Interfaces used to model elements of the Java programming language.
*
* The term "element" in this package is used to refer to program
* elements, the declared entities that make up a program. Elements
* include classes, interfaces, methods, constructors, and fields.
* The interfaces in this package do not model the structure of a
* program inside a method body; for example there is no
* representation of a {@code for} loop or {@code try}-{@code finally}
* block. However, the interfaces can model some structures only
* appearing inside method bodies, such as local variables and
* anonymous classes.
*
* <p>When used in the context of annotation processing, an accurate
* model of the element being represented must be returned. As this
* is a language model, the source code provides the fiducial