Updated pom.xml with required licensing info and attempted to produce javadocs.

java/pom.xml

@@ -15,8 +15,14 @@ Licensed under the MIT License.
 
   <name>Microsoft Azure Cosmos Serialization API</name>
   <description>This package contains Microsoft Azure Serialization API for Azure Cosmos DB</description>
-  <url>https://github.com/Azure/azure-sdk-for-java</url>
+  <url>https://github.com/microsoft/HybridRow</url>
-
+  <licenses>
+    <license>
+      <name>MIT License</name>
+      <url>http://www.opensource.org/licenses/mit-license.php</url>
+    </license>
+  </licenses>
+  
   <distributionManagement>
     <repository>
       <name>azure-cosmos-serialization</name>
@@ -44,7 +50,7 @@ Licensed under the MIT License.
   </repositories>
 
   <scm>
-    <url>https://github.com/Azure/azure-sdk-for-java</url>
+    <url>https://github.com/microsoft/HybridRow</url>
   </scm>
 
   <properties>

java/src/main/java/com/azure/data/cosmos/serialization/hybridrow/RowBuffer.java

@@ -444,6 +444,7 @@ public final class RowBuffer {
      * Read the value of a {@code FixedBinary} field at the given {@code offset} within this {@link RowBuffer}.
      *
      * @param offset offset of a {@code FixedBinary} field within this {@link RowBuffer}.
+     * @param length number of bytes to read.
      * @return the {@code FixedBinary} value read.
      */
     public ByteBuf readFixedBinary(int offset, int length) {
@@ -1093,6 +1094,8 @@ public final class RowBuffer {
 
     /**
      * The resolver for UDTs.
+     *
+     * @return reference to the resolver for UDTs.
      */
     public LayoutResolver resolver() {
         return this.resolver;

java/src/main/java/com/azure/data/cosmos/serialization/hybridrow/RowCursor.java

@@ -245,6 +245,8 @@ public final class RowCursor implements Cloneable {
 
     /**
      * The layout describing the contents of the scope, or {@code null} if the scope is unschematized.
+     *
+     * @return layout describing the context of the scope, or {@code null} if the scope is unschematized.
      */
     public Layout layout() {
         return this.layout;
@@ -256,8 +258,9 @@ public final class RowCursor implements Cloneable {
     }
 
     /**
-     * If existing, the offset to the metadata of the existing field, otherwise the location to.
+     * If existing, offset to the metadata of the existing field, otherwise the location to insert a new field.
-     * insert a new field.
+     *
+     * @return offset to the metadata of an existing field or the location to insert a new field.
      */
     public int metaOffset() {
         return this.metaOffset;
@@ -270,6 +273,8 @@ public final class RowCursor implements Cloneable {
 
     /**
      * If existing, the offset scope relative path for reading.
+     *
+     * @return If existing, the offset scope relative path for reading.
      */
     public int pathOffset() {
         return this.pathOffset;
@@ -282,6 +287,8 @@ public final class RowCursor implements Cloneable {
 
     /**
      * If existing, the layout string token of scope relative path for reading.
+     *
+     * @return If existing, the layout string token of scope relative path for reading.
      */
     public int pathToken() {
         return this.pathToken;
@@ -294,6 +301,8 @@ public final class RowCursor implements Cloneable {
 
     /**
      * The kind of scope within which this edit was prepared.
+     *
+     * @return The kind of scope within which this edit was prepared.
      */
     public LayoutTypeScope scopeType() {
         return this.scopeType;
@@ -306,6 +315,8 @@ public final class RowCursor implements Cloneable {
 
     /**
      * The type parameters of the scope within which this edit was prepared.
+     *
+     * @return The type parameters of the scope within which this edit was prepared.
      */
     public TypeArgumentList scopeTypeArgs() {
         return this.scopeTypeArgs;
@@ -317,7 +328,9 @@ public final class RowCursor implements Cloneable {
     }
 
     /**
-     * The 0-based byte offset from the beginning of the row where the first sparse field within the scope begins.
+     * The 0-based offset from the beginning of the row where the first sparse field within the scope begins.
+     *
+     * @return 0-based offset from the beginning of the row where the first sparse field within the scope begins.
      */
     public int start() {
         return this.start;
@@ -362,6 +375,8 @@ public final class RowCursor implements Cloneable {
 
     /**
      * If existing, the offset to the value of the existing field, otherwise undefined.
+     *
+     * @return If existing, the offset to the value of the existing field, otherwise undefined.
      */
     public int valueOffset() {
         return this.valueOffset;
@@ -374,6 +389,8 @@ public final class RowCursor implements Cloneable {
 
     /**
      * If existing, the scope relative path for writing.
+     *
+     * @return If existing, the scope relative path for writing.
      */
     public UtfAnyString writePath() {
         return this.writePath;
@@ -384,7 +401,9 @@ public final class RowCursor implements Cloneable {
     }
 
     /**
-     * If WritePath is tokenized, then its token.
+     * If {@link #writePath} is tokenized, then its token.
+     *
+     * @return if {@link #writePath} is tokenized, then its token.
      */
     public StringToken writePathToken() {
         return this.writePathToken;

java/src/main/java/com/azure/data/cosmos/serialization/hybridrow/RowCursors.java

@@ -60,10 +60,13 @@ public final class RowCursors {
     }
 
     /**
-     * Returns an equivalent scope that is read-only.
+     * An equivalent scope that is read-only.
+     *
+     * @param source source scope.
+     * @return an equivalent scope that is read-only.
      */
-    public static RowCursor asReadOnly(RowCursor src) {
+    public static RowCursor asReadOnly(RowCursor source) {
-        return src.clone().immutable(true);
+        return source.clone().immutable(true);
     }
 
     /**
@@ -71,6 +74,9 @@ public final class RowCursors {
      * <p>
      * The two cursors will have independent and unconnected lifetimes after cloning.  However, mutations to a
      * {@link RowBuffer} can invalidate any active cursors over the same row.
+     *
+     * @param source source cursor.
+     * @return copy of the source cursor.
      */
     public static RowCursor copy(RowCursor source) {
         return source.clone();