Revision: 14979
http://gate.svn.sourceforge.net/gate/?rev=14979&view=rev
Author: markagreenwood
Date: 2012-01-10 13:10:14 +0000 (Tue, 10 Jan 2012)
Log Message:
-----------
fixed a bunch of javadoc warnings
Modified Paths:
--------------
gate/trunk/src/gate/AnnotationSet.java
gate/trunk/src/gate/Corpus.java
gate/trunk/src/gate/Factory.java
gate/trunk/src/gate/SimpleCorpus.java
gate/trunk/src/gate/Utils.java
gate/trunk/src/gate/annotation/AnnotationSetImpl.java
Modified: gate/trunk/src/gate/AnnotationSet.java
===================================================================
--- gate/trunk/src/gate/AnnotationSet.java 2012-01-10 13:05:19 UTC (rev
14978)
+++ gate/trunk/src/gate/AnnotationSet.java 2012-01-10 13:10:14 UTC (rev
14979)
@@ -63,8 +63,6 @@
* @param end the end offset for the new annotation
* @param type the annotation type
* @param features the features for the new annotation
- * @return the newly generated annotation ID, which will be distinct
- * from all other annotations in this set.
* @throws InvalidOffsetException if the start or end offsets are
* <code>null</code>, or if the start offset is less than
* 0 or the end offset is greater than the length of the
Modified: gate/trunk/src/gate/Corpus.java
===================================================================
--- gate/trunk/src/gate/Corpus.java 2012-01-10 13:05:19 UTC (rev 14978)
+++ gate/trunk/src/gate/Corpus.java 2012-01-10 13:10:14 UTC (rev 14979)
@@ -34,7 +34,6 @@
* because there would be no way to get the document back
* again afterwards.
* @param doc Document to be unloaded from memory.
- * @return void.
*/
public void unloadDocument(Document doc);
Modified: gate/trunk/src/gate/Factory.java
===================================================================
--- gate/trunk/src/gate/Factory.java 2012-01-10 13:05:19 UTC (rev 14978)
+++ gate/trunk/src/gate/Factory.java 2012-01-10 13:10:14 UTC (rev 14979)
@@ -16,29 +16,41 @@
package gate;
-import java.io.BufferedInputStream;
-import java.io.IOException;
-import java.io.InputStreamReader;
-import java.io.Serializable;
-import java.lang.reflect.Constructor;
-import java.lang.reflect.InvocationTargetException;
-import java.net.*;
-import java.util.*;
-
-import gate.creole.*;
+import gate.annotation.ImmutableAnnotationSetImpl;
+import gate.creole.AbstractProcessingResource;
+import gate.creole.AbstractResource;
+import gate.creole.AnnotationSchema;
+import gate.creole.ConditionalController;
+import gate.creole.CustomDuplication;
+import gate.creole.ParameterException;
+import gate.creole.ParameterList;
+import gate.creole.ResourceData;
+import gate.creole.ResourceInstantiationException;
import gate.creole.gazetteer.Gazetteer;
-//import gate.creole.ontology.owlim.OWLIMOntologyLR;
import gate.event.CreoleEvent;
import gate.event.CreoleListener;
import gate.jape.constraint.ConstraintFactory;
import gate.jape.parser.ParseCpsl;
import gate.persist.PersistenceException;
import gate.persist.SerialDataStore;
-import gate.security.*;
import gate.security.SecurityException;
-import gate.util.*;
-import gate.annotation.ImmutableAnnotationSetImpl;
+import gate.util.BomStrippingInputStreamReader;
+import gate.util.Out;
+import gate.util.SimpleFeatureMapImpl;
+import gate.util.Strings;
+import java.io.IOException;
+import java.io.Serializable;
+import java.lang.reflect.Constructor;
+import java.lang.reflect.InvocationTargetException;
+import java.net.URI;
+import java.net.URL;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.IdentityHashMap;
+import java.util.Map;
+import java.util.Vector;
+
/** Provides static methods for the creation of Resources.
*/
public abstract class Factory {
@@ -777,10 +789,10 @@
* Active ConstraintFactory for creating and initializing Jape
<b>Constraint</b>s.
*/
private static ConstraintFactory japeConstraintFactory = new
ConstraintFactory();
+
/**
* Return the active {@link ConstraintFactory} for creating and initializing
Jape
* <b>Constraint</b>s.
- * @return
*/
public static ConstraintFactory getConstraintFactory() {
return japeConstraintFactory;
Modified: gate/trunk/src/gate/SimpleCorpus.java
===================================================================
--- gate/trunk/src/gate/SimpleCorpus.java 2012-01-10 13:05:19 UTC (rev
14978)
+++ gate/trunk/src/gate/SimpleCorpus.java 2012-01-10 13:10:14 UTC (rev
14979)
@@ -119,7 +119,7 @@
* @param documentRootElement content between the start and end of
* this element is considered for documents.
* @param encoding the encoding of the trec file.
- * @param numberOfFilesToExtract indicates the number of files to
+ * @param numberOfDocumentsToExtract indicates the number of documents to
* extract from the concatenated file. -1 to indicate all
* files.
* @param documentNamePrefix the prefix to use for document names when
Modified: gate/trunk/src/gate/Utils.java
===================================================================
--- gate/trunk/src/gate/Utils.java 2012-01-10 13:05:19 UTC (rev 14978)
+++ gate/trunk/src/gate/Utils.java 2012-01-10 13:10:14 UTC (rev 14979)
@@ -250,8 +250,7 @@
* whitespace; normalize internal whitespace to single spaces; return an
* empty String if the input contains nothing but whitespace, but null
* if the input is null.)
- * @param input
- * @return
+ * @return a cleaned version of the input String.
*/
public static String cleanString(String input) {
if (input == null) {
Modified: gate/trunk/src/gate/annotation/AnnotationSetImpl.java
===================================================================
--- gate/trunk/src/gate/annotation/AnnotationSetImpl.java 2012-01-10
13:05:19 UTC (rev 14978)
+++ gate/trunk/src/gate/annotation/AnnotationSetImpl.java 2012-01-10
13:10:14 UTC (rev 14979)
@@ -531,9 +531,7 @@
*
* @param neededType Type of annotation to return. If empty, all
* annotation types will be returned.
- * @param startOffset
- * @param endOffset
- * @return
+ * @return annotations of the given type that completely span the range.
*/
public AnnotationSet getCovering(String neededType, Long startOffset, Long
endOffset) {
//check the range
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
