Bug:19086 JavaDoc improvements

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

Author: nwalsh

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

@@ -97,15 +97,15 @@ public OutputStreamSender get() {
 	/**
 	 * Assigns an output stream sender providing the callback that writes
 	 * content to the database via an output stream.
-	 * @param content	the output stream sender
+	 * @param sender	the output stream sender
 	 */
 	public void set(OutputStreamSender sender) {
 		this.sender = sender;
 	}
     /**
 	 * Assigns an output stream sender providing the callback that writes
 	 * content to the database and returns the handle as a fluent convenience.
-	 * @param content	the output stream sender
+	 * @param sender	the output stream sender
 	 * @return	this handle
      */
 	public OutputStreamHandle with(OutputStreamSender sender) {

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

@@ -49,6 +49,9 @@ public class QueryOptionsListHandle
     private Marshaller marshaller;
     private Unmarshaller unmarshaller;
 
+    /**
+     * The constructor.
+     */
     public QueryOptionsListHandle() {
     	super();
     	super.setFormat(Format.XML);

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

@@ -255,7 +255,7 @@ public String[] getFacetNames() {
      * Returns the query plan associated with this search.
      *
      * <p>Query plans are highly variable and are always returned as a DOM Document.</p>
-     * @return
+     * @return the plan as a DOM Document
      */
     @Override
     public Document getPlan() {

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

@@ -122,7 +122,7 @@ protected void receiveContent(InputStream content) {
      *
      * <p>Calling this method always deletes any cached values.</p>
      *
-     * @param querydef The new QueryDefinition
+     * @param vdef The new ValuesDefinition
      */
     public void setQueryCriteria(ValuesDefinition vdef) {
         valuesdef = vdef;

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

@@ -46,6 +46,9 @@ public class ValuesListHandle
 
     String optionsName = null;
 
+    /**
+     * The constructor.
+     */
     public ValuesListHandle() {
     	super();
     	super.setFormat(Format.XML);
@@ -58,21 +61,47 @@ public ValuesListHandle() {
         }
     }
 
+    /**
+     * Sets the format associated with this handle.
+     *
+     * This handle only supports XML.
+     *
+     * @param format The format, which must be Format.XML or an exception will be raised.
+     */
     @Override
     public void setFormat(Format format) {
         if (format != Format.XML)
         	throw new IllegalArgumentException("ValuesListHandle supports the XML format only");
     }
 
+    /**
+     * Fluent setter for the format associated with this handle.
+     *
+     * This handle only supports XML.
+     *
+     * @param format The format, which must be Format.XML or an exception will be raised.
+     * @return The QueryOptionsListHandle instance on which this method was called.
+     */
     public ValuesListHandle withFormat(Format format) {
         setFormat(format);
         return this;
     }
 
+    /**
+     * Returns the name of the query options used for this query.
+     * @return The options name.
+     */
     public String getOptionsName() {
         return optionsName;
     }
 
+    /**
+     * Sets the name of the query options to be used for this query.
+     *
+     * If no query options node with the specified name exists, the query will fail.
+     *
+     * @param name The name of the saved query options node on the server.
+     */
     public void setOptionsName(String name) {
         optionsName = name;
     }
@@ -97,6 +126,13 @@ protected void receiveContent(InputStream content) {
         }
     }
 
+    /**
+     * Returns a HashMap of the named lexicon configurations.
+     *
+     * The keys are the names of the lexicons, the values are the corresponding URIs on the server.
+     *
+     * @return The map of names to URIs.
+     */
     @Override
     public HashMap<String, String> getValuesMap() {
         return valuesHolder.getValuesMap();