Class SummaryJavadocCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public class SummaryJavadocCheck
    extends AbstractJavadocCheck

    Checks that Javadoc summary sentence does not contain phrases that are not recommended to use. By default Check validate that first sentence is not empty:


     <module name="SummaryJavadocCheck"/>
     

    To ensure that summary do not contain phrase like "This method returns", use following config:

     <module name="SummaryJavadocCheck">
         <property name="forbiddenSummaryFragments"
         value="^This method returns.*"/>
     </module>
     

    To specify period symbol at the end of first javadoc sentence - use following config:

     <module name="SummaryJavadocCheck">
         <property name="period"
         value="period"/>
     </module>
     
    Author:
    max, Aleksey Nesterenko