Class JavadocTagsCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public final class JavadocTagsCheck
    extends AbstractCheck
    Check if the class/interface javadoc contains properly formatted author and version tags.

    Correct format is the following (of a class javadoc):

     /**
      * This is my new class.
      *
      * @author John Doe (john@example.com)
      * @version $Id$
      */
     public final class Foo {
         // ...
     

    "$Id$" will be replaced by a full text automatically by Subversion as explained in their documentation (see link below).

    Since:
    0.3
    See Also:
    Keywords substitution in Subversion