Improved doc comments - resolves #14 and resolves #16 [skip ci]

Co-authored-by: cho-thinkfree-com <117076481+cho-thinkfree-com@users.noreply.github.com>

Author: ankane

src/main/java/com/pgvector/PGbit.java

@@ -19,14 +19,14 @@ public class PGbit extends PGobject implements PGBinaryObject, Serializable, Clo
     private byte[] data;
 
     /**
-     * Constructor
+     * @hidden
      */
     public PGbit() {
         type = "bit";
     }
 
     /**
-     * Constructor
+     * Creates a bit string from a boolean array
      *
      * @param v boolean array
      */
@@ -40,7 +40,7 @@ public PGbit(boolean[] v) {
     }
 
     /**
-     * Constructor
+     * Creates a bit string from a byte array
      *
      * @param v byte array
      */
@@ -51,7 +51,7 @@ public PGbit(byte[] v) {
     }
 
     /**
-     * Constructor
+     * Creates a bit string from a text representation
      *
      * @param s text representation of a bit string
      * @throws SQLException exception

src/main/java/com/pgvector/PGhalfvec.java

@@ -20,14 +20,14 @@ public class PGhalfvec extends PGobject implements Serializable, Cloneable {
     private float[] vec;
 
     /**
-     * Constructor
+     * @hidden
      */
     public PGhalfvec() {
         type = "halfvec";
     }
 
     /**
-     * Constructor
+     * Creates a half vector from an array
      *
      * @param v float array
      */
@@ -37,7 +37,7 @@ public PGhalfvec(float[] v) {
     }
 
     /**
-     * Constructor
+     * Creates a half vector from a list
      *
      * @param <T> number
      * @param v list of numbers
@@ -56,7 +56,7 @@ public <T extends Number> PGhalfvec(List<T> v) {
     }
 
     /**
-     * Constructor
+     * Creates a half vector from a text representation
      *
      * @param s text representation of a half vector
      * @throws SQLException exception

src/main/java/com/pgvector/PGsparsevec.java

@@ -22,14 +22,14 @@ public class PGsparsevec extends PGobject implements PGBinaryObject, Serializabl
     private float[] values;
 
     /**
-     * Constructor
+     * @hidden
      */
     public PGsparsevec() {
         type = "sparsevec";
     }
 
     /**
-     * Constructor
+     * Creates a sparse vector from an array
      *
      * @param v float array
      */
@@ -58,7 +58,7 @@ public PGsparsevec(float[] v) {
     }
 
     /**
-     * Constructor
+     * Creates a sparse vector from a list
      *
      * @param <T> number
      * @param v list of numbers
@@ -95,7 +95,9 @@ public <T extends Number> PGsparsevec(List<T> v) {
     }
 
     /**
-     * Constructor
+     * Creates a sparse vector from a map of non-zero elements
+     * <p>
+     * Indices start at 0
      *
      * @param <T> number
      * @param map map of non-zero elements
@@ -126,7 +128,7 @@ public <T extends Number> PGsparsevec(Map<Integer, T> map, int dimensions) {
     }
 
     /**
-     * Constructor
+     * Creates a sparse vector from a text representation
      *
      * @param s text representation of a sparse vector
      * @throws SQLException exception

src/main/java/com/pgvector/PGvector.java

@@ -18,14 +18,14 @@ public class PGvector extends PGobject implements PGBinaryObject, Serializable,
     private float[] vec;
 
     /**
-     * Constructor
+     * @hidden
      */
     public PGvector() {
         type = "vector";
     }
 
     /**
-     * Constructor
+     * Creates a vector from an array
      *
      * @param v float array
      */
@@ -35,7 +35,7 @@ public PGvector(float[] v) {
     }
 
     /**
-     * Constructor
+     * Creates a vector from a list
      *
      * @param <T> number
      * @param v list of numbers
@@ -54,7 +54,7 @@ public <T extends Number> PGvector(List<T> v) {
     }
 
     /**
-     * Constructor
+     * Creates a vector from a text representation
      *
      * @param s text representation of a vector
      * @throws SQLException exception