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/12/09 20:15:40 UTC

svn commit: r1549651 - in /uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima: Constants.java ResourceFactory.java UimaContext.java

Author: schor
Date: Mon Dec  9 19:15:40 2013
New Revision: 1549651

URL: http://svn.apache.org/r1549651
Log:
[UIMA-3484] javadoc fixes

Modified:
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/Constants.java
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/ResourceFactory.java
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/UimaContext.java

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/Constants.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/Constants.java?rev=1549651&r1=1549650&r2=1549651&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/Constants.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/Constants.java Mon Dec  9 19:15:40 2013
@@ -63,13 +63,13 @@ public abstract class Constants {
   public static final String PROTOCOL_JMS = "JMS";
   
   /**
-   * Name of the UIMA Java framework, to be used in <frameworkImplementation> 
+   * Name of the UIMA Java framework, to be used in <frameworkImplementation> 
    * element of descriptors.
    */
   public static final String JAVA_FRAMEWORK_NAME = "org.apache.uima.java";
   
   /**
-   * Name of the UIMA C++ framework, to be used in <frameworkImplementation> 
+   * Name of the UIMA C++ framework, to be used in <frameworkImplementation> 
    * element of descriptors.
    */
   public static final String CPP_FRAMEWORK_NAME = "org.apache.uima.cpp";

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/ResourceFactory.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/ResourceFactory.java?rev=1549651&r1=1549650&r2=1549651&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/ResourceFactory.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/ResourceFactory.java Mon Dec  9 19:15:40 2013
@@ -29,7 +29,7 @@ import org.apache.uima.resource.Resource
  * A <code>ResourceFactory</code> is used to acquire instances of {@link Resource}s.
  * <p>
  * The method {@link #produceResource(Class,ResourceSpecifier,Map)} is used to produce an instance
- * of a <code>Resource<code>.  The input to this method
+ * of a <code>Resource</code>.  The input to this method
  * is a {@link ResourceSpecifier}, which contains all of the information that
  * this factory can use to acquire a reference to the resource.
  * <p>

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/UimaContext.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/UimaContext.java?rev=1549651&r1=1549650&r2=1549651&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/UimaContext.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/UimaContext.java Mon Dec  9 19:15:40 2013
@@ -38,7 +38,7 @@ import org.apache.uima.util.Logger;
  * include:
  * <ul>
  * <li>Configuration Parameters</li>
- * <li>Logging & Instrumentation Facilities</li>
+ * <li>Logging &amp; Instrumentation Facilities</li>
  * <li>Access to External Analysis Resources, such as dictionary files</li>
  * </ul>
  * 
@@ -267,7 +267,7 @@ public interface UimaContext {
    * <p>
    * This version of this method takes an array of parameters used to further identify the resource.
    * This can be used, for example, with resources that vary depending on the language of the
-   * document being analyzed, such as when the &lt;fileLanguageResourceSpecifier> element is used in
+   * document being analyzed, such as when the &lt;fileLanguageResourceSpecifier&gt; element is used in
    * the component descriptor.
    * 
    * @param aKey
@@ -275,7 +275,7 @@ public interface UimaContext {
    *          &lt;externalResourceDependencies&gt; section of the descriptor.
    * @param aParams
    *          parameters used to further identify the resource. When used to identify the language
-   *          for a &lt;fileLanguageResourceSpecifier>, this array should contain a single element,
+   *          for a &lt;fileLanguageResourceSpecifier&gt;, this array should contain a single element,
    *          the ISO language code for the language of the document (e.g. "en", "de").
    * 
    * @return the <code>URL</code> at which the named resource is located, <code>null</code> if
@@ -302,7 +302,7 @@ public interface UimaContext {
    * <p>
    * This version of this method takes an array of parameters used to further identify the resource.
    * This can be used, for example, with resources that vary depending on the language of the
-   * document being analyzed, such as when the &lt;fileLanguageResourceSpecifier> element is used in
+   * document being analyzed, such as when the &lt;fileLanguageResourceSpecifier&gt; element is used in
    * the component descriptor.
    * 
    * @param aKey
@@ -335,7 +335,7 @@ public interface UimaContext {
    * <p>
    * This version of this method takes an array of parameters used to further identify the resource.
    * This can be used, for example, with resources that vary depending on the language of the
-   * document being analyzed, such as when the &lt;fileLanguageResourceSpecifier> element is used in
+   * document being analyzed, such as when the &lt;fileLanguageResourceSpecifier&gt; element is used in
    * the component descriptor.
    * 
    * @param aKey
@@ -362,7 +362,7 @@ public interface UimaContext {
    * <p>
    * This version of this method takes an array of parameters used to further identify the resource.
    * This can be used, for example, with resources that vary depending on the language of the
-   * document being analyzed, such as when the &lt;fileLanguageResourceSpecifier> element is used in
+   * document being analyzed, such as when the &lt;fileLanguageResourceSpecifier&gt; element is used in
    * the component descriptor.
    * 
    * @param aKey
@@ -370,7 +370,7 @@ public interface UimaContext {
    *          &lt;externalResourceDependencies&gt; section of the descriptor.
    * @param aParams
    *          parameters used to further identify the resource. When used to identify the language
-   *          for a &lt;fileLanguageResourceSpecifier>, this array should contain a single element,
+   *          for a &lt;fileLanguageResourceSpecifier&gt;, this array should contain a single element,
    *          the ISO language code for the language of the document (e.g. "en", "de").
    * 
    * @return an <code>InputStream</code> for reading from the named resource, <code>null</code>
@@ -390,7 +390,7 @@ public interface UimaContext {
    * <p>
    * This version of this method takes an array of parameters used to further identify the resource.
    * This can be used, for example, with resources that vary depending on the language of the
-   * document being analyzed, such as when the &lt;fileLanguageResourceSpecifier> element is used in
+   * document being analyzed, such as when the &lt;fileLanguageResourceSpecifier&gt; element is used in
    * the component descriptor.
    * 
    * @param aKey
@@ -398,7 +398,7 @@ public interface UimaContext {
    *          &lt;externalResourceDependencies&gt; section of the descriptor.
    * @param aParams
    *          parameters used to further identify the resource. When used to identify the language
-   *          for a &lt;fileLanguageResourceSpecifier>, this array should contain a single element,
+   *          for a &lt;fileLanguageResourceSpecifier&gt;, this array should contain a single element,
    *          the ISO language code for the language of the document (e.g. "en", "de").
    * 
    * @return the object bound to <code>aName</code>, <code>null</code> if none.