You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2013/09/09 16:21:38 UTC

svn commit: r1521128 - in /uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util: AnalysisEnginePool.java CharArrayString.java GraphNode.java IntSet.java ResourcePool.java TextAnalysisEnginePool.java XMLUtils.java

Author: schor
Date: Mon Sep  9 14:21:37 2013
New Revision: 1521128

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

Modified:
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/AnalysisEnginePool.java
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/CharArrayString.java
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/GraphNode.java
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/IntSet.java
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/ResourcePool.java
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/TextAnalysisEnginePool.java
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/XMLUtils.java

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/AnalysisEnginePool.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/AnalysisEnginePool.java?rev=1521128&r1=1521127&r2=1521128&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/AnalysisEnginePool.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/AnalysisEnginePool.java Mon Sep  9 14:21:37 2013
@@ -107,7 +107,7 @@ public class AnalysisEnginePool {
    * Checks in an AnalysisEngine to the pool. Also notifies other Threads that may be waiting for a
    * connection.
    * 
-   * @param aResource
+   * @param aAE
    *          the resource to release
    */
   public void releaseAnalysisEngine(AnalysisEngine aAE) {
@@ -179,7 +179,7 @@ public class AnalysisEnginePool {
 //  }
   
   /**
-   * @see org.apache.uima.analysis_engine.MultithreadableAnalysisEngine#reconfigure()
+   * @see org.apache.uima.resource.ConfigurableResource#reconfigure()
    */
   public synchronized void reconfigure() throws ResourceConfigurationException {
     // reconfigure each AnalysisEngine in the pool

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/CharArrayString.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/CharArrayString.java?rev=1521128&r1=1521127&r2=1521128&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/CharArrayString.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/CharArrayString.java Mon Sep  9 14:21:37 2013
@@ -391,7 +391,7 @@ public class CharArrayString {
   /**
    * Check for equality with another CharArrayString.
    * 
-   * @param s
+   * @param o
    *          The other string.
    * @return <code>true</code> iff the two strings are equal.
    */

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/GraphNode.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/GraphNode.java?rev=1521128&r1=1521127&r2=1521128&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/GraphNode.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/GraphNode.java Mon Sep  9 14:21:37 2013
@@ -83,7 +83,7 @@ public class GraphNode {
   /**
    * Add a new successor node.
    * 
-   * @param dtr
+   * @param succ
    *          The node to be added.
    */
   public void addSuccessor(GraphNode succ) {

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/IntSet.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/IntSet.java?rev=1521128&r1=1521127&r2=1521128&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/IntSet.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/IntSet.java Mon Sep  9 14:21:37 2013
@@ -85,7 +85,7 @@ public class IntSet {
    * overflows. If the sums are not equal, the two sets cannot be equal. In case the sums are equal,
    * the two sets are compared element by element.
    * 
-   * @param s
+   * @param o
    *          the set to be tested for equality with this set.
    * @return <code>true</code> if the sets are equal, <code>false</code> otherwise.
    */

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/ResourcePool.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/ResourcePool.java?rev=1521128&r1=1521127&r2=1521128&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/ResourcePool.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/ResourcePool.java Mon Sep  9 14:21:37 2013
@@ -40,7 +40,7 @@ import org.apache.uima.util.Level;
  * <p>
  * This resource pool implementation does not deal with differently configured resources in the same
  * pool. All resources are assumed to be equivalent and to share the same metadata. Therefore, the
- * resource metadata can be retrieved via the {@link #getMetaDAta()} method without checking out a
+ * resource metadata can be retrieved via the {@link #getMetaData()} method without checking out a
  * Resource instance from the pool.
  * 
  * 

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/TextAnalysisEnginePool.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/TextAnalysisEnginePool.java?rev=1521128&r1=1521127&r2=1521128&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/TextAnalysisEnginePool.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/TextAnalysisEnginePool.java Mon Sep  9 14:21:37 2013
@@ -22,6 +22,7 @@ package org.apache.uima.internal.util;
 import java.util.Map;
 
 import org.apache.uima.analysis_engine.TextAnalysisEngine;
+import org.apache.uima.resource.Resource;
 import org.apache.uima.resource.ResourceInitializationException;
 import org.apache.uima.resource.ResourceSpecifier;
 
@@ -63,7 +64,7 @@ public class TextAnalysisEnginePool exte
    *          specifier that describes how to create the Resource instances for the pool
    * @param aResourceInitParams
    *          additional parameters to be passed to
-   *          {@link Resource#initialize(ResourceSpecifier,Map)} methods. May be null if there are
+   *          {@link Resource#initialize(ResourceSpecifier, Map)} methods. May be null if there are
    *          no parameters.
    * 
    * @throws ResourceInitializationException
@@ -89,7 +90,7 @@ public class TextAnalysisEnginePool exte
   /**
    * Checks in a TAE to the pool. Also notifies other Threads that may be waiting for a connection.
    * 
-   * @param aResource
+   * @param aTAE
    *          the resource to release
    */
   public void releaseTAE(TextAnalysisEngine aTAE) {

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/XMLUtils.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/XMLUtils.java?rev=1521128&r1=1521127&r2=1521128&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/XMLUtils.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/XMLUtils.java Mon Sep  9 14:21:37 2013
@@ -268,7 +268,7 @@ public abstract class XMLUtils {
 
   /**
    * Reads a primitive value from its standard DOM representation. (This is the representation
-   * produced by {@link #writePrimitiveValue(Object, ContentHandler)}.
+   * produced by {@link #writePrimitiveValue(Object, Writer)}.
    * <p>
    * This is intended to be used for Java Strings and wrappers for primitive value classes (e.g.
    * Integer, Boolean).