From 97b99c65289ef512de0ab15e4ab2786fbb29ff1c Mon Sep 17 00:00:00 2001 From: maxvetrenko Date: Fri, 14 Nov 2014 16:18:37 +0300 Subject: [PATCH] Fixed javadoc in SummaryJavadocCheck #365 --- .../checks/javadoc/SummaryJavadocCheck.java | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java index 43c3af208..4fb5c5f69 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java @@ -51,13 +51,13 @@ public class SummaryJavadocCheck extends AbstractJavadocCheck { /** - * Some javadoc. + * Regular expression for forbidden summary fragments. */ private Pattern mForbiddenSummaryFragments = Utils.createPattern("^$"); /** - * Some javadoc. - * @param aPattern Some javadoc. + * Sets custom value of regular expression for forbidden summary fragments. + * @param aPattern user's value. */ public void setForbiddenSummaryFragments(String aPattern) { @@ -89,9 +89,9 @@ public class SummaryJavadocCheck extends AbstractJavadocCheck } /** - * Some javadoc. - * @param aAst Some javadoc. - * @return Some javadoc. + * Finds and returns first sentence. + * @param aAst Javadoc root node. + * @return first sentence. */ private String getFirstSentence(DetailNode aAst) { @@ -111,9 +111,9 @@ public class SummaryJavadocCheck extends AbstractJavadocCheck } /** - * Some javadoc. - * @param aTextNode Some javadoc. - * @return Some javadoc. + * Finds and returns chars till first dot. + * @param aTextNode node with javadoc text. + * @return String with chars till first dot. */ private String getCharsTillDot(DetailNode aTextNode) { @@ -130,9 +130,9 @@ public class SummaryJavadocCheck extends AbstractJavadocCheck } /** - * Some javadoc. - * @param aFirstSentence Some javadoc. - * @return Some javadoc. + * Tests if first sentence contains forbidden summary fragment. + * @param aFirstSentence String with first sentence. + * @return true, if first sentence contains forbidden summary fragment. */ private boolean containsForbiddenFragment(String aFirstSentence) {