changeset 475:ff823a039e16

6909538: Clarify meaning of "element" in javax.lang.model.element API Reviewed-by: ahe
author darcy
date Thu, 10 Dec 2009 20:35:31 -0800
parents ea89c5d4af08
children 4011f49b4af8
files src/share/classes/javax/lang/model/element/package-info.java
diffstat 1 files changed, 10 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/src/share/classes/javax/lang/model/element/package-info.java	Mon Dec 07 14:35:07 2009 -0800
+++ b/src/share/classes/javax/lang/model/element/package-info.java	Thu Dec 10 20:35:31 2009 -0800
@@ -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