Skip to content

Commit

Permalink
Further tweaks to package-info for collect:
Browse files Browse the repository at this point in the history
- Provide a one-sentence intro to lead into the sections.
- Describe the immutable collections in full sentences.
- Sort the static utility classes alphabetically.
- Make one mention of "collection" plural.

RELNOTES=n/a
PiperOrigin-RevId: 546010744
  • Loading branch information
cpovirk authored and Google Java Core Libraries committed Jul 6, 2023
1 parent 2a82a51 commit fa695a1
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 18 deletions.
21 changes: 12 additions & 9 deletions android/guava/src/com/google/common/collect/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@
* Collection interfaces and implementations, and other utilities for collections. This package is a
* part of the open-source <a href="https://github.com/google/guava">Guava</a> library.
*
* <p>The classes in this package include:
*
* <h2>Immutable collections</h2>
*
* Implementations of JDK and Guava collection types whose contents will never change, and which
* offer a few additional guarantees. For details, see {@link ImmutableCollection}.
* These are collections whose contents will never change. They also offer a few additional
* guarantees (see {@link ImmutableCollection} for details). Implementations are available for both
* the JDK collection types and the Guava collection types (listed below).
*
* <h2>Collection types</h2>
*
Expand Down Expand Up @@ -75,20 +78,20 @@
* <h2>Classes of static utility methods</h2>
*
* <ul>
* <li>{@link Comparators}
* <li>{@link Collections2}
* <li>{@link Iterators}
* <li>{@link Comparators}
* <li>{@link Iterables}
* <li>{@link Iterators}
* <li>{@link Lists}
* <li>{@link Maps}
* <li>{@link MoreCollectors}
* <li>{@link Queues}
* <li>{@link Sets}
* <li>{@link Multisets}
* <li>{@link Multimaps}
* <li>{@link Tables}
* <li>{@link Multisets}
* <li>{@link ObjectArrays}
* <li>{@link Queues}
* <li>{@link Sets}
* <li>{@link Streams}
* <li>{@link Tables}
* </ul>
*
* <h2>Abstract implementations</h2>
Expand All @@ -102,7 +105,7 @@
*
* <h2>Forwarding collections</h2>
*
* We provide implementations of collection that forward all method calls to a delegate collection
* We provide implementations of collections that forward all method calls to a delegate collection
* by default. Subclasses can override one or more methods to implement the decorator pattern. For
* an example, see {@link ForwardingCollection}.
*
Expand Down
21 changes: 12 additions & 9 deletions guava/src/com/google/common/collect/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@
* Collection interfaces and implementations, and other utilities for collections. This package is a
* part of the open-source <a href="https://github.com/google/guava">Guava</a> library.
*
* <p>The classes in this package include:
*
* <h2>Immutable collections</h2>
*
* Implementations of JDK and Guava collection types whose contents will never change, and which
* offer a few additional guarantees. For details, see {@link ImmutableCollection}.
* These are collections whose contents will never change. They also offer a few additional
* guarantees (see {@link ImmutableCollection} for details). Implementations are available for both
* the JDK collection types and the Guava collection types (listed below).
*
* <h2>Collection types</h2>
*
Expand Down Expand Up @@ -75,20 +78,20 @@
* <h2>Classes of static utility methods</h2>
*
* <ul>
* <li>{@link Comparators}
* <li>{@link Collections2}
* <li>{@link Iterators}
* <li>{@link Comparators}
* <li>{@link Iterables}
* <li>{@link Iterators}
* <li>{@link Lists}
* <li>{@link Maps}
* <li>{@link MoreCollectors}
* <li>{@link Queues}
* <li>{@link Sets}
* <li>{@link Multisets}
* <li>{@link Multimaps}
* <li>{@link Tables}
* <li>{@link Multisets}
* <li>{@link ObjectArrays}
* <li>{@link Queues}
* <li>{@link Sets}
* <li>{@link Streams}
* <li>{@link Tables}
* </ul>
*
* <h2>Abstract implementations</h2>
Expand All @@ -102,7 +105,7 @@
*
* <h2>Forwarding collections</h2>
*
* We provide implementations of collection that forward all method calls to a delegate collection
* We provide implementations of collections that forward all method calls to a delegate collection
* by default. Subclasses can override one or more methods to implement the decorator pattern. For
* an example, see {@link ForwardingCollection}.
*
Expand Down

0 comments on commit fa695a1

Please sign in to comment.