[gate-cvs] SF.net SVN: gate:[20042] gate/branches/sawdust2/plugins/Coref_Tools/src/ main/java/gate/creole/coref

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

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

Modified Paths:
--------------
    gate/branches/sawdust2/plugins/Coref_Tools/src/main/java/gate/creole/coref/Tagger.java
    gate/branches/sawdust2/plugins/Coref_Tools/src/main/java/gate/creole/coref/Utils.java
    gate/branches/sawdust2/plugins/Coref_Tools/src/main/java/gate/creole/coref/matchers/CompoundMatcher.java

Modified: gate/branches/sawdust2/plugins/Coref_Tools/src/main/java/gate/creole/coref/Tagger.java
===================================================================
--- gate/branches/sawdust2/plugins/Coref_Tools/src/main/java/gate/creole/coref/Tagger.java	2017-02-01 06:50:42 UTC (rev 20041)
+++ gate/branches/sawdust2/plugins/Coref_Tools/src/main/java/gate/creole/coref/Tagger.java	2017-02-01 06:57:31 UTC (rev 20042)
@@ -24,7 +24,7 @@
   
   /**
    * Gets the annotation type this {@link Tagger} instance is used for.
-   * @return
+   * @return the annotation type this tagger uses
    */
   public String getAnnotationType();
   

Modified: gate/branches/sawdust2/plugins/Coref_Tools/src/main/java/gate/creole/coref/Utils.java
===================================================================
--- gate/branches/sawdust2/plugins/Coref_Tools/src/main/java/gate/creole/coref/Utils.java	2017-02-01 06:50:42 UTC (rev 20041)
+++ gate/branches/sawdust2/plugins/Coref_Tools/src/main/java/gate/creole/coref/Utils.java	2017-02-01 06:57:31 UTC (rev 20042)
@@ -53,8 +53,8 @@
    * Given an input string matched by {@link #MWE_UPPER_INITIAL_PATTERN}, this 
    * method returns the initials for constituent words of the multi-word 
    * expression.
-   * @param input
-   * @return
+   * @param input the multi-word expression to process
+   * @return the initials of the multi-word expression
    */
   public static final char[] initialsForMwe(String input) {
     // split on whitespace
@@ -80,8 +80,8 @@
   /**
    * Checks whether the input string is a multi-word reference as recognised by
    * {@link #MWE_UPPER_INITIAL_PATTERN}.
-   * @param text
-   * @return
+   * @param text the text to process
+   * @return true if the text is a multi-word expression
    */
   public static final boolean isMwe(String text) {
     return MWE_UPPER_INITIAL_PATTERN.matcher(text).matches();

Modified: gate/branches/sawdust2/plugins/Coref_Tools/src/main/java/gate/creole/coref/matchers/CompoundMatcher.java
===================================================================
--- gate/branches/sawdust2/plugins/Coref_Tools/src/main/java/gate/creole/coref/matchers/CompoundMatcher.java	2017-02-01 06:50:42 UTC (rev 20041)
+++ gate/branches/sawdust2/plugins/Coref_Tools/src/main/java/gate/creole/coref/matchers/CompoundMatcher.java	2017-02-01 06:57:31 UTC (rev 20042)
@@ -32,8 +32,6 @@
   
   /**
    * Constructs a compound matcher from a list of sub-matchers.
-   * @param annotationType
-   * @param antecedentType
    * @throws ResourceInstantiationException if not all sub-matchers use the same
    * annotation type and antecedent type.
    */
@@ -42,9 +40,9 @@
   }
   
   /**
-   * 
-   * @param subMatchers
-   * @throws ResourceInstantiationException
+   * Constructs a compound matcher from an array of sub-matchers
+   * @throws ResourceInstantiationException if not all sub-matchers use the same
+   * annotation type and antecedent type. 
    */
   public CompoundMatcher(Matcher[] subMatchers) throws ResourceInstantiationException {
     super(subMatchers[0].getAnnotationType(), 
@@ -64,9 +62,6 @@
     }
   }
 
-  /* (non-Javadoc)
-   * @see gate.creole.coref.matchers.AbstractMatcher#init(gate.creole.coref.CorefBase)
-   */
   @Override
   public void init(CorefBase owner) throws ResourceInstantiationException {
     for(Matcher aMatcher : subMatchers) aMatcher.init(owner);

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