AVRO-2115: Added documentation.

Project: http://git-wip-us.apache.org/repos/asf/avro/repo
Commit: http://git-wip-us.apache.org/repos/asf/avro/commit/53a9af76
Tree: http://git-wip-us.apache.org/repos/asf/avro/tree/53a9af76
Diff: http://git-wip-us.apache.org/repos/asf/avro/diff/53a9af76

Branch: refs/heads/master
Commit: 53a9af762acbfdc734a3cadf7d3c6d8736e1ec61
Parents: 164ee58
Author: Miguel Martinez-Espronceda <[email protected]>
Authored: Fri Dec 15 09:39:13 2017 +0100
Committer: Miguel Martinez-Espronceda <[email protected]>
Committed: Fri Dec 15 09:39:13 2017 +0100

----------------------------------------------------------------------
 lang/java/avro/src/main/java/org/apache/avro/reflect/Union.java   | 3 ++-
 lang/java/avro/src/main/java/org/apache/avro/reflect/package.html | 2 +-
 2 files changed, 3 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/avro/blob/53a9af76/lang/java/avro/src/main/java/org/apache/avro/reflect/Union.java
----------------------------------------------------------------------
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
index d823ebc..8f9f276 100644
--- 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 @@ import java.lang.annotation.Target;
  * 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})

http://git-wip-us.apache.org/repos/asf/avro/blob/53a9af76/lang/java/avro/src/main/java/org/apache/avro/reflect/package.html
----------------------------------------------------------------------
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
index dc6dbb9..98eca3f 100644
--- 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 @@ classes.
   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

Reply via email to