diff options
| author | Stephan Herrmann | 2012-07-30 20:17:13 +0000 |
|---|---|---|
| committer | Jayaprakash Arthanareeswaran | 2012-08-10 06:59:17 +0000 |
| commit | 0b7acd17e6eef2f223228752e14e0589f5cac72e (patch) | |
| tree | 91c6dfa8b622d0f75b229e3c98d4fa3b51518f60 | |
| parent | 56e6ea207731f6d3851d3f932b5a1a8aae6b42f7 (diff) | |
| download | eclipse.jdt.core-0b7acd17e6eef2f223228752e14e0589f5cac72e.tar.gz eclipse.jdt.core-0b7acd17e6eef2f223228752e14e0589f5cac72e.tar.xz eclipse.jdt.core-0b7acd17e6eef2f223228752e14e0589f5cac72e.zip | |
Bug 385564 - [null] document which entities are affected by
@NonNullByDefault
| -rw-r--r-- | org.eclipse.jdt.annotation/src/org/eclipse/jdt/annotation/NonNullByDefault.java | 10 |
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>, |