performed javacscript:fix and worked on documentation

[taxeditor.git] / taxeditor-store / src / main / java / eu / etaxonomy / taxeditor / parser / ParseHandler.java

diff --git a/taxeditor-store/src/main/java/eu/etaxonomy/taxeditor/parser/ParseHandler.java b/taxeditor-store/src/main/java/eu/etaxonomy/taxeditor/parser/ParseHandler.java
index 96bd7413569ebd36ccf49957f81ab96fe2eb97b9..47936053f0f2a4f2b1308d37a6b578d22413ed19 100644 (file)
--- a/taxeditor-store/src/main/java/eu/etaxonomy/taxeditor/parser/ParseHandler.java
+++ b/taxeditor-store/src/main/java/eu/etaxonomy/taxeditor/parser/ParseHandler.java
@@ -22,8 +22,10 @@ import eu.etaxonomy.taxeditor.store.CdmStore;
 import eu.etaxonomy.taxeditor.store.StoreUtil;
 
 /**
- * @author n.hoffmann
+ * <p>ParseHandler class.</p>
  *
+ * @author n.hoffmann
+ * @version $Id: $
  */
 public class ParseHandler{
 
@@ -76,10 +78,10 @@ public class ParseHandler{
        
        /**
         * Factory method to create a new instance of the this class
-        * 
+        *
         * @param textWidget    The text widget where the NonViralName may be entered into
-        * @param name                  An initial NonViralName or null when creating a new name 
-        * @return                              An instance of this class 
+        * @param name                  An initial NonViralName or null when creating a new name
+        * @return                              An instance of this class
         */
        public static ParseHandler NewInstance(Control textWidget, TaxonNameBase name){
                return new ParseHandler(textWidget, name);
@@ -87,15 +89,15 @@ public class ParseHandler{
        }
        
        /**
-        * Parses a given string and returns a <code>TaxonNameBase</code> instance with the 
+        * Parses a given string and returns a <code>TaxonNameBase</code> instance with the
         * reuslts of the parsing.
-        * 
+        *
         * This method should be used to quickly create a new name from a string.
-        * Wherever the string will be parsed again in subsequent editing, an instance 
+        * Wherever the string will be parsed again in subsequent editing, an instance
         * of <code>ParseHandler</code> should be attached to the text widget.
-        * 
-        * @param unparsedNameString
-        * @return
+        *
+        * @param unparsedNameString a {@link java.lang.String} object.
+        * @return a {@link eu.etaxonomy.cdm.model.name.TaxonNameBase} object.
         */
        public static TaxonNameBase quickParse(String unparsedNameString){
                TaxonNameBase name = nonViralNameParser.parseReferencedName(unparsedNameString,
@@ -111,8 +113,8 @@ public class ParseHandler{
        /**
         * Creates an empty <code>TaxonNameBase</code> instance with the nomenclatural code
         * currently set in preferences.
-        * 
-        * @return
+        *
+        * @return a {@link eu.etaxonomy.cdm.model.name.TaxonNameBase} object.
         */
        public static TaxonNameBase createEmptyName(){
                return nonViralNameParser.getNonViralNameInstance("", PreferencesUtil.getPreferredNomenclaturalCode());
@@ -134,8 +136,8 @@ public class ParseHandler{
        
        /**
         * Parses the string that was entered into the text widget and returns a
-        * NonViralName object that resulted from the parsing process. 
-        * 
+        * NonViralName object that resulted from the parsing process.
+        *
         * @return      The parsed NonViralName object
         */
        public NonViralName parse(){
@@ -164,12 +166,12 @@ public class ParseHandler{
        
        /**
         * Parses the string that was entered into the text widget and returns a
-        * NonViralName object that resulted from the parsing process. 
-        * 
+        * NonViralName object that resulted from the parsing process.
+        *
         * The atomized fields (scientific name, author and reference) will be matched
-        * against the database to find possible duplicates. If duplicates were found 
+        * against the database to find possible duplicates. If duplicates were found
         * the respective parts of the NonViralName will be replaced with the found
-        * objects. 
+        * objects.
         *
         * @return      The parsed NonViralName object
         */
@@ -353,6 +355,8 @@ public class ParseHandler{
        }
 
        /**
+        * <p>Getter for the field <code>textWidget</code>.</p>
+        *
         * @return The Control this ParseHandler is attached to.
         */
        public Control getTextWidget() {
@@ -360,6 +364,8 @@ public class ParseHandler{
        }
 
        /**
+        * <p>Setter for the field <code>textWidget</code>.</p>
+        *
         * @param textWidget The textWidget to set
         */
        public void setTextWidget(Control textWidget) {