Javadoc changes attached to https://bugs.eclipse.org/bugs/show_bug.cgi?id=251794 by Debajit.

5 files changed, 131 insertions, 39 deletions

diff --git a/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/command/ElementCustomizationCommand.java b/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/command/ElementCustomizationCommand.java
index e1a56ba50..b902155c5 100644
--- a/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/command/ElementCustomizationCommand.java
+++ b/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/command/ElementCustomizationCommand.java
@@ -66,6 +66,10 @@ public class ElementCustomizationCommand extends AbstractCreationCommand
         _creationData = creationData;
     }
 
+    
+    /* (non-Javadoc)
+     * @see org.eclipse.jst.pagedesigner.itemcreation.internal.AbstractCreationCommand#execute()
+     */
     @Override
     public void execute()
     {
@@ -73,6 +77,10 @@ public class ElementCustomizationCommand extends AbstractCreationCommand
         applyAttributeCustomization();
     }
 
+    
+    /* (non-Javadoc)
+     * @see org.eclipse.jst.pagedesigner.itemcreation.internal.AbstractCreationCommand#prepare()
+     */
     @Override
     protected boolean prepare()
     {
@@ -159,12 +167,20 @@ public class ElementCustomizationCommand extends AbstractCreationCommand
         }
     }
 
+    
+    /* (non-Javadoc)
+     * @see org.eclipse.jst.pagedesigner.itemcreation.internal.AbstractCreationCommand#chain(org.eclipse.emf.common.command.Command)
+     */
     @Override
     public final Command chain(final Command command)
     {
         return super.chain(command);
     }
 
+    
+    /* (non-Javadoc)
+     * @see org.eclipse.jst.pagedesigner.itemcreation.internal.AbstractCreationCommand#getResult()
+     */
     @Override
     public final Collection<Element> getResult()
     {
diff --git a/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/command/UserCustomizedContainerCreationCommand.java b/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/command/UserCustomizedContainerCreationCommand.java
index 99a17d8fd..92c1e057f 100644
--- a/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/command/UserCustomizedContainerCreationCommand.java
+++ b/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/command/UserCustomizedContainerCreationCommand.java
@@ -4,11 +4,38 @@ import org.eclipse.core.runtime.IAdaptable;
 import org.eclipse.jst.jsf.common.dom.TagIdentifier;
 import org.eclipse.jst.pagedesigner.dom.IDOMPosition;
 
+/**
+ * Tag container creation command for tags dropped on to the WPE by the user
+ * 
+ * @see TagContainerCreationCommand
+ * 
+ * @author Debajit Adhikary
+ * 
+ */
 public class UserCustomizedContainerCreationCommand extends
         TagContainerCreationCommand
 {
+    /**
+     * Customization data for tag dropped
+     * 
+     * @see ICustomizationData
+     * @see IAdaptable
+     */
     private final IAdaptable    _data;
+
     
+    /**
+     * @param domPosition
+     *            Position in the DOM where the tag is to be inserted
+     * @param containerTag
+     *            Container tag
+     * @param tagBeingCreated
+     *            The tag which was dropped
+     * @param data
+     *            Customization data for the tag dropped
+     * 
+     * @see TagContainerCreationCommand#TagContainerCreationCommand(IDOMPosition, TagIdentifier, TagIdentifier)
+     */
     public UserCustomizedContainerCreationCommand(IDOMPosition domPosition,
             TagIdentifier containerTag, TagIdentifier tagBeingCreated, IAdaptable data)
     {
@@ -16,6 +43,10 @@ public class UserCustomizedContainerCreationCommand extends
         _data = data;
     }
 
+    
+    /* (non-Javadoc)
+     * @see org.eclipse.jst.pagedesigner.itemcreation.command.TagContainerCreationCommand#getContainerCustomizationData()
+     */
     @Override
     protected IAdaptable getContainerCustomizationData()
     {
diff --git a/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/customizer/ChildrenData.java b/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/customizer/ChildrenData.java
index dcb25f8d5..dfdcca259 100644
--- a/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/customizer/ChildrenData.java
+++ b/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/customizer/ChildrenData.java
@@ -16,12 +16,24 @@ public class ChildrenData
     private List<ICustomizationData> childList;
 
     
+    /**
+     * Default constructor
+     * 
+     */
     public ChildrenData()
     {
         this.childList = new ArrayList<ICustomizationData>();
     }
 
     
+	/**
+	 * Constructor to initialize a ChildrenData object with a list of
+	 * customization data for the child tags
+	 * 
+	 * @param childList
+	 *            List of customization data objects for child tags
+	 * 
+	 */
     public ChildrenData(List<ICustomizationData> childList)
     {
         this.childList = childList;
diff --git a/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/customizer/CustomizationDataImpl.java b/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/customizer/CustomizationDataImpl.java
index 46540f031..9ba1f1119 100644
--- a/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/customizer/CustomizationDataImpl.java
+++ b/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/customizer/CustomizationDataImpl.java
@@ -15,14 +15,21 @@ import org.eclipse.jst.jsf.common.dom.TagIdentifier;
  * 
  */
 
-public class CustomizationDataImpl implements ICustomizationData, IAdaptable
+public class CustomizationDataImpl implements IWritableCustomizationData, IAdaptable
 {
     private TagIdentifier tagIdentifier;
     private AttributeData _attrs;
     private ChildrenData childrenData;
     private ParentData parentData;
+
     
-   
+	/**
+	 * Constructor.
+	 * 
+	 * @param target
+	 *            Tag identifier for the tag whose customization data this is
+	 * 
+	 */
     public CustomizationDataImpl(final TagIdentifier target)
     {
         tagIdentifier = target;
@@ -32,6 +39,9 @@ public class CustomizationDataImpl implements ICustomizationData, IAdaptable
     }
 
     
+    /* (non-Javadoc)
+     * @see org.eclipse.core.runtime.IAdaptable#getAdapter(java.lang.Class)
+     */
     public Object getAdapter(Class adapter)
     {
         if (ICustomizationData.class.equals(adapter))
@@ -48,12 +58,8 @@ public class CustomizationDataImpl implements ICustomizationData, IAdaptable
     //------------------------------------------------------------
 
     
-    /*
-     * (non-Javadoc)
-     * 
-     * @see
-     * org.eclipse.jst.pagedesigner.itemcreation.customizer.ICustomizationData
-     * #getTagIdentifier()
+    /* (non-Javadoc)
+     * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.ICustomizationData#getTagIdentifier()
      */
     public TagIdentifier getTagIdentifier()
     {
@@ -61,6 +67,9 @@ public class CustomizationDataImpl implements ICustomizationData, IAdaptable
     }
 
     
+    /* (non-Javadoc)
+     * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.IWritableCustomizationData#setTagIdentifier(org.eclipse.jst.jsf.common.dom.TagIdentifier)
+     */
     public void setTagIdentifier(TagIdentifier tagId)
     {
         this.tagIdentifier = tagId;
@@ -72,12 +81,8 @@ public class CustomizationDataImpl implements ICustomizationData, IAdaptable
     //------------------------------------------------------------
 
     
-    /*
-     * (non-Javadoc)
-     * 
-     * @see
-     * org.eclipse.jst.pagedesigner.itemcreation.customizer.ICustomizationData
-     * #getAttributeData()
+    /* (non-Javadoc)
+     * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.ICustomizationData#getAttributeData()
      */
     public final AttributeData getAttributeData()
     {
@@ -85,12 +90,18 @@ public class CustomizationDataImpl implements ICustomizationData, IAdaptable
     }
 
     
+    /* (non-Javadoc)
+     * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.IWritableCustomizationData#setAttributes(org.eclipse.jst.pagedesigner.itemcreation.customizer.AttributeData)
+     */
     public void setAttributes(AttributeData attrs)
     {
         _attrs = attrs;
     }
 
     
+    /* (non-Javadoc)
+     * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.IWritableCustomizationData#addAttribute(java.lang.String, java.lang.String)
+     */
     public void addAttribute(String attributeName, String attributeValue)
     {
         getAttributeData().addAttribute(attributeName, attributeValue);
@@ -102,12 +113,8 @@ public class CustomizationDataImpl implements ICustomizationData, IAdaptable
     //------------------------------------------------------------
 
     
-    /*
-     * (non-Javadoc)
-     * 
-     * @see
-     * org.eclipse.jst.pagedesigner.itemcreation.customizer.ICustomizationData
-     * #getChildrenData()
+    /* (non-Javadoc)
+     * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.ICustomizationData#getChildrenData()
      */
     public final ChildrenData getChildrenData()
     {
@@ -115,15 +122,21 @@ public class CustomizationDataImpl implements ICustomizationData, IAdaptable
     }    
 
     
+    /* (non-Javadoc)
+     * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.IWritableCustomizationData#setChildrenData(org.eclipse.jst.pagedesigner.itemcreation.customizer.ChildrenData)
+     */
     public void setChildrenData(ChildrenData data)
     {
         childrenData = data;
     }
 
     
-    public void addChildrenData (ICustomizationData childrenData)
+    /* (non-Javadoc)
+     * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.IWritableCustomizationData#addChildrenData(org.eclipse.jst.pagedesigner.itemcreation.customizer.ICustomizationData)
+     */
+    public void addChildrenData (ICustomizationData childData)
     {
-        getChildrenData().add(childrenData);
+        getChildrenData().add(childData);
     }
     
     
@@ -132,12 +145,8 @@ public class CustomizationDataImpl implements ICustomizationData, IAdaptable
     //------------------------------------------------------------
     
     
-    /*
-     * (non-Javadoc)
-     * 
-     * @see
-     * org.eclipse.jst.pagedesigner.itemcreation.customizer.ICustomizationData
-     * #getParentData()
+    /* (non-Javadoc)
+     * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.ICustomizationData#getParentData()
      */
     public final ParentData getParentData()
     {
@@ -145,22 +154,20 @@ public class CustomizationDataImpl implements ICustomizationData, IAdaptable
     }
 
     
+    /* (non-Javadoc)
+     * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.IWritableCustomizationData#setParentData(org.eclipse.jst.pagedesigner.itemcreation.customizer.ParentData)
+     */
     public void setParentData(ParentData parentData)
     {
         this.parentData = parentData;
     }
 
     
-    /**
-     * Attaches a parent to a tag (The customization data for a parent is added
-     * to the tag's customization data). The oldest parent (outermost container
-     * tag) should be attached (added) first.
-     * 
-     * @param parentData
-     *            Parent customization data
+    /* (non-Javadoc)
+     * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.IWritableCustomizationData#addParentData(org.eclipse.jst.pagedesigner.itemcreation.customizer.ICustomizationData)
      */
-    public void addParentData (ICustomizationData parentData)
+    public void addParentData (ICustomizationData parentData_)
     {
-        getParentData().add(parentData);
+        getParentData().add(parentData_);
     }
 }
diff --git a/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/customizer/ParentData.java b/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/customizer/ParentData.java
index 7651a59f0..e138685fe 100644
--- a/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/customizer/ParentData.java
+++ b/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/customizer/ParentData.java
@@ -4,34 +4,60 @@ import java.util.ArrayList;
 import java.util.List;
 
 /**
- * Class to represent parent tag customization data for a tag
+ * Class to represent parent tag customization data for a tag. This information
+ * is stored as a List of ICustomizationData objects, where each
+ * ICustomizationData object belongs to one parent tag. (The outermost parent tag
+ * (oldest ancestor) should be added first to this list)
  * 
  * @author Debajit Adhikary
  * 
  */
 public class ParentData
 {
-    private List<ICustomizationData> parentList;
+	/**
+	 * List of ICustomizationData objects to store parent tag information. The
+	 * outermost parent tag should be added first. 
+	 */
+	private List<ICustomizationData> parentList;
 
     
+    /**
+     * Default constructor
+     * 
+     */
     public ParentData ()
     {
         parentList = new ArrayList<ICustomizationData>();
     }
     
     
+    /**
+	 * @param parentData
+	 *            Customization data to add for the parent tag
+	 *            
+	 */
     public void add (ICustomizationData parentData)
     {
         this.parentList.add(parentData);
     }
 
     
+    /**
+	 * Returns the Parent customization data as a list of customization objects.
+	 * 
+	 * @return The parent customization data
+	 * 
+	 */
     public List<ICustomizationData> getParentCustomizationData ()
     {
         return parentList;
     }
 
     
+    /**
+     * @param parentList List of ICustomizationData to set it to
+     * 
+     */
     public void setParentCustomizationData (List<ICustomizationData> parentList)
     {
         this.parentList = parentList;