(maven-jlink-plugin) branch master updated: API doc copy edits (#225)

[elharo]

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-jlink-plugin.git


The following commit(s) were added to refs/heads/master by this push:
     new 2bcbcea  API doc copy edits (#225)
2bcbcea is described below

commit 2bcbcea321f26b83c42e44cee5fe61baee2228f2
Author: Elliotte Rusty Harold <elh...@users.noreply.github.com>
AuthorDate: Sat Dec 7 13:07:45 2024 +0000

    API doc copy edits (#225)
    
    * API doc copy edits
    
    * revert
---
 .../maven/plugins/jlink/AbstractJLinkMojo.java     | 23 +++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)

diff --git 
a/src/main/java/org/apache/maven/plugins/jlink/AbstractJLinkMojo.java 
b/src/main/java/org/apache/maven/plugins/jlink/AbstractJLinkMojo.java
index 6a590a3..3cd3460 100644
--- a/src/main/java/org/apache/maven/plugins/jlink/AbstractJLinkMojo.java
+++ b/src/main/java/org/apache/maven/plugins/jlink/AbstractJLinkMojo.java
@@ -175,15 +175,15 @@ public abstract class AbstractJLinkMojo extends 
AbstractMojo {
 
     /**
      * This will convert a module path separated by either {@code :} or {@code 
;} into a string which uses the platform
-     * depend path separator uniformly.
+     * path separator uniformly.
      *
-     * @param pluginModulePath The module path.
-     * @return The platform separated module path.
+     * @param pluginModulePath the module path
+     * @return the platform separated module path
      */
     protected StringBuilder 
convertSeparatedModulePathToPlatformSeparatedModulePath(String 
pluginModulePath) {
         StringBuilder sb = new StringBuilder();
-        // Split the module path by either ":" or ";" linux/windows path 
separator and
-        // convert uniformly to the platform used separator.
+        // Split the module path by either ":" or ";" Linux/Windows path 
separator and
+        // convert uniformly to the platform separator.
         String[] splitModule = pluginModulePath.split("[;:]");
         for (String module : splitModule) {
             if (sb.length() > 0) {
@@ -195,19 +195,20 @@ public abstract class AbstractJLinkMojo extends 
AbstractMojo {
     }
 
     /**
-     * Convert a list into a string which is separated by platform depend path 
separator.
+     * Convert a list into a string which is separated by the platform path 
separator.
      *
-     * @param modulePaths The list of elements.
-     * @return The string which contains the elements separated by {@link 
File#pathSeparatorChar}.
+     * @param modulePaths the list of elements
+     * @return the string which contains the elements separated by {@link 
File#pathSeparatorChar}.
      */
     protected String getPlatformDependSeparateList(Collection<String> 
modulePaths) {
         return String.join(Character.toString(File.pathSeparatorChar), 
modulePaths);
     }
 
     /**
-     * Convert a list into a
-     * @param modules The list of modules.
-     * @return The string with the module list which is separated by {@code ,}.
+     * Convert a list of modules into a comma separated string.
+     *
+     * @param modules the list of modules
+     * @return the string with the module list which is separated by {@code ,}
      */
     protected String getCommaSeparatedList(Collection<String> modules) {
         return String.join(",", modules);