Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'org.eclipse.jdt.annotation/src/org/eclipse/jdt/annotation/NonNullByDefault.java')
-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 bb0f9b9460..d5e5aa7077 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>,

Back to the top