OPENNLP-1758: Enhance Javadoc of opennlp.uima (#813)

Author: mawiesne

opennlp-extensions/opennlp-uima/src/main/java/opennlp/uima/chunker/Chunker.java

@@ -38,25 +38,34 @@
 import opennlp.uima.util.UimaUtil;
 
 /**
- * OpenNLP Chunker annotator.
+ * An OpenNLP-based Chunker annotator.
  * <p>
- * Mandatory parameters
+ * Mandatory parameters:
  * <table border=1>
  * <caption></caption>
  * <tr><th>Type</th> <th>Name</th> <th>Description</th></tr>
- * <tr><td>String</td> <td>opennlp.uima.ModelName</td> <td>The name of the model file</td></tr>
- * <tr><td>String</td> <td>opennlp.uima.SentenceType</td> <td>The full name of the sentence type</td></tr>
- * <tr><td>String</td> <td>opennlp.uima.TokenType</td> <td>The full name of the token type</td></tr>
- * <tr><td>String</td> <td>opennlp.uima.POSFeature</td></tr>
- * <tr><td>String</td> <td>opennlp.uima.ChunkType</td></tr>
- * <tr><td>String</td> <td>opennlp.uima.ChunkTagFeature</td></tr>
+ * <tr><td>String</td>
+ *  <td>{@code opennlp.uima.ModelName}</td>
+ *  <td>The name of the model file</td>
+ * </tr>
+ * <tr><td>String</td>
+ *  <td>{@code opennlp.uima.SentenceType}</td>
+ *  <td>The full name of the sentence type</td>
+ * </tr>
+ * <tr><td>String</td>
+ *  <td>{@code opennlp.uima.TokenType}</td>
+ *  <td>The full name of the token type</td>
+ * </tr>
+ * <tr><td>String</td> <td>{@code opennlp.uima.POSFeature}</td></tr>
+ * <tr><td>String</td> <td>{@code opennlp.uima.ChunkType}</td></tr>
+ * <tr><td>String</td> <td>{@code opennlp.uima.ChunkTagFeature}</td></tr>
  * </table>
  * <p>
- * Optional parameters
+ * Optional parameters:
  * <table border=1>
  * <caption></caption>
  * <tr><th>Type</th> <th>Name</th> <th>Description</th></tr>
- * <tr><td>Integer</td> <td>opennlp.uima.BeamSize</td></tr>
+ * <tr><td>Integer</td> <td>{@code opennlp.uima.BeamSize}</td></tr>
  * </table>
  */
 public final class Chunker extends CasAnnotator_ImplBase {
@@ -70,8 +79,7 @@ public final class Chunker extends CasAnnotator_ImplBase {
   /**
    * The chunk tag feature parameter
    */
-  public static final String CHUNK_TAG_FEATURE_PARAMETER =
-      "opennlp.uima.ChunkTagFeature";
+  public static final String CHUNK_TAG_FEATURE_PARAMETER = "opennlp.uima.ChunkTagFeature";
 
   private Type mTokenType;
 
@@ -100,9 +108,8 @@ public Chunker() {
    * <p>
    * Note: Do all initialization in this method, do not use the constructor.
    */
-  public void initialize(UimaContext context)
-      throws ResourceInitializationException {
-
+  @Override
+  public void initialize(UimaContext context) throws ResourceInitializationException {
     super.initialize(context);
 
     this.context = context;
@@ -128,10 +135,10 @@ public void initialize(UimaContext context)
   }
 
   /**
-   * Initializes the type system.
+   * Initializes the {@link TypeSystem type system}.
    */
-  public void typeSystemInit(TypeSystem typeSystem)
-      throws AnalysisEngineProcessException {
+  @Override
+  public void typeSystemInit(TypeSystem typeSystem) throws AnalysisEngineProcessException {
 
     // chunk type
     mChunkType = AnnotatorUtil.getRequiredTypeParameter(context, typeSystem,
@@ -177,13 +184,10 @@ public void process(CAS tcas) {
     int index = 0;
 
     for (AnnotationFS tokenAnnotation : tokenAnnotationIndex) {
-
       tokenAnnotations[index] = tokenAnnotation;
-
       tokens[index] = tokenAnnotation.getCoveredText();
 
-      pos[index++] = tokenAnnotation.getFeatureValueAsString(
-          mPosFeature);
+      pos[index++] = tokenAnnotation.getFeatureValueAsString(mPosFeature);
     }
 
     String[] result = mChunker.chunk(tokens, pos);

opennlp-extensions/opennlp-uima/src/main/java/opennlp/uima/chunker/ChunkerModelResource.java

@@ -19,6 +19,10 @@
 
 import opennlp.tools.chunker.ChunkerModel;
 
+/**
+ * A resource encapsulating an OpenNLP {@link ChunkerModel} which can be shared between
+ * <i>analysis engines</i> and loaded via the UIMA resource model.
+ */
 public interface ChunkerModelResource {
 
   ChunkerModel getModel();

opennlp-extensions/opennlp-uima/src/main/java/opennlp/uima/chunker/ChunkerModelResourceImpl.java

@@ -23,6 +23,9 @@
 import opennlp.tools.chunker.ChunkerModel;
 import opennlp.uima.util.AbstractModelResource;
 
+/**
+ * A default implementation of {@link ChunkerModelResource}.
+ */
 public class ChunkerModelResourceImpl extends AbstractModelResource<ChunkerModel>
     implements ChunkerModelResource {
 

opennlp-extensions/opennlp-uima/src/main/java/opennlp/uima/dictionary/DictionaryResource.java

@@ -19,6 +19,11 @@
 
 import opennlp.tools.dictionary.Dictionary;
 
+/**
+ * A resource encapsulating an OpenNLP {@link Dictionary} which can be shared between
+ * <i>analysis engines</i> and loaded via the UIMA resource model.
+ */
 public interface DictionaryResource {
+  
   Dictionary getDictionary();
 }

opennlp-extensions/opennlp-uima/src/main/java/opennlp/uima/dictionary/DictionaryResourceImpl.java

@@ -23,6 +23,9 @@
 import opennlp.tools.dictionary.Dictionary;
 import opennlp.uima.util.AbstractModelResource;
 
+/**
+ * A default implementation of {@link DictionaryResource}.
+ */
 public class DictionaryResourceImpl extends AbstractModelResource<Dictionary>
     implements DictionaryResource {
 

opennlp-extensions/opennlp-uima/src/main/java/opennlp/uima/doccat/DoccatModelResource.java

@@ -19,6 +19,11 @@
 
 import opennlp.tools.doccat.DoccatModel;
 
+/**
+ * A resource encapsulating an OpenNLP {@link DoccatModel} which can be shared between
+ * <i>analysis engines</i> and loaded via the UIMA resource model.
+ */
 public interface DoccatModelResource {
+
   DoccatModel getModel();
 }

opennlp-extensions/opennlp-uima/src/main/java/opennlp/uima/doccat/DoccatModelResourceImpl.java

@@ -23,6 +23,9 @@
 import opennlp.tools.doccat.DoccatModel;
 import opennlp.uima.util.AbstractModelResource;
 
+/**
+ * A default implementation of {@link DoccatModelResource}.
+ */
 public class DoccatModelResourceImpl extends AbstractModelResource<DoccatModel>
     implements DoccatModelResource {
 

opennlp-extensions/opennlp-uima/src/main/java/opennlp/uima/namefind/NameFinder.java

@@ -36,27 +36,38 @@
 import opennlp.uima.util.UimaUtil;
 
 /**
- * OpenNLP Name annotator.
+ * An OpenNLP-based Name annotator.
  * <p>
- * Mandatory parameters
+ * Mandatory parameters:
  * <table border=1>
  * <caption></caption>
  * <tr><th>Type</th> <th>Name</th> <th>Description</th></tr>
- * <tr><td>String</td> <td>opennlp.uima.ModelName</td> <td>The name of the model file</td></tr>
- * <tr><td>String</td> <td>opennlp.uima.SentenceType</td> <td>The full name of the sentence type</td></tr>
- * <tr><td>String</td> <td>opennlp.uima.TokenType</td> <td>The full name of the token type</td></tr>
- * <tr><td>String</td> <td>opennlp.uima.NameType</td> <td>The full name of the name type</td></tr>
+ * <tr><td>String</td>
+ *  <td>{@code opennlp.uima.ModelName}</td>
+ *  <td>The name of the model file</td>
+ * </tr>
+ * <tr><td>String</td>
+ *  <td>{@code opennlp.uima.SentenceType}</td>
+ *  <td>The full name of the sentence type</td>
+ * </tr>
+ * <tr><td>String</td>
+ *  <td>{@code opennlp.uima.TokenType}</td>
+ *  <td>The full name of the token type</td>
+ * </tr>
+ * <tr><td>String</td>
+ *  <td>{@code opennlp.uima.NameType}</td>
+ *  <td>The full name of the name type</td>
+ * </tr>
  * </table>
  * <p>
- * Optional parameters
+ * Optional parameters:
  * <table border=1>
  * <caption></caption>
  * <tr><th>Type</th> <th>Name</th> <th>Description</th></tr>
- * <tr><td>String</td> <td>opennlp.uima.ProbabilityFeature</td> <td>The name of the double
+ * <tr><td>String</td> <td>{@code opennlp.uima.ProbabilityFeature}</td> <td>The name of the double
  * probability feature (not set by default)</td></tr>
- * <tr><td>Integer</td> <td>opennlp.uima.BeamSize</td></tr>
- * <tr><td>String</td> <td>opennlp.uima.DocumentConfidenceType</td></tr>
- * <tr><td>String</td> <td>opennlp.uima.DocumentConfidenceType</td></tr>
+ * <tr><td>Integer</td> <td>{@code opennlp.uima.BeamSize}</td></tr>
+ * <tr><td>String</td> <td>{@code opennlp.uima.DocumentConfidenceType}</td></tr>
  * </table>
  */
 public final class NameFinder extends AbstractNameFinder {
@@ -114,7 +125,6 @@ public NameFinder() {
    */
   @Override
   public void initialize() throws ResourceInitializationException {
-
     super.initialize();
 
     TokenNameFinderModel model;
@@ -132,11 +142,10 @@ public void initialize() throws ResourceInitializationException {
   }
 
   /**
-   * Initializes the type system.
+   * Initializes the {@link TypeSystem type system}.
    */
   @Override
   public void typeSystemInit(TypeSystem typeSystem) throws AnalysisEngineProcessException {
-
     super.typeSystemInit(typeSystem);
 
     probabilityFeature = AnnotatorUtil.getOptionalFeatureParameter(context, mNameType,

opennlp-extensions/opennlp-uima/src/main/java/opennlp/uima/namefind/TokenNameFinderModelResource.java

@@ -19,6 +19,11 @@
 
 import opennlp.tools.namefind.TokenNameFinderModel;
 
+/**
+ * A resource encapsulating an OpenNLP {@link TokenNameFinderModel} which can be shared between
+ * <i>analysis engines</i> and loaded via the UIMA resource model.
+ */
 public interface TokenNameFinderModelResource {
+  
   TokenNameFinderModel getModel();
 }

opennlp-extensions/opennlp-uima/src/main/java/opennlp/uima/namefind/TokenNameFinderModelResourceImpl.java

@@ -23,6 +23,9 @@
 import opennlp.tools.namefind.TokenNameFinderModel;
 import opennlp.uima.util.AbstractModelResource;
 
+/**
+ * A default implementation of {@link TokenNameFinderModelResource}.
+ */
 public class TokenNameFinderModelResourceImpl extends AbstractModelResource<TokenNameFinderModel>
     implements TokenNameFinderModelResource {