From f2e7c40f5d72aebdc2ce6db2b0284cff7f92c3ed Mon Sep 17 00:00:00 2001 From: maxvetrenko Date: Fri, 14 Nov 2014 15:43:00 +0300 Subject: [PATCH] Fixed javadoc in AtclauseOrderCheck #365 --- .../checks/javadoc/AtclauseOrderCheck.java | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AtclauseOrderCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AtclauseOrderCheck.java index 3688729c7..89c0f3eef 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AtclauseOrderCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AtclauseOrderCheck.java @@ -63,7 +63,7 @@ public class AtclauseOrderCheck extends AbstractJavadocCheck { /** - * Some javadoc. + * Default order of atclauses. */ private static final String[] DEFAULT_ORDER = { "@author", "@version", @@ -75,7 +75,7 @@ public class AtclauseOrderCheck extends AbstractJavadocCheck }; /** - * Some javadoc. + * Default target of checking atclausts. */ private List mTarget = Arrays.asList( TokenTypes.CLASS_DEF, @@ -87,13 +87,13 @@ public class AtclauseOrderCheck extends AbstractJavadocCheck ); /** - * Some javadoc. + * Order of atclauses. */ private List mTagOrder = Arrays.asList(DEFAULT_ORDER); /** - * Some javadoc. - * @param aTarget Some javadoc. + * Sets custom targets. + * @param aTarget user's targets. */ public void setTarget(String aTarget) { @@ -105,8 +105,8 @@ public class AtclauseOrderCheck extends AbstractJavadocCheck } /** - * Some javadoc. - * @param aOrder Some javadoc. + * Sets custom order of atclauses. + * @param aOrder user's order. */ public void setTagOrder(String aOrder) { @@ -136,8 +136,8 @@ public class AtclauseOrderCheck extends AbstractJavadocCheck } /** - * Some javadoc. - * @param aJavadoc Some javadoc. + * Checks order of atclauses in tag section node. + * @param aJavadoc Javadoc root node. */ private void checkOrderInTagSection(DetailNode aJavadoc) { @@ -160,9 +160,9 @@ public class AtclauseOrderCheck extends AbstractJavadocCheck } /** - * Some javadoc. - * @param aCommentBlock Some javadoc. - * @return Some javadoc. + * Returns type of parent node. + * @param aCommentBlock child node. + * @return parent type. */ private int getParentType(DetailAST aCommentBlock) {