Support JDK-style Javadoc Tags #28

Merged
kske merged 1 commits from b/javadoc-tags into develop 2021-11-25 12:05:32 +01:00
1 changed files with 22 additions and 0 deletions

22
pom.xml
View File

@ -120,6 +120,28 @@
</goals>
</execution>
</executions>
<!-- Support JDK-style Javadoc tags -->
<configuration>
<tags>
<tag>
<name>apiNote</name>
<placement>a</placement>
<head>API Note:</head>
</tag>
<tag>
<name>implSpec</name>
<placement>a</placement>
<head>Implementation Requirements:</head>
</tag>
<tag>
<name>implNote</name>
<placement>a</placement>
delvh marked this conversation as resolved

What does <placement>a</placement> do? Places it the head above, or what?

What does `<placement>a</placement>` do? Places it the head **a**bove, or what?
Review

It defines on which elements the tag is permitted. See the Maven Javadoc Plugin Documentation.

It defines on which elements the tag is permitted. See the [Maven Javadoc Plugin Documentation](http://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#tags).
<head>Implementation Note:</head>
</tag>
</tags>
</configuration>
</plugin>
<!-- GPG sign JAR -->