diff options
author | cpovirk <cpovirk@google.com> | 2023-07-14 18:07:14 -0700 |
---|---|---|
committer | Google Java Core Libraries <java-core-libraries-team+copybara@google.com> | 2023-07-14 18:09:50 -0700 |
commit | a9c2970e1cdff1e71a27a75866b083f3ae60d6f2 (patch) | |
tree | 8a63b5caadcc0082a1c55e47569d7b66f97dbc4d | |
parent | 934446b8cb77cb52c5ddcb8959fd619f4505b785 (diff) | |
download | guava-a9c2970e1cdff1e71a27a75866b083f3ae60d6f2.tar.gz |
Add an overview to our generated Javadoc.
And remove the end of an HTML closing tag that was never started in `EventBus.java`.
RELNOTES=n/a
PiperOrigin-RevId: 548265592
-rw-r--r-- | README.md | 4 | ||||
-rw-r--r-- | android/guava/pom.xml | 1 | ||||
-rw-r--r-- | guava/pom.xml | 1 | ||||
-rw-r--r-- | guava/src/com/google/common/eventbus/EventBus.java | 4 | ||||
-rw-r--r-- | overview.html | 11 |
5 files changed, 19 insertions, 2 deletions
@@ -4,12 +4,16 @@ [![Build Status](https://github.com/google/guava/workflows/CI/badge.svg?branch=master)](https://github.com/google/guava/actions) [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7197/badge)](https://bestpractices.coreinfrastructure.org/projects/7197) +<!-- LINT.IfChange --> + Guava is a set of core Java libraries from Google that includes new collection types (such as multimap and multiset), immutable collections, a graph library, and utilities for concurrency, I/O, hashing, primitives, strings, and more! It is widely used on most Java projects within Google, and widely used by many other companies as well. +<!-- LINT.ThenChange(overview.html) --> + Guava comes in two flavors: * The JRE flavor requires JDK 1.8 or higher. diff --git a/android/guava/pom.xml b/android/guava/pom.xml index c6f1f3830..9b03bdddb 100644 --- a/android/guava/pom.xml +++ b/android/guava/pom.xml @@ -198,6 +198,7 @@ <links> <link>https://errorprone.info/api/latest/</link> </links> + <overview>../../overview.html</overview> </configuration> <executions> <execution> diff --git a/guava/pom.xml b/guava/pom.xml index c7c39a749..e1a5fe527 100644 --- a/guava/pom.xml +++ b/guava/pom.xml @@ -198,6 +198,7 @@ <links> <link>https://errorprone.info/api/latest/</link> </links> + <overview>../overview.html</overview> </configuration> <executions> <execution> diff --git a/guava/src/com/google/common/eventbus/EventBus.java b/guava/src/com/google/common/eventbus/EventBus.java index 7ca671686..f739fa7d1 100644 --- a/guava/src/com/google/common/eventbus/EventBus.java +++ b/guava/src/com/google/common/eventbus/EventBus.java @@ -27,7 +27,7 @@ import java.util.logging.Logger; /** * Dispatches events to listeners, and provides ways for listeners to register themselves. - + * <!-- LINT.IfChange(avoid) --> * * <h2>Avoid EventBus</h2> * @@ -83,7 +83,7 @@ import java.util.logging.Logger; * to <a href="https://github.com/google/guava/issues/3311">more verbose</a>. * </ul> * - --> + * <!-- LINT.ThenChange(README.md:avoid) --> * * <h2>EventBus Summary</h2> * diff --git a/overview.html b/overview.html new file mode 100644 index 000000000..b9cb1a9e4 --- /dev/null +++ b/overview.html @@ -0,0 +1,11 @@ +<body> +<!-- LINT.IfChange --> +Guava is a set of core Java libraries from Google that includes new collection +types (such as multimap and multiset), immutable collections, a graph library, +and utilities for concurrency, I/O, hashing, primitives, strings, and more! It +is widely used on most Java projects within Google, and widely used by many +other companies as well. +<!-- LINT.ThenChange(README.md) --> + +<p>For more information, see <a href="https://guava.dev/">guava.dev</a>. +</body> |