From 36be69b1c4bd90c8b0704752f9a50323d1dfec2e Mon Sep 17 00:00:00 2001
From: Reinier Zwitserloot <r.zwitserloot@projectlombok.org>
Date: Sun, 30 Mar 2025 00:26:14 +0100
Subject: [PATCH] [docs][fixes #3853] Update maven instructions: You need to
 explicitly specify lombok is an annotation processor.

---
 website/templates/_download-edge.html | 28 +++++++++++++++++++++++-
 website/templates/setup/maven.html    | 31 ++++++++++++++++-----------
 2 files changed, 45 insertions(+), 14 deletions(-)

diff --git a/website/templates/_download-edge.html b/website/templates/_download-edge.html
index 0e04596c..7b98d3b2 100644
--- a/website/templates/_download-edge.html
+++ b/website/templates/_download-edge.html
@@ -10,7 +10,13 @@
 		</div><div class="row text-center">
 			<h2><a href="/lombok-edge.jar" id="downloadLink">Download edge release now!</a></h2>
 			<p>
-				You can use the edge release from maven using the projectlombok.org repository:<pre>
+				You can use the edge release from maven using the projectlombok.org repository.
+				This requires:<ul>
+					<li>Adding the lombok maven repository to your <code>repositories</code> section</li>
+					<li>Adding lombok as a dependency to your project in the <code>dependencies</code> section, specifying version <code>edge-SNAPSHOT</code>.</li>
+					<li>Adding lombok as an annotation processor in the <code>annotationProcessorPaths</code> section, specifying version <code>edge-SNAPSHOT</code>.</li>
+				</ul>
+				These sections in your pom file should look like this:<pre>
 &lt;repositories&gt;
 	&lt;repository&gt;
 		&lt;id&gt;projectlombok.org&lt;/id&gt;
@@ -26,6 +32,26 @@
 		&lt;scope&gt;provided&lt;/scope&gt;
 	&lt;/dependency&gt;
 &lt;/dependencies&gt;</pre>
+<pre>
+&lt;build&gt;
+	&lt;plugins&gt;
+		&lt;plugin&gt;
+			&lt;groupId&gt;org.apache.maven.plugins&lt;/groupId&gt;
+			&lt;artifactId&gt;maven-compiler-plugin&lt;/artifactId&gt;
+			&lt;configuration&gt;
+				&lt;annotationProcessorPaths&gt;
+					&lt;path&gt;
+						&lt;groupId&gt;org.projectlombok&lt;/groupId&gt;
+						&lt;artifactId&gt;lombok&lt;/artifactId&gt;
+						&lt;version&gt;edge-SNAPSHOT&lt;/version&gt;
+					&lt;/path&gt;
+				&lt;/annotationProcessorPaths&gt;
+			&lt;/configuration&gt;
+		&lt;/plugin&gt;
+	&lt;/plugins&gt;
+&lt;/build&gt;
+
+</pre>
 			</p>
 			<p>
 				You can use the edge release from gradle using the projectlombok.org repository:<pre>
diff --git a/website/templates/setup/maven.html b/website/templates/setup/maven.html
index f6c36822..27153cb3 100644
--- a/website/templates/setup/maven.html
+++ b/website/templates/setup/maven.html
@@ -22,20 +22,25 @@
 &lt;/dependencies&gt;
 </pre>
 		</p>
-	</@s.section>
-
-	<@s.section title="JDK9+ with module-info.java">
 		<p>
-			The configuration of the compiler plug-in should contain the following:<pre>
-&lt;annotationProcessorPaths&gt;
-	&lt;path&gt;
-		&lt;groupId&gt;org.projectlombok&lt;/groupId&gt;
-		&lt;artifactId&gt;lombok&lt;/artifactId&gt;
-		&lt;version&gt;${version}&lt;/version&gt;
-	&lt;/path&gt;
-&lt;/annotationProcessorPaths&gt;
-</pre>
-		</p>
+		You also need to add lombok as an annotation processor. This is mandatory starting with JDK23, or JDK9+ if compiling as modules (you have <code>module-info.java</code> files in your build):<pre>
+&lt;build&gt;
+	&lt;plugins&gt;
+		&lt;plugin&gt;
+			&lt;groupId&gt;org.apache.maven.plugins&lt;/groupId&gt;
+			&lt;artifactId&gt;maven-compiler-plugin&lt;/artifactId&gt;
+			&lt;configuration&gt;
+				&lt;annotationProcessorPaths&gt;
+					&lt;path&gt;
+						&lt;groupId&gt;org.projectlombok&lt;/groupId&gt;
+						&lt;artifactId&gt;lombok&lt;/artifactId&gt;
+						&lt;version&gt;${version}&lt;/version&gt;
+					&lt;/path&gt;
+				&lt;/annotationProcessorPaths&gt;
+			&lt;/configuration&gt;
+		&lt;/plugin&gt;
+	&lt;/plugins&gt;
+&lt;/build&gt;
 	</@s.section>
 	
 	<@s.section title="Eclipse Compiler (ECJ/JDT)">