You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opennlp.apache.org by jo...@apache.org on 2011/05/24 17:25:09 UTC

svn commit: r1127113 - in /incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/parser: AbstractBottomUpParser.java Parser.java

Author: joern
Date: Tue May 24 15:25:09 2011
New Revision: 1127113

URL: http://svn.apache.org/viewvc?rev=1127113&view=rev
Log:
OPENNLP-21 Fixed javadoc warnings

Modified:
    incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/parser/AbstractBottomUpParser.java
    incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/parser/Parser.java

Modified: incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/parser/AbstractBottomUpParser.java
URL: http://svn.apache.org/viewvc/incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/parser/AbstractBottomUpParser.java?rev=1127113&r1=1127112&r2=1127113&view=diff
==============================================================================
--- incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/parser/AbstractBottomUpParser.java (original)
+++ incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/parser/AbstractBottomUpParser.java Tue May 24 15:25:09 2011
@@ -502,7 +502,8 @@ public abstract class AbstractBottomUpPa
    * 
    * @param data The data stream of parses.
    * @param rules The head rules for the parses.
-   * @param cutoff The minimum number of entries required for the n-gram to be saved as part of the dictionary.
+   * @param params can contain a cutoff, the minimum number of entries required for the
+   *        n-gram to be saved as part of the dictionary.
    * @return A dictionary object.
    */
   public static Dictionary buildDictionary(ObjectStream<Parse> data, HeadRules rules, TrainingParameters params)
@@ -583,6 +584,14 @@ public abstract class AbstractBottomUpPa
     return mdict.toDictionary(true);
   }
   
+  /**
+   * Creates a n-gram dictionary from the specified data stream using the specified head rule and specified cut-off.
+   * 
+   * @param data The data stream of parses.
+   * @param rules The head rules for the parses.
+   * @param cutoff The minimum number of entries required for the n-gram to be saved as part of the dictionary.
+   * @return A dictionary object.
+   */
   public static Dictionary buildDictionary(ObjectStream<Parse> data, HeadRules rules, int cutoff)
       throws IOException {
     

Modified: incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/parser/Parser.java
URL: http://svn.apache.org/viewvc/incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/parser/Parser.java?rev=1127113&r1=1127112&r2=1127113&view=diff
==============================================================================
--- incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/parser/Parser.java (original)
+++ incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/parser/Parser.java Tue May 24 15:25:09 2011
@@ -27,7 +27,7 @@ public interface Parser {
    * Returns the specified number of parses or fewer for the specified tokens. <br>
    * <b>Note:</b> The nodes within
    * the returned parses are shared with other parses and therefore their parent node references will not be consistent
-   * with their child node reference.  {@link #setParents setParents} can be used to make the parents consistent
+   * with their child node reference.  {@link Parse#setParent(Parse)} can be used to make the parents consistent
    * with a particular parse, but subsequent calls to <code>setParents</code> can invalidate the results of earlier
    * calls.<br>
    * @param tokens A parse containing the tokens with a single parent node.