Bug:19086 JavaDoc completion

git-svn-id: svn+ssh://svn.marklogic.com/project/engsvn/client-api/java/trunk@113040 62cac252-8da6-4816-9e9d-6dc37b19578c

Author: ehennum

src/main/java/com/marklogic/client/MarkLogicBindingException.java

@@ -18,6 +18,11 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * A Binding Exception indicates a problem converting between a Java object
+ * and XML representation of the data.  The exception may indicate an internal
+ * error.  Please contact MarkLogic support.
+ */
 @SuppressWarnings("serial")
 public class MarkLogicBindingException extends RuntimeException {
 

src/main/java/com/marklogic/client/MarkLogicIOException.java

@@ -15,9 +15,10 @@
  */
 package com.marklogic.client;
 
-
 /**
- * RuntimeException thrown by the Java Client API when a code block internally throws java.lang.IOException.
+ * An IO Exception indicates that there was a problem on input or output (similar
+ * to a java.lang.IOException but defined as a runtime rather than checked
+ * exception).
  */
 @SuppressWarnings("serial")
 public class MarkLogicIOException extends RuntimeException {

src/main/java/com/marklogic/client/UnauthorizedUserException.java

@@ -15,6 +15,11 @@
  */
 package com.marklogic.client;
 
+/**
+ * An Unauthorized User Exception indicates the user is
+ * not recognized by the server.
+ *
+ */
 @SuppressWarnings("serial")
 public class UnauthorizedUserException extends RuntimeException {
 	public UnauthorizedUserException() {

src/main/java/com/marklogic/client/admin/NamespacesManager.java

@@ -28,12 +28,47 @@
  * To use NamespacesManager, an application must authenticate as rest-admin.
  */
 public interface NamespacesManager {
+	/**
+	 * Returns the namespace URI bound to the specified prefix on the server.
+	 * @param prefix	the prefix for the binding
+	 * @return	the namespace URI
+	 */
     public String readPrefix(String prefix) throws ForbiddenUserException, FailedRequestException;
+    /**
+     * Reads all of the namespace bindings from the server.
+     * @return	a namespace context with the bindings
+     */
     public NamespaceContext readAll() throws ForbiddenUserException, FailedRequestException;
+    /**
+     * Creates a namespace binding on the server.
+     * @param prefix	the prefix bound to the URI
+     * @param namespaceURI	the URI bound to the prefix
+     */
     public void addPrefix(String prefix, String namespaceURI) throws ForbiddenUserException, FailedRequestException;
+    /**
+     * Writes a namespace binding on the server.
+     * @param prefix	the prefix bound to the URI
+     * @param namespaceURI	the URI bound to the prefix
+     */
     public void updatePrefix(String prefix, String namespaceURI) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException;
+    /**
+     * Deletes a namespace binding on the server.
+     * @param prefix	the prefix bound to the URI
+     */
     public void deletePrefix(String prefix) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException;
+    /**
+     * Deletes all namespace bindings on the server.
+     */
     public void deleteAll() throws ForbiddenUserException, FailedRequestException;
+    /**
+     * Starts debugging client requests. You can suspend and resume debugging output
+     * using the methods of the logger.
+     * 
+     * @param logger	the logger that receives debugging output
+     */
     public void startLogging(RequestLogger logger);
+    /**
+     *  Stops debugging client requests.
+     */
     public void stopLogging();
 }

src/main/java/com/marklogic/client/io/BaseHandle.java

@@ -28,8 +28,8 @@
  * Write handles send content to the server and must implement the sendContent() method.
  * A handle can support both read and write operations.
  *
- * @param <R>
- * @param <W>
+ * @param <R>	a read handle or OperationNotSupported in the com.marklogic.client.io.marker package
+ * @param <W>	a write handle or OperationNotSupported in the com.marklogic.client.io.marker package
  */
 public abstract class BaseHandle<R,W>
     extends HandleImplementation<R,W>
@@ -38,6 +38,9 @@ public abstract class BaseHandle<R,W>
 	private String mimetype;
 	private long length = UNKNOWN_LENGTH;
 
+	/**
+	 * Zero-argument constructor.
+	 */
 	public BaseHandle() {
 		super();
 	}