Skip to content

Commit 2621600

Browse files
authored
Fix/classutils outdated javadocs (#1410)
* [javadoc] Correct `human-readable` in ClassUtils Correct `human-readable` instead of `human readable`. * [javadoc] Update parameter `name` in `getCanonicalName` method * [javadoc] Fix opening parenthesis in ClassUtils * [javadoc] Fix repeated word in ClassUtils * [javadoc] Fix closing parenthesis in ClassUtils
1 parent c8dffbd commit 2621600

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/main/java/org/apache/commons/lang3/ClassUtils.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
* </p>
4242
*
4343
* <p>
44-
* The notion of a {@code canonical name} includes the human readable name for the type, for example {@code int[]}. The
44+
* The notion of a {@code canonical name} includes the human-readable name for the type, for example {@code int[]}. The
4545
* non-canonical method variants work with the JVM names, such as {@code [I}.
4646
* </p>
4747
*
@@ -474,7 +474,7 @@ public static String getCanonicalName(final Object object, final String valueIfN
474474
* </ul>
475475
* </p>
476476
*
477-
* @param className the name of class.
477+
* @param name the name of class.
478478
* @return canonical form of class name.
479479
*/
480480
private static String getCanonicalName(final String name) {
@@ -767,7 +767,7 @@ static Class<?> getPrimitiveClass(final String className) {
767767
/**
768768
* Gets the desired Method much like {@code Class.getMethod}, however it ensures that the returned Method is from a
769769
* public class or interface and not from an anonymous inner class. This means that the Method is invokable and doesn't
770-
* fall foul of Java bug <a href="https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4071957">4071957</a>).
770+
* fall foul of Java bug (<a href="https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4071957">4071957</a>).
771771
*
772772
* <pre>
773773
* {@code Set set = Collections.unmodifiableSet(...);
@@ -984,7 +984,7 @@ public static String getShortClassName(final Object object, final String valueIf
984984
* </p>
985985
*
986986
* <p>
987-
* The difference is is significant only in case of classes that are inner classes of some other classes. In this case
987+
* The difference is significant only in case of classes that are inner classes of some other classes. In this case
988988
* the separator between the outer and inner class (possibly on multiple hierarchy level) has to be {@code $} (dollar
989989
* sign) and not {@code .} (dot), as it is returned by {@code Class.getName()}
990990
* </p>
@@ -997,7 +997,7 @@ public static String getShortClassName(final Object object, final String valueIf
997997
* <p>
998998
* Note that this method differs from {@link #getSimpleName(Class)} in that this will return, for example
999999
* {@code "Map.Entry"} whilst the {@link Class} variant will simply return {@code "Entry"}. In this example
1000-
* the argument {@code className} is the string {@code java.util.Map$Entry} (note the {@code $} sign.
1000+
* the argument {@code className} is the string {@code java.util.Map$Entry} (note the {@code $} sign).
10011001
* </p>
10021002
*
10031003
* @param className the className to get the short name for. It has to be formatted as returned by

0 commit comments

Comments
 (0)