Search code examples
javajavadocdocumentation-generation

Automatic @since javadoc tag for releases

Is there a tool to automatically add the @since tag to all elements when I want to have a release version?

So let's say I have a bunch of methods and my base system is working now, so I decide to release it as version 0.1.0

What I want now is a tool that searches for every missing @since tag and adds it accordingly.

I'm using Eclipse and I have found JAutodoc, but as far as I can see it only allows to search for the missing tags and I'd have to add them manually.

EDIT: One workaround that might be interesting for someone: From the beginning on use an Eclipse Template with the right since tag and after each release change the template.

Solution

  • This sounds like something your build tool should provide you with. If you are using maven you should have a look at javadoc:fix. It looks like it does exactly what you want:

    http://maven.apache.org/plugins/maven-javadoc-plugin/fix-mojo.html