Add docs for TreeRangeMap, including @since tag for the copyOf …

…method from cl/682878547. RELNOTES=n/a PiperOrigin-RevId: 698541136
google · Nov 20, 2024 · 4d4b29c · 4d4b29c
1 parent 27bb9c2
commit 4d4b29c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/android/guava/src/com/google/common/collect/TreeRangeMap.java b/android/guava/src/com/google/common/collect/TreeRangeMap.java
@@ -57,10 +57,16 @@ public final class TreeRangeMap<K extends Comparable, V> implements RangeMap<K,
 
   private final NavigableMap<Cut<K>, RangeMapEntry<K, V>> entriesByLowerBound;
 
+  /** Returns a new, empty {@link TreeRangeMap}. */
   public static <K extends Comparable, V> TreeRangeMap<K, V> create() {
     return new TreeRangeMap<>();
   }
 
+  /**
+   * Returns a new {@link TreeRangeMap} containing the same ranges as the given {@code RangeMap}.
+   *
+   * @since NEXT
+   */
   @SuppressWarnings("unchecked")
   public static <K extends Comparable<?>, V> TreeRangeMap<K, V> copyOf(
       RangeMap<K, ? extends V> rangeMap) {

diff --git a/guava/src/com/google/common/collect/TreeRangeMap.java b/guava/src/com/google/common/collect/TreeRangeMap.java
@@ -59,10 +59,16 @@ public final class TreeRangeMap<K extends Comparable, V> implements RangeMap<K,
 
   private final NavigableMap<Cut<K>, RangeMapEntry<K, V>> entriesByLowerBound;
 
+  /** Returns a new, empty {@link TreeRangeMap}. */
   public static <K extends Comparable, V> TreeRangeMap<K, V> create() {
     return new TreeRangeMap<>();
   }
 
+  /**
+   * Returns a new {@link TreeRangeMap} containing the same ranges as the given {@code RangeMap}.
+   *
+   * @since NEXT
+   */
   @SuppressWarnings("unchecked")
   public static <K extends Comparable<?>, V> TreeRangeMap<K, V> copyOf(
       RangeMap<K, ? extends V> rangeMap) {