This project provides the code samples for the CodeFX blog post about the new Javadoc tags @apiNote, @implSpec and @implNote, which are first used in Java 8.
This includes:
- an interface
Lottery
which uses them - implementing classes which show how to inherit the tags:
OldLottery
does not implement the default method ~> the method has no documentation block in the class commentPrivateLottery
provides no Javadoc for its implementation ~> the documentation from the default method is copied (and a remark added) without the new tagsStateLottery
uses{@inheritDoc}
~> inherits the documentation without the new tagsUselessLottery
uses, e.g.,@apiNote {@inheritDoc}
~> inherits those specific tags
- the
pom.xml
needed to let Maven parameterize Javadoc so that it process the tags - the created Javadoc to make things a little easier for the Maven averse