Prepare for 321 release: javadoc fixes

Author: colinduplantis

cluster/cluster-core/src/main/java/org/marketcetera/cluster/service/AbstractClusterService.java

@@ -547,10 +547,10 @@ protected ClusterWorkUnitDescriptor generateWorkUnitDescriptor(ClusterWorkUnitSp
      * Returns a candidate that suits the given work unit spec if one exists.
      *
      * @param inWorkUnitSpec a <code>ClusterWorkUnitSpec</code> value
-     * @return an <code>Object</code> value
-     * @throws InvocationTargetException 
-     * @throws IllegalArgumentException 
-     * @throws IllegalAccessException 
+     * @return an <code>Object</code> value or <code>null</code>
+     * @throws InvocationTargetException if the candidate cannot be instantiated
+     * @throws IllegalArgumentException if an error occurs finding the candidate
+     * @throws IllegalAccessException if the candidate cannot be instatiated
      */
     protected Object findCandidateFor(ClusterWorkUnitSpec inWorkUnitSpec)
             throws IllegalAccessException, IllegalArgumentException, InvocationTargetException
@@ -590,10 +590,10 @@ protected void activateWorkUnit(Object inCandidate)
      * Finds a candidate bean for the given work unit spec and activates it.
      *
      * @param inWorkUnitSpec a <code>ClusterWorkUnitSpec</code> value
-     * @return an <code>Object</code>value
-     * @throws InvocationTargetException
-     * @throws IllegalArgumentException
-     * @throws IllegalAccessException
+     * @return an <code>Object</code>value or <code>null</code>
+     * @throws InvocationTargetException if the work unit cannot be activated
+     * @throws IllegalArgumentException if an error occurs finding the work unit
+     * @throws IllegalAccessException if the work unit cannot be activated
      */
     protected Object findAndActivateWorkUnit(ClusterWorkUnitSpec inWorkUnitSpec)
             throws IllegalAccessException, IllegalArgumentException, InvocationTargetException
@@ -723,6 +723,8 @@ protected Map<String,Object> findAllBeansWith(Class<? extends Annotation> inAnno
     /**
      * Gets the annotation of the given type from the given argument.
      *
+     * @param <Clazz> the class of the given object
+     * @param <AnnotationClazz> the type of the given annotation
      * @param inInstance an <code>Object</code> value
      * @param inAnnotation a <code>Class&lt;AnnotationClazz&gt;</code> value
      * @return an <code>AnnotationClazz</code> value
@@ -859,6 +861,7 @@ protected void logClusterMetaData()
     /**
      * Marshals the given value as XML.
      *
+     * @param <Clazz> the type of the provided data
      * @param inData a <code>Clazz</code> value
      * @return a <code>String</code> value
      * @throws JAXBException if the given object cannot be marshaled

fix/fix-acceptor/src/main/java/org/marketcetera/fix/acceptor/DynamicAcceptorSessionProvider.java

@@ -38,6 +38,7 @@ public class DynamicAcceptorSessionProvider
      * @param inApplication an <code>Application</code> value
      * @param inSessionService a <code>SessionService</code> value
      * @param inFixSettingsProviderFactory a <code>FixSettingsProviderFactory</code> value
+     * @param inClusterData a <code>ClusterData</code> value
      */
     public DynamicAcceptorSessionProvider(Application inApplication,
                                           SessionService inSessionService,

fork/commons-csv/src/java/org/apache/commons/csv/CSVStrategy.java

@@ -59,8 +59,10 @@ public CSVStrategy(char delimiter, char encapsulator, char commentStart) {
      * @param delimiter a Char used for value separation
      * @param encapsulator a Char used as value encapsulation marker
      * @param commentStart a Char used for comment identification
+     * @param escape a Char used to escape other chars
      * @param ignoreLeadingWhitespace TRUE when leading whitespaces should be
      *                                ignored
+     * @param ignoreTrailingWhitespace TRUE when trailing whitespaces should be ignored
      * @param interpretUnicodeEscapes TRUE when unicode escapes should be 
      *                                interpreted
      * @param ignoreEmptyLines TRUE when the parser should skip emtpy lines

modules/marketdata/csv/pom.xml

@@ -73,8 +73,8 @@
         <version>3.2.0</version>
         <configuration>
           <links>
-            <link>http://commons.apache.org/sandbox/csv/apidocs/</link>
-            <link>http://repo.marketcetera.org/javadoc/1.5.0/platform/</link>
+            <link>https://javadoc.io/doc/org.apache.commons/commons-csv/latest/index.html</link>
+            <link>https://repo.marketcetera.org/javadoc/3.2.1/platform</link>
           </links>
         </configuration>
       </plugin>

modules/marketdata/marketcetera/src/main/java/org/marketcetera/marketdata/marketcetera/MarketceteraFeed.java

@@ -432,8 +432,8 @@ private MarketceteraFeed(String inProviderName)
      * 
      * @param inProviderName a <code>String</code> value
      * @return a <code>MarketceteraFeed</code> value
-     * @throws CoreException 
-     * @throws URISyntaxException 
+     * @throws CoreException if the instance cannot be retrieved
+     * @throws URISyntaxException if the provider name cannot be parsed
      */
     public static MarketceteraFeed getInstance(String inProviderName)
         throws URISyntaxException, CoreException

modules/marketdata/marketdata-core/src/main/java/org/marketcetera/marketdata/core/webservice/ConnectionException.java

@@ -6,7 +6,7 @@
 /* $License$ */
 
 /**
- *
+ * Indicates an error occurred trying to connect to a remote source.
  *
  * @author <a href="mailto:[email protected]">Colin DuPlantis</a>
  * @version $Id$
@@ -24,8 +24,8 @@ public ConnectionException()
     /**
      * Create a new ConnectionException instance.
      *
-     * @param inHostname
-     * @param inPort
+     * @param inHostname a <code>String</code> value
+     * @param inPort an <code>int</code> value
      */
     public ConnectionException(String inHostname,
                                int inPort)
@@ -84,7 +84,7 @@ public void setHostname(String inHostname)
     /**
      * Get the port value.
      *
-     * @return a <code>int</code> value
+     * @return an <code>int</code> value
      */
     public int getPort()
     {
@@ -93,18 +93,18 @@ public int getPort()
     /**
      * Sets the port value.
      *
-     * @param inPort a <code>int</code> value
+     * @param inPort an <code>int</code> value
      */
     public void setPort(int inPort)
     {
         port = inPort;
     }
     /**
-     * 
+     * hostname value
      */
     private String hostname;
     /**
-     * 
+     * port value
      */
     private int port;
     private static final long serialVersionUID = 8121822556635716771L;

modules/marketdata/marketdata-core/src/main/java/org/marketcetera/marketdata/core/webservice/MarketDataService.java

@@ -90,7 +90,7 @@ long getLastUpdate(@WebParam(name="context")ClientContext inContext,
      * @param inContext a <code>ClientContext</code> value
      * @param inRequestIds a <code>List&lt;Long&gt;</code> value
      * @return a <code>Map&lt;Long,LinkedList&lt;Event&gt;&gt;</code> value
-     * @throws RemoteException
+     * @throws RemoteException if an error occurs getting the events
      */
     Map<Long,LinkedList<Event>> getAllEvents(@WebParam(name="context")ClientContext inContext,
                                              @WebParam(name="id")List<Long> inRequestIds)

saclient/src/main/java/org/marketcetera/saclient/rpc/XmlValue.java

@@ -24,7 +24,7 @@ public class XmlValue
     /**
      * Create a new XmlValue instance.
      *
-     * @param inValue
+     * @param inValue an <code>Object</code> value
      */
     public XmlValue(Object inValue)
     {