[COLLECTIONS-857] Update documentation to match bloomfilter

garydgregory · garydgregory · commit 45cd71153959 · 2024-11-15T10:11:32.000-05:00
implementation
diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/package-info.java b/src/main/java/org/apache/commons/collections4/bloomfilter/package-info.java
@@ -37,8 +37,8 @@
  *
  * <h3>BloomFilter</h3>
  *
- * <p>The Bloom filter architecture here is designed for speed of execution, so some methods like {@code merge}, {@code remove},
- * {@code add}, and {@code subtract} may throw exceptions. Once an exception is thrown the state of the Bloom filter is unknown.
+ * <p>The Bloom filter architecture here is designed for speed of execution, so some methods like {@link org.apache.commons.collections4.bloomfilter.CountingBloomFilter}'s
+ * {@code merge}, {@code remove}, {@code add}, and {@code subtract} may throw exceptions. Once an exception is thrown the state of the Bloom filter is unknown.
  * The choice to use not use atomic transactions was made to achieve maximum performance under correct usage.</p>
  *
  * <h4>Nomenclature</h4>

Original file line number	Diff line number	Diff line change
`@@ -37,8 +37,8 @@`
`37`	`37`	`*`
`38`	`38`	`* <h3>BloomFilter</h3>`
`39`	`39`	`*`
`40`		`- * <p>The Bloom filter architecture here is designed for speed of execution, so some methods like {@code merge}, {@code remove},`
`41`		`- * {@code add}, and {@code subtract} may throw exceptions. Once an exception is thrown the state of the Bloom filter is unknown.`
	`40`	`+ * <p>The Bloom filter architecture here is designed for speed of execution, so some methods like {@link org.apache.commons.collections4.bloomfilter.CountingBloomFilter}'s`
	`41`	`+ * {@code merge}, {@code remove}, {@code add}, and {@code subtract} may throw exceptions. Once an exception is thrown the state of the Bloom filter is unknown.`
`42`	`42`	`* The choice to use not use atomic transactions was made to achieve maximum performance under correct usage.</p>`
`43`	`43`	`*`
`44`	`44`	`* <h4>Nomenclature</h4>`