Fixed JavaDoc in TMF UI plugin

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / project / model / TmfExperimentFolder.java

diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/TmfExperimentFolder.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/TmfExperimentFolder.java
index 115f4d16b2dc7ab23046ea97189976d525e0140e..52a83b54ff1869450131d9797c62e64a92b486d9 100644 (file)
--- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/TmfExperimentFolder.java
+++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/TmfExperimentFolder.java
@@ -20,15 +20,20 @@ import org.eclipse.ui.views.properties.IPropertySource2;
 import org.eclipse.ui.views.properties.TextPropertyDescriptor;
 
 /**
- * <b><u>TmfExperimentFolder</u></b>
+ * Implementation of the model element for the experiment folder.
  * <p>
+ * @version 1.0
+ * @author Francois Chouinard
+ * 
  */
 public class TmfExperimentFolder extends TmfProjectModelElement implements IPropertySource2 {
 
     // ------------------------------------------------------------------------
     // Constants
     // ------------------------------------------------------------------------
-
+    /**
+     * The name of the experiment folder.
+     */
     public static final String EXPER_FOLDER_NAME = "Experiments"; //$NON-NLS-1$
 
     // Property View stuff
@@ -53,6 +58,13 @@ public class TmfExperimentFolder extends TmfProjectModelElement implements IProp
     // Constructors
     // ------------------------------------------------------------------------
 
+    /**
+     * Constructor. 
+     * Creates a TmfExperimentFolder model element.
+     * @param name The name of the folder
+     * @param folder The folder reference
+     * @param parent The parent (project element)
+     */
     public TmfExperimentFolder(String name, IFolder folder, TmfProjectElement parent) {
         super(name, folder, parent);
         parent.addChild(this);
@@ -61,24 +73,62 @@ public class TmfExperimentFolder extends TmfProjectModelElement implements IProp
     // ------------------------------------------------------------------------
     // TmfProjectModelElement
     // ------------------------------------------------------------------------
-
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.linuxtools.tmf.ui.project.model.TmfProjectModelElement#getResource()
+     */
     @Override
     public IFolder getResource() {
         return (IFolder) fResource;
     }
-
+    
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.linuxtools.tmf.ui.project.model.ITmfProjectModelElement#getProject()
+     */
     @Override
     public TmfProjectElement getProject() {
         return (TmfProjectElement) getParent();
     }
-
+    
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.linuxtools.tmf.ui.project.model.TmfProjectModelElement#refresh()
+     */
     @Override
     public void refresh() {
         TmfProjectElement project = (TmfProjectElement) getParent();
         project.refresh();
     }
 
-    // ------------------------------------------------------------------------}
-    // IPropertySource2\r    // ------------------------------------------------------------------------\r\r    @Override\r    public Object getEditableValue() {\r        return null;\r    }\r\r    @Override\r    public IPropertyDescriptor[] getPropertyDescriptors() {\r        return (sfDescriptors != null) ? Arrays.copyOf(sfDescriptors, sfDescriptors.length) : null;\r    }\r\r    @Override\r    public Object getPropertyValue(Object id) {\r\r        if (sfName.equals(id))\r            return getName();\r\r        if (sfPath.equals(id))\r            return getPath().toString();\r\r        if (sfLocation.equals(id))\r            return getLocation().toString();\r\r        return null;\r    }\r\r    @Override\r    public void resetPropertyValue(Object id) {\r    }\r\r    @Override\r    public void setPropertyValue(Object id, Object value) {\r    }\r\r    @Override\r    public boolean isPropertyResettable(Object id) {\r        return false;\r    }\r\r    @Override\r    public boolean isPropertySet(Object id) {\r        return false;\r    }
+    // ------------------------------------------------------------------------
+    // IPropertySource2\r    // ------------------------------------------------------------------------\r
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.ui.views.properties.IPropertySource#getEditableValue()
+     */\r    @Override\r    public Object getEditableValue() {\r        return null;\r    }\r
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.ui.views.properties.IPropertySource#getPropertyDescriptors()
+     */\r    @Override\r    public IPropertyDescriptor[] getPropertyDescriptors() {\r        return (sfDescriptors != null) ? Arrays.copyOf(sfDescriptors, sfDescriptors.length) : null;\r    }\r    
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.ui.views.properties.IPropertySource#getPropertyValue(java.lang.Object)
+     */\r    @Override\r    public Object getPropertyValue(Object id) {\r\r        if (sfName.equals(id))\r            return getName();\r\r        if (sfPath.equals(id))\r            return getPath().toString();\r\r        if (sfLocation.equals(id))\r            return getLocation().toString();\r\r        return null;\r    }\r    /*
+     * (non-Javadoc)
+     * @see org.eclipse.ui.views.properties.IPropertySource#resetPropertyValue(java.lang.Object)
+     */\r    @Override\r    public void resetPropertyValue(Object id) {\r    }\r
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.ui.views.properties.IPropertySource#setPropertyValue(java.lang.Object, java.lang.Object)
+     */\r    @Override\r    public void setPropertyValue(Object id, Object value) {\r    }\r
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.ui.views.properties.IPropertySource2#isPropertyResettable(java.lang.Object)
+     */\r    @Override\r    public boolean isPropertyResettable(Object id) {\r        return false;\r    }\r
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.ui.views.properties.IPropertySource2#isPropertySet(java.lang.Object)
+     */\r    @Override\r    public boolean isPropertySet(Object id) {\r        return false;\r    }
 
 }\r\r
\ No newline at end of file