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 2019/07/03 13:33:11 UTC
svn commit: r1862471 - in /uima/uimaj/trunk:
uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/
uimaj-examples/src/main/java/org/apache/uima/examples/
Author: schor
Date: Wed Jul 3 13:33:11 2019
New Revision: 1862471
URL: http://svn.apache.org/viewvc?rev=1862471&view=rev
Log:
no Jira, fixup javadocs
Modified:
uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/CASTransportable.java
uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceStub.java
uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineService_impl.java
uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineService_impl.java
uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/PrintAnnotations.java
uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/RunAE.java
uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/SofaExampleApplication.java
Modified: uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/CASTransportable.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/CASTransportable.java?rev=1862471&r1=1862470&r2=1862471&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/CASTransportable.java (original)
+++ uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/CASTransportable.java Wed Jul 3 13:33:11 2019
@@ -78,10 +78,10 @@ public class CASTransportable extends De
* This constructor is used on the service side - a CAS Pool reference is provided. We don't check
* a CAS out of the pool until we get a request.
*
- * @param casPool
- * @param outOfTypeSystemData
- * @param uimaContext
- * @param includeDocText
+ * @param casPool -
+ * @param outOfTypeSystemData -
+ * @param uimaContext -
+ * @param includeDocText -
*/
public CASTransportable(CasPool casPool, OutOfTypeSystemData outOfTypeSystemData,
UimaContext uimaContext, boolean includeDocText) {
@@ -98,10 +98,10 @@ public class CASTransportable extends De
* This constructor is used on the client side, where we have a dedicated CAS instance for the
* request.
*
- * @param cas
- * @param outOfTypeSystemData
- * @param uimaContext
- * @param includeDocText
+ * @param cas -
+ * @param outOfTypeSystemData -
+ * @param uimaContext -
+ * @param includeDocText -
*/
public CASTransportable(CAS cas, OutOfTypeSystemData outOfTypeSystemData,
UimaContext uimaContext, boolean includeDocText) {
Modified: uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceStub.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceStub.java?rev=1862471&r1=1862470&r2=1862471&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceStub.java (original)
+++ uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceStub.java Wed Jul 3 13:33:11 2019
@@ -200,6 +200,8 @@ public class VinciAnalysisEngineServiceS
/**
* @see CasObjectProcessor#processCas(CAS)
+ * @return -
+ * @throws ResourceServiceException -
*/
public void callProcessCas(CAS aCAS) throws ResourceServiceException {
doProcess(aCAS);
@@ -278,6 +280,8 @@ public class VinciAnalysisEngineServiceS
/**
* @see CasObjectProcessor#isReadOnly()
+ * @return -
+ * @throws ResourceServiceException -
*/
public boolean callIsReadOnly() throws ResourceServiceException {
try {
@@ -297,6 +301,8 @@ public class VinciAnalysisEngineServiceS
/**
* @see CasObjectProcessor#isStateless()
+ * @return -
+ * @throws ResourceServiceException -
*/
public boolean callIsStateless() throws ResourceServiceException {
try {
Modified: uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineService_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineService_impl.java?rev=1862471&r1=1862470&r2=1862471&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineService_impl.java (original)
+++ uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineService_impl.java Wed Jul 3 13:33:11 2019
@@ -75,8 +75,8 @@ public class VinciAnalysisEngineService_
* Instantiate Analysis Engine from a given descriptor, debug mode, and instance Id
*
* @param serviceConfigPath descriptor location
- * @param debug
- * @param instanceId
+ * @param debug -
+ * @param instanceId -
* @throws Exception passthru
*/
public VinciAnalysisEngineService_impl(String serviceConfigPath, boolean debug, String instanceId)
@@ -89,7 +89,8 @@ public class VinciAnalysisEngineService_
* Instantiate Analysis Engine service from a given descriptor - possibly in debug mode.
*
* @param serviceConfigPath descriptor location
- * @param debug
+ * @param debug -
+ * @throws Exception -
*/
public VinciAnalysisEngineService_impl(String serviceConfigPath, boolean debug) throws Exception {
this.debug = debug;
Modified: uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineService_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineService_impl.java?rev=1862471&r1=1862470&r2=1862471&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineService_impl.java (original)
+++ uima/uimaj/trunk/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineService_impl.java Wed Jul 3 13:33:11 2019
@@ -84,8 +84,9 @@ public class VinciBinaryAnalysisEngineSe
* Instantiate Analysis Engine from a given descriptor - possibly in debug mode.
*
* @param serviceConfigPath descriptor location
- * @param debug
- * @param instanceId
+ * @param debug -
+ * @param instanceId -
+ * @throws Exception -
*/
public VinciBinaryAnalysisEngineService_impl(String serviceConfigPath, boolean debug,
String instanceId) throws Exception {
@@ -98,7 +99,8 @@ public class VinciBinaryAnalysisEngineSe
* Instantiate Analysis Engine from a given descriptor - possibly in debug mode.
*
* @param serviceConfigPath descriptor location
- * @param debug
+ * @param debug -
+ * @throws Exception -
*/
public VinciBinaryAnalysisEngineService_impl(String serviceConfigPath, boolean debug)
throws Exception {
@@ -133,6 +135,7 @@ public class VinciBinaryAnalysisEngineSe
* Instantiate Analysis Engine from a given descriptor.
*
* @param serviceConfigPath descriptor location
+ * @throws Exception -
*/
public VinciBinaryAnalysisEngineService_impl(String serviceConfigPath) throws Exception {
this(serviceConfigPath, false);
Modified: uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/PrintAnnotations.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/PrintAnnotations.java?rev=1862471&r1=1862470&r2=1862471&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/PrintAnnotations.java (original)
+++ uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/PrintAnnotations.java Wed Jul 3 13:33:11 2019
@@ -227,9 +227,10 @@ public class PrintAnnotations {
}
/**
- * Main program for testing this class. Ther are two required arguments - the path to the XML
+ * Main program for testing this class. There are two required arguments - the path to the XML
* descriptor for the TAE to run and an input file. Additional arguments are Type or Feature names
* to be included in the ResultSpecification passed to the TAE.
+ * @param args - see above
*/
public static void main(String[] args) {
try {
Modified: uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/RunAE.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/RunAE.java?rev=1862471&r1=1862470&r2=1862471&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/RunAE.java (original)
+++ uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/RunAE.java Wed Jul 3 13:33:11 2019
@@ -105,6 +105,7 @@ public class RunAE implements StatusCall
/**
* Constructor. Sets up and runs an Analysis Engine.
+ * @param args -
*/
public RunAE(String[] args) {
try {
Modified: uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/SofaExampleApplication.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/SofaExampleApplication.java?rev=1862471&r1=1862470&r2=1862471&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/SofaExampleApplication.java (original)
+++ uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/SofaExampleApplication.java Wed Jul 3 13:33:11 2019
@@ -44,6 +44,9 @@ public class SofaExampleApplication {
/**
* Main program
*
+ * @param args the arguments
+ * @throws UIMAException the UIMA exception
+ * @throws IOException Signals that an I/O exception has occurred.
*/
public static void main(String[] args) throws UIMAException, IOException {
// parse AnalysisEngine descriptor