svn commit: r922255 - in /incubator/lcf/trunk/modules/connectors/solr/connector/org/apache/lcf/agents/output/solr: HttpPoster.java SolrConnector.java

[kw...@apache.org]

Author: kwright
Date: Fri Mar 12 13:52:48 2010
New Revision: 922255

URL: http://svn.apache.org/viewvc?rev=922255&view=rev
Log:
Fix javadoc warnings.

Modified:
    incubator/lcf/trunk/modules/connectors/solr/connector/org/apache/lcf/agents/output/solr/HttpPoster.java
    incubator/lcf/trunk/modules/connectors/solr/connector/org/apache/lcf/agents/output/solr/SolrConnector.java

Modified: incubator/lcf/trunk/modules/connectors/solr/connector/org/apache/lcf/agents/output/solr/HttpPoster.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/solr/connector/org/apache/lcf/agents/output/solr/HttpPoster.java?rev=922255&r1=922254&r2=922255&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/solr/connector/org/apache/lcf/agents/output/solr/HttpPoster.java (original)
+++ incubator/lcf/trunk/modules/connectors/solr/connector/org/apache/lcf/agents/output/solr/HttpPoster.java Fri Mar 12 13:52:48 2010
@@ -429,8 +429,8 @@ public class HttpPoster
 
   /**
   * Get the response code of the post
-  * @param stream the stream the response is going to come from
-  * @return the response string
+  * @param in the stream the response is going to come from
+  * @return the response details.
   * @throws LCFException
   */
   protected CodeDetails getResponse(InputStream in) throws LCFException, ServiceInterruption

Modified: incubator/lcf/trunk/modules/connectors/solr/connector/org/apache/lcf/agents/output/solr/SolrConnector.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/solr/connector/org/apache/lcf/agents/output/solr/SolrConnector.java?rev=922255&r1=922254&r2=922255&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/solr/connector/org/apache/lcf/agents/output/solr/SolrConnector.java (original)
+++ incubator/lcf/trunk/modules/connectors/solr/connector/org/apache/lcf/agents/output/solr/SolrConnector.java Fri Mar 12 13:52:48 2010
@@ -177,7 +177,7 @@ public class SolrConnector extends org.a
   *@param outputDescription is the description string that was constructed for this document by the getOutputDescription() method.
   *@param document is the document data to be processed (handed to the output data store).
   *@param authorityNameString is the name of the authority responsible for authorizing any access tokens passed in with the repository document.  May be null.
-  *@activities is the handle to an object that the implementer of an output connector may use to perform operations, such as logging processing activity.
+  *@param activities is the handle to an object that the implementer of an output connector may use to perform operations, such as logging processing activity.
   *@return the document status (accepted or permanently rejected).
   */
   public int addOrReplaceDocument(String documentURI, String outputDescription, RepositoryDocument document, String authorityNameString, IOutputAddActivity activities)
@@ -197,7 +197,7 @@ public class SolrConnector extends org.a
   *@param documentURI is the URI of the document.  The URI is presumed to be the unique identifier which the output data store will use to process
   * and serve the document.  This URI is constructed by the repository connector which fetches the document, and is thus universal across all output connectors.
   *@param outputDescription is the last description string that was constructed for this document by the getOutputDescription() method above.
-  *@activities is the handle to an object that the implementer of an output connector may use to perform operations, such as logging processing activity.
+  *@param activities is the handle to an object that the implementer of an output connector may use to perform operations, such as logging processing activity.
   */
   public void removeDocument(String documentURI, String outputDescription, IOutputRemoveActivity activities)
     throws LCFException, ServiceInterruption
@@ -290,10 +290,10 @@ public class SolrConnector extends org.a
   }
 
   /** Unstuffer for unpacking lists of variable length.
+  *@param output is the output array to put the unpacked values into.
   *@param value is the value to unpack.
   *@param startPosition is the place to start the unpack.
   *@param delimiter is the character to use between values.
-  *@param endChar is the character to use to mark the end.
   *@return the next position beyond the end of the list.
   */
   protected static int unpackList(ArrayList output, String value, int startPosition, char delimiter)