Skip to content

Commit 9fcb829

Browse files
committed
fix(velocity): explicitly add the annotation processor in Maven
1 parent e08375d commit 9fcb829

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

src/content/docs/velocity/dev/getting-started/creating-your-first-plugin.mdx

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,13 @@ system's documentation ([Gradle](https://docs.gradle.org/current/userguide/userg
9191
```
9292
</TabItem>
9393
<TabItem label="Maven">
94+
:::caution
95+
96+
If you're using JDK 23 or later, you must add the annotation processor manually to your `pom.xml`, as described in the example.
97+
See the [Maven documentation](https://maven.apache.org/plugins/maven-compiler-plugin-4.x/examples/annotation-processor.html) for more information.
98+
99+
:::
100+
94101
```xml title="pom.xml" replace
95102
<project>
96103
<repositories>
@@ -107,8 +114,34 @@ system's documentation ([Gradle](https://docs.gradle.org/current/userguide/userg
107114
<version>\{LATEST_VELOCITY_RELEASE}</version>
108115
<scope>provided</scope>
109116
</dependency>
117+
<!-- add the annotation processor (Maven 4+) -->
118+
<dependency>
119+
<groupId>com.velocitypowered</groupId>
120+
<artifactId>velocity-api</artifactId>
121+
<version>\{LATEST_VELOCITY_RELEASE}</version>
122+
<type>processor</type>
123+
</dependency>
110124
</dependencies>
111125
</project>
126+
127+
<build>
128+
<plugins>
129+
<plugin>
130+
<groupId>org.apache.maven.plugins</groupId>
131+
<artifactId>maven-compiler-plugin</artifactId>
132+
<configuration>
133+
<!-- add the annotation processor (Maven 3) -->
134+
<annotationProcessorPaths>
135+
<path>
136+
<groupId>com.velocitypowered</groupId>
137+
<artifactId>velocity-api</artifactId>
138+
<version>\{LATEST_VELOCITY_RELEASE}</version>
139+
</path>
140+
</annotationProcessorPaths>
141+
</configuration>
142+
</plugin>
143+
</plugins>
144+
</build>
112145
```
113146
</TabItem>
114147
</Tabs>

0 commit comments

Comments
 (0)