avro-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From b...@apache.org
Subject [15/43] avro git commit: AVRO-1834: Lower the Javadoc warnings on the generated code.
Date Sat, 14 May 2016 23:43:48 GMT
AVRO-1834: Lower the Javadoc warnings on the generated code.


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

Branch: refs/heads/branch-1.8
Commit: 8826b38b16f8c4aa5a3df33e6dbd8a339093a38d
Parents: d1c8523
Author: Niels Basjes <nielsbasjes@apache.org>
Authored: Mon Apr 25 22:54:58 2016 +0200
Committer: Ryan Blue <blue@apache.org>
Committed: Sat May 14 16:43:07 2016 -0700

----------------------------------------------------------------------
 CHANGES.txt                                                    | 2 ++
 .../avro/compiler/specific/templates/java/classic/record.vm    | 3 +++
 .../compiler/output-string/avro/examples/baseball/Player.java  | 6 ++++++
 lang/java/tools/src/test/compiler/output/Player.java           | 6 ++++++
 4 files changed, 17 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/avro/blob/8826b38b/CHANGES.txt
----------------------------------------------------------------------
diff --git a/CHANGES.txt b/CHANGES.txt
index b1c3799..bce23ce 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -27,6 +27,8 @@ Trunk (not yet released)
     AVRO-1819, AVRO-1820: Java: Add aliases, custom properties to Protocol.
     (Konstantin Usachev via blue)
 
+    AVRO-1834: Lower the Javadoc warnings on the generated code. (nielsbasjes)
+
   BUG FIXES
 
     AVRO-1493. Java: Avoid the "Turkish Locale Problem". Schema fingerprints are

http://git-wip-us.apache.org/repos/asf/avro/blob/8826b38b/lang/java/compiler/src/main/velocity/org/apache/avro/compiler/specific/templates/java/classic/record.vm
----------------------------------------------------------------------
diff --git a/lang/java/compiler/src/main/velocity/org/apache/avro/compiler/specific/templates/java/classic/record.vm
b/lang/java/compiler/src/main/velocity/org/apache/avro/compiler/specific/templates/java/classic/record.vm
index 5673fa4..3c69396 100644
--- a/lang/java/compiler/src/main/velocity/org/apache/avro/compiler/specific/templates/java/classic/record.vm
+++ b/lang/java/compiler/src/main/velocity/org/apache/avro/compiler/specific/templates/java/classic/record.vm
@@ -72,6 +72,7 @@ public class ${this.mangle($schema.getName())}#if ($schema.isError()) extends
or
    * All-args constructor.
 #foreach ($field in $schema.getFields())
 #if ($field.doc())   * @param ${this.mangle($field.name())} $field.doc()
+#else   * @param ${this.mangle($field.name())} The new value for ${field.name()}
 #end
 #end
    */
@@ -120,6 +121,7 @@ public class ${this.mangle($schema.getName())}#if ($schema.isError())
extends or
   /**
    * Gets the value of the '${this.mangle($field.name(), $schema.isError())}' field.
 #if ($field.doc())   * @return $field.doc()
+#else   * @return The value of the '${this.mangle($field.name(), $schema.isError())}' field.
 #end
    */
   public ${this.javaType($field.schema())} ${this.generateGetMethod($schema, $field)}() {
@@ -310,6 +312,7 @@ public class ${this.mangle($schema.getName())}#if ($schema.isError())
extends or
      * Sets the Builder instance for the '${this.mangle($field.name(), $schema.isError())}'
field
 #if ($field.doc())     * $field.doc()
 #end
+     * @param value The builder instance that must be set.
      * @return This builder.
      */
     public #if ($schema.getNamespace())$schema.getNamespace().#end${this.mangle($schema.getName())}.Builder
${this.generateSetBuilderMethod($schema, $field)}(${this.javaUnbox($field.schema())}.Builder
value) {

http://git-wip-us.apache.org/repos/asf/avro/blob/8826b38b/lang/java/tools/src/test/compiler/output-string/avro/examples/baseball/Player.java
----------------------------------------------------------------------
diff --git a/lang/java/tools/src/test/compiler/output-string/avro/examples/baseball/Player.java
b/lang/java/tools/src/test/compiler/output-string/avro/examples/baseball/Player.java
index d092078..46a0cba 100644
--- a/lang/java/tools/src/test/compiler/output-string/avro/examples/baseball/Player.java
+++ b/lang/java/tools/src/test/compiler/output-string/avro/examples/baseball/Player.java
@@ -27,6 +27,9 @@ public class Player extends org.apache.avro.specific.SpecificRecordBase
implemen
   /**
    * All-args constructor.
    * @param number The number of the player
+   * @param first_name The new value for first_name
+   * @param last_name The new value for last_name
+   * @param position The new value for position
    */
   public Player(java.lang.Integer number, java.lang.String first_name, java.lang.String last_name,
java.util.List<avro.examples.baseball.Position> position) {
     this.number = number;
@@ -77,6 +80,7 @@ public class Player extends org.apache.avro.specific.SpecificRecordBase
implemen
 
   /**
    * Gets the value of the 'first_name' field.
+   * @return The value of the 'first_name' field.
    */
   public java.lang.String getFirstName() {
     return first_name;
@@ -92,6 +96,7 @@ public class Player extends org.apache.avro.specific.SpecificRecordBase
implemen
 
   /**
    * Gets the value of the 'last_name' field.
+   * @return The value of the 'last_name' field.
    */
   public java.lang.String getLastName() {
     return last_name;
@@ -107,6 +112,7 @@ public class Player extends org.apache.avro.specific.SpecificRecordBase
implemen
 
   /**
    * Gets the value of the 'position' field.
+   * @return The value of the 'position' field.
    */
   public java.util.List<avro.examples.baseball.Position> getPosition() {
     return position;

http://git-wip-us.apache.org/repos/asf/avro/blob/8826b38b/lang/java/tools/src/test/compiler/output/Player.java
----------------------------------------------------------------------
diff --git a/lang/java/tools/src/test/compiler/output/Player.java b/lang/java/tools/src/test/compiler/output/Player.java
index 2363ed1..ce05afd 100644
--- a/lang/java/tools/src/test/compiler/output/Player.java
+++ b/lang/java/tools/src/test/compiler/output/Player.java
@@ -27,6 +27,9 @@ public class Player extends org.apache.avro.specific.SpecificRecordBase
implemen
   /**
    * All-args constructor.
    * @param number The number of the player
+   * @param first_name The new value for first_name
+   * @param last_name The new value for last_name
+   * @param position The new value for position
    */
   public Player(java.lang.Integer number, java.lang.CharSequence first_name, java.lang.CharSequence
last_name, java.util.List<avro.examples.baseball.Position> position) {
     this.number = number;
@@ -77,6 +80,7 @@ public class Player extends org.apache.avro.specific.SpecificRecordBase
implemen
 
   /**
    * Gets the value of the 'first_name' field.
+   * @return The value of the 'first_name' field.
    */
   public java.lang.CharSequence getFirstName() {
     return first_name;
@@ -92,6 +96,7 @@ public class Player extends org.apache.avro.specific.SpecificRecordBase
implemen
 
   /**
    * Gets the value of the 'last_name' field.
+   * @return The value of the 'last_name' field.
    */
   public java.lang.CharSequence getLastName() {
     return last_name;
@@ -107,6 +112,7 @@ public class Player extends org.apache.avro.specific.SpecificRecordBase
implemen
 
   /**
    * Gets the value of the 'position' field.
+   * @return The value of the 'position' field.
    */
   public java.util.List<avro.examples.baseball.Position> getPosition() {
     return position;


Mime
View raw message