Skip to content

Commit

Permalink
Javadoc update
Browse files Browse the repository at this point in the history
  • Loading branch information
cstamas committed Sep 25, 2024
1 parent d4976e3 commit 4277bb1
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,12 @@
* The {@code ModelParser} interface is used to locate and read {@link Model}s from the file system.
* This allows plugging in additional syntaxes for the main model read by Maven when building a project.
* <p>
* Note: if component names of {@link ModelParser} and {@link ModelWriter} are same, the pair is considered
* a "model dialect", as reading from- and writing to- this dialect becomes possible (symmetrical). Hence,
* "model translation" as read from one dialect and write out to another dialect becomes possible as well.
* Note: to provide Maven model "dialect", that can have models translated from-to, implement {@link ModelDialectProvider}
* that compose pairs of parser and writer (make dialect symmetrical).
*
* @since 4.0.0
* @see ModelDialectProvider
* @see DialectProvider
*/
@Experimental
@Consumer
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,12 @@
* The {@code ModelWriter} interface is used to write {@link Model}s to the file system.
* This allows plugging in additional syntaxes for the main model write.
* <p>
* Note: if component names of {@link ModelParser} and {@link ModelWriter} are same, the pair is considered
* a "model dialect", as reading from- and writing to- this dialect becomes possible (symmetrical). Hence,
* "model translation" as read from one dialect and write out to another dialect becomes possible as well.
* Note: to provide Maven model "dialect", that can have models translated from-to, implement {@link ModelDialectProvider}
* that compose pairs of parser and writer (make dialect symmetrical).
*
* @since 4.0.0
* @see ModelDialectProvider
* @see DialectProvider
*/
@Experimental
@Consumer
Expand Down

0 comments on commit 4277bb1

Please sign in to comment.