Skip to content

Commit

Permalink
Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Feb 5, 2025
1 parent 9923a60 commit 7e8eb00
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
*/

/**
* Assists in creating consistent {@code equals(Object)}, {@code toString()}, {@code hashCode()}, and {@code compareTo(Object)} methods.
* Provides classes to create consistent {@code equals(Object)}, {@code toString()}, {@code hashCode()}, and {@code compareTo(Object)} methods.
* These classes are not thread-safe.
*
* <p>When you write a {@link Object#hashCode() hashCode()}, do you check Bloch's Effective Java? No?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
*/

/**
* Extends {@link java.math} for business mathematical classes.
* Provides {@link java.math} extensions for business mathematical classes.
* This package is intended for business mathematical use, not scientific use.
* See <a href="https://commons.apache.org/proper/commons-math/">Commons Math</a> for a more complete set of mathematical classes.
* These classes are immutable, and therefore thread-safe.
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/apache/commons/lang3/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
*/

/**
* Provides highly reusable static utility methods, chiefly concerned with adding value to the {@link java.lang} classes.
* Provides highly reusable utility methods, chiefly concerned with adding value to the {@link java.lang} classes.
* Most of these classes are immutable and thus thread-safe.
* However {@link org.apache.commons.lang3.CharSet} is not currently guaranteed thread-safe under all circumstances.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
*/

/**
* Accumulates common high-level uses of the {@code java.lang.reflect} APIs.
* <p>These classes are immutable, and therefore thread-safe.</p>
* Provides high-level uses of the {@code java.lang.reflect} APIs.
* <p>These classes are immutable and thread-safe.</p>
*
* @since 3.0
*/
Expand Down
14 changes: 7 additions & 7 deletions src/main/java/org/apache/commons/lang3/text/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,17 @@
*/

/**
* Deprecated: Provides classes for handling and manipulating text, partly as an extension to {@link java.text}. The classes in this package are, for the most part,
* intended to be instantiated (i.e. they are not utility classes with lots of static methods).
* <strong>Deprecated</strong>: Provides classes for handling and manipulating text, partly as an extension to {@link java.text}. The classes in this package
* are, for the most part, intended to be instantiated (i.e. they are not utility classes with lots of static methods).
*
* <p>
* Amongst other classes, the text package provides a replacement for {@link StringBuffer} named {@link org.apache.commons.lang3.text.StrBuilder}, a
* class for substituting variables within a String named {@link org.apache.commons.lang3.text.StrSubstitutor} and a replacement for
* {@link java.util.StringTokenizer} named {@link org.apache.commons.lang3.text.StrTokenizer}. While somewhat ungainly, the {@code Str} prefix has been used to
* ensure we don't clash with any current or future standard Java classes.
* Amongst other classes, the text package provides a replacement for {@link StringBuffer} named {@link org.apache.commons.lang3.text.StrBuilder}, a class for
* substituting variables within a String named {@link org.apache.commons.lang3.text.StrSubstitutor} and a replacement for {@link java.util.StringTokenizer}
* named {@link org.apache.commons.lang3.text.StrTokenizer}. While somewhat ungainly, the {@code Str} prefix has been used to ensure we don't clash with any
* current or future standard Java classes.
* </p>
* <p>
* <strong>Deprecated</strong> As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use the Apache Commons Text
* <strong>Deprecated</strong>: As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use the Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/package-summary.html"> text package</a>.
* </p>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@
*/

/**
* Deprecated: Provides text translation routines from a set of smaller building blocks. Initially created to make it possible for the user to customize the
* rules in the StringEscapeUtils class.
* <strong>Deprecated</strong>: Provides text translation routines from a set of smaller building blocks. Initially created to make it possible for the user to
* customize the rules in the StringEscapeUtils class.
* <p>
* These classes are immutable, and therefore thread-safe.
* </p>
* <p>
* <strong>Deprecated</strong> As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use the Apache Commons Text
* <strong>Deprecated</strong>: As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use the Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/package-summary.html"> translate package</a>.
* </p>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
*/

/**
* Tuple classes, both mutable and immutable {@link Pair} and {@link Triple}.
* Provides tuple classes, both mutable and immutable {@link Pair} and {@link Triple}.
*
* @since 3.0
*/
Expand Down

0 comments on commit 7e8eb00

Please sign in to comment.