From 9c966b496ec339972818b1d265964fa3927e5793 Mon Sep 17 00:00:00 2001 From: Gary Gregory Date: Sun, 17 Dec 2023 14:17:35 -0500 Subject: [PATCH] Better Javadoc --- src/main/java/org/apache/commons/lang3/ClassUtils.java | 2 +- src/main/java/org/apache/commons/lang3/SystemUtils.java | 2 +- src/main/java/org/apache/commons/lang3/ThreadUtils.java | 2 +- .../org/apache/commons/lang3/builder/HashCodeBuilder.java | 4 ++-- .../commons/lang3/builder/ReflectionToStringBuilder.java | 4 ++-- .../apache/commons/lang3/concurrent/BasicThreadFactory.java | 2 +- .../org/apache/commons/lang3/builder/ToStringBuilderTest.java | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/ClassUtils.java b/src/main/java/org/apache/commons/lang3/ClassUtils.java index 6ef65d7f0..86a02730b 100644 --- a/src/main/java/org/apache/commons/lang3/ClassUtils.java +++ b/src/main/java/org/apache/commons/lang3/ClassUtils.java @@ -982,7 +982,7 @@ public class ClassUtils { * *

* Note that this method differs from {@link #getSimpleName(Class)} in that this will return, for example - * {@code "Map.Entry"} whilst the {@code java.lang.Class} variant will simply return {@code "Entry"}. In this example + * {@code "Map.Entry"} whilst the {@link Class} variant will simply return {@code "Entry"}. In this example * the argument {@code className} is the string {@code java.util.Map$Entry} (note the {@code $} sign. *

* diff --git a/src/main/java/org/apache/commons/lang3/SystemUtils.java b/src/main/java/org/apache/commons/lang3/SystemUtils.java index 13190bbbd..2c52cff7a 100644 --- a/src/main/java/org/apache/commons/lang3/SystemUtils.java +++ b/src/main/java/org/apache/commons/lang3/SystemUtils.java @@ -19,7 +19,7 @@ package org.apache.commons.lang3; import java.io.File; /** - * Helpers for {@code java.lang.System}. + * Helpers for {@link System}. * *

* If a system property cannot be read due to security restrictions, the corresponding field in this class will be set diff --git a/src/main/java/org/apache/commons/lang3/ThreadUtils.java b/src/main/java/org/apache/commons/lang3/ThreadUtils.java index b71457de8..8a127e9ec 100644 --- a/src/main/java/org/apache/commons/lang3/ThreadUtils.java +++ b/src/main/java/org/apache/commons/lang3/ThreadUtils.java @@ -28,7 +28,7 @@ import java.util.stream.Stream; import org.apache.commons.lang3.time.DurationUtils; /** - * Helpers for {@code java.lang.Thread} and {@code java.lang.ThreadGroup}. + * Helpers for {@link Thread} and {@link ThreadGroup}. * *

* #ThreadSafe# diff --git a/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java b/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java index afe59a8bd..a881f232e 100644 --- a/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java +++ b/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java @@ -544,8 +544,8 @@ public class HashCodeBuilder implements Builder { *

*

* This is in contrast to the standard {@code java.lang.Boolean.hashCode} handling, which computes - * a {@code hashCode} value of {@code 1231} for {@code java.lang.Boolean} instances - * that represent {@code true} or {@code 1237} for {@code java.lang.Boolean} instances + * a {@code hashCode} value of {@code 1231} for {@link Boolean} instances + * that represent {@code true} or {@code 1237} for {@link Boolean} instances * that represent {@code false}. *

*

diff --git a/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java b/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java index 06770bc58..7950a208e 100644 --- a/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java +++ b/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java @@ -296,7 +296,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder { * *

* Superclass fields will be appended up to and including the specified superclass. A null superclass is treated as - * {@code java.lang.Object}. + * {@link Object}. *

* *

@@ -353,7 +353,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder { * *

* Superclass fields will be appended up to and including the specified superclass. A null superclass is treated as - * {@code java.lang.Object}. + * {@link Object}. *

* *

diff --git a/src/main/java/org/apache/commons/lang3/concurrent/BasicThreadFactory.java b/src/main/java/org/apache/commons/lang3/concurrent/BasicThreadFactory.java index d9ba392b6..ba3e4d96d 100644 --- a/src/main/java/org/apache/commons/lang3/concurrent/BasicThreadFactory.java +++ b/src/main/java/org/apache/commons/lang3/concurrent/BasicThreadFactory.java @@ -54,7 +54,7 @@ import java.util.concurrent.atomic.AtomicLong; * threads. This can impact the exit behavior of the current Java application * because the JVM shuts down if there are only daemon threads running. *

  • The priority of the thread. Here an integer value can be provided. The - * {@code java.lang.Thread} class defines constants for valid ranges of priority + * {@link Thread} class defines constants for valid ranges of priority * values.
    • *
  • The {@link UncaughtExceptionHandler} for the thread. This handler is * called if an uncaught exception occurs within the thread.
    • diff --git a/src/test/java/org/apache/commons/lang3/builder/ToStringBuilderTest.java b/src/test/java/org/apache/commons/lang3/builder/ToStringBuilderTest.java index 6a53a5814..d84351e99 100644 --- a/src/test/java/org/apache/commons/lang3/builder/ToStringBuilderTest.java +++ b/src/test/java/org/apache/commons/lang3/builder/ToStringBuilderTest.java @@ -1265,7 +1265,7 @@ public class ToStringBuilderTest extends AbstractLangTest { *

    Transient fields are not output.

    * *

    Superclass fields will be appended up to and including the specified superclass. - * A null superclass is treated as {@code java.lang.Object}.

    + * A null superclass is treated as {@link Object}.

    * *

    If the style is {@code null}, the default * {@code ToStringStyle} is used.