Skip to content

Commit

Permalink
Update package-info for common.base.
Browse files Browse the repository at this point in the history
- Remove classes that became obsolete because of JDK features, and point out that general trend.
- Move rarely used `Defaults` down to the end, alongside a new mention of rarely used `Utf8`.
- Add commonly used `StandardSystemProperty` and `Verify`.

RELNOTES=n/a
PiperOrigin-RevId: 540592401
  • Loading branch information
cpovirk authored and Google Java Core Libraries committed Jun 15, 2023
1 parent 65c7f10 commit 03e2792
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 40 deletions.
40 changes: 20 additions & 20 deletions android/guava/src/com/google/common/base/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -20,40 +20,40 @@
*
* <h2>Contents</h2>
*
* <h3>String-related utilities</h3>
* The classes in this package that are most commonly useful are:
*
* <h3>String utilities</h3>
*
* <ul>
* <li>{@link com.google.common.base.Ascii}
* <li>{@link com.google.common.base.CaseFormat}
* <li>{@link com.google.common.base.CharMatcher}
* <li>{@link com.google.common.base.Charsets}
* <li>{@link com.google.common.base.Joiner}
* <li>{@link com.google.common.base.Splitter}
* <li>{@link com.google.common.base.Strings}
* <li>{@link Ascii}
* <li>{@link CaseFormat}
* <li>{@link CharMatcher}
* <li>{@link Splitter}
* <li>{@link Strings}
* </ul>
*
* <h3>Function types</h3>
*
* <ul>
* <li>{@link com.google.common.base.Function}, {@link com.google.common.base.Functions}
* <li>{@link com.google.common.base.Predicate}, {@link com.google.common.base.Predicates}
* <li>{@link com.google.common.base.Equivalence}
* <li>{@link com.google.common.base.Converter}
* <li>{@link com.google.common.base.Supplier}, {@link com.google.common.base.Suppliers}
* <li>{@link Converter}
* <li>{@link Equivalence}
* </ul>
*
* <h3>Other</h3>
*
* <ul>
* <li>{@link com.google.common.base.Defaults}
* <li>{@link com.google.common.base.Enums}
* <li>{@link com.google.common.base.Objects}
* <li>{@link com.google.common.base.Optional}
* <li>{@link com.google.common.base.Preconditions}
* <li>{@link com.google.common.base.Stopwatch}
* <li>{@link com.google.common.base.Throwables}
* <li>{@link Enums}
* <li>{@link Preconditions}
* <li>{@link StandardSystemProperty}
* <li>{@link Stopwatch}
* <li>{@link Throwables}
* <li>{@link Verify}
* </ul>
*
* <h3>The rest</h3>
*
* This package also contains some classes with niche use cases (e.g., {@link Utf8} and {@link
* Defaults}), as well as a number of classes that have been superseded by additions to the JDK.
*/
@CheckReturnValue
@ParametersAreNonnullByDefault
Expand Down
40 changes: 20 additions & 20 deletions guava/src/com/google/common/base/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -20,40 +20,40 @@
*
* <h2>Contents</h2>
*
* <h3>String-related utilities</h3>
* The classes in this package that are most commonly useful are:
*
* <h3>String utilities</h3>
*
* <ul>
* <li>{@link com.google.common.base.Ascii}
* <li>{@link com.google.common.base.CaseFormat}
* <li>{@link com.google.common.base.CharMatcher}
* <li>{@link com.google.common.base.Charsets}
* <li>{@link com.google.common.base.Joiner}
* <li>{@link com.google.common.base.Splitter}
* <li>{@link com.google.common.base.Strings}
* <li>{@link Ascii}
* <li>{@link CaseFormat}
* <li>{@link CharMatcher}
* <li>{@link Splitter}
* <li>{@link Strings}
* </ul>
*
* <h3>Function types</h3>
*
* <ul>
* <li>{@link com.google.common.base.Function}, {@link com.google.common.base.Functions}
* <li>{@link com.google.common.base.Predicate}, {@link com.google.common.base.Predicates}
* <li>{@link com.google.common.base.Equivalence}
* <li>{@link com.google.common.base.Converter}
* <li>{@link com.google.common.base.Supplier}, {@link com.google.common.base.Suppliers}
* <li>{@link Converter}
* <li>{@link Equivalence}
* </ul>
*
* <h3>Other</h3>
*
* <ul>
* <li>{@link com.google.common.base.Defaults}
* <li>{@link com.google.common.base.Enums}
* <li>{@link com.google.common.base.Objects}
* <li>{@link com.google.common.base.Optional}
* <li>{@link com.google.common.base.Preconditions}
* <li>{@link com.google.common.base.Stopwatch}
* <li>{@link com.google.common.base.Throwables}
* <li>{@link Enums}
* <li>{@link Preconditions}
* <li>{@link StandardSystemProperty}
* <li>{@link Stopwatch}
* <li>{@link Throwables}
* <li>{@link Verify}
* </ul>
*
* <h3>The rest</h3>
*
* This package also contains some classes with niche use cases (e.g., {@link Utf8} and {@link
* Defaults}), as well as a number of classes that have been superseded by additions to the JDK.
*/
@CheckReturnValue
@ParametersAreNonnullByDefault
Expand Down

0 comments on commit 03e2792

Please sign in to comment.