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/26 20:24:34 UTC

svn commit: r1526640 - in /uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima: UIMAFramework.java analysis_engine/AnalysisEngine.java analysis_engine/impl/AnalysisEngineDescription_impl.java resource/metadata/impl/ConfigurationParameter_impl.java

Author: schor
Date: Thu Sep 26 18:24:34 2013
New Revision: 1526640

URL: http://svn.apache.org/r1526640
Log:
no Jira fix spelling errors in javadoc crossrefs

Modified:
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/UIMAFramework.java
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngine.java
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/AnalysisEngineDescription_impl.java
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/ConfigurationParameter_impl.java

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/UIMAFramework.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/UIMAFramework.java?rev=1526640&r1=1526639&r2=1526640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/UIMAFramework.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/UIMAFramework.java Thu Sep 26 18:24:34 2013
@@ -232,7 +232,7 @@ public abstract class UIMAFramework {
    *          {@link Resource#initialize(ResourceSpecifier,Map)} method. May be <code>null</code>
    *          if there are no parameters. Parameter names are defined as constants on the
    *          {@link AnalysisEngine}, and {@link Resource}.
-   *          Furthermore, the entry under the key {@link Resource.PARAM_PERFORMANCE_TUNING_SETTINGS}
+   *          Furthermore, the entry under the key {@link Resource#PARAM_PERFORMANCE_TUNING_SETTINGS}
    *          is a map which may contain settings with keys defined as constants here {@link UIMAFramework} interfaces. 
    *          For example this can be used to set
    *          performance-tuning settings as described in
@@ -262,7 +262,7 @@ public abstract class UIMAFramework {
    *          {@link Resource#initialize(ResourceSpecifier,Map)} method. May be <code>null</code>
    *          if there are no parameters. Parameter names are defined as constants on the
    *          {@link AnalysisEngine}, and {@link Resource}.
-   *          Furthermore, the entry under the key {@link Resource.PARAM_PERFORMANCE_TUNING_SETTINGS}
+   *          Furthermore, the entry under the key {@link Resource#PARAM_PERFORMANCE_TUNING_SETTINGS}
    *          is a map which may contain settings with keys defined as constants here {@link UIMAFramework} interfaces. 
    *          For example this can be used to set
    *          performance-tuning settings as described in
@@ -303,7 +303,7 @@ public abstract class UIMAFramework {
    *          {@link Resource#initialize(ResourceSpecifier,Map)} method. May be <code>null</code>
    *          if there are no parameters. Parameter names are defined as constants on the
    *          {@link AnalysisEngine}, and {@link Resource}.
-   *          Furthermore, the entry under the key {@link Resource.PARAM_PERFORMANCE_TUNING_SETTINGS}
+   *          Furthermore, the entry under the key {@link Resource#PARAM_PERFORMANCE_TUNING_SETTINGS}
    *          is a map which may contain settings with keys defined as constants here {@link UIMAFramework} interfaces. 
    *          For example this can be used to set
    *          performance-tuning settings as described in
@@ -386,7 +386,7 @@ public abstract class UIMAFramework {
    *          {@link Resource#initialize(ResourceSpecifier,Map)} method. May be <code>null</code>
    *          if there are no parameters. Parameter names are defined as constants on the
    *          {@link AnalysisEngine}, and {@link Resource}.
-   *          Furthermore, the entry under the key {@link Resource.PARAM_PERFORMANCE_TUNING_SETTINGS}
+   *          Furthermore, the entry under the key {@link Resource#PARAM_PERFORMANCE_TUNING_SETTINGS}
    *          is a map which may contain settings with keys defined as constants here {@link UIMAFramework} interfaces. 
    *          For example this can be used to set
    *          performance-tuning settings as described in
@@ -426,7 +426,7 @@ public abstract class UIMAFramework {
    *          {@link Resource#initialize(ResourceSpecifier,Map)} method. May be <code>null</code>
    *          if there are no parameters. Parameter names are defined as constants on the
    *          {@link AnalysisEngine}, and {@link Resource}.
-   *          Furthermore, the entry under the key {@link Resource.PARAM_PERFORMANCE_TUNING_SETTINGS}
+   *          Furthermore, the entry under the key {@link Resource#PARAM_PERFORMANCE_TUNING_SETTINGS}
    *          is a map which may contain settings with keys defined as constants here {@link UIMAFramework} interfaces. 
    *          For example this can be used to set
    *          performance-tuning settings as described in
@@ -539,7 +539,7 @@ public abstract class UIMAFramework {
    *          {@link Resource#initialize(ResourceSpecifier,Map)} method. May be <code>null</code>
    *          if there are no parameters. Parameter names are defined as constants on the
    *          {@link AnalysisEngine}, and {@link Resource}.
-   *          Furthermore, the entry under the key {@link Resource.PARAM_PERFORMANCE_TUNING_SETTINGS}
+   *          Furthermore, the entry under the key {@link Resource#PARAM_PERFORMANCE_TUNING_SETTINGS}
    *          is a map which may contain settings with keys defined as constants here {@link UIMAFramework} interfaces. 
    *          For example this can be used to set
    *          performance-tuning settings as described in
@@ -577,7 +577,7 @@ public abstract class UIMAFramework {
    *          {@link Resource#initialize(ResourceSpecifier,Map)} method. May be <code>null</code>
    *          if there are no parameters. Parameter names are defined as constants on the
    *          {@link AnalysisEngine}, and {@link Resource}.
-   *          Furthermore, the entry under the key {@link Resource.PARAM_PERFORMANCE_TUNING_SETTINGS}
+   *          Furthermore, the entry under the key {@link Resource#PARAM_PERFORMANCE_TUNING_SETTINGS}
    *          is a map which may contain settings with keys defined as constants here {@link UIMAFramework} interfaces. 
    *          For example this can be used to set
    *          performance-tuning settings as described in
@@ -678,7 +678,7 @@ public abstract class UIMAFramework {
    *          {@link Resource#initialize(ResourceSpecifier,Map)} method. May be <code>null</code>
    *          if there are no parameters. Parameter names are defined as constants on the
    *          {@link AnalysisEngine}, and {@link Resource}.
-   *          Furthermore, the entry under the key {@link Resource.PARAM_PERFORMANCE_TUNING_SETTINGS}
+   *          Furthermore, the entry under the key {@link Resource#PARAM_PERFORMANCE_TUNING_SETTINGS}
    *          is a map which may contain settings with keys defined as constants here {@link UIMAFramework} interfaces. 
    *          For example this can be used to set
    *          performance-tuning settings as described in
@@ -710,7 +710,7 @@ public abstract class UIMAFramework {
    *          {@link Resource#initialize(ResourceSpecifier,Map)} method. May be <code>null</code>
    *          if there are no parameters. Parameter names are defined as constants on the
    *          {@link AnalysisEngine}, and {@link Resource}.
-   *          Furthermore, the entry under the key {@link Resource.PARAM_PERFORMANCE_TUNING_SETTINGS}
+   *          Furthermore, the entry under the key {@link Resource#PARAM_PERFORMANCE_TUNING_SETTINGS}
    *          is a map which may contain settings with keys defined as constants here {@link UIMAFramework} interfaces. 
    *          For example this can be used to set
    *          performance-tuning settings as described in
@@ -760,7 +760,7 @@ public abstract class UIMAFramework {
    *          {@link Resource#initialize(ResourceSpecifier,Map)} method. May be <code>null</code>
    *          if there are no parameters. Parameter names are defined as constants on the
    *          {@link AnalysisEngine}, and {@link Resource}.
-   *          Furthermore, the entry under the key {@link Resource.PARAM_PERFORMANCE_TUNING_SETTINGS}
+   *          Furthermore, the entry under the key {@link Resource#PARAM_PERFORMANCE_TUNING_SETTINGS}
    *          is a map which may contain settings with keys defined as constants here {@link UIMAFramework} interfaces. 
    *          For example this can be used to set
    *          performance-tuning settings as described in
@@ -793,7 +793,7 @@ public abstract class UIMAFramework {
    *          {@link Resource#initialize(ResourceSpecifier,Map)} method. May be <code>null</code>
    *          if there are no parameters. Parameter names are defined as constants on the
    *          {@link AnalysisEngine}, and {@link Resource}.
-   *          Furthermore, the entry under the key {@link Resource.PARAM_PERFORMANCE_TUNING_SETTINGS}
+   *          Furthermore, the entry under the key {@link Resource#PARAM_PERFORMANCE_TUNING_SETTINGS}
    *          is a map which may contain settings with keys defined as constants here {@link UIMAFramework} interfaces. 
    *          For example this can be used to set
    *          performance-tuning settings as described in
@@ -848,7 +848,7 @@ public abstract class UIMAFramework {
    *          {@link Resource#initialize(ResourceSpecifier,Map)} method. May be <code>null</code>
    *          if there are no parameters. Parameter names are defined as constants on the
    *          {@link AnalysisEngine}, and {@link Resource}.
-   *          Furthermore, the entry under the key {@link Resource.PARAM_PERFORMANCE_TUNING_SETTINGS}
+   *          Furthermore, the entry under the key {@link Resource#PARAM_PERFORMANCE_TUNING_SETTINGS}
    *          is a map which may contain settings with keys defined as constants here {@link UIMAFramework} interfaces. 
    *          For example this can be used to set
    *          performance-tuning settings as described in
@@ -881,7 +881,7 @@ public abstract class UIMAFramework {
    *          {@link Resource#initialize(ResourceSpecifier,Map)} method. May be <code>null</code>
    *          if there are no parameters. Parameter names are defined as constants on the
    *          {@link AnalysisEngine}, and {@link Resource}.
-   *          Furthermore, the entry under the key {@link Resource.PARAM_PERFORMANCE_TUNING_SETTINGS}
+   *          Furthermore, the entry under the key {@link Resource#PARAM_PERFORMANCE_TUNING_SETTINGS}
    *          is a map which may contain settings with keys defined as constants here {@link UIMAFramework} interfaces. 
    *          For example this can be used to set
    *          performance-tuning settings as described in
@@ -927,7 +927,7 @@ public abstract class UIMAFramework {
    *          {@link CollectionProcessingEngine#initialize(CpeDescription,Map)} method. May be
    *          <code>null</code> if there are no parameters. Parameter names are defined as constants on the
    *          {@link AnalysisEngine}, and {@link Resource}.
-   *          Furthermore, the entry under the key {@link Resource.PARAM_PERFORMANCE_TUNING_SETTINGS}
+   *          Furthermore, the entry under the key {@link Resource#PARAM_PERFORMANCE_TUNING_SETTINGS}
    *          is a map which may contain settings with keys defined as constants here {@link UIMAFramework} interfaces. 
    *          For example this can be used to set
    *          performance-tuning settings as described in
@@ -959,7 +959,7 @@ public abstract class UIMAFramework {
    *          {@link CollectionProcessingEngine#initialize(CpeDescription,Map)} method. May be
    *          <code>null</code> if there are no parameters. Parameter names are defined as constants on the
    *          {@link AnalysisEngine}, and {@link Resource}.
-   *          Furthermore, the entry under the key {@link Resource.PARAM_PERFORMANCE_TUNING_SETTINGS}
+   *          Furthermore, the entry under the key {@link Resource#PARAM_PERFORMANCE_TUNING_SETTINGS}
    *          is a map which may contain settings with keys defined as constants here {@link UIMAFramework} interfaces. 
    *          For example this can be used to set
    *          performance-tuning settings as described in
@@ -1277,7 +1277,7 @@ public abstract class UIMAFramework {
    *          {@link CollectionProcessingEngine#initialize(CpeDescription,Map)} method. May be
    *          <code>null</code> if there are no parameters. Parameter names are defined as constants on the
    *          {@link AnalysisEngine}, and {@link Resource}.
-   *          Furthermore, the entry under the key {@link Resource.PARAM_PERFORMANCE_TUNING_SETTINGS}
+   *          Furthermore, the entry under the key {@link Resource#PARAM_PERFORMANCE_TUNING_SETTINGS}
    *          is a map which may contain settings with keys defined as constants here {@link UIMAFramework} interfaces. 
    *          For example this can be used to set
    *          performance-tuning settings as described in

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngine.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngine.java?rev=1526640&r1=1526639&r2=1526640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngine.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngine.java Thu Sep 26 18:24:34 2013
@@ -88,7 +88,7 @@ public interface AnalysisEngine extends 
    * that this AnalysisEngine should use. This value is used as a key in the
    * <code>aAdditionalParams</code> Map that is passed to the
    * {@link #initialize(ResourceSpecifier,Map)} method.
-   * @deprecated use {@link Resource.PARAM_RESOURCE_MANAGER}
+   * @deprecated use {@link Resource#PARAM_RESOURCE_MANAGER}
    */
   public static final String PARAM_RESOURCE_MANAGER = Resource.PARAM_RESOURCE_MANAGER;
 
@@ -98,7 +98,7 @@ public interface AnalysisEngine extends 
    * overriding any conflicting settings specified in this AnalysisEngine's Descriptor. This value
    * is used as a key in the <code>aAdditionalParams</code> Map that is passed to the
    * {@link #initialize(ResourceSpecifier,Map)} method.
-   * @deprecated use {@link Resource.PARAM_CONFIG_PARAM_SETTINGS}
+   * @deprecated use {@link Resource#PARAM_CONFIG_PARAM_SETTINGS}
    */
   public static final String PARAM_CONFIG_PARAM_SETTINGS = Resource.PARAM_CONFIG_PARAM_SETTINGS;
 

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/AnalysisEngineDescription_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/AnalysisEngineDescription_impl.java?rev=1526640&r1=1526639&r2=1526640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/AnalysisEngineDescription_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/AnalysisEngineDescription_impl.java Thu Sep 26 18:24:34 2013
@@ -75,7 +75,7 @@ import org.xml.sax.SAXException;
  * Reference implementation of {@link AnalysisEngineDescription}. Note that this class contains two
  * attributes of class Map, which are not supported by the default XML input/output routines.
  * Therefore we override the {@link MetaDataObject_impl#writePropertyAsElement(PropertyXmlInfo, String, ContentHandler)} and
- * {@link MetaDataObject_impl#readPropertyValueFromXMLElement(PropertyXmlInfo, Element, XMLParser, ParsingOptions)} methods.
+ * {@link MetaDataObject_impl#readPropertyValueFromXMLElement(PropertyXmlInfo, Element, XMLParser, XMLParser.ParsingOptions)} methods.
  * 
  * 
  */
@@ -880,7 +880,7 @@ public class AnalysisEngineDescription_i
    * attribute has a value of type <code>Map</code>, which is not handled by the default XML
    * import logic.
    * 
-   * @see MetaDataObject_impl#readPropertyValueFromXMLElement(PropertyXmlInfo, Element, XMLParser, ParsingOptions)
+   * @see MetaDataObject_impl#readPropertyValueFromXMLElement(PropertyXmlInfo, Element, XMLParser, XMLParser.ParsingOptions)
    */
   @Override
   protected void readPropertyValueFromXMLElement(PropertyXmlInfo aPropXmlInfo, Element aElement,

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/ConfigurationParameter_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/ConfigurationParameter_impl.java?rev=1526640&r1=1526639&r2=1526640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/ConfigurationParameter_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/ConfigurationParameter_impl.java Thu Sep 26 18:24:34 2013
@@ -156,7 +156,7 @@ public class ConfigurationParameter_impl
     mMandatory = aMandatory;
   }
 
-  /**
+  /*
    * @see ConfigurationParameter#isPublished()
    */
   /*