AVRO-2115: Added documentation.

Zetatango · Dec 15, 2017 · 53a9af7 · 53a9af7
1 parent 164ee58
commit 53a9af7
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/lang/java/avro/src/main/java/org/apache/avro/reflect/Union.java b/lang/java/avro/src/main/java/org/apache/avro/reflect/Union.java
@@ -28,7 +28,8 @@
  * May be used for base classes or interfaces whose instantiable subclasses can
  * be listed in the parameters to the @Union annotation.  If applied to method
  * parameters this determines the reflected message parameter type.  If applied
- * to a method, this determines its return type.
+ * to a method, this determines its return type. A null schema may be specified 
+ * with {@link java.lang.Void}.
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.TYPE, ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD})

diff --git a/lang/java/avro/src/main/java/org/apache/avro/reflect/package.html b/lang/java/avro/src/main/java/org/apache/avro/reflect/package.html
@@ -30,7 +30,7 @@
   that are not static or transient are used.  Fields are not permitted
   to be null unless annotated by {@link
   org.apache.avro.reflect.Nullable Nullable} or a {@link
-  org.apache.avro.reflect.Union Union} containing null.</li>
+  org.apache.avro.reflect.Union Union} containing {@link java.lang.Void}.</li>
 
 <li><b>Arrays</b> are mapped to Avro array schemas.  If an array's
   elements are a union defined by the {@link