You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2024/01/29 14:28:54 UTC

(commons-cli) 01/02: Fix Javadoc code tag and replace some code tags with link tags

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-cli.git

commit f2768dea7f013e857b3dddc50bd524c5bb1aa0b0
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Mon Jan 29 09:26:36 2024 -0500

    Fix Javadoc code tag and replace some code tags with link tags
    
    Adjust Checkstyle for compact array declarations
---
 src/conf/checkstyle.xml                             |  1 -
 src/main/java/org/apache/commons/cli/Converter.java | 12 +++++++-----
 2 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/src/conf/checkstyle.xml b/src/conf/checkstyle.xml
index 8ef1cfd..39f5c5d 100644
--- a/src/conf/checkstyle.xml
+++ b/src/conf/checkstyle.xml
@@ -73,7 +73,6 @@
     <!-- Checks for whitespace -->
     <!-- See http://checkstyle.sf.net/config_whitespace.html -->
     <module name="EmptyForIteratorPad" />
-    <module name="NoWhitespaceAfter" />
     <module name="NoWhitespaceBefore" />
     <module name="ParenPad" />
 
diff --git a/src/main/java/org/apache/commons/cli/Converter.java b/src/main/java/org/apache/commons/cli/Converter.java
index b915689..cf96bb1 100644
--- a/src/main/java/org/apache/commons/cli/Converter.java
+++ b/src/main/java/org/apache/commons/cli/Converter.java
@@ -42,16 +42,18 @@ public interface Converter<T, E extends Throwable> {
     Converter<?, RuntimeException> DEFAULT = s -> s;
 
     /**
-     * Class name converter. Calls {@code Class.forName}.
+     * Class name converter. Calls {@link Class#forName(String)}.
      */
     Converter<Class<?>, ClassNotFoundException> CLASS = Class::forName;
 
     /**
-     * File name converter. Calls @{code new File(s)}.
+     * File name converter. Calls {@link File#File(String)}.
      */
     Converter<File, NullPointerException> FILE = File::new;
 
-    /** Path converter. Calls @{code new Path(s)} */
+    /**
+     * Path converter. Calls {@code new File(s).toPath()}.
+     */
     Converter<Path, InvalidPathException> PATH = s -> new File(s).toPath();
 
     /**
@@ -72,8 +74,8 @@ public interface Converter<T, E extends Throwable> {
      */
     Converter<Object, ReflectiveOperationException> OBJECT = s -> CLASS.apply(s).getConstructor().newInstance();
 
-    /** 
-     * Creates a URL. Calls {@code new URL(s)}.
+    /**
+     * Creates a URL. Calls {@link URL#URL(String)}.
      */
     Converter<URL, MalformedURLException> URL = java.net.URL::new;