Skip to content

Commit 01748e2

Browse files
toddbaerttoddbaert
committed
fixup: configure javadoc plugin to recognize JDK doc-tags
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
1 parent 54466db commit 01748e2

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

‎pom.xml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -653,6 +653,26 @@
653653
<failOnWarnings>true</failOnWarnings>
654654
<doclint>all,-missing
655655
</doclint> <!-- ignore missing javadoc, these are enforced with more customizability in the checkstyle plugin -->
656+
<!-- recognize JDK doc-tags (@apiNote, @implSpec, @implNote); these are
657+
standard in the JDK source but not enabled by default in javadoc.
658+
No runtime dependency; only affects generated javadoc. -->
659+
<tags>
660+
<tag>
661+
<name>apiNote</name>
662+
<placement>a</placement>
663+
<head>API Note:</head>
664+
</tag>
665+
<tag>
666+
<name>implSpec</name>
667+
<placement>a</placement>
668+
<head>Implementation Requirements:</head>
669+
</tag>
670+
<tag>
671+
<name>implNote</name>
672+
<placement>a</placement>
673+
<head>Implementation Note:</head>
674+
</tag>
675+
</tags>
656676
</configuration>
657677
<executions>
658678
<execution>

0 commit comments

Comments
 (0)