[avro] branch master updated: Improve generated comments and compiler option description (#1935)

[mgrigorov]

This is an automated email from the ASF dual-hosted git repository.

mgrigorov pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/avro.git


The following commit(s) were added to refs/heads/master by this push:
     new 50a12a3bb Improve generated comments and compiler option description 
(#1935)
50a12a3bb is described below

commit 50a12a3bb5244bf80ef2238d920636d1253a0ca9
Author: Milind Mantri <mil...@milindmantri.com>
AuthorDate: Thu Oct 27 12:33:22 2022 +0530

    Improve generated comments and compiler option description (#1935)
    
    * Fix indentation of comments on optional getter methods
    
    * Fix description comment on gettersReturnOptional
---
 .../apache/avro/compiler/specific/templates/java/classic/record.vm    | 4 ++--
 .../src/main/java/org/apache/avro/mojo/AbstractAvroMojo.java          | 3 +--
 2 files changed, 3 insertions(+), 4 deletions(-)

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 1e054d3ec..971cfa677 100755
--- 
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
@@ -229,7 +229,7 @@ public class 
${this.mangleTypeIdentifier($schema.getName())}#if ($schema.isError
 #if (${this.gettersReturnOptional} && 
(!${this.optionalGettersForNullableFieldsOnly} || 
${field.schema().isNullable()}))
   /**
    * Gets the value of the '${this.mangle($field.name(), $schema.isError())}' 
field as an Optional&lt;${this.javaType($field.schema())}&gt;.
-#if ($field.doc())      * $field.doc()
+#if ($field.doc())   * $field.doc()
 #end
    * @return The value wrapped in an 
Optional&lt;${this.javaType($field.schema())}&gt;.
    */
@@ -251,7 +251,7 @@ public class 
${this.mangleTypeIdentifier($schema.getName())}#if ($schema.isError
 #if (${this.createOptionalGetters})
   /**
    * Gets the value of the '${this.mangle($field.name(), $schema.isError())}' 
field as an Optional&lt;${this.javaType($field.schema())}&gt;.
-#if ($field.doc())      * $field.doc()
+#if ($field.doc())   * $field.doc()
 #end
    * @return The value wrapped in an 
Optional&lt;${this.javaType($field.schema())}&gt;.
    */
diff --git 
a/lang/java/maven-plugin/src/main/java/org/apache/avro/mojo/AbstractAvroMojo.java
 
b/lang/java/maven-plugin/src/main/java/org/apache/avro/mojo/AbstractAvroMojo.java
index d0407eb74..968d8d0bd 100644
--- 
a/lang/java/maven-plugin/src/main/java/org/apache/avro/mojo/AbstractAvroMojo.java
+++ 
b/lang/java/maven-plugin/src/main/java/org/apache/avro/mojo/AbstractAvroMojo.java
@@ -140,8 +140,7 @@ public abstract class AbstractAvroMojo extends AbstractMojo 
{
 
   /**
    * The gettersReturnOptional parameter enables generating get... methods that
-   * return an Optional of the requested type. This will replace the This works
-   * ONLY on Java 8+
+   * return an Optional of the requested type. This works ONLY on Java 8+
    *
    * @parameter property="gettersReturnOptional"
    */