svn commit: r1580440 - /opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/BaseToolFactory.java

[jk...@apache.org]

Author: jkosin
Date: Sun Mar 23 04:24:07 2014
New Revision: 1580440

URL: http://svn.apache.org/r1580440
Log:
OPENNLP-669 Fixed list <li> and changed a @link to @code because I could not find the link.

Modified:
    opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/BaseToolFactory.java

Modified: opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/BaseToolFactory.java
URL: http://svn.apache.org/viewvc/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/BaseToolFactory.java?rev=1580440&r1=1580439&r2=1580440&view=diff
==============================================================================
--- opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/BaseToolFactory.java (original)
+++ opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/BaseToolFactory.java Sun Mar 23 04:24:07 2014
@@ -28,11 +28,14 @@ import opennlp.tools.util.model.BaseMode
 /**
  * Base class for all tool factories.
  * 
- * Extensions of this class should: <li>implement an empty constructor (TODO is
- * it necessary?) <li>implement a constructor that takes the
- * {@link ArtifactProvider} and calls {@link #BaseToolFactory(Map)} <li>override
- * {@link #createArtifactMap()} and {@link #createArtifactSerializersMap()}
- * methods if necessary.
+ * Extensions of this class should: 
+ * <ul>
+ *  <li>implement an empty constructor (TODO is it necessary?) 
+ *  <li>implement a constructor that takes the {@link ArtifactProvider} and 
+ *      calls {@code BaseToolFactory(Map)} 
+ *  <li>override {@link #createArtifactMap()} and 
+ *      {@link #createArtifactSerializersMap()} methods if necessary.
+ * </ul>
  */
 public abstract class BaseToolFactory {
 
@@ -54,7 +57,7 @@ public abstract class BaseToolFactory {
   /**
    * Creates a {@link Map} with pairs of keys and {@link ArtifactSerializer}.
    * The models implementation should call this method from
-   * {@link BaseModel#createArtifactSerializersMap}
+   * {@code BaseModel#createArtifactSerializersMap}
    * <p>
    * The base implementation will return a {@link HashMap} that should be
    * populated by sub-classes.