Class MultilineJavadocTagsCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public final class MultilineJavadocTagsCheck
    extends AbstractCheck
    Check indents in multi line JavaDoc tags.

    This is how you should format javadoc tags that need a few lines:

      * This is my new method.
      * @param text Some text information, provided to the
      *  method by another class
      * @todo #123 I will implement it later, when more information
      *  come to light and I have documentation supplied by
      *  AAA team in the office accross the street
     public void func() {
         // ...

    Keep in mind that all free-text information should go before javadoc tags, or else it will treated as part of the latest tag and qulice will complain.