svn commit: r517666 - /incubator/uima/uimaj/trunk/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/AnnotatorTester.java

[mb...@apache.org]

Author: mbaessler
Date: Tue Mar 13 05:33:33 2007
New Revision: 517666

URL: http://svn.apache.org/viewvc?view=rev&rev=517666
Log:
add some JavaDoc comments - no Jira

Modified:
    incubator/uima/uimaj/trunk/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/AnnotatorTester.java

Modified: incubator/uima/uimaj/trunk/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/AnnotatorTester.java
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/AnnotatorTester.java?view=diff&rev=517666&r1=517665&r2=517666
==============================================================================
--- incubator/uima/uimaj/trunk/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/AnnotatorTester.java (original)
+++ incubator/uima/uimaj/trunk/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/AnnotatorTester.java Tue Mar 13 05:33:33 2007
@@ -76,8 +76,8 @@
   /**
    * Constructor save the specified descriptor file path and initialize the analysis engine.
    * 
-   * @param descFilePath
-   *          descriptor file path
+   * @param descFile
+   *          descriptor file
    * @throws Exception
    *           if an analysis engine initialze error occurs.
    */
@@ -156,7 +156,10 @@
    *          parameter name
    * @param paramValue
    *          parameter value
+   *          
    * @throws InvalidXMLException
+   * @throws ResourceInitializationException
+   * @throws IOException
    */
   public void changeDelegateParameterSetting(String delegeteKey, String groupName,
           String paramName, Object paramValue) throws InvalidXMLException,
@@ -187,6 +190,14 @@
 
   }
 
+  /**
+   * does configuration parameter test
+   * 
+   * @param configDescFilePath
+   * @return AnalysisEngine
+   * 
+   * @throws Exception
+   */
   public static AnalysisEngine doConfigurationTest(String configDescFilePath) throws Exception {
     try {
       AnalysisEngine ae = null;
@@ -270,6 +281,8 @@
    * performs a test with a special annotator configuration. For this a new AE is created and used
    * to process the specified document for the specified language.
    * 
+   * @param descFilePath
+   *          Descriptor file path
    * @param text
    *          a document text
    * @param language
@@ -361,6 +374,8 @@
    *          respected annotation types
    * @param refFile
    *          reference output
+   * @param testFile
+   *          test file for the current output
    * @throws Exception
    */
   public static void checkResult(CAS cas, String[] AnnotationTypes, File refFile, File testFile)