AVRO-1524: update documents

apache · Nov 2, 2023 · e8ac07c · e8ac07c
1 parent 7b2d368
commit e8ac07c
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 9 deletions.
diff --git a/doc/content/en/docs/++version++/IDL Language/_index.md b/doc/content/en/docs/++version++/IDL Language/_index.md
@@ -66,19 +66,18 @@ A Maven plugin is also provided to generate _.java_, _.avpr_ and _.avsc_ files f
       <executions>
         <execution>
           <goals>
-            <goal>idl</goal>
+            <goal>idl2java</goal>
           </goals>
         </execution>
       </executions>
-      <configuration>
-        <generateJava>true</generateJava>
-        <generateProtocol>false</generateProtocol>
-        <generateSchema>true</generateSchema>
-      </configuration>
     </plugin>
   </plugins>
 </build>
 ```
+goals:
+- `idl2java`: Generate Java classes and interfaces (.java) from AvroIDL files (.avdl)
+- `idl2protocol`: Generate JSON Avro protocol files (.avpr) from AvroIDL files (.avdl)
+- `idl2schema`: Generate JSON Avro schema files (.avsc) from AvroIDL files (.avdl)
 
 ## Defining a Schema in Avro IDL
 An Avro IDL file consists of exactly one (main) schema definition. The minimal schema is defined by the following code:

diff --git a/lang/java/maven-plugin/src/main/java/org/apache/avro/mojo/IDL2JavaMojo.java b/lang/java/maven-plugin/src/main/java/org/apache/avro/mojo/IDL2JavaMojo.java
@@ -26,7 +26,7 @@
 import java.io.IOException;
 
 /**
- * Generate Java classes and interfaces from AvroIDL files (.avdl)
+ * Generate Java classes and interfaces (.java) from AvroIDL files (.avdl)
  *
  * @goal idl2java
  * @requiresDependencyResolution runtime

diff --git a/lang/java/maven-plugin/src/main/java/org/apache/avro/mojo/IDL2ProtocolMojo.java b/lang/java/maven-plugin/src/main/java/org/apache/avro/mojo/IDL2ProtocolMojo.java
@@ -28,7 +28,7 @@
 import static org.apache.avro.compiler.specific.SpecificCompiler.mangleTypeIdentifier;
 
 /**
- * Generate Java classes and interfaces from AvroIDL files (.avdl)
+ * Generate JSON Avro protocol files (.avpr) from AvroIDL files (.avdl)
  *
  * @goal idl2protocol
  * @requiresDependencyResolution runtime

diff --git a/lang/java/maven-plugin/src/main/java/org/apache/avro/mojo/IDL2SchemaMojo.java b/lang/java/maven-plugin/src/main/java/org/apache/avro/mojo/IDL2SchemaMojo.java
@@ -30,7 +30,7 @@
 import static org.apache.avro.compiler.specific.SpecificCompiler.mangleTypeIdentifier;
 
 /**
- * Generate Java classes and interfaces from AvroIDL files (.avdl)
+ * Generate JSON Avro schema files (.avsc) from AvroIDL files (.avdl)
  *
  * @goal idl2schema
  * @requiresDependencyResolution runtime