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
saquib1928 · Jul 15, 2023 · a9c2970 · a9c2970
1 parent 934446b
commit a9c2970
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -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
@@ -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
@@ -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
@@ -27,7 +27,7 @@
 
 /**
  * Dispatches events to listeners, and provides ways for listeners to register themselves.
-
+ * <!-- LINT.IfChange(avoid) -->
  *
  * <h2>Avoid EventBus</h2>
  *
@@ -83,7 +83,7 @@
  *       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
@@ -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>