javadoc for NonNull/Nullable annotations

ReactiveX · Feb 3, 2017 · 8e8978c · 8e8978c
1 parent 0f10874
commit 8e8978c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/src/main/java/io/reactivex/annotations/NonNull.java b/src/main/java/io/reactivex/annotations/NonNull.java
@@ -23,6 +23,9 @@
 import static java.lang.annotation.ElementType.PARAMETER;
 import static java.lang.annotation.RetentionPolicy.CLASS;
 
+/**
+ * Indicates that a field/parameter/variable/return type is never null.
+ */
 @Documented
 @Target(value = {FIELD, METHOD, PARAMETER, LOCAL_VARIABLE})
 @Retention(value = CLASS)

diff --git a/src/main/java/io/reactivex/annotations/Nullable.java b/src/main/java/io/reactivex/annotations/Nullable.java
@@ -23,6 +23,9 @@
 import static java.lang.annotation.ElementType.PARAMETER;
 import static java.lang.annotation.RetentionPolicy.CLASS;
 
+/**
+ * Indicates that a field/parameter/variable/return type may be null.
+ */
 @Documented
 @Target(value = {FIELD, METHOD, PARAMETER, LOCAL_VARIABLE})
 @Retention(value = CLASS)