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/11/08 20:26:22 UTC
svn commit: r1199397 - in /incubator/opennlp/trunk:
opennlp-maxent/src/main/java/opennlp/maxent/io/
opennlp-maxent/src/main/java/opennlp/model/
opennlp-maxent/src/main/java/opennlp/perceptron/
opennlp-tools/src/main/java/opennlp/tools/dictionary/serial...
Author: joern
Date: Tue Nov 8 19:26:21 2011
New Revision: 1199397
URL: http://svn.apache.org/viewvc?rev=1199397&view=rev
Log:
OPENNLP-362 Fixed javadoc warnings. Thanks to Aliaksandr Autayeu for providing a patch.
Modified:
incubator/opennlp/trunk/opennlp-maxent/src/main/java/opennlp/maxent/io/ObjectGISModelReader.java
incubator/opennlp/trunk/opennlp-maxent/src/main/java/opennlp/model/SequenceStream.java
incubator/opennlp/trunk/opennlp-maxent/src/main/java/opennlp/perceptron/PerceptronTrainer.java
incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/dictionary/serializer/DictionarySerializer.java
incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/tokenize/TokenizerME.java
incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/eval/Evaluator.java
incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/model/ModelUtil.java
incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/normalizer/NumberUtil.java
incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/tokenize/Tokenizer.java
incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/tokenize/TokenizerModelResource.java
incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/util/AnnotationComparator.java
incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/util/OpennlpUtil.java
Modified: incubator/opennlp/trunk/opennlp-maxent/src/main/java/opennlp/maxent/io/ObjectGISModelReader.java
URL: http://svn.apache.org/viewvc/incubator/opennlp/trunk/opennlp-maxent/src/main/java/opennlp/maxent/io/ObjectGISModelReader.java?rev=1199397&r1=1199396&r2=1199397&view=diff
==============================================================================
--- incubator/opennlp/trunk/opennlp-maxent/src/main/java/opennlp/maxent/io/ObjectGISModelReader.java (original)
+++ incubator/opennlp/trunk/opennlp-maxent/src/main/java/opennlp/maxent/io/ObjectGISModelReader.java Tue Nov 8 19:26:21 2011
@@ -31,8 +31,7 @@ public class ObjectGISModelReader extend
* Constructor which directly instantiates the ObjectInputStream containing
* the model contents.
*
- * @param dis
- * The DataInputStream containing the model information.
+ * @param ois The DataInputStream containing the model information.
*/
public ObjectGISModelReader(ObjectInputStream ois) {
Modified: incubator/opennlp/trunk/opennlp-maxent/src/main/java/opennlp/model/SequenceStream.java
URL: http://svn.apache.org/viewvc/incubator/opennlp/trunk/opennlp-maxent/src/main/java/opennlp/model/SequenceStream.java?rev=1199397&r1=1199396&r2=1199397&view=diff
==============================================================================
--- incubator/opennlp/trunk/opennlp-maxent/src/main/java/opennlp/model/SequenceStream.java (original)
+++ incubator/opennlp/trunk/opennlp-maxent/src/main/java/opennlp/model/SequenceStream.java Tue Nov 8 19:26:21 2011
@@ -27,8 +27,7 @@ public interface SequenceStream extends
* Creates a new event array based on the outcomes predicted by the specified parameters
* for the specified sequence.
* @param sequence The sequence to be evaluated.
- * @param ep The parameters of the current model.
- * @return
+ * @return event array
*/
public Event[] updateContext(Sequence sequence, AbstractModel model);
Modified: incubator/opennlp/trunk/opennlp-maxent/src/main/java/opennlp/perceptron/PerceptronTrainer.java
URL: http://svn.apache.org/viewvc/incubator/opennlp/trunk/opennlp-maxent/src/main/java/opennlp/perceptron/PerceptronTrainer.java?rev=1199397&r1=1199396&r2=1199397&view=diff
==============================================================================
--- incubator/opennlp/trunk/opennlp-maxent/src/main/java/opennlp/perceptron/PerceptronTrainer.java (original)
+++ incubator/opennlp/trunk/opennlp-maxent/src/main/java/opennlp/perceptron/PerceptronTrainer.java Tue Nov 8 19:26:21 2011
@@ -118,9 +118,7 @@ public class PerceptronTrainer {
* of the more volatile early iterations. The use of perfect
* squares allows us to sample from successively farther apart iterations.
*
- * @param averaging
- *
- * @return
+ * @param averaging averaging flag
*/
public void setSkippedAveraging(boolean averaging) {
useSkippedlAveraging = averaging;
Modified: incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/dictionary/serializer/DictionarySerializer.java
URL: http://svn.apache.org/viewvc/incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/dictionary/serializer/DictionarySerializer.java?rev=1199397&r1=1199396&r2=1199397&view=diff
==============================================================================
--- incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/dictionary/serializer/DictionarySerializer.java (original)
+++ incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/dictionary/serializer/DictionarySerializer.java Tue Nov 8 19:26:21 2011
@@ -195,13 +195,13 @@ public class DictionarySerializer {
/**
- * Creates {@link Entry}s form the given {@link InputStream} and
+ * Creates {@link Entry}s from the given {@link InputStream} and
* forwards these {@link Entry}s to the {@link EntryInserter}.
*
* After creation is finished the provided {@link InputStream} is closed.
*
- * @param in
- * @param inserter
+ * @param in stream to read entries from
+ * @param inserter inserter to forward entries to
*
* @return isCaseSensitive attribute for Dictionary
*
@@ -233,11 +233,11 @@ public class DictionarySerializer {
* After the serialization is finished the provided
* {@link OutputStream} remains open.
*
- * @param out
- * @param entries
+ * @param out stream to serialize to
+ * @param entries entries to serialize
*
* @throws IOException If an I/O error occurs
- * @deprecated Use {@link DictionarySerializer#serialize(java.io.OutputStream, java.util.Iterator, boolean) instead
+ * @deprecated Use {@link DictionarySerializer#serialize(java.io.OutputStream, java.util.Iterator, boolean)} instead
*/
@Deprecated
public static void serialize(OutputStream out, Iterator<Entry> entries)
@@ -251,8 +251,8 @@ public class DictionarySerializer {
* After the serialization is finished the provided
* {@link OutputStream} remains open.
*
- * @param out
- * @param entries
+ * @param out stream to serialize to
+ * @param entries entries to serialize
* @param casesensitive indicates if the written dictionary
* should be case sensitive or case insensitive.
*
Modified: incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/tokenize/TokenizerME.java
URL: http://svn.apache.org/viewvc/incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/tokenize/TokenizerME.java?rev=1199397&r1=1199396&r2=1199397&view=diff
==============================================================================
--- incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/tokenize/TokenizerME.java (original)
+++ incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/tokenize/TokenizerME.java Tue Nov 8 19:26:21 2011
@@ -89,7 +89,7 @@ public class TokenizerME extends Abstrac
/**
* Alpha-Numeric Pattern
- * @deprecated As of release 1.5.2, replaced by {@link Factory#getAlphanumericPattern(String)}
+ * @deprecated As of release 1.5.2, replaced by {@link Factory#getAlphanumeric(String)}
*/
@Deprecated
public static final Pattern alphaNumeric = Pattern.compile(Factory.DEFAULT_ALPHANUMERIC);
Modified: incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/eval/Evaluator.java
URL: http://svn.apache.org/viewvc/incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/eval/Evaluator.java?rev=1199397&r1=1199396&r2=1199397&view=diff
==============================================================================
--- incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/eval/Evaluator.java (original)
+++ incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/eval/Evaluator.java Tue Nov 8 19:26:21 2011
@@ -66,11 +66,11 @@ public abstract class Evaluator<T> {
/**
* Evaluates the given reference object. The default implementation calls
- * {@link Evaluator#processSample(T)}
+ * {@link Evaluator#processSample(Object)}
*
* <p>
* <b>note:</b> this method will be changed to private in the future.
- * Implementations should override {@link Evaluator#processSample(T)} instead.
+ * Implementations should override {@link Evaluator#processSample(Object)} instead.
* If this method is override, the implementation has to update the score
* after every invocation.
* </p>
@@ -100,7 +100,8 @@ public abstract class Evaluator<T> {
*
* @param samples the stream of reference which
* should be evaluated.
- *
+ *
+ * @throws IOException IOException
*/
public void evaluate(ObjectStream<T> samples) throws IOException {
T sample;
Modified: incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/model/ModelUtil.java
URL: http://svn.apache.org/viewvc/incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/model/ModelUtil.java?rev=1199397&r1=1199396&r2=1199397&view=diff
==============================================================================
--- incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/model/ModelUtil.java (original)
+++ incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/model/ModelUtil.java Tue Nov 8 19:26:21 2011
@@ -133,10 +133,10 @@ public final class ModelUtil {
/**
* Note: Do not use this legacy support method, internal use only!
*
- * @param iterations
- * @param cutoff
+ * @param iterations number of iterations
+ * @param cutoff cutoff threshold
*
- * @return
+ * @return training parameters instance
*/
public static TrainingParameters createTrainingParameters(int iterations, int cutoff) {
TrainingParameters mlParams = new TrainingParameters();
Modified: incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/normalizer/NumberUtil.java
URL: http://svn.apache.org/viewvc/incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/normalizer/NumberUtil.java?rev=1199397&r1=1199396&r2=1199397&view=diff
==============================================================================
--- incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/normalizer/NumberUtil.java (original)
+++ incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/normalizer/NumberUtil.java Tue Nov 8 19:26:21 2011
@@ -30,8 +30,8 @@ public final class NumberUtil {
/**
* Checks if the language is supported.
*
- * @param languageCode
- * @return
+ * @param languageCode language code, e.g. "en", "pt"
+ * @return true if the language is supported
*/
public static boolean isLanguageSupported(String languageCode) {
Locale locale = new Locale(languageCode);
@@ -73,10 +73,10 @@ public final class NumberUtil {
/**
* Gives its best to parse the provided number.
*
- * @param number
- * @param languageCode
- * @return
- * @throws ParseException
+ * @param number number to parse
+ * @param languageCode language code, e.g. "en", "pt"
+ * @return parsed number
+ * @throws ParseException ParseException
*/
public static Number parse(String number, String languageCode)
throws ParseException {
Modified: incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/tokenize/Tokenizer.java
URL: http://svn.apache.org/viewvc/incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/tokenize/Tokenizer.java?rev=1199397&r1=1199396&r2=1199397&view=diff
==============================================================================
--- incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/tokenize/Tokenizer.java (original)
+++ incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/tokenize/Tokenizer.java Tue Nov 8 19:26:21 2011
@@ -49,7 +49,8 @@ import org.apache.uima.resource.Resource
* <tr><td>String</td> <td>opennlp.uima.ProbabilityFeature</td> <td>The name of the double
* probability feature (not set by default)</td>
* </table>
- * @see {@link TokenizerME}
+ *
+ * @see TokenizerME
*/
public final class Tokenizer extends AbstractTokenizer {
Modified: incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/tokenize/TokenizerModelResource.java
URL: http://svn.apache.org/viewvc/incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/tokenize/TokenizerModelResource.java?rev=1199397&r1=1199396&r2=1199397&view=diff
==============================================================================
--- incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/tokenize/TokenizerModelResource.java (original)
+++ incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/tokenize/TokenizerModelResource.java Tue Nov 8 19:26:21 2011
@@ -30,7 +30,7 @@ public interface TokenizerModelResource
/**
* Retrieves the shared model instance.
*
- * @return
+ * @return the shared model instance
*/
TokenizerModel getModel();
}
Modified: incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/util/AnnotationComparator.java
URL: http://svn.apache.org/viewvc/incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/util/AnnotationComparator.java?rev=1199397&r1=1199396&r2=1199397&view=diff
==============================================================================
--- incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/util/AnnotationComparator.java (original)
+++ incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/util/AnnotationComparator.java Tue Nov 8 19:26:21 2011
@@ -23,8 +23,6 @@ import org.apache.uima.cas.text.Annotati
/**
* Checks two annotations for equality.
- *
- * @param <T>
*/
public class AnnotationComparator implements Comparator<AnnotationFS>
{
@@ -32,7 +30,7 @@ public class AnnotationComparator implem
/**
* Compares the begin indexes of the annotations.
*
- * @param a - first anntoation
+ * @param a - first annotation
* @param b - second annotation
*
* @return 0 if equals, < 0 if before and > 0 if after
Modified: incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/util/OpennlpUtil.java
URL: http://svn.apache.org/viewvc/incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/util/OpennlpUtil.java?rev=1199397&r1=1199396&r2=1199397&view=diff
==============================================================================
--- incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/util/OpennlpUtil.java (original)
+++ incubator/opennlp/trunk/opennlp-uima/src/main/java/opennlp/uima/util/OpennlpUtil.java Tue Nov 8 19:26:21 2011
@@ -38,9 +38,8 @@ final public class OpennlpUtil {
* Serializes a {@link GISModel} and writes it to the given
* {@link OutputStream}.
*
- * @param model
- * @param out
- * @throws IOException
+ * @param model model to serialize
+ * @throws IOException IOException
*/
public static void serialize(BaseModel model, File modelFile)
throws IOException {