performed javacscript:fix and worked on documentation

[taxeditor.git] / taxeditor-editor / src / main / java / eu / etaxonomy / taxeditor / dialogs / filteredSelection / FilteredNameSelectionDialog.java

diff --git a/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/dialogs/filteredSelection/FilteredNameSelectionDialog.java b/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/dialogs/filteredSelection/FilteredNameSelectionDialog.java
index 4aab65894c23aa8f8669188876674ad22e78ec26..da2df9c18df6167576a23ef66678247d4124e429 100644 (file)
--- a/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/dialogs/filteredSelection/FilteredNameSelectionDialog.java
+++ b/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/dialogs/filteredSelection/FilteredNameSelectionDialog.java
@@ -21,6 +21,8 @@ import eu.etaxonomy.taxeditor.editor.newWizard.NewNonViralNameWizard;
 import eu.etaxonomy.taxeditor.store.CdmStore;
 
 /**
+ * <p>FilteredNameSelectionDialog class.</p>
+ *
  * @author n.hoffmann
  * @created 04.06.2009
  * @version 1.0
@@ -29,13 +31,13 @@ public class FilteredNameSelectionDialog extends AbstractFilteredCdmResourceSele
 
        /**
         * Creates a filtered selection dialog to select a name.
-        * 
+        *
         * @param shell
         *                              The shell for displaying this widget
         * @param name
         *                              A name that should be selected when the dialog opens
-        * @return
-        *                              A name object upon selection
+        * @param conversation a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
+        * @return a {@link eu.etaxonomy.cdm.model.name.TaxonNameBase} object.
         */
        public static TaxonNameBase select(Shell shell, ConversationHolder conversation, TaxonNameBase name) {
                FilteredNameSelectionDialog dialog = new FilteredNameSelectionDialog(shell, conversation,
@@ -44,10 +46,14 @@ public class FilteredNameSelectionDialog extends AbstractFilteredCdmResourceSele
        }
        
        /**
-       * @param shell
-       * @param title
-        * @param name 
-       */
+        * <p>Constructor for FilteredNameSelectionDialog.</p>
+        *
+        * @param shell a {@link org.eclipse.swt.widgets.Shell} object.
+        * @param title a {@link java.lang.String} object.
+        * @param name a {@link eu.etaxonomy.cdm.model.name.TaxonNameBase} object.
+        * @param conversation a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
+        * @param multi a boolean.
+        */
        protected FilteredNameSelectionDialog(Shell shell, ConversationHolder conversation, String title, boolean multi, TaxonNameBase name) {
                super(shell, conversation, title, multi, FilteredNameSelectionDialog.class.getCanonicalName(), name);
        }
@@ -55,6 +61,7 @@ public class FilteredNameSelectionDialog extends AbstractFilteredCdmResourceSele
        /* (non-Javadoc)
         * @see eu.etaxonomy.taxeditor.dialogs.AbstractFilteredCdmResourceSelectionDialog#getPersistentObject(java.util.UUID)
         */
+       /** {@inheritDoc} */
        @Override
        protected TaxonNameBase getPersistentObject(UUID cdmUuid) {
                return CdmStore.getNameService().load(cdmUuid);
@@ -63,16 +70,19 @@ public class FilteredNameSelectionDialog extends AbstractFilteredCdmResourceSele
        /* (non-Javadoc)
         * @see eu.etaxonomy.taxeditor.dialogs.AbstractFilteredCdmResourceSelectionDialog#initModel()
         */
+       /** {@inheritDoc} */
        @Override
        protected void initModel() {
                model = CdmStore.getNameService().getUuidAndTitleCache();               
        }
 
+       /** {@inheritDoc} */
        @Override
        protected AbstractNewEntityWizard getNewEntityWizard() {
                return new NewNonViralNameWizard();
        }
 
+       /** {@inheritDoc} */
        @Override
        protected String getNewWizardLinkText() {
                return "Click <A>here</A> to create a new name.";