improve typedoc

Callidon · Nov 5, 2024 · f448b2b · f448b2b
1 parent fc60c02
commit f448b2b
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 5 deletions.
diff --git a/src/bloom/counting-bloom-filter.ts b/src/bloom/counting-bloom-filter.ts
@@ -220,7 +220,7 @@ export default class CountingBloomFilter
 
   /**
    * Check if another Counting Bloom Filter is equal to this one
-   * @param  filter - The filter to compare to this one
+   * @param  other - The filter to compare to this one
    * @return True if they are equal, false otherwise
    */
   public equals(other: CountingBloomFilter): boolean {

diff --git a/src/bloom/partitioned-bloom-filter.ts b/src/bloom/partitioned-bloom-filter.ts
@@ -282,7 +282,7 @@ export default class PartitionedBloomFilter
 
   /**
    * Check if another Partitioned Bloom Filter is equal to this one
-   * @param  filter - The filter to compare to this one
+   * @param  other - The filter to compare to this one
    * @return True if they are equal, false otherwise
    */
   public equals(other: PartitionedBloomFilter): boolean {

diff --git a/src/bloom/xor-filter.ts b/src/bloom/xor-filter.ts
@@ -343,7 +343,7 @@ export default class XorFilter extends BaseFilter {
    * Follow the algorithm 2 and 3 of the paper (@see https://arxiv.org/pdf/1912.08258.pdf)
    * Inspired by Go impl from (@see https://github.com/FastFilter/xorfilter/blob/master/xorfilter.go)
    * @param elements array of elements to add in the filter
-   * @param arraylength length of the filter
+   * @param arrayLength length of the filter
    * @returns
    */
   public _create(elements: XorHashableInput[], arrayLength: number) {

diff --git a/src/iblt/invertible-bloom-lookup-tables.ts b/src/iblt/invertible-bloom-lookup-tables.ts
@@ -278,7 +278,7 @@ export default class InvertibleBloomFilter
 
   /**
    * Substract the filter with another {@link InvertibleBloomFilter}, and returns the resulting filter.
-   * @param  remote - The filter to substract with
+   * @param  iblt - The filter to substract with
    * @return A new InvertibleBloomFilter which is the XOR of the local and remote one
    */
   public substract(iblt: InvertibleBloomFilter): InvertibleBloomFilter {

diff --git a/src/sketch/count-min-sketch.ts b/src/sketch/count-min-sketch.ts
@@ -161,7 +161,7 @@ export default class CountMinSketch
 
   /**
    * Check if another Count Min Sketch is equal to this one
-   * @param  filter - The filter to compare to this one
+   * @param  other - The filter to compare to this one
    * @return True if they are equal, false otherwise
    */
   public equals(other: CountMinSketch): boolean {