[gate-cvs] SF.net SVN: gate:[20040] gate/branches/sawdust2/plugins/Teamware_Tools/src/ main/java/gate/qa/QAForTeamwarePR.java

[<mar...@us...>]

Revision: 20040
          http://sourceforge.net/p/gate/code/20040
Author:   markagreenwood
Date:     2017-02-01 06:46:01 +0000 (Wed, 01 Feb 2017)
Log Message:
-----------
more javadoc fixes

Modified Paths:
--------------
    gate/branches/sawdust2/plugins/Teamware_Tools/src/main/java/gate/qa/QAForTeamwarePR.java

Modified: gate/branches/sawdust2/plugins/Teamware_Tools/src/main/java/gate/qa/QAForTeamwarePR.java
===================================================================
--- gate/branches/sawdust2/plugins/Teamware_Tools/src/main/java/gate/qa/QAForTeamwarePR.java	2017-02-01 06:34:45 UTC (rev 20039)
+++ gate/branches/sawdust2/plugins/Teamware_Tools/src/main/java/gate/qa/QAForTeamwarePR.java	2017-02-01 06:46:01 UTC (rev 20040)
@@ -797,7 +797,7 @@
 	/**
 	 * Annotation types for which the stats should be calculated
 	 * 
-	 * @return
+	 * @return the annotation types for which the states should be calculated
 	 */
 	public List<String> getAnnotationTypes() {
 		return annotationTypes;
@@ -806,7 +806,7 @@
 	/**
 	 * Annotation types for which the stats should be calculated
 	 * 
-	 * @param annotationTypes
+	 * @param annotationTypes the annotation types for which stats should be calculated
 	 */
 	@RunTime
 	@CreoleParameter
@@ -817,7 +817,7 @@
 	/**
 	 * Features names for which the stats should be calculated
 	 * 
-	 * @return
+	 * @return the feature names for which the states should be calculated
 	 */
 	public List<String> getFeatureNames() {
 		return featureNames;
@@ -826,7 +826,7 @@
 	/**
 	 * Features names for which the stats should be calculated
 	 * 
-	 * @param featureNames
+	 * @param featureNames the feature names for which the stats should be calculayed
 	 */
 	@RunTime
 	@Optional
@@ -838,7 +838,7 @@
 	/**
 	 * Measure to use for stats calculation
 	 * 
-	 * @return
+	 * @return the measure used for stats calculation
 	 */
 	public Measure getMeasure() {
 		return measure;
@@ -847,7 +847,7 @@
 	/**
 	 * Measure to use for stats calculation
 	 * 
-	 * @param measure
+	 * @param measure the measure to use for the stats calculation
 	 */
 	@RunTime
 	@CreoleParameter
@@ -858,7 +858,7 @@
 	/**
 	 * URL of the folder to store output files into
 	 * 
-	 * @return
+	 * @return the URL of the folder in which to store the output files
 	 */
 	public URL getOutputFolderUrl() {
 		return outputFolderUrl;
@@ -867,7 +867,7 @@
 	/**
 	 * URL of the folder to store output files into
 	 * 
-	 * @param outputFolderUrl
+	 * @param outputFolderUrl the URL of the folder in which to store the output files
 	 */
 	@RunTime
 	@CreoleParameter(suffixes = "html")
@@ -878,7 +878,7 @@
 	/**
 	 * annotators to ignore when computing IAA
 	 * 
-	 * @return
+	 * @return the list of annotators to ignore when cslculating IAA
 	 */
 	public List<String> getAnnotatorsToIgnore() {
 		return annotatorsToIgnore;
@@ -889,7 +889,7 @@
 	 * least one value provided for the annotationSetNamesAsAnnotators, this
 	 * parameter will have no effect.
 	 * 
-	 * @param annotatorsToIgnore
+	 * @param annotatorsToIgnore the list of annotators to ignore when doing the IAA calculation
 	 */
 	@RunTime
 	@Optional

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.