svn commit: r1508997 - /uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/Serialization.java

[sc...@apache.org]

Author: schor
Date: Wed Jul 31 19:31:58 2013
New Revision: 1508997

URL: http://svn.apache.org/r1508997
Log:
[UIMA-3124] fix missing javadoc info on return tags

Modified:
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/Serialization.java

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/Serialization.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/Serialization.java?rev=1508997&r1=1508996&r2=1508997&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/Serialization.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/Serialization.java Wed Jul 31 19:31:58 2013
@@ -97,7 +97,7 @@ public class Serialization {
    * Convert a CAS + the type system and index definitions into a
    * CASCompleteSerializer object
    * @param casMgr
-   * @return
+   * @return a Java Object which is serializable and has both the type system, index definitions, and the CAS contents
    */
   public static CASCompleteSerializer serializeCASComplete(CASMgr casMgr) {
     return new CASCompleteSerializer((CASImpl) casMgr);
@@ -117,7 +117,7 @@ public class Serialization {
    * Deserialize a type system and index repository definition and use to initialize
    * a new instance of a CAS.
    * @param ser
-   * @return
+   * @return the initialized CAS loaded with the deserialized info about the CAS Type systen and Index repositories
    */
   public static CASMgr createCASMgr(CASMgrSerializer ser) {
     return new CASImpl(ser);
@@ -132,7 +132,7 @@ public class Serialization {
    * return the currentview in that Cas.
    * @param casMgr
    * @param casSer
-   * @return
+   * @return the initialized CAS loaded with the deserialized data
    */
   public static CAS createCAS(CASMgr casMgr, CASSerializer casSer) {
     ((CASImpl) casMgr).reinit(casSer);