You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by re...@apache.org on 2013/08/23 17:32:44 UTC

svn commit: r1516889 - in /uima/sandbox/uimafit/trunk: uimafit-core/src/main/java/org/apache/uima/fit/factory/ uimafit-core/src/main/java/org/apache/uima/fit/pipeline/ uimafit-examples/src/test/java/org/apache/uima/fit/examples/tutorial/ex1/ uimafit-ex...

Author: rec
Date: Fri Aug 23 15:32:43 2013
New Revision: 1516889

URL: http://svn.apache.org/r1516889
Log:
No jira. Removed incomplete and outdated JavaDoc tags.

Modified:
    uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/factory/AnalysisEngineFactory.java
    uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/factory/ConfigurationParameterFactory.java
    uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/pipeline/SimplePipeline.java
    uima/sandbox/uimafit/trunk/uimafit-examples/src/test/java/org/apache/uima/fit/examples/tutorial/ex1/RoomNumberAnnotator1Test.java
    uima/sandbox/uimafit/trunk/uimafit-examples/src/test/java/org/apache/uima/fit/examples/tutorial/ex1/RoomNumberAnnotator2Test.java
    uima/sandbox/uimafit/trunk/uimafit-examples/src/test/java/org/apache/uima/fit/examples/xmi/XmiTest.java
    uima/sandbox/uimafit/trunk/uimafit-maven-plugin/src/main/java/org/apache/uima/fit/maven/EnhanceMojo.java
    uima/sandbox/uimafit/trunk/uimafit-maven-plugin/src/main/java/org/apache/uima/fit/maven/GenerateDescriptorsMojo.java
    uima/sandbox/uimafit/trunk/uimafit-maven-plugin/src/main/java/org/apache/uima/fit/maven/util/Util.java

Modified: uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/factory/AnalysisEngineFactory.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/factory/AnalysisEngineFactory.java?rev=1516889&r1=1516888&r2=1516889&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/factory/AnalysisEngineFactory.java (original)
+++ uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/factory/AnalysisEngineFactory.java Fri Aug 23 15:32:43 2013
@@ -560,10 +560,6 @@ public final class AnalysisEngineFactory
    *          value) pairs, so there should always be an even number of parameters.
    * @return an {@link AnalysisEngine} created from the specified component class and initialized
    *         with the configuration parameters.
-   * @throws IOException
-   *           if an I/O error occurs
-   * @throws InvalidXMLException
-   *           if the input XML is not valid or does not specify a valid {@link ResourceSpecifier}
    * @throws ResourceInitializationException
    *           if a failure occurred during production of the resource.
    * @see <a href="package-summary.html#InstancesVsDescriptors">Why are descriptors better than
@@ -601,10 +597,6 @@ public final class AnalysisEngineFactory
    *          value) pairs, so there should always be an even number of parameters.
    * @return an {@link AnalysisEngine} created from the specified component class and initialized
    *         with the configuration parameters.
-   * @throws IOException
-   *           if an I/O error occurs
-   * @throws InvalidXMLException
-   *           if the input XML is not valid or does not specify a valid {@link ResourceSpecifier}
    * @throws ResourceInitializationException
    *           if a failure occurred during production of the resource.
    * @see <a href="package-summary.html#InstancesVsDescriptors">Why are descriptors better than

Modified: uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/factory/ConfigurationParameterFactory.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/factory/ConfigurationParameterFactory.java?rev=1516889&r1=1516888&r2=1516889&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/factory/ConfigurationParameterFactory.java (original)
+++ uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/factory/ConfigurationParameterFactory.java Fri Aug 23 15:32:43 2013
@@ -299,8 +299,9 @@ public final class ConfigurationParamete
    *          the component class which will be analyzed for parameters. Must match the
    *          implementationName set in the descriptor.
    * @param configurationParameters
-   *          additional parameters
+   *          additional parameter names
    * @param configurationValues
+   *          additional parameters values
    */
   public static void setParameters(ResourceCreationSpecifier desc,
           Class<?> componentClass, ConfigurationParameter[] configurationParameters,

Modified: uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/pipeline/SimplePipeline.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/pipeline/SimplePipeline.java?rev=1516889&r1=1516888&r2=1516889&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/pipeline/SimplePipeline.java (original)
+++ uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/pipeline/SimplePipeline.java Fri Aug 23 15:32:43 2013
@@ -185,8 +185,6 @@ public final class SimplePipeline {
    *          the jCas to process
    * @param descs
    *          a sequence of analysis engines to run on the jCas
-   * @throws ResourceInitializationException 
-   * @throws AnalysisEngineProcessException 
    */
   public static void runPipeline(final JCas jCas, final AnalysisEngineDescription... descs)
           throws AnalysisEngineProcessException, ResourceInitializationException {
@@ -202,7 +200,6 @@ public final class SimplePipeline {
    *          the jCas to process
    * @param engines
    *          a sequence of analysis engines to run on the jCas
-   * @throws AnalysisEngineProcessException 
    */
   public static void runPipeline(final JCas jCas, final AnalysisEngine... engines)
           throws AnalysisEngineProcessException {
@@ -220,7 +217,6 @@ public final class SimplePipeline {
    *          the CAS to process
    * @param engines
    *          a sequence of analysis engines to run on the jCas
-   * @throws AnalysisEngineProcessException 
    */
   public static void runPipeline(final CAS cas, final AnalysisEngine... engines)
           throws AnalysisEngineProcessException {

Modified: uima/sandbox/uimafit/trunk/uimafit-examples/src/test/java/org/apache/uima/fit/examples/tutorial/ex1/RoomNumberAnnotator1Test.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-examples/src/test/java/org/apache/uima/fit/examples/tutorial/ex1/RoomNumberAnnotator1Test.java?rev=1516889&r1=1516888&r2=1516889&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-examples/src/test/java/org/apache/uima/fit/examples/tutorial/ex1/RoomNumberAnnotator1Test.java (original)
+++ uima/sandbox/uimafit/trunk/uimafit-examples/src/test/java/org/apache/uima/fit/examples/tutorial/ex1/RoomNumberAnnotator1Test.java Fri Aug 23 15:32:43 2013
@@ -45,8 +45,6 @@ public class RoomNumberAnnotator1Test {
    * descriptor was automatically generated, you might not want your tests to rely on descriptor
    * files. This test also creates a new JCas object. Creating a new JCas is a bit expensive (>40 ms
    * on my laptop) - so this can really add up over a large test suite.
-   * 
-   * @throws Exception
    */
   @Test
   public void testRNA1() throws Exception {
@@ -67,8 +65,6 @@ public class RoomNumberAnnotator1Test {
    * still need a descriptor file for the type system but this isn't so bad as we expect there to be
    * a descriptor file for the type system as it is used to generate the Java jCas types. We are
    * still, unfortunately, creating a new JCas which is not so great.
-   * 
-   * @throws Exception
    */
   @Test
   public void testRNA2() throws Exception {
@@ -89,8 +85,6 @@ public class RoomNumberAnnotator1Test {
   /**
    * This test requires no descriptor files for either the TypeSystemDescription or the
    * AnalysisEngine.
-   * 
-   * @throws Exception
    */
   @Test
   public void testRNA3() throws Exception {
@@ -105,5 +99,4 @@ public class RoomNumberAnnotator1Test {
     assertEquals("01-144", roomNumber.getCoveredText());
     assertEquals("Yorktown", roomNumber.getBuilding());
   }
-
 }

Modified: uima/sandbox/uimafit/trunk/uimafit-examples/src/test/java/org/apache/uima/fit/examples/tutorial/ex1/RoomNumberAnnotator2Test.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-examples/src/test/java/org/apache/uima/fit/examples/tutorial/ex1/RoomNumberAnnotator2Test.java?rev=1516889&r1=1516888&r2=1516889&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-examples/src/test/java/org/apache/uima/fit/examples/tutorial/ex1/RoomNumberAnnotator2Test.java (original)
+++ uima/sandbox/uimafit/trunk/uimafit-examples/src/test/java/org/apache/uima/fit/examples/tutorial/ex1/RoomNumberAnnotator2Test.java Fri Aug 23 15:32:43 2013
@@ -39,8 +39,6 @@ public class RoomNumberAnnotator2Test ex
   /**
    * This test is nice because the super classes provides the typeSystemDescription and jCas
    * objects.
-   * 
-   * @throws Exception
    */
   @Test
   public void testRNA1() throws Exception {

Modified: uima/sandbox/uimafit/trunk/uimafit-examples/src/test/java/org/apache/uima/fit/examples/xmi/XmiTest.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-examples/src/test/java/org/apache/uima/fit/examples/xmi/XmiTest.java?rev=1516889&r1=1516888&r2=1516889&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-examples/src/test/java/org/apache/uima/fit/examples/xmi/XmiTest.java (original)
+++ uima/sandbox/uimafit/trunk/uimafit-examples/src/test/java/org/apache/uima/fit/examples/xmi/XmiTest.java Fri Aug 23 15:32:43 2013
@@ -49,8 +49,6 @@ public class XmiTest extends ExamplesTes
   /**
    * Here we are testing Annotator3 by setting up the "pipeline" and running it before testing the
    * final annotator.
-   * 
-   * @throws Exception
    */
   @Test
   public void testWithoutXmi() throws Exception {
@@ -80,8 +78,6 @@ public class XmiTest extends ExamplesTes
    * <p>
    * The xmi file is generated once by running {@link #main(String[])}. Hopefully, it will not be
    * necessary to regenerate the xmi file often.
-   * 
-   * @throws Exception
    */
   @Test
   public void testWithXmi() throws Exception {
@@ -96,9 +92,6 @@ public class XmiTest extends ExamplesTes
 
   /**
    * Here we generate an xmi file that will be used by {@link #testWithXmi()}.
-   * 
-   * @param args
-   * @throws Exception
    */
   public static void main(String[] args) throws Exception {
     TypeSystemDescription tsd = createTypeSystemDescription("org.apache.uima.fit.examples.TypeSystem");

Modified: uima/sandbox/uimafit/trunk/uimafit-maven-plugin/src/main/java/org/apache/uima/fit/maven/EnhanceMojo.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-maven-plugin/src/main/java/org/apache/uima/fit/maven/EnhanceMojo.java?rev=1516889&r1=1516888&r2=1516889&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-maven-plugin/src/main/java/org/apache/uima/fit/maven/EnhanceMojo.java (original)
+++ uima/sandbox/uimafit/trunk/uimafit-maven-plugin/src/main/java/org/apache/uima/fit/maven/EnhanceMojo.java Fri Aug 23 15:32:43 2013
@@ -121,7 +121,7 @@ public class EnhanceMojo extends Abstrac
   /**
    * Override copyright in generated descriptors.
    * 
-   * @see #component
+   * @see #componentCopyright
    */
   @Parameter(defaultValue = "false", required = true)
   private boolean overrideComponentCopyright;

Modified: uima/sandbox/uimafit/trunk/uimafit-maven-plugin/src/main/java/org/apache/uima/fit/maven/GenerateDescriptorsMojo.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-maven-plugin/src/main/java/org/apache/uima/fit/maven/GenerateDescriptorsMojo.java?rev=1516889&r1=1516888&r2=1516889&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-maven-plugin/src/main/java/org/apache/uima/fit/maven/GenerateDescriptorsMojo.java (original)
+++ uima/sandbox/uimafit/trunk/uimafit-maven-plugin/src/main/java/org/apache/uima/fit/maven/GenerateDescriptorsMojo.java Fri Aug 23 15:32:43 2013
@@ -150,9 +150,6 @@ public class GenerateDescriptorsMojo ext
 
   /**
    * Save descriptor XML to file system.
-   * 
-   * @throws IOException
-   * @throws SAXException
    */
   private void toXML(ResourceSpecifier aDesc, String aFilename) throws SAXException, IOException {
     OutputStream os = null;

Modified: uima/sandbox/uimafit/trunk/uimafit-maven-plugin/src/main/java/org/apache/uima/fit/maven/util/Util.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-maven-plugin/src/main/java/org/apache/uima/fit/maven/util/Util.java?rev=1516889&r1=1516888&r2=1516889&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-maven-plugin/src/main/java/org/apache/uima/fit/maven/util/Util.java (original)
+++ uima/sandbox/uimafit/trunk/uimafit-maven-plugin/src/main/java/org/apache/uima/fit/maven/util/Util.java Fri Aug 23 15:32:43 2013
@@ -122,8 +122,6 @@ public final class Util {
   /**
    * Create a class loader which covers the classes compiled in the current project and all
    * dependencies.
-   * 
-   * @throws MojoExecutionException
    */
   public static URLClassLoader getClassloader(MavenProject aProject, Log aLog)
           throws MojoExecutionException {