fix: javadoc #7

yankun1992 · Jul 21, 2023 · ffeeeed · ffeeeed
1 parent a418d17
commit ffeeeed
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -18,6 +18,7 @@ Language: [简体中文](./docs/README.zh_cn.md)
         - [requirements](#requirements)
         - [install](#install)
     - [Rust](#rust)
+    - [Java](#java)
 - [Examples](#examples)
     - [BloomFilter](#bloomfilter)
         - [Python](#python-1)
@@ -58,6 +59,16 @@ pip install fastbloom-rs
 fastbloom-rs = "{latest}"
 ```
 
+## Java
+maven
+```xml
+<dependency>
+    <groupId>io.github.yankun1992</groupId>
+    <artifactId>fastbloom</artifactId>
+    <version>{latest-version}</version>
+</dependency>
+```
+
 # Examples
 
 ## BloomFilter

diff --git a/docs/README.zh_cn.md b/docs/README.zh_cn.md
@@ -17,6 +17,7 @@ Language: [English](../README.md)
         - [requirements](#requirements)
         - [install](#install)
     - [Rust](#rust)
+    - [Java](#java)
 - [例子](#examples)
     - [BloomFilter](#bloomfilter)
         - [Python](#python-1)
@@ -57,6 +58,16 @@ pip install fastbloom-rs
 fastbloom-rs = "{latest}"
 ```
 
+## Java
+maven
+```xml
+<dependency>
+    <groupId>io.github.yankun1992</groupId>
+    <artifactId>fastbloom</artifactId>
+    <version>{latest-version}</version>
+</dependency>
+```
+
 # Examples
 
 ## BloomFilter

diff --git a/fastbloomjvm/src/io/github/yankun1992/bloom/CountingBloomFilter.java b/fastbloomjvm/src/io/github/yankun1992/bloom/CountingBloomFilter.java
@@ -25,7 +25,7 @@
  * A Counting Bloom filter works in a similar manner as a regular Bloom filter; however, it is able to keep track of
  * insertions and deletions. In a counting Bloom filter, each entry in the Bloom filter is a small counter associated
  * with a basic Bloom filter bit.
- * <br/>
+ *
  * <b>Reference</b>: F. Bonomi, M. Mitzenmacher, R. Panigrahy, S. Singh, and G. Varghese, "An Improved Construction
  * for Counting Bloom Filters," in 14th Annual European Symposium on Algorithms, LNCS 4168, 2006
  */