Skip to content

Commit 446a37a

Browse files
author
geompokon@csd.auth.gr
committed
Javadoc corrections
more concise class doc fixed regex description of toString() (did not consider lack of final space before) fixed broken link in default constructor pointing to private field
1 parent 2f56f75 commit 446a37a

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

src/main/java/gr/geompokon/bitarray/BitArray.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@
2222
* Class that models an array of {@code Booleans} with the {@link java.util.List} interface.
2323
*
2424
* <p>
25-
* The aim of this class is to enhance the performance of common operations such as {@code add}, {@code remove} and
26-
* {@code set} while also minimizing its memory footprint. This class was made explicitly to replace {@link java.util.ArrayList}
27-
* when working with {@code Boolean} elements.
25+
* This class was made explicitly to replace {@link java.util.ArrayList} when working with {@code Boolean} elements.
26+
* It aims to enhance the performance of common operations such as {@code add}, {@code remove} and {@code set} while
27+
* also minimizing its memory footprint.
2828
* </p>
2929
*
3030
* <p>
@@ -78,7 +78,7 @@ public final class BitArray extends AbstractList<Boolean> implements RandomAcces
7878
private int elements;
7979

8080
/**
81-
* Default constructor. Sets initial capacity to {@link #DEFAULT_CAPACITY}.
81+
* Default constructor. Sets initial capacity to 64
8282
*/
8383
public BitArray() {
8484
this(DEFAULT_CAPACITY);
@@ -515,9 +515,9 @@ public BitArray clone() {
515515
*
516516
* <p>
517517
* The string consists of the number of elements in the array and a list of the elements in a human readable
518-
* format. Exact representation is "Size = SIZE, [((0 | 1) + ' ')*]" where SIZE is a non negative integer and
519-
* the list of elements consists of opening square brackets ([), zero or more bits (single digit ones or zeros)
520-
* separated by spaces and closing square brackets.
518+
* format. Exact representation is "Size = SIZE, [(((0 | 1) + ' ')* (0 | 1))?]" where SIZE is a non negative integer
519+
* and '+' is the concatenation operator. The list of elements consists of opening square brackets ([), zero or more
520+
* bits (single digit ones or zeros) separated by spaces and closing square brackets.
521521
* </p>
522522
* <p>
523523
* Examples:<br>

0 commit comments

Comments
 (0)