performed javacscript:fix and worked on documentation

[taxeditor.git] / taxeditor-store / src / main / java / eu / etaxonomy / taxeditor / model / NameHelper.java

diff --git a/taxeditor-store/src/main/java/eu/etaxonomy/taxeditor/model/NameHelper.java b/taxeditor-store/src/main/java/eu/etaxonomy/taxeditor/model/NameHelper.java
index c342b418f3d83cbd3d88d40f1306ae0112867767..aa626693b9b9e75181723a74c2919e0d18658913 100644 (file)
--- a/taxeditor-store/src/main/java/eu/etaxonomy/taxeditor/model/NameHelper.java
+++ b/taxeditor-store/src/main/java/eu/etaxonomy/taxeditor/model/NameHelper.java
@@ -14,6 +14,8 @@ import eu.etaxonomy.cdm.model.name.TaxonNameBase;
 import eu.etaxonomy.cdm.model.taxon.TaxonBase;
 
 /**
+ * <p>NameHelper class.</p>
+ *
  * @author p.ciardelli
  * @author n.hoffmann
  * @created 18.03.2009
@@ -21,14 +23,32 @@ import eu.etaxonomy.cdm.model.taxon.TaxonBase;
  */
 public class NameHelper {      
 
+       /**
+        * <p>getDisplayName</p>
+        *
+        * @param name a {@link eu.etaxonomy.cdm.model.name.TaxonNameBase} object.
+        * @return a {@link java.lang.String} object.
+        */
        public static String getDisplayName(TaxonNameBase name){
                return name.getTitleCache();
        }
        
+       /**
+        * <p>getDisplayName</p>
+        *
+        * @param taxon a {@link eu.etaxonomy.cdm.model.taxon.TaxonBase} object.
+        * @return a {@link java.lang.String} object.
+        */
        public static String getDisplayName(TaxonBase<?> taxon){
                return getDisplayName(taxon.getName());
        }
        
+       /**
+        * <p>getDisplayNameWithRef</p>
+        *
+        * @param taxonBase a {@link eu.etaxonomy.cdm.model.taxon.TaxonBase} object.
+        * @return a {@link java.lang.String} object.
+        */
        public static String getDisplayNameWithRef(TaxonBase taxonBase) {
                TaxonNameBase name = (TaxonNameBase) HibernateProxyHelper.deproxy(taxonBase.getName());
                if (name != null) {