Revision: 14978
http://gate.svn.sourceforge.net/gate/?rev=14978&view=rev
Author: markagreenwood
Date: 2012-01-10 13:05:19 +0000 (Tue, 10 Jan 2012)
Log Message:
-----------
fixed a bunch of javadoc warnings
Modified Paths:
--------------
gate/trunk/src/gate/corpora/CorpusImpl.java
gate/trunk/src/gate/corpora/DocumentStaxUtils.java
gate/trunk/src/gate/corpora/DocumentXmlUtils.java
gate/trunk/src/gate/corpora/SerialCorpusImpl.java
Modified: gate/trunk/src/gate/corpora/CorpusImpl.java
===================================================================
--- gate/trunk/src/gate/corpora/CorpusImpl.java 2012-01-10 12:27:13 UTC (rev
14977)
+++ gate/trunk/src/gate/corpora/CorpusImpl.java 2012-01-10 13:05:19 UTC (rev
14978)
@@ -776,7 +776,7 @@
* Fills the provided corpus with documents extracted from the
* provided single concatenated file.
*
- * @param trecFile the trec file.
+ * @param singleConcatenatedFile the single concatenated file to load.
* @param documentRootElement content between the start and end of
* this element is considered for documents.
* @param encoding the encoding of the trec file.
Modified: gate/trunk/src/gate/corpora/DocumentStaxUtils.java
===================================================================
--- gate/trunk/src/gate/corpora/DocumentStaxUtils.java 2012-01-10 12:27:13 UTC
(rev 14977)
+++ gate/trunk/src/gate/corpora/DocumentStaxUtils.java 2012-01-10 13:05:19 UTC
(rev 14978)
@@ -377,7 +377,7 @@
*
* @param xsr
* @param nodeIdToOffsetMap
- * @return
+ * @return the text content of the document
*/
public static String readTextWithNodes(XMLStreamReader xsr,
Map<Integer, Long> nodeIdToOffsetMap) throws XMLStreamException {
@@ -428,8 +428,6 @@
* each with a Name and Value. The reader will be returned positioned
* on the closing GateDocumentFeatures or Annotation tag.
*
- * @param xsr
- * @return
* @throws XMLStreamException
*/
public static FeatureMap readFeatureMap(XMLStreamReader xsr)
@@ -677,7 +675,7 @@
* <code>cesAna</code> tag and will be left pointing to the
* corresponding end tag.
*
- * @param reader the XMLStreamReader to read from.
+ * @param xsr the XMLStreamReader to read from.
* @param as the annotation set to read into.
* @throws XMLStreamException
*/
@@ -778,8 +776,6 @@
* attributes. The reader will be returned positioned on the closing
* struct tag.
*
- * @param xsr
- * @return
* @throws XMLStreamException
*/
public static FeatureMap readXcesFeatureMap(XMLStreamReader xsr)
Modified: gate/trunk/src/gate/corpora/DocumentXmlUtils.java
===================================================================
--- gate/trunk/src/gate/corpora/DocumentXmlUtils.java 2012-01-10 12:27:13 UTC
(rev 14977)
+++ gate/trunk/src/gate/corpora/DocumentXmlUtils.java 2012-01-10 13:05:19 UTC
(rev 14978)
@@ -403,12 +403,13 @@
}// buildEntityMapFromString();
/**
- * This method saves an AnnotationSet as XML.
+ * Converts the Annotation set to XML which is appended to the supplied
+ * StringBuffer instance.
*
* @param anAnnotationSet
* The annotation set that has to be saved as XML.
- * @return a String like this: <AnnotationSet> <Annotation>....
- * </AnnotationSet>
+ * @param buffer
+ * the StringBuffer that the XML representation should be appended
to
*/
public static void annotationSetToXml(AnnotationSet anAnnotationSet,
StringBuffer buffer) {
@@ -444,17 +445,20 @@
buffer.append("</AnnotationSet>\n");
}// annotationSetToXml
-
/**
- * This method saves an AnnotationSet as XML.
+ * Converts the Annotation set to XML which is appended to the supplied
+ * StringBuffer instance. The standard
+ * {@link #annotationSetToXml(AnnotationSet, StringBuffer) method} uses the
+ * name that belongs to the provided annotation set, however, this method
+ * allows one to store the provided annotation set under a different
+ * annotation set name.
*
* @param anAnnotationSet
- * The annotation set that has to be saved as XML.
+ * the annotation set that has to be saved as XML.
* @param annotationSetNameToUse
- * The standard annotationSetToXml(AnnotaionSet, StringBuffer) uses
the name that belongs to the provided annotation set,
- * however, this method allows one to store the provided annotation
set under a different annotation set name.
- * @return a String like this: <AnnotationSet> <Annotation>....
- * </AnnotationSet>
+ * the new name for the annotation set being converted to XML
+ * @param buffer
+ * the StringBuffer that the XML representation should be appended
to
*/
public static void annotationSetToXml(AnnotationSet anAnnotationSet, String
annotationSetNameToUse,
StringBuffer buffer) {
Modified: gate/trunk/src/gate/corpora/SerialCorpusImpl.java
===================================================================
--- gate/trunk/src/gate/corpora/SerialCorpusImpl.java 2012-01-10 12:27:13 UTC
(rev 14977)
+++ gate/trunk/src/gate/corpora/SerialCorpusImpl.java 2012-01-10 13:05:19 UTC
(rev 14978)
@@ -390,7 +390,7 @@
* Fills the provided corpus with documents extracted from the
* provided single concatenated file.
*
- * @param trecFile the trec file.
+ * @param singleConcatenatedFile the single concatenated file.
* @param documentRootElement content between the start and end of
* this element is considered for documents.
* @param encoding the encoding of the trec file.
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
