You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2014/08/30 23:12:11 UTC
svn commit: r1621538 - in
/maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle:
./ exec/ resource/
Author: hboutemy
Date: Sat Aug 30 21:12:11 2014
New Revision: 1621538
URL: http://svn.apache.org/r1621538
Log:
fixed typos
Modified:
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.java
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleReport.java
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.java
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/exec/CheckstyleCheckerListener.java
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/exec/DefaultCheckstyleExecutor.java
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/resource/LicenseResourceManager.java
Modified: maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.java?rev=1621538&r1=1621537&r2=1621538&view=diff
==============================================================================
--- maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.java (original)
+++ maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.java Sat Aug 30 21:12:11 2014
@@ -184,7 +184,7 @@ public abstract class AbstractCheckstyle
private File outputDirectory;
/**
- * Specifies the path and filename to save the checkstyle output. The format
+ * Specifies the path and filename to save the Checkstyle output. The format
* of the output file is determined by the <code>outputFileFormat</code>
* parameter.
*/
@@ -343,7 +343,7 @@ public abstract class AbstractCheckstyle
* <p/>
* <p>
* See <code>suppressionsFileExpression</code> for the property that will
- * be made available to your checkstyle configuration.
+ * be made available to your Checkstyle configuration.
* </p>
*
* @since 2.0-beta-2
@@ -360,7 +360,7 @@ public abstract class AbstractCheckstyle
/**
* Specifies the format of the output to be used when writing to the output
- * file. Valid values are "plain" and "xml".
+ * file. Valid values are "<code>plain</code>" and "<code>xml</code>".
*/
@Parameter( property = "checkstyle.output.format", defaultValue = "xml" )
private String outputFileFormat;
@@ -400,18 +400,18 @@ public abstract class AbstractCheckstyle
/**
* The Maven Project Object.
*/
- @Parameter( defaultValue = "${project}", readonly = true )
+ @Parameter( defaultValue = "${project}", readonly = true, required = true )
protected MavenProject project;
/**
* The Plugin Descriptor
*/
- @Parameter( defaultValue = "${plugin}", readonly = true )
+ @Parameter( defaultValue = "${plugin}", readonly = true, required = true )
private PluginDescriptor plugin;
// remove when requiring Maven 3.x, just use #plugin
- @Parameter( defaultValue = "${mojoExecution}", readonly = true )
+ @Parameter( defaultValue = "${mojoExecution}", readonly = true, required = true )
private MojoExecution mojoExecution;
/**
@@ -503,12 +503,10 @@ public abstract class AbstractCheckstyle
locator.setOutputDirectory( new File( project.getBuild().getDirectory() ) );
- // for when we start using maven-shared-io and
- // maven-shared-monitor...
+ // for when we start using maven-shared-io and maven-shared-monitor...
// locator = new Locator( new MojoLogMonitorAdaptor( getLog() ) );
- // locator = new Locator( getLog(), new File(
- // project.getBuild().getDirectory() ) );
+ // locator = new Locator( getLog(), new File( project.getBuild().getDirectory() ) );
ClassLoader currentClassLoader = Thread.currentThread().getContextClassLoader();
Modified: maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleReport.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleReport.java?rev=1621538&r1=1621537&r2=1621538&view=diff
==============================================================================
--- maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleReport.java (original)
+++ maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleReport.java Sat Aug 30 21:12:11 2014
@@ -108,7 +108,7 @@ public class CheckstyleReport
* defines a Checkstyle property named
* <code>checkstyle.suppressions.file</code> with the value of this
* property. This allows using the Checkstyle property in your own custom
- * checkstyle configuration file when specifying a suppressions file.
+ * Checkstyle configuration file when specifying a suppressions file.
*
* @deprecated Use suppressionsLocation instead.
*/
Modified: maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.java?rev=1621538&r1=1621537&r2=1621538&view=diff
==============================================================================
--- maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.java (original)
+++ maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.java Sat Aug 30 21:12:11 2014
@@ -95,7 +95,7 @@ public class CheckstyleViolationCheckMoj
/**
* Specifies the format of the output to be used when writing to the output
- * file. Valid values are "plain" and "xml".
+ * file. Valid values are "<code>plain</code>" and "<code>xml</code>".
*/
@Parameter( property = "checkstyle.output.format", defaultValue = "xml" )
private String outputFileFormat;
@@ -120,7 +120,7 @@ public class CheckstyleViolationCheckMoj
/**
* The lowest severity level that is considered a violation.
- * Valid values are "error", "warning" and "info".
+ * Valid values are "<code>error</code>", "<code>warning</code>" and "<code>info</code>".
*
* @since 2.2
*/
@@ -145,7 +145,7 @@ public class CheckstyleViolationCheckMoj
private boolean skip;
/**
- * Skip checktyle execution will only scan the outputFile.
+ * Skip Checkstyle execution will only scan the outputFile.
*
* @since 2.5
*/
@@ -282,13 +282,13 @@ public class CheckstyleViolationCheckMoj
* <p>
* This parameter is resolved as resource, URL, then file. If successfully
* resolved, the contents of the suppressions XML is copied into the
- * <code>${project.build.directory}/checkstyle-supressions.xml</code> file
+ * <code>${project.build.directory}/checkstyle-suppressions.xml</code> file
* before being passed to Checkstyle for loading.
* </p>
* <p/>
* <p>
* See <code>suppressionsFileExpression</code> for the property that will
- * be made available to your checkstyle configuration.
+ * be made available to your Checkstyle configuration.
* </p>
*
* @since 2.0-beta-2
@@ -321,17 +321,17 @@ public class CheckstyleViolationCheckMoj
/**
* The Maven Project Object.
*/
- @Parameter ( defaultValue = "${project}", readonly = true )
+ @Parameter ( defaultValue = "${project}", readonly = true, required = true )
protected MavenProject project;
/**
* The Plugin Descriptor
*/
- @Parameter( defaultValue = "${plugin}", readonly = true )
+ @Parameter( defaultValue = "${plugin}", readonly = true, required = true )
private PluginDescriptor plugin;
// remove when requiring Maven 3.x, just use #plugin
- @Parameter( defaultValue = "${mojoExecution}", readonly = true )
+ @Parameter( defaultValue = "${mojoExecution}", readonly = true, required = true )
private MojoExecution mojoExecution;
/**
@@ -370,8 +370,8 @@ public class CheckstyleViolationCheckMoj
private String resourceIncludes;
/**
- * If this is true, and checkstyle reported any violations or errors,
- * the build fails immediately after running checkstyle, before checking the log
+ * If this is true, and Checkstyle reported any violations or errors,
+ * the build fails immediately after running Checkstyle, before checking the log
* for {@link #logViolationsToConsole}. If you want to use {@link #logViolationsToConsole},
* use {@link #failOnViolation} instead of this.
*/
@@ -436,7 +436,7 @@ public class CheckstyleViolationCheckMoj
private boolean includeTestResources = true;
/**
- * By using this property, you can specify the whole checkstyle rules
+ * By using this property, you can specify the whole Checkstyle rules
* inline directly inside this pom.
*
* <pre>
@@ -463,7 +463,7 @@ public class CheckstyleViolationCheckMoj
private PlexusConfiguration checkstyleRules;
/**
- * dump file for inlined checkstyle rules
+ * dump file for inlined Checkstyle rules
*/
@Parameter( property = "checkstyle.output.rules.file",
defaultValue = "${project.build.directory}/checkstyle-rules.xml" )
Modified: maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/exec/CheckstyleCheckerListener.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/exec/CheckstyleCheckerListener.java?rev=1621538&r1=1621537&r2=1621538&view=diff
==============================================================================
--- maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/exec/CheckstyleCheckerListener.java (original)
+++ maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/exec/CheckstyleCheckerListener.java Sat Aug 30 21:12:11 2014
@@ -64,7 +64,7 @@ public class CheckstyleCheckerListener
}
/**
* @param sourceDirectory assume that is <code>sourceDirectory</code> is a not null directory and exists
- * @param configuration checkstyle configuration
+ * @param configuration Checkstyle configuration
* @since 2.5
*/
public CheckstyleCheckerListener( File sourceDirectory, Configuration configuration )
@@ -75,7 +75,7 @@ public class CheckstyleCheckerListener
}
/**
- * @param configuration checkstyle configuration
+ * @param configuration Checkstyle configuration
* @since 2.5
*/
public CheckstyleCheckerListener( Configuration configuration )
Modified: maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/exec/DefaultCheckstyleExecutor.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/exec/DefaultCheckstyleExecutor.java?rev=1621538&r1=1621537&r2=1621538&view=diff
==============================================================================
--- maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/exec/DefaultCheckstyleExecutor.java (original)
+++ maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/exec/DefaultCheckstyleExecutor.java Sat Aug 30 21:12:11 2014
@@ -30,7 +30,6 @@ import java.net.URLClassLoader;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.ArrayList;
-import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.LinkedHashSet;
@@ -86,10 +85,10 @@ public class DefaultCheckstyleExecutor
public CheckstyleResults executeCheckstyle( CheckstyleExecutorRequest request )
throws CheckstyleExecutorException, CheckstyleException
{
- // checkstyle will always use the context classloader in order
+ // Checkstyle will always use the context classloader in order
// to load resources (dtds),
// so we have to fix it
- // olamy this hack is not anymore needed in maven 3.x
+ // olamy this hack is not anymore needed in Maven 3.x
ClassLoader checkstyleClassLoader = PackageNamesLoader.class.getClassLoader();
Thread.currentThread().setContextClassLoader( checkstyleClassLoader );
@@ -339,7 +338,7 @@ public class DefaultCheckstyleExecutor
{
try
{
- // checkstyle will always use the context classloader in order
+ // Checkstyle will always use the context classloader in order
// to load resources (dtds),
// so we have to fix it
ClassLoader checkstyleClassLoader = PackageNamesLoader.class.getClassLoader();
Modified: maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/resource/LicenseResourceManager.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/resource/LicenseResourceManager.java?rev=1621538&r1=1621537&r2=1621538&view=diff
==============================================================================
--- maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/resource/LicenseResourceManager.java (original)
+++ maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/resource/LicenseResourceManager.java Sat Aug 30 21:12:11 2014
@@ -31,7 +31,7 @@ import org.codehaus.plexus.resource.load
import org.codehaus.plexus.resource.loader.ThreadContextClasspathResourceLoader;
/**
- * License resource manager, to avoid defaulting license to maven-checkstyle-plugin license.
+ * License resource manager, to avoid defaulting license to maven-checkstyle-plugin's own license.
*
* @since 2.12
*/