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 2018/06/27 19:29:10 UTC

svn commit: r1834535 - /uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/pear/tools/InstallationTester.java

Author: schor
Date: Wed Jun 27 19:29:09 2018
New Revision: 1834535

URL: http://svn.apache.org/viewvc?rev=1834535&view=rev
Log:
[UIMA-5799][UIMA-5798] fix javadoc comments

Modified:
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/pear/tools/InstallationTester.java

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/pear/tools/InstallationTester.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/pear/tools/InstallationTester.java?rev=1834535&r1=1834534&r2=1834535&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/pear/tools/InstallationTester.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/pear/tools/InstallationTester.java Wed Jun 27 19:29:09 2018
@@ -234,8 +234,10 @@ public class InstallationTester {
    * engine. Returns <code>true</code>, if an analysis engine can be instantiated,
    * <code>false</code> otherwise.
    * 
-   * @return <code>true</code>, if an AE can be instantiated, <code>false</code> otherwise.
-   * 
+   * @param specifier the resource specifier
+   * @param resource_manager a new resource_manager
+   * @param status the place where to put the results
+   *
    * @throws IOException
    *           If an I/O exception occurred while creating <code>XMLInputSource</code>.
    * @throws InvalidXMLException
@@ -243,6 +245,15 @@ public class InstallationTester {
    * @throws ResourceInitializationException
    *           If the specified AE cannot be instantiated.
    */
+  /**
+   * 
+   * @param specifier
+   * @param resource_manager
+   * @param status
+   * @throws IOException
+   * @throws InvalidXMLException
+   * @throws ResourceInitializationException
+   */
   private void testAnalysisEngine(ResourceSpecifier specifier, 
                                   ResourceManager resource_manager, 
                                   TestStatus status) 
@@ -271,8 +282,10 @@ public class InstallationTester {
    * Checks if a given CC specifier file can be used to produce an instance of CC. Returns
    * <code>true</code>, if a CC can be instantiated, <code>false</code> otherwise.
    * 
-   * @return <code>true</code>, if a CC can be instantiated, <code>false</code> otherwise.
-   * 
+   * @param specifier the resource specifier
+   * @param resource_manager a new resource_manager
+   * @param status the place where to put the results
+   *
    * @throws IOException
    *           If an I/O exception occurred while creating <code>XMLInputSource</code>.
    * @throws InvalidXMLException
@@ -301,7 +314,10 @@ public class InstallationTester {
    * Checks if a given CI specifier file can be used to produce an instance of CI. Returns
    * <code>true</code>, if a CI can be instantiated, <code>false</code> otherwise.
    * 
-   * @return <code>true</code>, if a CI can be instantiated, <code>false</code> otherwise.
+   * @param specifier the resource specifier
+   * @param resource_manager a new resource_manager
+   * @param status the place where to put the results
+   *
    * @throws IOException
    *           If an I/O exception occurred while creating <code>XMLInputSource</code>.
    * @throws InvalidXMLException
@@ -330,7 +346,10 @@ public class InstallationTester {
    * Checks if a given CR specifier file can be used to produce an instance of CR. Returns
    * <code>true</code>, if a CR can be instantiated, <code>false</code> otherwise.
    * 
-   * @return <code>true</code>, if a CR can be instantiated, <code>false</code> otherwise.
+   * @param specifier the resource specifier
+   * @param resource_manager a new resource_manager
+   * @param status the place where to put the results
+   *
    * @throws IOException
    *           If an I/O exception occurred while creating <code>XMLInputSource</code>.
    * @throws InvalidXMLException
@@ -358,8 +377,10 @@ public class InstallationTester {
    * Checks if a given CPE specifier file can be used to produce an instance of CPE. Returns
    * <code>true</code>, if a CPE can be instantiated, <code>false</code> otherwise.
    * 
-   * @return <code>true</code>, if a CPE can be instantiated, <code>false</code> otherwise.
-   * 
+   * @param specifier the resource specifier
+   * @param resource_manager a new resource_manager
+   * @param status the place where to put the results
+   *
    * @throws IOException
    *           If an I/O exception occurred while creating <code>XMLInputSource</code>.
    * @throws InvalidXMLException
@@ -390,8 +411,7 @@ public class InstallationTester {
    * Checks if a given TS specifier file can be used to create an instance of CAS. Returns
    * <code>true</code>, if a CAS can be created for a given TS, <code>false</code> otherwise.
    * 
-   * @return <code>true</code>, if a CAS can be created for the given TS, <code>false</code>
-   *         otherwise.
+   * @return the result of the testing
    * @throws IOException
    *           If an I/O exception occurred while creating <code>XMLInputSource</code>.
    * @throws InvalidXMLException