You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2010/05/18 14:22:43 UTC
svn commit: r945615 - in /uima/sandbox/trunk:
BSFAnnotator/src/main/java/org/apache/uima/annotator/bsf/
ConceptMapper/src/main/java/org/apache/uima/conceptMapper/
ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/dictionaryResource/
Con...
Author: schor
Date: Tue May 18 12:22:42 2010
New Revision: 945615
URL: http://svn.apache.org/viewvc?rev=945615&view=rev
Log:
[UIMA-1756] fix Javadoc warnings
Modified:
uima/sandbox/trunk/BSFAnnotator/src/main/java/org/apache/uima/annotator/bsf/BSFAnnotatorConfigurationException.java
uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/ConceptMapper.java
uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/dictionaryResource/DictionaryResource.java
uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/dictionaryResource/DictionaryResource_impl.java
uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/dictionaryResource/EntryProperties.java
uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/tokenizer/OffsetTokenizer.java
uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/tokens/TokenFilter.java
uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/tokens/TokenNormalizer.java
uima/sandbox/trunk/Tagger/src/main/java/org/apache/uima/examples/tagger/IModelResource.java
uima/sandbox/trunk/Tagger/src/main/java/org/apache/uima/examples/tagger/Tagger.java
uima/sandbox/trunk/Tagger/src/main/java/org/apache/uima/examples/tagger/Viterbi.java
Modified: uima/sandbox/trunk/BSFAnnotator/src/main/java/org/apache/uima/annotator/bsf/BSFAnnotatorConfigurationException.java
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/BSFAnnotator/src/main/java/org/apache/uima/annotator/bsf/BSFAnnotatorConfigurationException.java?rev=945615&r1=945614&r2=945615&view=diff
==============================================================================
--- uima/sandbox/trunk/BSFAnnotator/src/main/java/org/apache/uima/annotator/bsf/BSFAnnotatorConfigurationException.java (original)
+++ uima/sandbox/trunk/BSFAnnotator/src/main/java/org/apache/uima/annotator/bsf/BSFAnnotatorConfigurationException.java Tue May 18 12:22:42 2010
@@ -18,6 +18,8 @@
*/
package org.apache.uima.annotator.bsf;
+import java.text.MessageFormat;
+
import org.apache.uima.resource.ResourceInitializationException;
/**
@@ -37,7 +39,7 @@ public class BSFAnnotatorConfigurationEx
* @param aMessageKey
* an identifier that maps to the message for this exception. The message may contain
* placeholders for arguments as defined by the
- * {@link java.text.MessageFormat MessageFormat} class.
+ * {@link MessageFormat} class.
* @param aArguments
* The arguments to the message. <code>null</code> may be used if the message has no
* arguments.
@@ -53,7 +55,7 @@ public class BSFAnnotatorConfigurationEx
* @param aMessageKey
* an identifier that maps to the message for this exception. The message may contain
* placeholders for arguments as defined by the
- * {@link java.text.MessageFormat MessageFormat} class.
+ * {@link MessageFormat} class.
* @param aArguments
* The arguments to the message. <code>null</code> may be used if the message has no
* arguments.
Modified: uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/ConceptMapper.java
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/ConceptMapper.java?rev=945615&r1=945614&r2=945615&view=diff
==============================================================================
--- uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/ConceptMapper.java (original)
+++ uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/ConceptMapper.java Tue May 18 12:22:42 2010
@@ -364,7 +364,7 @@ public class ConceptMapper extends Annot
/**
* Perform local type system initialization.
*
- * @param aTypeSystem
+ * @param typeSystem
* the current type system.
* @see org.apache.uima.analysis_engine.annotator.TextAnnotator#typeSystemInit(TypeSystem)
*/
@@ -480,7 +480,7 @@ public class ConceptMapper extends Annot
* Perform the actual analysis. Iterate over the document content looking for any matching words
* or phrases in the loaded dictionary and post an annotation for each match found.
*
- * @param aTCAS
+ * @param tcas
* the current CAS to process.
* @param aResultSpec
* a specification of the result annotation that should be created by this annotator
Modified: uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/dictionaryResource/DictionaryResource.java
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/dictionaryResource/DictionaryResource.java?rev=945615&r1=945614&r2=945615&view=diff
==============================================================================
--- uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/dictionaryResource/DictionaryResource.java (original)
+++ uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/dictionaryResource/DictionaryResource.java Tue May 18 12:22:42 2010
@@ -60,8 +60,7 @@ public interface DictionaryResource {
void putEntry(String[] elements, String unsorted, EntryProperties props);
/**
- * @param string
- * @return
+ * @return list of dictionary entries
*/
ArrayList<DictEntry> getEntries();
@@ -89,7 +88,7 @@ public interface DictionaryResource {
* return data structure containing a list of dictionary entries, sorted by number of tokens
*
* @param key
- * @return
+ * @return data structure containing a list of dictionary entries, sorted by number of tokens
*/
public DictEntriesByLength getEntries(String key);
@@ -109,17 +108,17 @@ public interface DictionaryResource {
public void putEntry(String key, String[] tokens, String unsortedEntry,
int length, EntryProperties props);
- /**
- * @return
- */
public Enumeration<String> keys();
public String toString();
/**
* @param context
- * @param tokenizerDescriptor
+ * @param logger
* @param tokenAnnotationName
+ * @param tokenTypeFeatureName
+ * @param tokenClassFeatureName
+ * @param tokenizerDescriptor
* @throws ResourceInitializationException
*/
public void loadDictionaryContents(AnnotatorContext context, Logger logger,
Modified: uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/dictionaryResource/DictionaryResource_impl.java
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/dictionaryResource/DictionaryResource_impl.java?rev=945615&r1=945614&r2=945615&view=diff
==============================================================================
--- uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/dictionaryResource/DictionaryResource_impl.java (original)
+++ uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/dictionaryResource/DictionaryResource_impl.java Tue May 18 12:22:42 2010
@@ -126,7 +126,6 @@ public class DictionaryResource_impl imp
public int entryNum = 0;
/**
- * @param NumOfInitialDictEntries
*
*/
public DictionaryResource_impl() {
@@ -136,7 +135,7 @@ public class DictionaryResource_impl imp
}
/**
- * @param NumOfInitialDictEntries
+ * @param initialDictEntries Number of initial dictionary entries
*
*/
public DictionaryResource_impl(int initialDictEntries) {
@@ -459,7 +458,6 @@ public class DictionaryResource_impl imp
EntryProperties properties;
/**
- * @param text
* @param elements
* @param unsorted
* @param properties
Modified: uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/dictionaryResource/EntryProperties.java
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/dictionaryResource/EntryProperties.java?rev=945615&r1=945614&r2=945615&view=diff
==============================================================================
--- uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/dictionaryResource/EntryProperties.java (original)
+++ uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/dictionaryResource/EntryProperties.java Tue May 18 12:22:42 2010
@@ -31,7 +31,7 @@ public class EntryProperties implements
/**
*
- * @param factory
+ * @param root
* @param maxNumberOfProperties
* @throws NullPointerException
*
Modified: uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/tokenizer/OffsetTokenizer.java
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/tokenizer/OffsetTokenizer.java?rev=945615&r1=945614&r2=945615&view=diff
==============================================================================
--- uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/tokenizer/OffsetTokenizer.java (original)
+++ uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/tokenizer/OffsetTokenizer.java Tue May 18 12:22:42 2010
@@ -34,7 +34,7 @@ import org.apache.uima.jcas.JCas;
/**
* Simple class to tokenize a string (similar to <code>java.util.StringTokenizer</code>), except
* that this tokenizer returns
- * {@link org.apache.uima.conceptMapper.support.TokenAnnotation TokenAnnotation} objects, which, in
+ * {@link TokenAnnotation} objects, which, in
* addition to the token text string, also contain the start and end offsets of the token in the
* original string.
* <p>
@@ -42,7 +42,7 @@ import org.apache.uima.jcas.JCas;
* The tokenizer will optionally perform stemming and case normalization on the tokens, and the set
* of characters that delimit tokens may be specified. The default stemmer is the Snowball Porter
* stemmer, but any stemmer may be supplied to the tokenizer as long as it implements the
- * {@link org.apache.uima.conceptMapper.support.Stemmer Stemmer}interface.
+ * {@link org.apache.uima.conceptMapper.support.stemmer.Stemmer Stemmer}interface.
*
*/
public class OffsetTokenizer extends JTextAnnotator_ImplBase {
@@ -134,8 +134,9 @@ public class OffsetTokenizer extends JT
/**
* Set the text to tokenize. After this method is called, the next call to
- * {@link #nextToken nextToken} will return the first token from the input string
- * {@link TextToken.text}
+ * {@link #nextToken(JCas) nextToken} will return the first token from the input string
+ * as a TokenAnnotation; you can get the text by using
+ * {@link TokenAnnotation#getText()}
*/
public void setText(String text) {
this.text = text;
@@ -371,12 +372,12 @@ public class OffsetTokenizer extends JT
* Perform the actual analysis. Iterate over the document content looking for tokens and post an
* annotation for each match found.
*
- * @param aTCAS
+ * @param jcas
* the current CAS to process.
* @param aResultSpec
* a specification of the result annotation that should be created by this annotator
*
- * @see org.apache.uima.analysis_engine.annotator.JTextAnnotator#process(ResultSpecification)
+ * @see org.apache.uima.analysis_engine.annotator.JTextAnnotator#process(JCas, ResultSpecification)
*/
public void process(JCas jcas, ResultSpecification aResultSpec) throws AnnotatorProcessException {
@@ -402,7 +403,6 @@ public class OffsetTokenizer extends JT
* @param jcas
* @param documentText
* @param delimiters
- * @param logger
*/
protected void doTokenization(JCas jcas, String documentText, String delimiters) {
@@ -421,8 +421,8 @@ public class OffsetTokenizer extends JT
}
/**
- * @param configParametersNames
- * @param configParameters
+ * @param configParameterName
+ * @param configParameterValue
*/
public void processConfigurationParameter(String configParameterName, Object configParameterValue) {
if (configParameterName.equals(PARAM_CASE_MATCH)) {
Modified: uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/tokens/TokenFilter.java
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/tokens/TokenFilter.java?rev=945615&r1=945614&r2=945615&view=diff
==============================================================================
--- uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/tokens/TokenFilter.java (original)
+++ uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/tokens/TokenFilter.java Tue May 18 12:22:42 2010
@@ -209,7 +209,7 @@ public class TokenFilter {
}
/**
- * @param tokenClass
+ * @param token
* tokenClass to look up
* @return true if in includedTokenClasses or if both includedTokenClasses and
* excludedTokenClasses are unset, of if excludedTokenClasses does not contain an entry
@@ -270,8 +270,8 @@ public class TokenFilter {
}
/**
- * @param intValue
- * @return
+ * @param token
+ * @return false if tokenTypeFeature is set, and the token's tokenTypeFeature slot is set, but the value is not OK
*/
public boolean checkTokenType(AnnotationFS token) {
boolean returnValue = true;
Modified: uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/tokens/TokenNormalizer.java
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/tokens/TokenNormalizer.java?rev=945615&r1=945614&r2=945615&view=diff
==============================================================================
--- uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/tokens/TokenNormalizer.java (original)
+++ uima/sandbox/trunk/ConceptMapper/src/main/java/org/apache/uima/conceptMapper/support/tokens/TokenNormalizer.java Tue May 18 12:22:42 2010
@@ -66,10 +66,8 @@ public class TokenNormalizer {
private boolean replaceCommaWithAND;
/**
- * @param replaceCommaWithAND
- * @param all
- * @param digit
- * @param cap
+ * @param annotatorContext
+ * @param logger
* @throws AnnotatorContextException
*/
public TokenNormalizer(AnnotatorContext annotatorContext, Logger logger)
Modified: uima/sandbox/trunk/Tagger/src/main/java/org/apache/uima/examples/tagger/IModelResource.java
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/Tagger/src/main/java/org/apache/uima/examples/tagger/IModelResource.java?rev=945615&r1=945614&r2=945615&view=diff
==============================================================================
--- uima/sandbox/trunk/Tagger/src/main/java/org/apache/uima/examples/tagger/IModelResource.java (original)
+++ uima/sandbox/trunk/Tagger/src/main/java/org/apache/uima/examples/tagger/IModelResource.java Tue May 18 12:22:42 2010
@@ -27,10 +27,6 @@ import org.apache.uima.examples.tagger.t
*/
public interface IModelResource {
- /**
- * Obtain an input stream for this resource.
- * @return
- */
ModelGeneration getModel();
}
Modified: uima/sandbox/trunk/Tagger/src/main/java/org/apache/uima/examples/tagger/Tagger.java
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/Tagger/src/main/java/org/apache/uima/examples/tagger/Tagger.java?rev=945615&r1=945614&r2=945615&view=diff
==============================================================================
--- uima/sandbox/trunk/Tagger/src/main/java/org/apache/uima/examples/tagger/Tagger.java (original)
+++ uima/sandbox/trunk/Tagger/src/main/java/org/apache/uima/examples/tagger/Tagger.java Tue May 18 12:22:42 2010
@@ -33,7 +33,8 @@ import org.apache.uima.resource.Resource
*
* Known implementations: {@link HMMTagger} using {@link Viterbi} algorithm
* to compute the most probable path of parts of speech for a given sequence of tokens
- * @see Viterbi, HMMTagger
+ * @see Viterbi
+ * @see HMMTagger
*/
@@ -48,7 +49,7 @@ public interface Tagger {
/**
* Trains a new model for tagger, if a training is defined in {@code tagger.properties} file
- * @see ModelGenerator
+ * @see org.apache.uima.examples.tagger.trainAndTest#ModelGeneration
*/
Modified: uima/sandbox/trunk/Tagger/src/main/java/org/apache/uima/examples/tagger/Viterbi.java
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/Tagger/src/main/java/org/apache/uima/examples/tagger/Viterbi.java?rev=945615&r1=945614&r2=945615&view=diff
==============================================================================
--- uima/sandbox/trunk/Tagger/src/main/java/org/apache/uima/examples/tagger/Viterbi.java (original)
+++ uima/sandbox/trunk/Tagger/src/main/java/org/apache/uima/examples/tagger/Viterbi.java Tue May 18 12:22:42 2010
@@ -66,12 +66,14 @@ public class Viterbi {
/**
* @param N
* @param sentence
- * @param pos_s
+ * @param suffix_tree
+ * @param suffix_tree_cap
* @param transition_probs
* @param word_probs
* @param lambdas2
- * , lambdas3
- * @return
+ * @param lambdas3
+ * @param theta
+ * @return the viterbi path
*/
@SuppressWarnings("unchecked")
public static List process(int N, List<String> sentence,