svn commit: r1521119 - in /uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/service/impl: AnalysisEngineServiceAdapter.java AnalysisEngineService_impl.java ServiceDataCargo.java

[sc...@apache.org]

Author: schor
Date: Mon Sep  9 14:14:42 2013
New Revision: 1521119

URL: http://svn.apache.org/r1521119
Log:
[UIMA-3256] fixup Javadocs

Modified:
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/service/impl/AnalysisEngineServiceAdapter.java
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/service/impl/AnalysisEngineService_impl.java
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/service/impl/ServiceDataCargo.java

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/service/impl/AnalysisEngineServiceAdapter.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/service/impl/AnalysisEngineServiceAdapter.java?rev=1521119&r1=1521118&r2=1521119&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/service/impl/AnalysisEngineServiceAdapter.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/service/impl/AnalysisEngineServiceAdapter.java Mon Sep  9 14:14:42 2013
@@ -46,8 +46,8 @@ import org.apache.uima.util.UimaTimer;
  * know whether it is calling a local AnalysisEngine or a remote service.
  * <p>
  * Subclasses must provide an implementation of the {@link #initialize(ResourceSpecifier,Map)}
- * method, which must create an {@link AnalysisEngineStub} object that can communicate with the
- * remote service. The stub must be passed to the {@link #setStub(AnalysisEngineStub)} method of
+ * method, which must create an {@link AnalysisEngineServiceStub} object that can communicate with the
+ * remote service. The stub must be passed to the {@link #setStub(AnalysisEngineServiceStub)} method of
  * this class.
  * 
  * 

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/service/impl/AnalysisEngineService_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/service/impl/AnalysisEngineService_impl.java?rev=1521119&r1=1521118&r2=1521119&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/service/impl/AnalysisEngineService_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/service/impl/AnalysisEngineService_impl.java Mon Sep  9 14:14:42 2013
@@ -56,8 +56,7 @@ public class AnalysisEngineService_impl 
   /**
    * Initialize this service. This is where the CAS pool is created.
    * 
-   * @see org.apache.uima.resource.service.impl.ResourceService_impl#initialize(org.apache.uima.resource.ResourceSpecifier,
-   *      int, java.util.Map, int)
+   * @see org.apache.uima.resource.service.impl.ResourceService_impl#initialize(ResourceSpecifier, Map)
    */
   public void initialize(ResourceSpecifier aResourceSpecifier, Map<String, Object> aResourceInitParams)
           throws ResourceInitializationException {

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/service/impl/ServiceDataCargo.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/service/impl/ServiceDataCargo.java?rev=1521119&r1=1521118&r2=1521119&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/service/impl/ServiceDataCargo.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/service/impl/ServiceDataCargo.java Mon Sep  9 14:14:42 2013
@@ -45,9 +45,9 @@ import org.apache.uima.util.ProcessTrace
  * <code>ServiceDataCargo</code> and send that to the remote service.
  * <p>
  * A <code>ServiceDataCargo</code> can be unmarshalled into an existing
- * <code>AnalysisProcessData</code> by calling the {@link #unmarshalInto(AnalysisProcessData)}
+ * <code>AnalysisProcessData</code> by calling the {@link #unmarshalInto(AnalysisProcessData, boolean)}
  * method. Alternatively, the CAS state can be unmarshalled separately by calling the
- * {@link #unmarshalCas(CAS)} method.
+ * {@link #unmarshalCas(CAS, boolean)} method.
  * 
  * 
  */
@@ -110,10 +110,11 @@ public class ServiceDataCargo implements
    * <code>CAS</code> instance. The data in the exsiting CAS will be replaced by the CAS data in
    * this object.
    * 
-   * @param aDataContainer
-   *          the AnalysisProcessData to unmarshal into
+   * @param aCas the CAS to unmarshal into
+   * @param aReplaceCasTypeSystem if true, assumes serialized data contains the type system
+   * @throws CASException
    */
-  public void unmarshalCas(CAS aCas, boolean aReplaceCasTypeSystem) throws CASException {
+   public void unmarshalCas(CAS aCas, boolean aReplaceCasTypeSystem) throws CASException {
     CASMgr casMgr = (CASMgr) aCas;
     if (aReplaceCasTypeSystem) {
       Serialization.deserializeCASComplete(mCasSer, casMgr);