From bae7fdded6474cd908e3b78f144ecdcc7edc23da Mon Sep 17 00:00:00 2001 From: maxvetrenko Date: Fri, 14 Nov 2014 15:59:40 +0300 Subject: [PATCH] Fixed javadoc in JavadocTagContinuationIndentationCheck #365 --- ...JavadocTagContinuationIndentationCheck.java | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocTagContinuationIndentationCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocTagContinuationIndentationCheck.java index 2da313ec3..1a322d817 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocTagContinuationIndentationCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocTagContinuationIndentationCheck.java @@ -43,7 +43,7 @@ import com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes; public class JavadocTagContinuationIndentationCheck extends AbstractJavadocCheck { - /** Default indentation */ + /** Default tag continuation indentation */ private static final int DEFAULT_INDENTATION = 4; /** @@ -52,8 +52,8 @@ public class JavadocTagContinuationIndentationCheck extends AbstractJavadocCheck private int mOffset = DEFAULT_INDENTATION; /** - * Some javadoc. - * @param aOffset Some javadoc. + * Sets custom indentation level. + * @param aOffset custom value. */ public void setOffset(int aOffset) { @@ -90,9 +90,9 @@ public class JavadocTagContinuationIndentationCheck extends AbstractJavadocCheck } /** - * Some javadoc. - * @param aDescriptionNode Some javadoc. - * @return Some javadoc. + * Finds and collects all NEWLINE nodes inside DESCRIPTION node. + * @param aDescriptionNode DESCRIPTION node. + * @return List with NEWLINE nodes. */ private List getAllNewlineNodes(DetailNode aDescriptionNode) { @@ -108,9 +108,9 @@ public class JavadocTagContinuationIndentationCheck extends AbstractJavadocCheck } /** - * Some javadoc. - * @param aDescription Some javadoc. - * @return Some javadoc. + * Checks, if description node is a description of in-line tag. + * @param aDescription DESCRIPTION node. + * @return true, if description node is a description of in-line tag. */ private boolean isInlineDescription(DetailNode aDescription) {