Merge pull request #22 from dhendriks/18-release-2.0

#18 More JavaDoc fixes to fix release build.

Author: dhendriks

src/main/java/com/github/javabdd/BDDFactory.java

@@ -770,7 +770,7 @@ public void save(String filename, BDD var) throws IOException {
      * </p>
      *
      * @param out writer
-     * @praam r BDD
+     * @param r BDD
      * @throws IOException In case of an I/O error.
      */
     public void save(BufferedWriter out, BDD r) throws IOException {
@@ -798,6 +798,12 @@ public void save(BufferedWriter out, BDD r) throws IOException {
 
     /**
      * Helper function for save().
+     *
+     * @param out writer
+     * @param visited visited nodes bitset
+     * @param root root BDD
+     * @return bitset index
+     * @throws IOException In case of an I/O error.
      */
     protected int save_rec(BufferedWriter out, BitSet visited, BDD root) throws IOException {
         if (root.isZero()) {

src/main/java/com/github/javabdd/BDDPairing.java

@@ -15,6 +15,9 @@ public abstract class BDDPairing {
      * <p>
      * Compare to bdd_setpair.
      * </p>
+     *
+     * @param oldvar old variable
+     * @param newvar new variable
      */
     public abstract void set(int oldvar, int newvar);
 
@@ -24,6 +27,9 @@ public abstract class BDDPairing {
      * <p>
      * Compare to bdd_setpairs.
      * </p>
+     *
+     * @param oldvar old variables
+     * @param newvar new variables
      */
     public void set(int[] oldvar, int[] newvar) {
         if (oldvar.length != newvar.length) {
@@ -44,6 +50,9 @@ public void set(int[] oldvar, int[] newvar) {
      * <p>
      * Compare to bdd_setbddpair.
      * </p>
+     *
+     * @param oldvar old variable
+     * @param newvar new BDD
      */
     public abstract void set(int oldvar, BDD newvar);
 
@@ -53,6 +62,9 @@ public void set(int[] oldvar, int[] newvar) {
      * <p>
      * Compare to bdd_setbddpairs.
      * </p>
+     *
+     * @param oldvar old variables
+     * @param newvar new BDDs
      */
     public void set(int[] oldvar, BDD[] newvar) {
         if (oldvar.length != newvar.length) {
@@ -70,6 +82,9 @@ public void set(int[] oldvar, BDD[] newvar) {
      * <p>
      * Compare to fdd_setpair.
      * </p>
+     *
+     * @param p1 first finite domain block
+     * @param p2 second finite domain block
      */
     public void set(BDDDomain p1, BDDDomain p2) {
         int[] ivar1 = p1.vars();
@@ -83,6 +98,9 @@ public void set(BDDDomain p1, BDDDomain p2) {
      * <p>
      * Compare to fdd_setpairs.
      * </p>
+     *
+     * @param p1 first finite domain blocks
+     * @param p2 second finite domain blocks
      */
     public void set(BDDDomain[] p1, BDDDomain[] p2) {
         if (p1.length != p2.length) {

src/main/java/com/github/javabdd/BitString.java

@@ -43,6 +43,9 @@ public final class BitString implements Cloneable, java.io.Serializable {
 
     /**
      * Convert bitIndex to a subscript into the bits[] array.
+     *
+     * @param bitIndex bit index
+     * @return subscript
      */
     private static int subscript(int bitIndex) {
         return bitIndex >> BITS_PER_UNIT;
@@ -63,6 +66,8 @@ public BitString(int nbits) {
 
     /**
      * Returns the first index in the bit string which is set, or -1 if there is no such index.
+     *
+     * @return the first index
      */
     public int firstSet() {
         return firstSet(-1);
@@ -73,6 +78,7 @@ public int firstSet() {
      * index.
      *
      * @param where the starting point for the search. May be negative.
+     * @return the first index
      */
     public int firstSet(int where) {
         // convert exclusive starting point to inclusive starting point
@@ -175,6 +181,7 @@ public static final int bsr(int v) {
      * index.
      *
      * @param where the starting point for the search.
+     * @return last index
      */
     public int lastSet(int where) {
         // convert exclusive starting point to inclusive starting point
@@ -199,6 +206,8 @@ public int lastSet(int where) {
 
     /**
      * Returns the last index in the bit string which is set, or -1 if there is no such index.
+     *
+     * @return last index
      */
     public int lastSet() {
         return lastSet(size());
@@ -291,6 +300,7 @@ public void clear(int bit) {
      * Gets a bit.
      *
      * @param bit the bit to be gotten (zero-based)
+     * @return the bit
      */
     public boolean get(int bit) {
         int n = subscript(bit);
@@ -302,6 +312,7 @@ public boolean get(int bit) {
      * modified in response to the operation.
      *
      * @param set the bit set to be ANDed with
+     * @return modified
      */
     public boolean and(BitString set) {
         if (this == set) { // should help alias analysis
@@ -322,6 +333,7 @@ public boolean and(BitString set) {
      * modified in response to the operation.
      *
      * @param set the bit set to be ORed with
+     * @return modified
      */
     public boolean or(BitString set) {
         if (this == set) { // should help alias analysis
@@ -342,6 +354,7 @@ public boolean or(BitString set) {
      * modified in response to the operation.
      *
      * @param set the bit set to be ORed with
+     * @return modified
      */
     public boolean or_upTo(BitString set, int bit) {
         if (this == set) { // should help alias analysis
@@ -365,6 +378,7 @@ public boolean or_upTo(BitString set, int bit) {
      * modified in response to the operation.
      *
      * @param set the bit set to be XORed with
+     * @return modified
      */
     public boolean xor(BitString set) {
         int setLength = set.bits.length;
@@ -382,6 +396,7 @@ public boolean xor(BitString set) {
      * was modified in response to the operation.
      *
      * @param set the bit set to subtract
+     * @return modified
      */
     public boolean minus(BitString set) {
         int n = bits.length;
@@ -398,6 +413,7 @@ public boolean minus(BitString set) {
      * Check if the intersection of the two sets is empty.
      *
      * @param other the set to check intersection with
+     * @return is empty or not
      */
     public boolean intersectionEmpty(BitString other) {
         int n = bits.length;
@@ -413,6 +429,7 @@ public boolean intersectionEmpty(BitString other) {
      * Check if this set contains all bits of the given set.
      *
      * @param other the set to check containment with
+     * @return contains or not
      */
     public boolean contains(BitString other) {
         int n = bits.length;
@@ -523,6 +540,8 @@ public int hashCode() {
     /**
      * Returns the "logical size" of this <code>BitString</code>: the index of the highest set bit in the
      * <code>BitString</code> plus one. Returns zero if the <code>BitString</code> contains no set bits.
+     *
+     * @return logical size
      */
     public int length() {
         return lastSet() + 1;
@@ -531,6 +550,8 @@ public int length() {
     /**
      * Returns the number of bits of space actually in use by this <code>BitString</code> to represent bit values. The
      * maximum element in the set is the size - 1st element. The minimum element in the set is the zero'th element.
+     *
+     * @return number of bits
      */
     public int size() {
         return bits.length << BITS_PER_UNIT;
@@ -656,6 +677,8 @@ public String toString() {
 
     /**
      * Returns an iterator that iterates through the bits in forward order.
+     *
+     * @return an iterator
      */
     public ForwardBitStringIterator iterator() {
         return new ForwardBitStringIterator();
@@ -667,13 +690,17 @@ public ForwardBitStringZeroIterator zeroIterator() {
 
     /**
      * Returns an iterator that iterates through the bits in backward order.
+     *
+     * @return an iterator
      */
     public BackwardBitStringIterator backwardsIterator() {
         return new BackwardBitStringIterator();
     }
 
     /**
      * Returns an iterator that iterates through the bits in backward order, starting at the given index.
+     *
+     * @return an iterator
      */
     public BackwardBitStringIterator backwardsIterator(int i) {
         return new BackwardBitStringIterator(i);
@@ -685,6 +712,8 @@ public BackwardBitStringIterator backwardsIterator(int i) {
     public abstract static class BitStringIterator implements Iterator<Integer> {
         /**
          * Returns the index of the next bit set.
+         *
+         * @return the index
          */
         public abstract int nextIndex();
 

src/main/java/com/github/javabdd/TryVarOrder.java

@@ -299,7 +299,6 @@ public void free() {
     /** File pointers for output and input BDDs. */
     File f0, f1, f2, f3;
 
-    /** Construct a new TryVarOrder. */
     public TryVarOrder(int nodeTableSize, int cacheSize, int maxIncrease, long bestTime, long delayTime) {
         this.bestCalcTime = bestTime;
         // this.nodeTableSize = b1.getFactory().getAllocNum();
@@ -388,6 +387,7 @@ public void writeBDDConfig(BDDFactory bdd, String fileName) throws IOException {
     /**
      * Try out a variable order.
      *
+     * @param factory BDD factory name
      * @param reverse whether to reverse the bits
      * @param varOrder variable order to try
      * @return time spent, or Long.MAX_VALUE if it didn't terminate