Checking for @since
[ vmassol ] 08:19, Tuesday, 18 July 2006

It would be nice if there were a tool that could verify that you have correctly added @since tags for methods added in the current version. It would do this by checking against the previous release.

This tool could be based on Clirr or JDiff for example. It would also have an option to fail the build if there are new methods without a @since tag.

Do you know if such a tool exists?

TrackBack
Comments

JDiff does this - it outputs a missingSinces file when its run

--Stephen Colebourne, July 18, 2006 01:35 PM

Within Clirr I think this is impossible to implement because Clirr operates on the bytecode, javadoc @since tags are not available there.

Clirr could be used to extract the info about added classes/methods/fields to an XML file. That file could be used by a sourcecode analysis tool like Checkstyle to implement your functionality.

It would be pretty simple to implement a Checkstyle plugin that does this, but I'm not sure how useful that would be if JDiff already has the functionality built in...

--Lars Kühne, July 18, 2006 09:47 PM

FWIW I've logged this feature for the JDiff Maven2 plugin here: http://jira.codehaus.org/browse/MJDIFF-4

--Vincent Massol, July 22, 2006 06:01 PM
Post a comment









Remember personal info?