This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-checkstyle-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new e5c4e9d Fix Javadoc issues per Oracle conventions (#650)
e5c4e9d is described below
commit e5c4e9d455a261e10263a107965cca3b8040cdd4
Author: Elliotte Rusty Harold <[email protected]>
AuthorDate: Wed Jan 7 15:19:33 2026 +0000
Fix Javadoc issues per Oracle conventions (#650)
* Fix Javadoc issues per Oracle conventions
* Fix comment formatting for Checkstyle configuration param
* Fix typo in CheckstyleCheckerListener comments
---
.../checkstyle/AbstractCheckstyleReport.java | 40 +++++++++++++--------
.../checkstyle/CheckstyleAggregateReport.java | 8 +++--
.../maven/plugins/checkstyle/CheckstyleReport.java | 12 ++++---
.../checkstyle/CheckstyleReportRenderer.java | 20 ++++++-----
.../checkstyle/CheckstyleViolationCheckMojo.java | 15 +++++---
.../plugins/checkstyle/CompositeAuditListener.java | 2 +-
.../plugins/checkstyle/MavenConsoleLogger.java | 4 ++-
.../apache/maven/plugins/checkstyle/RuleUtil.java | 1 +
.../apache/maven/plugins/checkstyle/Violation.java | 5 +--
.../checkstyle/exec/CheckstyleCheckerListener.java | 41 ++++++++++++++--------
.../checkstyle/exec/CheckstyleExecutor.java | 2 +-
.../exec/CheckstyleExecutorException.java | 12 +++----
.../checkstyle/exec/CheckstyleExecutorRequest.java | 37 ++++++++++---------
.../plugins/checkstyle/exec/CheckstyleResults.java | 1 -
.../checkstyle/exec/DefaultCheckstyleExecutor.java | 6 ++--
15 files changed, 123 insertions(+), 83 deletions(-)
diff --git
a/src/main/java/org/apache/maven/plugins/checkstyle/AbstractCheckstyleReport.java
b/src/main/java/org/apache/maven/plugins/checkstyle/AbstractCheckstyleReport.java
index dbf23c4..e853f75 100644
---
a/src/main/java/org/apache/maven/plugins/checkstyle/AbstractCheckstyleReport.java
+++
b/src/main/java/org/apache/maven/plugins/checkstyle/AbstractCheckstyleReport.java
@@ -204,6 +204,7 @@ public abstract class AbstractCheckstyleReport extends
AbstractMavenReport {
/**
* Specifies the names filter of the resource files to be used for
Checkstyle.
+ *
* @since 2.11
*/
@Parameter(property = "checkstyle.resourceIncludes", defaultValue =
"**/*.properties", required = true)
@@ -212,6 +213,7 @@ public abstract class AbstractCheckstyleReport extends
AbstractMavenReport {
/**
* Specifies the names filter of the resource files to be excluded for
* Checkstyle.
+ *
* @since 2.11
*/
@Parameter(property = "checkstyle.resourceExcludes")
@@ -219,6 +221,7 @@ public abstract class AbstractCheckstyleReport extends
AbstractMavenReport {
/**
* Specifies whether to include the resource directories in the check.
+ *
* @since 2.11
*/
@Parameter(property = "checkstyle.includeResources", defaultValue =
"true", required = true)
@@ -226,6 +229,7 @@ public abstract class AbstractCheckstyleReport extends
AbstractMavenReport {
/**
* Specifies whether to include the test resource directories in the check.
+ *
* @since 2.11
*/
@Parameter(property = "checkstyle.includeTestResources", defaultValue =
"true", required = true)
@@ -244,6 +248,7 @@ public abstract class AbstractCheckstyleReport extends
AbstractMavenReport {
/**
* Specifies the location of the source directories to be used for
Checkstyle.
* Default value is <code>${project.compileSourceRoots}</code>.
+ *
* @since 2.13
*/
// Compatibility with all Maven 3: default of 'project.compileSourceRoots'
is done manually because of MNG-5440
@@ -264,6 +269,7 @@ public abstract class AbstractCheckstyleReport extends
AbstractMavenReport {
/**
* Specifies the location of the test source directories to be used for
Checkstyle.
* Default value is <code>${project.testCompileSourceRoots}</code>.
+ *
* @since 2.13
*/
// Compatibility with all Maven 3: default of
'project.testCompileSourceRoots' is done manually because of MNG-5440
@@ -336,7 +342,7 @@ public abstract class AbstractCheckstyleReport extends
AbstractMavenReport {
private boolean enableFilesSummary;
/**
- * The Plugin Descriptor
+ * The Plugin Descriptor.
*/
@Parameter(defaultValue = "${plugin}", readonly = true, required = true)
private PluginDescriptor plugin;
@@ -445,7 +451,7 @@ public abstract class AbstractCheckstyleReport extends
AbstractMavenReport {
protected final CheckstyleExecutor checkstyleExecutor;
/**
- * Internationalization component
+ * Internationalization component.
*/
private I18N i18n;
@@ -458,22 +464,26 @@ public abstract class AbstractCheckstyleReport extends
AbstractMavenReport {
this.i18n = i18n;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public String getName(Locale locale) {
return getI18nString(locale, "name");
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public String getDescription(Locale locale) {
return getI18nString(locale, "description");
}
/**
- * @param locale The locale
- * @param key The key to search for
- * @return The text appropriate for the locale.
+ * @param locale the locale
+ * @param key the key to search for
+ * @return the text appropriate for the locale
*/
protected String getI18nString(Locale locale, String key) {
return i18n.getString("checkstyle-report", locale,
"report.checkstyle." + key);
@@ -483,7 +493,9 @@ public abstract class AbstractCheckstyleReport extends
AbstractMavenReport {
return reactorProjects;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public void executeReport(Locale locale) throws MavenReportException {
checkDeprecatedParameterUsage(sourceDirectory, "sourceDirectory",
"sourceDirectories");
@@ -565,8 +577,8 @@ public abstract class AbstractCheckstyleReport extends
AbstractMavenReport {
/**
* Create the Checkstyle executor request.
*
- * @return The executor request.
- * @throws MavenReportException If something goes wrong during creation.
+ * @return the executor request
+ * @throws MavenReportException if something goes wrong during creation
*/
protected abstract CheckstyleExecutorRequest createRequest() throws
MavenReportException;
@@ -601,8 +613,8 @@ public abstract class AbstractCheckstyleReport extends
AbstractMavenReport {
/**
* Creates and returns the report generation listener.
*
- * @return The audit listener.
- * @throws MavenReportException If something goes wrong.
+ * @return the audit listener
+ * @throws MavenReportException if something goes wrong
*/
protected AuditListener getListener() throws MavenReportException {
AuditListener listener = null;
@@ -651,8 +663,8 @@ public abstract class AbstractCheckstyleReport extends
AbstractMavenReport {
/**
* Creates and returns the console listener.
*
- * @return The console listener.
- * @throws MavenReportException If something goes wrong.
+ * @return the console listener
+ * @throws MavenReportException if something goes wrong
*/
protected AuditListener getConsoleListener() throws MavenReportException {
AuditListener consoleListener;
diff --git
a/src/main/java/org/apache/maven/plugins/checkstyle/CheckstyleAggregateReport.java
b/src/main/java/org/apache/maven/plugins/checkstyle/CheckstyleAggregateReport.java
index 861bbcf..8136137 100644
---
a/src/main/java/org/apache/maven/plugins/checkstyle/CheckstyleAggregateReport.java
+++
b/src/main/java/org/apache/maven/plugins/checkstyle/CheckstyleAggregateReport.java
@@ -81,13 +81,17 @@ public class CheckstyleAggregateReport extends
AbstractCheckstyleReport {
return request;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public String getOutputName() {
return "checkstyle-aggregate";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public boolean canGenerateReport() {
// TODO: would be good to scan the files here
diff --git
a/src/main/java/org/apache/maven/plugins/checkstyle/CheckstyleReport.java
b/src/main/java/org/apache/maven/plugins/checkstyle/CheckstyleReport.java
index 76b28b5..f208ad6 100644
--- a/src/main/java/org/apache/maven/plugins/checkstyle/CheckstyleReport.java
+++ b/src/main/java/org/apache/maven/plugins/checkstyle/CheckstyleReport.java
@@ -40,7 +40,6 @@ import org.codehaus.plexus.resource.ResourceManager;
* @author <a href="mailto:[email protected]";>Emmanuel Venisse</a>
* @author <a href="mailto:[email protected]";>Vincent Siveton</a>
* @author <a href="mailto:[email protected]";>Joakim Erdfelt</a>
- *
*/
@Mojo(name = "checkstyle", requiresDependencyResolution =
ResolutionScope.COMPILE, threadSafe = true)
public class CheckstyleReport extends AbstractCheckstyleReport {
@@ -85,13 +84,17 @@ public class CheckstyleReport extends
AbstractCheckstyleReport {
return request;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public String getOutputName() {
return "checkstyle";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public boolean canGenerateReport() {
if (skip) {
@@ -118,7 +121,8 @@ public class CheckstyleReport extends
AbstractCheckstyleReport {
/**
* Check if any of the resources exist.
- * @param resources The resources to check
+ *
+ * @param resources the resources to check
* @return <code>true</code> if the resource directory exist
*/
private boolean hasResources(List<Resource> resources) {
diff --git
a/src/main/java/org/apache/maven/plugins/checkstyle/CheckstyleReportRenderer.java
b/src/main/java/org/apache/maven/plugins/checkstyle/CheckstyleReportRenderer.java
index a9ed2f9..743425a 100644
---
a/src/main/java/org/apache/maven/plugins/checkstyle/CheckstyleReportRenderer.java
+++
b/src/main/java/org/apache/maven/plugins/checkstyle/CheckstyleReportRenderer.java
@@ -111,8 +111,8 @@ public class CheckstyleReportRenderer extends
AbstractMavenReportRenderer {
}
/**
- * @param key The key.
- * @return The translated string.
+ * @param key the key
+ * @return the translated string
*/
private String getI18nString(String key) {
return i18n.getString("checkstyle-report", locale,
"report.checkstyle." + key);
@@ -223,9 +223,9 @@ public class CheckstyleReportRenderer extends
AbstractMavenReportRenderer {
/**
* Create a summary for one Checkstyle rule.
*
- * @param ref The configuration reference for the row
- * @param results The results to summarize
- * @param previousCategory The previous row's category
+ * @param ref the configuration reference for the row
+ * @param results the results to summarize
+ * @param previousCategory the previous row's category
*/
private void renderRuleRow(ConfReference ref, CheckstyleResults results,
String previousCategory) {
Configuration checkerConfig = ref.configuration;
@@ -324,10 +324,10 @@ public class CheckstyleReportRenderer extends
AbstractMavenReportRenderer {
* Check if a violation matches a rule.
*
* @param event the violation to check
- * @param ruleName The name of the rule
- * @param expectedMessage A message that, if it's not null, will be
matched to the message from the violation
- * @param expectedSeverity A severity that, if it's not null, will be
matched to the severity from the violation
- * @return The number of rule violations
+ * @param ruleName the name of the rule
+ * @param expectedMessage a message that, if it's not null, will be
matched to the message from the violation
+ * @param expectedSeverity a severity that, if it's not null, will be
matched to the severity from the violation
+ * @return the number of rule violations
*/
public boolean matchRule(AuditEvent event, String ruleName, String
expectedMessage, String expectedSeverity) {
if (!ruleName.equals(RuleUtil.getName(event))) {
@@ -567,6 +567,7 @@ public class CheckstyleReportRenderer extends
AbstractMavenReportRenderer {
/**
* Render an icon of given level with associated text.
+ *
* @param level one of <code>INFO</code>, <code>WARNING</code> or
<code>ERROR</code> constants
* @param textType one of <code>NO_TEXT</code>, <code>TEXT_SIMPLE</code>,
<code>TEXT_TITLE</code> or
* <code>TEXT_ABBREV</code> constants
@@ -593,6 +594,7 @@ public class CheckstyleReportRenderer extends
AbstractMavenReportRenderer {
/**
* Get the effective Checkstyle version at runtime.
+ *
* @return the MANIFEST implementation version of Checkstyle API package
(can be <code>null</code>)
*/
private String getCheckstyleVersion() {
diff --git
a/src/main/java/org/apache/maven/plugins/checkstyle/CheckstyleViolationCheckMojo.java
b/src/main/java/org/apache/maven/plugins/checkstyle/CheckstyleViolationCheckMojo.java
index ac343d9..2f69842 100644
---
a/src/main/java/org/apache/maven/plugins/checkstyle/CheckstyleViolationCheckMojo.java
+++
b/src/main/java/org/apache/maven/plugins/checkstyle/CheckstyleViolationCheckMojo.java
@@ -72,7 +72,6 @@ import
org.codehaus.plexus.util.xml.pull.XmlPullParserException;
* It can also be configured to re-use an earlier analysis.
*
* @author <a href="mailto:[email protected]";>Joakim Erdfelt</a>
- *
*/
@Mojo(
name = "check",
@@ -309,7 +308,7 @@ public class CheckstyleViolationCheckMojo extends
AbstractMojo {
protected MavenProject project;
/**
- * The Plugin Descriptor
+ * The Plugin Descriptor.
*/
@Parameter(defaultValue = "${plugin}", readonly = true, required = true)
private PluginDescriptor plugin;
@@ -337,6 +336,7 @@ public class CheckstyleViolationCheckMojo extends
AbstractMojo {
/**
* Specifies the names filter of the files to be excluded for
* Checkstyle when checking resources.
+ *
* @since 2.11
*/
@Parameter(property = "checkstyle.resourceExcludes")
@@ -344,6 +344,7 @@ public class CheckstyleViolationCheckMojo extends
AbstractMojo {
/**
* Specifies the names filter of the files to be used for Checkstyle when
checking resources.
+ *
* @since 2.11
*/
@Parameter(property = "checkstyle.resourceIncludes", defaultValue =
"**/*.properties", required = true)
@@ -372,6 +373,7 @@ public class CheckstyleViolationCheckMojo extends
AbstractMojo {
/**
* Specifies the location of the test source directories to be used for
Checkstyle.
* Default value is <code>${project.testCompileSourceRoots}</code>.
+ *
* @since 2.13
*/
// Compatibility with all Maven 3: default of
'project.testCompileSourceRoots' is done manually because of MNG-5440
@@ -399,6 +401,7 @@ public class CheckstyleViolationCheckMojo extends
AbstractMojo {
/**
* Specifies the location of the source directories to be used for
Checkstyle.
* Default value is <code>${project.compileSourceRoots}</code>.
+ *
* @since 2.13
*/
// Compatibility with all Maven 3: default of 'project.compileSourceRoots'
is done manually because of MNG-5440
@@ -407,6 +410,7 @@ public class CheckstyleViolationCheckMojo extends
AbstractMojo {
/**
* Whether to apply Checkstyle to resource directories.
+ *
* @since 2.11
*/
@Parameter(property = "checkstyle.includeResources", defaultValue =
"true", required = true)
@@ -414,6 +418,7 @@ public class CheckstyleViolationCheckMojo extends
AbstractMojo {
/**
* Whether to apply Checkstyle to test resource directories.
+ *
* @since 2.11
*/
@Parameter(property = "checkstyle.includeTestResources", defaultValue =
"true", required = true)
@@ -493,7 +498,9 @@ public class CheckstyleViolationCheckMojo extends
AbstractMojo {
this.checkstyleExecutor = checkstyleExecutor;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public void execute() throws MojoExecutionException, MojoFailureException {
checkDeprecatedParameterUsage(sourceDirectory, "sourceDirectory",
"sourceDirectories");
@@ -722,7 +729,7 @@ public class CheckstyleViolationCheckMojo extends
AbstractMojo {
/**
* Checks if the given severity is considered a violation.
*
- * @param severity The severity to check
+ * @param severity the severity to check
* @return <code>true</code> if the given severity is a violation,
otherwise <code>false</code>
*/
private boolean isViolation(String severity) {
diff --git
a/src/main/java/org/apache/maven/plugins/checkstyle/CompositeAuditListener.java
b/src/main/java/org/apache/maven/plugins/checkstyle/CompositeAuditListener.java
index e7a3595..9d9426f 100644
---
a/src/main/java/org/apache/maven/plugins/checkstyle/CompositeAuditListener.java
+++
b/src/main/java/org/apache/maven/plugins/checkstyle/CompositeAuditListener.java
@@ -25,7 +25,7 @@ import com.puppycrawl.tools.checkstyle.api.AuditEvent;
import com.puppycrawl.tools.checkstyle.api.AuditListener;
/**
- * AuditListener that forwards events to a list of other AuditListeners
+ * AuditListener that forwards events to a list of other AuditListeners.
*/
public class CompositeAuditListener implements AuditListener {
diff --git
a/src/main/java/org/apache/maven/plugins/checkstyle/MavenConsoleLogger.java
b/src/main/java/org/apache/maven/plugins/checkstyle/MavenConsoleLogger.java
index 9b56464..6389299 100644
--- a/src/main/java/org/apache/maven/plugins/checkstyle/MavenConsoleLogger.java
+++ b/src/main/java/org/apache/maven/plugins/checkstyle/MavenConsoleLogger.java
@@ -29,7 +29,9 @@ import com.puppycrawl.tools.checkstyle.api.AuditListener;
import com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions;
import org.apache.maven.plugin.logging.Log;
-/** An implementation of {@link AuditListener} that redirects output to the
specified {@code log} */
+/**
+ * An implementation of {@link AuditListener} that redirects output to the
specified {@code log}
+ */
public class MavenConsoleLogger implements AuditListener {
private final Log log;
diff --git a/src/main/java/org/apache/maven/plugins/checkstyle/RuleUtil.java
b/src/main/java/org/apache/maven/plugins/checkstyle/RuleUtil.java
index c26dd54..99b4bc0 100644
--- a/src/main/java/org/apache/maven/plugins/checkstyle/RuleUtil.java
+++ b/src/main/java/org/apache/maven/plugins/checkstyle/RuleUtil.java
@@ -131,6 +131,7 @@ public final class RuleUtil {
public interface Matcher {
/**
* Does the event source name match?
+ *
* @param eventSrcName the event source name
* @return boolean
*/
diff --git a/src/main/java/org/apache/maven/plugins/checkstyle/Violation.java
b/src/main/java/org/apache/maven/plugins/checkstyle/Violation.java
index 7565601..5697e5e 100644
--- a/src/main/java/org/apache/maven/plugins/checkstyle/Violation.java
+++ b/src/main/java/org/apache/maven/plugins/checkstyle/Violation.java
@@ -31,10 +31,10 @@ class Violation {
*/
protected static final String NO_COLUMN = "-1";
- /** The full qualified class name of the checkstyle rule */
+ /** The full qualified class name of the checkstyle rule. */
private final String source;
- /** The absolute path of the file containing the violation */
+ /** The absolute path of the file containing the violation. */
private final String file;
private final String line;
@@ -124,6 +124,7 @@ class Violation {
/**
* Sets the column value for this violation to the given string value.
+ *
* @param column the column value to set. May be {@code null}, which will
set it to the {@link #NO_COLUMN} value.
*/
protected void setColumn(/* Nullable */ String column) {
diff --git
a/src/main/java/org/apache/maven/plugins/checkstyle/exec/CheckstyleCheckerListener.java
b/src/main/java/org/apache/maven/plugins/checkstyle/exec/CheckstyleCheckerListener.java
index ba5d5a1..d32353a 100644
---
a/src/main/java/org/apache/maven/plugins/checkstyle/exec/CheckstyleCheckerListener.java
+++
b/src/main/java/org/apache/maven/plugins/checkstyle/exec/CheckstyleCheckerListener.java
@@ -35,7 +35,6 @@ import org.apache.commons.lang3.StringUtils;
*
* @author <a href="mailto:[email protected]";>Emmanuel Venisse</a>
* @author <a href="mailto:[email protected]";>Vincent Siveton</a>
- *
*/
public class CheckstyleCheckerListener extends AutomaticBean implements
AuditListener {
private final List<File> sourceDirectories;
@@ -85,32 +84,38 @@ public class CheckstyleCheckerListener extends
AutomaticBean implements AuditLis
}
/**
- * @param severityLevel The severity level of the events to listen to.
+ * @param severityLevel the severity level of the events to listen to
*/
public void setSeverityLevelFilter(SeverityLevel severityLevel) {
this.severityLevel = severityLevel;
}
/**
- * @return The severity level of the events to listen to.
+ * @return the severity level of the events to listen to
*/
public SeverityLevel getSeverityLevelFilter() {
return severityLevel;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public void auditStarted(AuditEvent event) {
setResults(new CheckstyleResults());
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public void auditFinished(AuditEvent event) {
// do nothing
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public void fileStarted(AuditEvent event) {
final String fileName = StringUtils.replace(event.getFileName(), "\\",
"/");
@@ -132,14 +137,18 @@ public class CheckstyleCheckerListener extends
AutomaticBean implements AuditLis
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public void fileFinished(AuditEvent event) {
getResults().setFileViolations(currentFile, events);
currentFile = null;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public void addError(AuditEvent event) {
if (SeverityLevel.IGNORE.equals(event.getSeverityLevel())) {
@@ -151,20 +160,24 @@ public class CheckstyleCheckerListener extends
AutomaticBean implements AuditLis
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public void addException(AuditEvent event, Throwable throwable) {
// Do Nothing
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
protected void finishLocalSetup() throws CheckstyleException {
// Do Nothing
}
/**
- * @return The results of Checkstyle invocation.
+ * @return the results of Checkstyle invocation
*/
public CheckstyleResults getResults() {
results.setConfiguration(checkstyleConfiguration);
@@ -172,22 +185,22 @@ public class CheckstyleCheckerListener extends
AutomaticBean implements AuditLis
}
/**
- * @param results The results of Checkstyle invocation.
+ * @param results the results of Checkstyle invocation
*/
public void setResults(CheckstyleResults results) {
this.results = results;
}
/**
+ * @return the configuration of Checkstyle to use
* @since 2.5
- * @return The configuration of Checkstyle to use.
*/
public Configuration getCheckstyleConfiguration() {
return checkstyleConfiguration;
}
/**
- * @param checkstyleConfiguration The configuration of Checkstyle to use.
+ * @param checkstyleConfiguration the configuration of Checkstyle to use
* @since 2.5
*/
public void setCheckstyleConfiguration(Configuration
checkstyleConfiguration) {
diff --git
a/src/main/java/org/apache/maven/plugins/checkstyle/exec/CheckstyleExecutor.java
b/src/main/java/org/apache/maven/plugins/checkstyle/exec/CheckstyleExecutor.java
index 6a302b0..d9c04ff 100644
---
a/src/main/java/org/apache/maven/plugins/checkstyle/exec/CheckstyleExecutor.java
+++
b/src/main/java/org/apache/maven/plugins/checkstyle/exec/CheckstyleExecutor.java
@@ -30,8 +30,8 @@ public interface CheckstyleExecutor {
/**
* @param request {@link CheckstyleExecutorRequest}
* @return {@link CheckstyleResults}
- * @throws CheckstyleExecutorException in case of an error during plugin
execution
* @throws CheckstyleException in case of an error raised by Checkstyle
+ * @throws CheckstyleExecutorException in case of an error during plugin
execution
*/
CheckstyleResults executeCheckstyle(CheckstyleExecutorRequest request)
throws CheckstyleExecutorException, CheckstyleException;
diff --git
a/src/main/java/org/apache/maven/plugins/checkstyle/exec/CheckstyleExecutorException.java
b/src/main/java/org/apache/maven/plugins/checkstyle/exec/CheckstyleExecutorException.java
index d2a6335..93b6326 100644
---
a/src/main/java/org/apache/maven/plugins/checkstyle/exec/CheckstyleExecutorException.java
+++
b/src/main/java/org/apache/maven/plugins/checkstyle/exec/CheckstyleExecutorException.java
@@ -21,36 +21,32 @@ package org.apache.maven.plugins.checkstyle.exec;
/**
* @author Olivier Lamy
* @since 2.5
- *
*/
public class CheckstyleExecutorException extends Exception {
private static final long serialVersionUID = 3239899539232498912L;
- /**
- *
- */
public CheckstyleExecutorException() {
// nothing
}
/**
- * @param message Message of the exception.
+ * @param message message of the exception
*/
public CheckstyleExecutorException(String message) {
super(message);
}
/**
- * @param cause Cause of the exception.
+ * @param cause cause of the exception
*/
public CheckstyleExecutorException(Throwable cause) {
super(cause);
}
/**
- * @param message Message of the exception.
- * @param cause Cause of the exception.
+ * @param message message of the exception
+ * @param cause cause of the exception
*/
public CheckstyleExecutorException(String message, Throwable cause) {
super(message, cause);
diff --git
a/src/main/java/org/apache/maven/plugins/checkstyle/exec/CheckstyleExecutorRequest.java
b/src/main/java/org/apache/maven/plugins/checkstyle/exec/CheckstyleExecutorRequest.java
index 0b1b9f3..fa1420a 100644
---
a/src/main/java/org/apache/maven/plugins/checkstyle/exec/CheckstyleExecutorRequest.java
+++
b/src/main/java/org/apache/maven/plugins/checkstyle/exec/CheckstyleExecutorRequest.java
@@ -30,7 +30,6 @@ import org.apache.maven.project.MavenProject;
/**
* @author Olivier Lamy
* @since 2.5
- *
*/
public class CheckstyleExecutorRequest {
@@ -131,7 +130,7 @@ public class CheckstyleExecutorRequest {
/**
* Returns the includes parameter.
*
- * @return The includes parameter.
+ * @return the includes parameter
*/
public String getIncludes() {
return includes;
@@ -334,7 +333,7 @@ public class CheckstyleExecutorRequest {
/**
* Returns true if the report is aggregated.
*
- * @return <code>true</code> if the report is aggregated.
+ * @return <code>true</code> if the report is aggregated
*/
public boolean isAggregate() {
return aggregate;
@@ -343,8 +342,8 @@ public class CheckstyleExecutorRequest {
/**
* Sets the aggregate parameter.
*
- * @param pAggregate <code>true</code> if an aggregated report is desired.
- * @return This object.
+ * @param pAggregate <code>true</code> if an aggregated report is desired
+ * @return this object
*/
public CheckstyleExecutorRequest setAggregate(boolean pAggregate) {
this.aggregate = pAggregate;
@@ -354,7 +353,7 @@ public class CheckstyleExecutorRequest {
/**
* Returns the list of reactor projects.
*
- * @return The reactor projects.
+ * @return the reactor projects
*/
public List<MavenProject> getReactorProjects() {
return reactorProjects;
@@ -363,8 +362,8 @@ public class CheckstyleExecutorRequest {
/**
* Sets the list of reactor projects.
*
- * @param pReactorProjects The reactor projects.
- * @return This object.
+ * @param pReactorProjects the reactor projects
+ * @return this object
*/
public CheckstyleExecutorRequest setReactorProjects(List<MavenProject>
pReactorProjects) {
this.reactorProjects = pReactorProjects;
@@ -383,8 +382,8 @@ public class CheckstyleExecutorRequest {
/**
* Sets a list of license artifacts, which may contain the license.
*
- * @param licenseArtifacts List of license artifacts.
- * @return This object.
+ * @param licenseArtifacts list of license artifacts
+ * @return this object
*/
public CheckstyleExecutorRequest setLicenseArtifacts(List<Artifact>
licenseArtifacts) {
this.licenseArtifacts = licenseArtifacts;
@@ -403,8 +402,8 @@ public class CheckstyleExecutorRequest {
/**
* Sets a list of artifacts, which may contain the checkstyle
configuration.
*
- * @param configArtifacts List of artifacts.
- * @return This object.
+ * @param configArtifacts list of artifacts
+ * @return this object
*/
public CheckstyleExecutorRequest setConfigurationArtifacts(List<Artifact>
configArtifacts) {
this.configurationArtifacts = configArtifacts;
@@ -416,8 +415,8 @@ public class CheckstyleExecutorRequest {
}
/**
- * @param includeResources whether to include the resource directories in
the checks.
- * @return This object.
+ * @param includeResources whether to include the resource directories in
the checks
+ * @return this object
*/
public CheckstyleExecutorRequest setIncludeResources(boolean
includeResources) {
this.includeResources = includeResources;
@@ -429,8 +428,8 @@ public class CheckstyleExecutorRequest {
}
/**
- * @param includeTestResources whether to set the test resource
directories in the checks.
- * @return This object.
+ * @param includeTestResources whether to set the test resource
directories in the checks
+ * @return this object
*/
public CheckstyleExecutorRequest setIncludeTestResources(boolean
includeTestResources) {
this.includeTestResources = includeTestResources;
@@ -440,15 +439,15 @@ public class CheckstyleExecutorRequest {
/**
* Returns true if ignored modules (modules with severity 'ignore') should
be omitted.
*
- * @return <code>true</code> if ignored modules should be omitted.
+ * @return <code>true</code> if ignored modules should be omitted
*/
public boolean isOmitIgnoredModules() {
return omitIgnoredModules;
}
/**
- * @param omitIgnoredModules Whether to omit ignored modules (modules with
severity 'ignore').
- * @return This object.
+ * @param omitIgnoredModules whether to omit ignored modules (modules with
severity 'ignore')
+ * @return this object
*/
public CheckstyleExecutorRequest setOmitIgnoredModules(boolean
omitIgnoredModules) {
this.omitIgnoredModules = omitIgnoredModules;
diff --git
a/src/main/java/org/apache/maven/plugins/checkstyle/exec/CheckstyleResults.java
b/src/main/java/org/apache/maven/plugins/checkstyle/exec/CheckstyleResults.java
index 8db1aea..0bfaf61 100644
---
a/src/main/java/org/apache/maven/plugins/checkstyle/exec/CheckstyleResults.java
+++
b/src/main/java/org/apache/maven/plugins/checkstyle/exec/CheckstyleResults.java
@@ -32,7 +32,6 @@ import com.puppycrawl.tools.checkstyle.api.SeverityLevel;
* TODO: provide fallback to disk based storage if too many results.
*
* @author <a href="mailto:[email protected]";>Joakim Erdfelt</a>
- *
*/
public class CheckstyleResults {
private Map<String, List<AuditEvent>> files;
diff --git
a/src/main/java/org/apache/maven/plugins/checkstyle/exec/DefaultCheckstyleExecutor.java
b/src/main/java/org/apache/maven/plugins/checkstyle/exec/DefaultCheckstyleExecutor.java
index bd30668..8435bef 100644
---
a/src/main/java/org/apache/maven/plugins/checkstyle/exec/DefaultCheckstyleExecutor.java
+++
b/src/main/java/org/apache/maven/plugins/checkstyle/exec/DefaultCheckstyleExecutor.java
@@ -356,9 +356,9 @@ public class DefaultCheckstyleExecutor implements
CheckstyleExecutor {
/**
* Get the effective Checkstyle version at runtime.
- * @return the MANIFEST implementation version of Checkstyle API package
(can be <code>null</code>)
*
- *@todo Copied from CheckstyleReportGenerator - move to a utility class
+ * @return the MANIFEST implementation version of Checkstyle API package
(can be <code>null</code>)
+ * @todo Copied from CheckstyleReportGenerator - move to a utility class
*/
private String getCheckstyleVersion() {
Package checkstyleApiPackage = Configuration.class.getPackage();
@@ -634,7 +634,7 @@ public class DefaultCheckstyleExecutor implements
CheckstyleExecutor {
* Configures search paths in the resource locator.
* This method should only be called once per execution.
*
- * @param request executor request data.
+ * @param request executor request data
*/
private void configureResourceLocator(
final ResourceManager resourceManager,
