Skip to content

Commit 4277bb1

Browse files
committed
Javadoc update
1 parent d4976e3 commit 4277bb1

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

api/maven-api-spi/src/main/java/org/apache/maven/api/spi/ModelParser.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,12 @@
3434
* The {@code ModelParser} interface is used to locate and read {@link Model}s from the file system.
3535
* This allows plugging in additional syntaxes for the main model read by Maven when building a project.
3636
* <p>
37-
* Note: if component names of {@link ModelParser} and {@link ModelWriter} are same, the pair is considered
38-
* a "model dialect", as reading from- and writing to- this dialect becomes possible (symmetrical). Hence,
39-
* "model translation" as read from one dialect and write out to another dialect becomes possible as well.
37+
* Note: to provide Maven model "dialect", that can have models translated from-to, implement {@link ModelDialectProvider}
38+
* that compose pairs of parser and writer (make dialect symmetrical).
4039
*
4140
* @since 4.0.0
41+
* @see ModelDialectProvider
42+
* @see DialectProvider
4243
*/
4344
@Experimental
4445
@Consumer

api/maven-api-spi/src/main/java/org/apache/maven/api/spi/ModelWriter.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,12 @@
3333
* The {@code ModelWriter} interface is used to write {@link Model}s to the file system.
3434
* This allows plugging in additional syntaxes for the main model write.
3535
* <p>
36-
* Note: if component names of {@link ModelParser} and {@link ModelWriter} are same, the pair is considered
37-
* a "model dialect", as reading from- and writing to- this dialect becomes possible (symmetrical). Hence,
38-
* "model translation" as read from one dialect and write out to another dialect becomes possible as well.
36+
* Note: to provide Maven model "dialect", that can have models translated from-to, implement {@link ModelDialectProvider}
37+
* that compose pairs of parser and writer (make dialect symmetrical).
3938
*
4039
* @since 4.0.0
40+
* @see ModelDialectProvider
41+
* @see DialectProvider
4142
*/
4243
@Experimental
4344
@Consumer

0 commit comments

Comments
 (0)