performed javacscript:fix and worked on documentation
[taxeditor.git] / taxeditor-store / src / main / java / eu / etaxonomy / taxeditor / model / TimeHelper.java
index abe5b450a8a9681ba8ca2a74253917db0e4e2040..447e5a7cb904fdb30bc71d35169bbe976ac95720 100644 (file)
@@ -12,6 +12,8 @@ package eu.etaxonomy.taxeditor.model;
 import eu.etaxonomy.cdm.model.common.TimePeriod;
 
 /**
+ * <p>TimeHelper class.</p>
+ *
  * @autor p.ciardelli
  * @author n.hoffmann
  * @created 18.03.2009
@@ -19,13 +21,13 @@ import eu.etaxonomy.cdm.model.common.TimePeriod;
  */
 public class TimeHelper {
        /**
-        * Converts a <code>String</code> whose format is either a valid year 
-        * or two valid years with the format "XXXX-XXXX" into a TimePeriod. 
+        * Converts a <code>String</code> whose format is either a valid year
+        * or two valid years with the format "XXXX-XXXX" into a TimePeriod.
         *
         * @see #getValidYear(String yearStr)
-        * @param refYear
-        * @return
-        * @throws NumberFormatException
+        * @param refYear a {@link java.lang.String} object.
+        * @throws java.lang.NumberFormatException if any.
+        * @return a {@link eu.etaxonomy.cdm.model.common.TimePeriod} object.
         */
        public static TimePeriod convertTimePeriod(String refYear) throws NumberFormatException {
                
@@ -57,10 +59,10 @@ public class TimeHelper {
        /**
         * Checks whether a <code>String</code> is a valid year between
         * 1750 and 2030. Throws a <code>NumberFormatException</code> if not.
-        * 
-        * @param yearStr
-        * @return
-        * @throws NumberFormatException
+        *
+        * @param yearStr a {@link java.lang.String} object.
+        * @throws java.lang.NumberFormatException if any.
+        * @return a {@link java.lang.Integer} object.
         */
        public static Integer getValidYear(String yearStr) throws NumberFormatException {