svn commit: r1812410 - in /uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima: cas/ArrayFS.java jcas/cas/FSArray.java jcas/cas/FSList.java jcas/cas/StringList.java

[sc...@apache.org]

Author: schor
Date: Tue Oct 17 14:46:14 2017
New Revision: 1812410

URL: http://svn.apache.org/viewvc?rev=1812410&view=rev
Log:
no Jira fix javadocs

Modified:
    uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ArrayFS.java
    uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray.java
    uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSList.java
    uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/StringList.java

Modified: uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ArrayFS.java
URL: http://svn.apache.org/viewvc/uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ArrayFS.java?rev=1812410&r1=1812409&r2=1812410&view=diff
==============================================================================
--- uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ArrayFS.java (original)
+++ uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ArrayFS.java Tue Oct 17 14:46:14 2017
@@ -31,6 +31,7 @@ public interface ArrayFS<E extends Featu
   /**
    * Get the i-th feature structure from the array.
    * @param i index
+   * @param <U> The class of the item being obtained by the get
    * @return The i-th feature structure.
    * @exception ArrayIndexOutOfBoundsException
    *              If the index is out of bounds.
@@ -79,6 +80,7 @@ public interface ArrayFS<E extends Featu
    *          Where to start copying to in the destination array.
    * @param length
    *          The number of elements to copy.
+   * @param <T> the class of the array being copied into
    * @exception ArrayIndexOutOfBoundsException
    *              If <code>srcOffset &lt; 0</code> or <code>length &gt; size()</code> or
    *              <code>destOffset + length &gt; destArray.length</code>.

Modified: uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray.java
URL: http://svn.apache.org/viewvc/uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray.java?rev=1812410&r1=1812409&r2=1812410&view=diff
==============================================================================
--- uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray.java (original)
+++ uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray.java Tue Oct 17 14:46:14 2017
@@ -253,6 +253,7 @@ public final class FSArray<T extends Fea
    * Convenience - create a FSArray from an existing FeatureStructure[]
    * @param jcas -
    * @param a -
+   * @param <U> the element type of the FSArray, subtype of FeatureStructure
    * @return -
    */
   public static <U extends FeatureStructure> FSArray<U> create(JCas jcas, U[] a) {

Modified: uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSList.java
URL: http://svn.apache.org/viewvc/uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSList.java?rev=1812410&r1=1812409&r2=1812410&view=diff
==============================================================================
--- uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSList.java (original)
+++ uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSList.java Tue Oct 17 14:46:14 2017
@@ -74,7 +74,7 @@ public abstract class FSList<T extends T
     
   /**
    * Treat an FSArray as a source for SelectFSs. 
-   * @param <T> generic type being selected
+   * @param <U> generic type being selected
    * @return a new instance of SelectFSs
    */
   public <U extends T> SelectFSs<U> select() {
@@ -84,7 +84,7 @@ public abstract class FSList<T extends T
   /**
    * Treat an FSArray as a source for SelectFSs. 
    * @param filterByType only includes elements of this type
-   * @param <T> generic type being selected
+   * @param <U> generic type being selected
    * @return a new instance of SelectFSs
    */
   public <U extends T> SelectFSs<U> select(Type filterByType) {
@@ -94,7 +94,7 @@ public abstract class FSList<T extends T
   /**
    * Treat an FSArray as a source for SelectFSs.  
    * @param filterByType only includes elements of this JCas class
-   * @param <T> generic type being selected
+   * @param <U> generic type being selected
    * @return a new instance of SelectFSs
    */
   public <U extends T> SelectFSs<U> select(Class<U> filterByType) {
@@ -104,7 +104,7 @@ public abstract class FSList<T extends T
   /**
    * Treat an FSArray as a source for SelectFSs. 
    * @param filterByType only includes elements of this JCas class's type
-   * @param <T> generic type being selected
+   * @param <U> generic type being selected
    * @return a new instance of SelectFSs
    */
   public <U extends T> SelectFSs<U> select(int filterByType) {
@@ -114,7 +114,7 @@ public abstract class FSList<T extends T
   /**
    * Treat an FSArray as a source for SelectFSs. 
    * @param filterByType only includes elements of this type (fully qualifined type name)
-   * @param <T> generic type being selected
+   * @param <U> generic type being selected
    * @return a new instance of SelectFSs
    */
   public <U extends T> SelectFSs<U> select(String filterByType) {
@@ -125,6 +125,7 @@ public abstract class FSList<T extends T
    * Create an FSList from an existing array of Feature Structures
    * @param jcas the JCas to use
    * @param a the array of Feature Structures to populate the list with
+   * @param <U> the type of FeatureStructures being stored in the FSList being created
    * @return an FSList, with the elements from the array
    */
   public static <U extends TOP> FSList<U> create(JCas jcas, FeatureStructure[] a) {
@@ -153,7 +154,6 @@ public abstract class FSList<T extends T
   }
 
   /**
-   * @param <T> generic type being returned
    * @return a stream over this FSList
    */
   public Stream<T> stream() {

Modified: uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/StringList.java
URL: http://svn.apache.org/viewvc/uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/StringList.java?rev=1812410&r1=1812409&r2=1812410&view=diff
==============================================================================
--- uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/StringList.java (original)
+++ uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/StringList.java Tue Oct 17 14:46:14 2017
@@ -91,7 +91,6 @@ public abstract class StringList extends
   }
   
   /**
-   * @param <T> generic type being returned
    * @return a stream over this FSList
    */
   public Stream<String> stream() {