Skip to content

Fix Javadocs in ClassUtils #1410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
garydgregory merged 5 commits into from
Jul 11, 2025
Merged

Fix Javadocs in ClassUtils #1410

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
75759de
[javadoc] Correct `human-readable` in ClassUtils
h3ssan Jul 11, 2025
d8d3d61
[javadoc] Update parameter `name` in `getCanonicalName` method
h3ssan Jul 11, 2025
a44b178
[javadoc] Fix opening parenthesis in ClassUtils
h3ssan Jul 11, 2025
a0a51c0
[javadoc] Fix repeated word in ClassUtils
h3ssan Jul 11, 2025
dbd3069
[javadoc] Fix closing parenthesis in ClassUtils
h3ssan Jul 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/main/java/org/apache/commons/lang3/ClassUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
* </p>
*
* <p>
* The notion of a {@code canonical name} includes the human readable name for the type, for example {@code int[]}. The
* The notion of a {@code canonical name} includes the human-readable name for the type, for example {@code int[]}. The
* non-canonical method variants work with the JVM names, such as {@code [I}.
* </p>
*
Expand Down Expand Up @@ -474,7 +474,7 @@ public static String getCanonicalName(final Object object, final String valueIfN
* </ul>
* </p>
*
* @param className the name of class.
* @param name the name of class.
* @return canonical form of class name.
*/
private static String getCanonicalName(final String name) {
Expand Down Expand Up @@ -767,7 +767,7 @@ static Class<?> getPrimitiveClass(final String className) {
/**
* Gets the desired Method much like {@code Class.getMethod}, however it ensures that the returned Method is from a
* public class or interface and not from an anonymous inner class. This means that the Method is invokable and doesn't
* fall foul of Java bug <a href="https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4071957">4071957</a>).
* fall foul of Java bug (<a href="https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4071957">4071957</a>).
*
* <pre>
* {@code Set set = Collections.unmodifiableSet(...);
Expand Down Expand Up @@ -984,7 +984,7 @@ public static String getShortClassName(final Object object, final String valueIf
* </p>
*
* <p>
* The difference is is significant only in case of classes that are inner classes of some other classes. In this case
* The difference is significant only in case of classes that are inner classes of some other classes. In this case
* the separator between the outer and inner class (possibly on multiple hierarchy level) has to be {@code $} (dollar
* sign) and not {@code .} (dot), as it is returned by {@code Class.getName()}
* </p>
Expand All @@ -997,7 +997,7 @@ public static String getShortClassName(final Object object, final String valueIf
* <p>
* Note that this method differs from {@link #getSimpleName(Class)} in that this will return, for 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.
* the argument {@code className} is the string {@code java.util.Map$Entry} (note the {@code $} sign).
* </p>
*
* @param className the className to get the short name for. It has to be formatted as returned by
Expand Down