diff --git a/src/main/java/rife/bld/extension/CheckstyleOperation.java b/src/main/java/rife/bld/extension/CheckstyleOperation.java index 4434ec1..7e07690 100644 --- a/src/main/java/rife/bld/extension/CheckstyleOperation.java +++ b/src/main/java/rife/bld/extension/CheckstyleOperation.java @@ -38,7 +38,6 @@ public class CheckstyleOperation extends AbstractProcessOperation options = new ConcurrentHashMap<>(); - /** * The source files(s) or folder(s). */ @@ -133,8 +132,12 @@ public class CheckstyleOperation extends AbstractProcessOperationonly Javadoc comment content - * without including '/**' and '*/' at the beginning and at the end respectively. The option cannot - * be used other options and requires exactly one file to run on to be specified. + * This option is used to print the Parse Tree of the Javadoc comment. The file has to contain only Javadoc comment + * content excluding '/**' and '*/' at the beginning and at the end respectively. It can only be used on a + * single file and cannot be combined with other options. * * @param isTree {@code true} or {@code false} * @return the checkstyle operation @@ -282,31 +287,14 @@ public class CheckstyleOperation extends AbstractProcessOperation - * ATTENTION: generated result will have few queries, joined by pipe(|). Together they will match all AST nodes - * on specified line and column. You need to choose only one and recheck that it works. Usage of all of them is also - * ok, but might result in undesirable matching and suppress other issues. + * Defaults to stdout. * - * @param lineColumn the line column + * @param file the output file * @return the checkstyle operation */ - public CheckstyleOperation lineColumn(String lineColumn) { - if (isNotBlank(lineColumn)) { - options.put("-s", lineColumn); - } - return this; - } - - /** - * Sets the output file. Defaults to stdout. - * - * @param file the file - * @return the checkstyle operation - */ - public CheckstyleOperation output(String file) { + public CheckstyleOperation outputPath(String file) { if (isNotBlank(file)) { options.put("-o", file); } @@ -351,7 +339,28 @@ public class CheckstyleOperation extends AbstractProcessOperation + * Note that the generated result will have few queries, joined by pipe({@code |}). Together they will match all + * AST nodes on specified line and column. You need to choose only one and recheck that it works. Usage of all of + * them is also ok, but might result in undesirable matching and suppress other issues. + * + * @param lineColumnNumber the line column number + * @return the checkstyle operation + */ + public CheckstyleOperation suppressionLineColumnNumber(String lineColumnNumber) { + if (isNotBlank(lineColumnNumber)) { + options.put("-s", lineColumnNumber); + } + return this; + } + + /** + * Sets the length of the tab character. Used only with the + * {@link #suppressionLineColumnNumber(String) suppressionLineColumnNumber} option. + *

* Default value is {@code 8}. * * @param length the length @@ -363,8 +372,8 @@ public class CheckstyleOperation extends AbstractProcessOperation