aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStephan Herrmann2012-07-30 16:17:13 (EDT)
committerJayaprakash Arthanareeswaran2012-08-10 02:59:17 (EDT)
commit0b7acd17e6eef2f223228752e14e0589f5cac72e (patch)
tree91c6dfa8b622d0f75b229e3c98d4fa3b51518f60
parent56e6ea207731f6d3851d3f932b5a1a8aae6b42f7 (diff)
downloadeclipse.jdt.core-0b7acd17e6eef2f223228752e14e0589f5cac72e.zip
eclipse.jdt.core-0b7acd17e6eef2f223228752e14e0589f5cac72e.tar.gz
eclipse.jdt.core-0b7acd17e6eef2f223228752e14e0589f5cac72e.tar.bz2
Bug 385564 - [null] document which entities are affected by
@NonNullByDefault
-rw-r--r--org.eclipse.jdt.annotation/src/org/eclipse/jdt/annotation/NonNullByDefault.java10
1 files changed, 8 insertions, 2 deletions
diff --git a/org.eclipse.jdt.annotation/src/org/eclipse/jdt/annotation/NonNullByDefault.java b/org.eclipse.jdt.annotation/src/org/eclipse/jdt/annotation/NonNullByDefault.java
index bb0f9b9..d5e5aa7 100644
--- a/org.eclipse.jdt.annotation/src/org/eclipse/jdt/annotation/NonNullByDefault.java
+++ b/org.eclipse.jdt.annotation/src/org/eclipse/jdt/annotation/NonNullByDefault.java
@@ -23,8 +23,14 @@ import java.lang.annotation.Target;
/**
* This annotation can be applied to a package, type, method or constructor in order to
- * define that all contained entities for which a null annotation is otherwise lacking
- * should be considered as {@link NonNull @NonNull}.
+ * define that contained entities for which a null annotation is otherwise lacking
+ * should be considered as {@link NonNull @NonNull}. Entities affected by
+ * <code>@NonNullByDefault</code> are:
+ * <ul>
+ * <li>method return values</li>
+ * <li>parameters of a method or constructor.</li>
+ * </ul>
+ * Local variables are <em>not</em> affected.
* <dl>
* <dt>Canceling a default</dt>
* <dd>By using a <code>@NonNullByDefault</code> annotation with the argument <code>false</code>,