Skip to content

Commit d3d191c

Browse files
committed
Update javadoc and switch to Java release 17
Enhance MjmlDocument Javadoc to better describe the record and add an @param for the root node. In pom.xml, replace the maven.compiler.source/target properties with maven.compiler.release and update the maven-compiler-plugin configuration to use <release>17. This simplifies Java version configuration and ensures the project is built with the Java 17 release flag.
1 parent 75f591e commit d3d191c

2 files changed

Lines changed: 8 additions & 6 deletions

File tree

mjml-java-core/src/main/java/dev/jcputney/mjml/parser/MjmlDocument.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
package dev.jcputney.mjml.parser;
22

33
/**
4-
* Parsed MJML document model containing the root node and convenience accessors for head and body
5-
* sections.
4+
* Represents an MJML document's structure, containing a root node
5+
* and methods to access key elements such as the head and body nodes.
6+
* This class encapsulates the MJML document's logical model, allowing
7+
* for the retrieval of specific parts of its structure.
8+
*
9+
* @param root the root {@code <mjml>} node of the document
610
*/
711
public record MjmlDocument(MjmlNode root) {
812

pom.xml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,7 @@
4747
<properties>
4848
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
4949
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
50-
<maven.compiler.source>17</maven.compiler.source>
51-
<maven.compiler.target>17</maven.compiler.target>
50+
<maven.compiler.release>17</maven.compiler.release>
5251
<junit.version>6.0.2</junit.version>
5352
<version.plugin.central-publishing>0.10.0</version.plugin.central-publishing>
5453
<version.plugin.gpg>3.2.8</version.plugin.gpg>
@@ -79,8 +78,7 @@
7978
<artifactId>maven-compiler-plugin</artifactId>
8079
<version>3.15.0</version>
8180
<configuration>
82-
<source>17</source>
83-
<target>17</target>
81+
<release>17</release>
8482
</configuration>
8583
</plugin>
8684
<plugin>

0 commit comments

Comments
 (0)