Skip to content

Commit

Permalink
API doc copy edits (#225)
Browse files Browse the repository at this point in the history
* API doc copy edits

* revert
  • Loading branch information
elharo authored Dec 7, 2024
1 parent 0101406 commit 2bcbcea
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions src/main/java/org/apache/maven/plugins/jlink/AbstractJLinkMojo.java
Original file line number Diff line number Diff line change
Expand Up @@ -175,15 +175,15 @@ protected boolean hasClassifier(String classifier) {

/**
* 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) {
Expand All @@ -195,19 +195,20 @@ protected StringBuilder convertSeparatedModulePathToPlatformSeparatedModulePath(
}

/**
* 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);
Expand Down

0 comments on commit 2bcbcea

Please sign in to comment.