Typos and grammar (#1234)

Author: elharo

src/main/java/org/apache/maven/plugins/javadoc/AbstractFixJavadocMojo.java

@@ -863,7 +863,7 @@ private ClassLoader getProjectClassLoader() throws MojoExecutionException {
     }
 
     /**
-     * Process the given {@link JavaClass}, ie add missing javadoc tags depending user parameters.
+     * Process the given {@link JavaClass}, ie add missing javadoc tags depending on user parameters.
      *
      * @param javaClass not null
      * @throws IOException            if any
@@ -1069,7 +1069,7 @@ private boolean fixClassComment(
 
     /**
      * @param modifiers list of modifiers (public, private, protected, package)
-     * @return <code>true</code> if modifier is align with <code>level</code>.
+     * @return <code>true</code> if modifier is aligned with <code>level</code>.
      */
     private boolean isInLevel(List<String> modifiers) {
         if (LEVEL_PUBLIC.equalsIgnoreCase(level.trim())) {

src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java

@@ -515,7 +515,7 @@ public AbstractJavadocMojo(
      * Detect the Java API link for the current build, e.g. <code>https://docs.oracle.com/javase/1.4.2/docs/api/</code>
      * for Java source 1.4.
      * <br/>
-     * By default, the goal detects the Javadoc API link depending the value of the <code>source</code>
+     * By default, the goal detects the Javadoc API link depending on the value of the <code>source</code>
      * parameter in the <code>org.apache.maven.plugins:maven-compiler-plugin</code>
      * (defined in <code>${project.build.plugins}</code> or in <code>${project.build.pluginManagement}</code>),
      * or try to compute it from the {@code javadocExecutable} version.
@@ -528,7 +528,7 @@ public AbstractJavadocMojo(
     private boolean detectJavaApiLink;
 
     /**
-     * Use this parameter <b>only</b> if if you want to override the default URLs.
+     * Use this parameter <b>only</b> if you want to override the default URLs.
      *
      * The key should match {@code api_x}, where {@code x} matches the Java version.
      *
@@ -846,7 +846,7 @@ public AbstractJavadocMojo(
     // ----------------------------------------------------------------------
 
     /**
-     * Specifies whether or not the author text is included in the generated Javadocs.
+     * Specifies whether the author text is included in the generated Javadocs.
      * @see <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options">Doclet option author</a>.
      */
     @Parameter(property = "author", defaultValue = "true")
@@ -1149,7 +1149,7 @@ public AbstractJavadocMojo(
     private String noqualifier;
 
     /**
-     * Omits from the generated docs the "Since" sections associated with the since tags.
+     * Omits the "Since" sections from the generated docs.
      * @see <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options">Doclet option nosince</a>.
      */
     @Parameter(property = "nosince", defaultValue = "false")
@@ -1345,8 +1345,8 @@ public AbstractJavadocMojo(
     private TagletArtifact tagletArtifact;
 
     /**
-     * Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be
-     * auto-detect and so no need to specify them.
+     * Specifies several Taglet artifacts containing the taglet class files (.class). These taglet class names will be
+     * auto-detected and so no need to specify them.
      * <br/>
      * Example:
      * <pre>
@@ -2111,7 +2111,7 @@ protected Map<Path, Collection<String>> getFiles(Collection<Path> sourcePaths) t
                         sourceDirectory, sourceFileIncludes, sourceFileExcludes, excludedPackages));
 
                 // in the aggregate goal (and theoretically in others too), there can be
-                // more then one module-info.java. Filter out all of them.
+                // more than one module-info.java. Filter out all of them.
                 if (autoExclude && files.removeIf(s -> s.endsWith("module-info.java"))) {
                     getLog().debug("Auto exclude module-info.java due to source value");
                 }
@@ -3377,7 +3377,7 @@ private void addProxyArg(Commandline cmd) {
     }
 
     /**
-     * Get the path of the Javadoc tool executable depending the user entry or try to find it depending the OS
+     * Get the path of the Javadoc tool executable depending on the user entry or try to find it depending on the OS
      * or the <code>java.home</code> system property or the <code>JAVA_HOME</code> environment variable.
      *
      * @return the path of the Javadoc tool
@@ -3586,7 +3586,7 @@ private void addArgIf(List<String> arguments, boolean b, String value, JavaVersi
 
     /**
      * Convenience method to add an argument to the <code>command line</code>
-     * if the the value is not null or empty.
+     * if the value is not null or empty.
      * <p/>
      * Moreover, the value could be comma separated.
      *
@@ -3601,7 +3601,7 @@ private void addArgIfNotEmpty(List<String> arguments, String key, String value)
 
     /**
      * Convenience method to add an argument to the <code>command line</code>
-     * if the the value is not null or empty.
+     * if the value is not null or empty.
      * <p/>
      * Moreover, the value could be comma separated.
      *
@@ -3635,7 +3635,7 @@ private void addArgIfNotEmpty(
 
     /**
      * Convenience method to add an argument to the <code>command line</code>
-     * if the the value is not null or empty.
+     * if the value is not null or empty.
      * <p/>
      * Moreover, the value could be comma separated.
      *
@@ -3673,7 +3673,7 @@ private void addArgIfNotEmpty(
 
     /**
      * Convenience method to add an argument to the <code>command line</code>
-     * if the the value is not null or empty.
+     * if the value is not null or empty.
      * <p/>
      * Moreover, the value could be comma separated.
      *
@@ -3774,7 +3774,7 @@ private Set<OfflineLink> getOfflineLinks() throws MavenReportException {
      * If {@code detectLinks}, try to add javadoc apidocs according Maven conventions for all dependencies given
      * in the project.
      * <br/>
-     * According the Javadoc documentation, all defined links should have <code>${link}/package-list</code> fetchable.
+     * According to the Javadoc documentation, all defined links should have <code>${link}/package-list</code> fetchable.
      * <br/>
      * <b>Note</b>: when a link is not fetchable:
      * <ul>
@@ -4165,8 +4165,8 @@ private void addCommandLineOptions(Commandline cmd, List<String> arguments, File
     }
 
     /**
-     * Generate a file called <code>argfile</code> (or <code>files</code>, depending the JDK) to hold files and add
-     * the <code>@argfile</code> (or <code>@file</code>, depending the JDK) in the command line.
+     * Generate a file called <code>argfile</code> (or <code>files</code>, depending on the JDK) to hold files and add
+     * the <code>@argfile</code> (or <code>@file</code>, depending on the JDK) in the command line.
      *
      * @param cmd                    not null
      * @param javadocOutputDirectory not null
@@ -4392,7 +4392,7 @@ private void addJavadocOptions(
                 if (aggregatedProject != null && !"pom".equals(aggregatedProject.getPackaging())) {
                     ResolvePathResult result = null;
 
-                    // Prefer jar over outputDirectory, since it may may contain an automatic module name
+                    // Prefer jar over outputDirectory, since it may contain an automatic module name
                     File artifactFile = getClassesFile(aggregatedProject);
                     if (artifactFile != null) {
                         ResolvePathRequest<File> request = ResolvePathRequest.ofFile(artifactFile);
@@ -5402,7 +5402,7 @@ private List<OfflineLink> getModulesLinks() throws MavenReportException {
                         throw new MavenReportException(e.getMessage(), e);
                     }
                 } finally {
-                    // just create the directory to prevent repeated invocations..
+                    // just create the directory to prevent repeated invocations.
                     if (!location.exists()) {
                         getLog().warn("Creating fake javadoc directory to prevent repeated invocations: " + location);
                         location.mkdirs();

src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java

@@ -180,9 +180,9 @@ protected static List<String> pruneFiles(Collection<String> files) {
      * Determine whether a file should be excluded from the provided list of paths, based on whether it exists and is
      * already present in the list.
      *
-     * @param f The files.
-     * @param pruned The list of pruned files..
-     * @return true if the file could be pruned false otherwise.
+     * @param f the files
+     * @param pruned the list of pruned files
+     * @return true if the file could be pruned, false otherwise
      */
     public static boolean shouldPruneFile(String f, List<String> pruned) {
         if (f != null) {
@@ -573,7 +573,7 @@ protected static String extractJavadocVersion(String output) {
 
     /**
      * Parse a memory string which be used in the JVM arguments <code>-Xms</code> or <code>-Xmx</code>. <br>
-     * Here are some supported memory string depending the JDK used:
+     * Here are some supported memory string depending on the JDK used:
      * <table><caption>Memory argument support per JDK</caption>
      * <tr>
      * <th>JDK</th>
@@ -639,7 +639,7 @@ protected static String parseJavadocMemory(String memory) {
     /**
      * Validate if a charset is supported on this platform.
      *
-     * @param charsetName the charsetName to be check.
+     * @param charsetName the charsetName to check
      * @return <code>true</code> if the given charset is supported by the JVM, <code>false</code> otherwise.
      */
     protected static boolean validateEncoding(String charsetName) {
@@ -874,7 +874,7 @@ protected static String readFile(final File javaFile, final String encoding) {
     }
 
     /**
-     * Split the given path with colon and semi-colon, to support Solaris and Windows path. Examples:
+     * Split the given path with colon and semicolon, to support Unix and Windows paths. Examples:
      *
      * <pre>
      * splitPath( "/home:/tmp" )     = ["/home", "/tmp"]
@@ -1132,7 +1132,7 @@ private static class PathTokenizer {
         private String lookahead = null;
 
         /**
-         * Flag to indicate whether or not we are running on a platform with a DOS style filesystem
+         * Flag to indicate whether we are running on a platform with a DOS style filesystem
          */
         private boolean dosStyleFilesystem;
 

src/main/java/org/apache/maven/plugins/javadoc/StaleHelper.java

@@ -43,7 +43,7 @@ public class StaleHelper {
     /**
      * Compute the encoding of the stale javadoc
      *
-     * @return the the encoding of the stale data
+     * @return the encoding of the stale data
      */
     private static Charset getDataCharset() {
         if (JavaVersion.JAVA_SPECIFICATION_VERSION.isAtLeast("9")