Skip to content

Commit d449ea1

Browse files
authored
Merge pull request #31 from scijava/add-therapi-runtime-javadoc-scribe
Add therapi-runtime-javadoc-scribe To Maven Compiler Plugin Annotation Processors
2 parents 37ba45e + 6f5c844 commit d449ea1

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

pom.xml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,22 @@
222222
-->
223223
<scijava.natives.classifier>natives-${scijava.platform.family.medium}_${scijava.platform.bits}</scijava.natives.classifier>
224224

225+
<!--
226+
NB: The javadoc.runtimeAccessPackages property allows downstream
227+
projects to identify directories whose Javadoc should be made available
228+
at runtime. This javadoc can then be accessed through
229+
therapi-runtime-javadoc. By default, Javadoc is not available for any
230+
packages. Downstream projects can identify a comma-delineated set of
231+
packages to make those packages' Javadoc available. To retain some
232+
packages, override the javadoc.runtimeAccessPackages property in your
233+
POM with something like this:
234+
<javadoc.runtimeAccessPackages>com.example.foo,com.example.bar</javadoc.runtimeAccessPackages>
235+
To retain all packages, override the javadoc.runtimeAccessPackages
236+
property in your POM with:
237+
<javadoc.runtimeAccessPackages/>
238+
-->
239+
<javadoc.runtimeAccessPackages>-</javadoc.runtimeAccessPackages>
240+
225241
<!-- Additional configuration -->
226242

227243
<!-- NB: Avoid platform encoding warning when copying resources. -->
@@ -289,6 +305,8 @@
289305
<kotlin.version>1.4.21</kotlin.version>
290306
<revapi-java.version>0.20.2</revapi-java.version>
291307
<scijava-coding-style.version>2.0.0</scijava-coding-style.version>
308+
<therapi.version>0.12.0</therapi.version>
309+
<com.github.therapi.therapi-runtime-javadoc-scribe.version>${therapi.version}</com.github.therapi.therapi-runtime-javadoc-scribe.version>
292310
<velocity.version>1.7</velocity.version>
293311

294312
<!-- Build extensions -->
@@ -318,6 +336,19 @@
318336
<plugin>
319337
<artifactId>maven-compiler-plugin</artifactId>
320338
<version>${maven-compiler-plugin.version}</version>
339+
<configuration>
340+
<annotationProcessorPaths>
341+
<path>
342+
<groupId>com.github.therapi</groupId>
343+
<artifactId>therapi-runtime-javadoc-scribe</artifactId>
344+
<version>${com.github.therapi.therapi-runtime-javadoc-scribe.version}</version>
345+
</path>
346+
</annotationProcessorPaths>
347+
<fork>true</fork>
348+
<compilerArgs>
349+
<arg>-Ajavadoc.packages="${javadoc.runtimeAccessPackages}"</arg>
350+
</compilerArgs>
351+
</configuration>
321352
</plugin>
322353

323354
<plugin>

0 commit comments

Comments
 (0)