svn commit: r821162 - /incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java

[sc...@apache.org]

Author: schor
Date: Fri Oct  2 20:36:04 2009
New Revision: 821162

URL: http://svn.apache.org/viewvc?rev=821162&view=rev
Log:
UIMA-985 fix javadoc comments.

Modified:
    incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java

Modified: incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java?rev=821162&r1=821161&r2=821162&view=diff
==============================================================================
--- incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java (original)
+++ incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java Fri Oct  2 20:36:04 2009
@@ -891,14 +891,14 @@
   /**
    * Get the document text.
    * 
-   * @return The text being analyzed.
+   * @return The text being analyzed, or <code>null</code> if not set.
    */
   String getDocumentText();
 
   /**
    * Get the Sofa Data String (a.k.a. the document text).
    * 
-   * @return The Sofa data string.
+   * @return The Sofa data string, or <code>null</code> if not set.
    */
   String getSofaDataString();
 
@@ -935,7 +935,7 @@
   /**
    * Get the Sofa data array.
    * 
-   * @return The Sofa Data being analyzed.
+   * @return The Sofa Data being analyzed, or <code>null</code> if not set.
    */
   FeatureStructure getSofaDataArray();
 
@@ -955,14 +955,14 @@
   /**
    * Get the Sofa data array.
    * 
-   * @return The Sofa Data being analyzed.
+   * @return The Sofa URI being analyzed, or <code>null</code> if not set.
    */
   String getSofaDataURI();
 
   /**
    * Get the Sofa data as a byte stream.
    * 
-   * @return A stream handle to the Sofa Data.
+   * @return A stream handle to the Sofa Data, or <code>null</code> if not set.
    */
   InputStream getSofaDataStream();