fasten icon indicating copy to clipboard operation
fasten copied to clipboard

Published 20 hours ago • verified publisher icon fasten-project

Support JDK's extended tags

Open vigna opened this issue 4 years ago • 0 comments

We started using consistently in the Javadoc documentation the new tags defined by this JEP draft and now common in JDK's API. However, support under Maven requires the following blurb in the (now non-existing) configuration for the Javadoc plugin. I don't know the best level to set this in—the general POM? the core POM?

It would be nice if someone with more visibility over the whole project and more familiarity with Maven would add this to the configuration so that at least the core project can use such tags.

					<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>
							<head>Implementation Note:</head>
						</tag>
						<tag><name>param</name></tag>
						<tag><name>return</name></tag>
						<tag><name>throws</name></tag>
						<tag><name>since</name></tag>
						<tag><name>version</name></tag>
						<tag><name>serialData</name></tag>
						<tag><name>see</name></tag>
					</tags>

An example can be found here: https://github.com/nipafx/demo-javadoc-8-tags/blob/master/pom.xml?ts=4#L110-L133

vigna avatar Feb 05 '21 09:02 vigna