Revision: 14977
http://gate.svn.sourceforge.net/gate/?rev=14977&view=rev
Author: markagreenwood
Date: 2012-01-10 12:27:13 +0000 (Tue, 10 Jan 2012)
Log Message:
-----------
fixed a bunch of javadoc warnings
Modified Paths:
--------------
gate/trunk/src/gate/creole/AbstractController.java
gate/trunk/src/gate/creole/ControllerAwarePR.java
gate/trunk/src/gate/creole/CustomDuplication.java
gate/trunk/src/gate/creole/RealtimeCorpusController.java
gate/trunk/src/gate/creole/SerialController.java
Modified: gate/trunk/src/gate/creole/AbstractController.java
===================================================================
--- gate/trunk/src/gate/creole/AbstractController.java 2012-01-10 12:12:26 UTC
(rev 14976)
+++ gate/trunk/src/gate/creole/AbstractController.java 2012-01-10 12:27:13 UTC
(rev 14977)
@@ -423,8 +423,6 @@
/**
* Returns the benchmark ID of this controller.
- *
- * @return
*/
public String getBenchmarkId() {
if(benchmarkID == null) {
Modified: gate/trunk/src/gate/creole/ControllerAwarePR.java
===================================================================
--- gate/trunk/src/gate/creole/ControllerAwarePR.java 2012-01-10 12:12:26 UTC
(rev 14976)
+++ gate/trunk/src/gate/creole/ControllerAwarePR.java 2012-01-10 12:27:13 UTC
(rev 14977)
@@ -38,7 +38,7 @@
* a conditional controller the methods defined by this interface are invoked
* independently of the RunningStrategy for the processing resource: even if
* the PR is disabled, the methods will get invoked. The method
- * {@see gate.Utils#isEnabled(Controller, ProcessingResource)} can be used
+ * {@link gate.Utils#isEnabled(Controller, ProcessingResource)} can be used
* inside the implementation of the methods defined in this interface
* if necessary to find out if the processing resource has a chance to run
* in the controller.
Modified: gate/trunk/src/gate/creole/CustomDuplication.java
===================================================================
--- gate/trunk/src/gate/creole/CustomDuplication.java 2012-01-10 12:12:26 UTC
(rev 14976)
+++ gate/trunk/src/gate/creole/CustomDuplication.java 2012-01-10 12:27:13 UTC
(rev 14977)
@@ -23,7 +23,7 @@
* {@link Factory#duplicate(Resource) Factory.duplicate}). If a Resource
* class requires custom duplication logic it should implement this
* interface and provide an implementation of the
- * {@link #duplicate(Resource) duplicate} method to create a new
+ * {@link #duplicate(DuplicationContext) duplicate} method to create a new
* resource instance that has the same behaviour as <code>this</code>.
*
* @author ian
Modified: gate/trunk/src/gate/creole/RealtimeCorpusController.java
===================================================================
--- gate/trunk/src/gate/creole/RealtimeCorpusController.java 2012-01-10
12:12:26 UTC (rev 14976)
+++ gate/trunk/src/gate/creole/RealtimeCorpusController.java 2012-01-10
12:27:13 UTC (rev 14977)
@@ -11,27 +11,33 @@
*
* $Id$
*
- */package gate.creole;
+ */
-import java.util.Timer;
-import java.util.TimerTask;
+package gate.creole;
+
+import gate.Document;
+import gate.Executable;
+import gate.Factory;
+import gate.LanguageAnalyser;
+import gate.ProcessingResource;
+import gate.Resource;
+import gate.creole.metadata.CreoleParameter;
+import gate.creole.metadata.CreoleResource;
+import gate.util.Err;
+import gate.util.Out;
+import gate.util.profile.Profiler;
+
import java.util.HashMap;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
-import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import org.apache.log4j.Logger;
-import gate.*;
-import gate.creole.metadata.*;
-import gate.util.Err;
-import gate.util.profile.Profiler;
-import gate.util.Out;
/**
* A custom GATE controller that interrupts the execution over a document when
a
* specified amount of time has elapsed. It also ignores all errors/exceptions
@@ -314,7 +320,6 @@
* Gets the timeout in milliseconds before execution on a document is
* forcibly stopped (forcibly stopping execution may result in memory leaks
* and/or unexpected behaviour).
- * @return
*/
public Long getTimeout() {
return timeout;
@@ -325,7 +330,7 @@
* Sets the timeout in milliseconds before execution on a document is
* forcibly stopped (forcibly stopping execution may result in memory leaks
* and/or unexpected behaviour).
- * @param timeout
+ * @param timeout in milliseconds before execution is forcibly stopped
*/
@CreoleParameter(defaultValue = "60000",
comment = "Timeout in milliseconds before execution on a document is
forcibly stopped (forcibly stopping execution may result in memory leaks and/or
unexpected behaviour)")
@@ -344,7 +349,6 @@
* Gets the timeout in milliseconds before execution on a document is
* gracefully stopped. Defaults to -1 which disables this functionality and
* relies, as previously, on forcibly stopping execution.
- * @return
*/
public Long getGracefulTimeout() {
return graceful;
@@ -354,7 +358,7 @@
* Sets the timeout in milliseconds before execution on a document is
* gracefully stopped. Defaults to -1 which disables this functionality and
* relies, as previously, on forcibly stopping execution.
- * @param graceful
+ * @param graceful timeout in milliseconds before execution is gracefully
stopped
*/
@CreoleParameter(defaultValue = "-1",
comment = "Timeout in milliseconds before execution on a document is
gracefully stopped. Defaults to -1 which disables this functionality and
relies, as previously, on forcibly stoping execution.")
Modified: gate/trunk/src/gate/creole/SerialController.java
===================================================================
--- gate/trunk/src/gate/creole/SerialController.java 2012-01-10 12:12:26 UTC
(rev 14976)
+++ gate/trunk/src/gate/creole/SerialController.java 2012-01-10 12:27:13 UTC
(rev 14977)
@@ -184,7 +184,6 @@
/**
* Returns the HashMap that lists the total time taken by each PR
- * @return
*/
public HashMap<String, Long> getPrTimeMap() {
return this.prTimeMap;
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Write once. Port to many.
Get the SDK and tools to simplify cross-platform app development. Create
new or port existing apps to sell to consumers worldwide. Explore the
Intel AppUpSM program developer opportunity. appdeveloper.intel.com/join
http://p.sf.net/sfu/intel-appdev
_______________________________________________
GATE-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gate-cvs
