Package com.puppycrawl.tools.checkstyle.checks.javadoc

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. Check also violate javadoc that does not contain first sentence. 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>

    • Field Detail

      • MSG_SUMMARY_FIRST_SENTENCE

        public static final java.lang.String MSG_SUMMARY_FIRST_SENTENCE
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values

      • MSG_SUMMARY_JAVADOC

        public static final java.lang.String MSG_SUMMARY_JAVADOC
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values

      • MSG_SUMMARY_JAVADOC_MISSING

        public static final java.lang.String MSG_SUMMARY_JAVADOC_MISSING
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values

    • Constructor Detail

      • SummaryJavadocCheck

        public SummaryJavadocCheck()

    • Method Detail

      • setForbiddenSummaryFragments

        public void setForbiddenSummaryFragments​(java.util.regex.Pattern pattern)
        Sets custom value of regular expression for forbidden summary fragments.
        Parameters:
        pattern - a pattern.

      • setPeriod

        public void setPeriod​(java.lang.String period)
        Sets value of period symbol at the end of first javadoc sentence.
        Parameters:
        period - period's value.