Merge branch 'master' into lttng-luna

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.core / src / org / eclipse / linuxtools / tmf / core / ctfadaptor / CtfTmfEventType.java

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfTmfEventType.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfTmfEventType.java
index 7cd7b836024f4bd5666b84c7db8596bc899b5004..585d30b3f990fc064651be2af890f841fbe79b05 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfTmfEventType.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfTmfEventType.java
@@ -16,31 +16,44 @@ import org.eclipse.linuxtools.tmf.core.event.TmfEventType;
 import org.eclipse.linuxtools.tmf.core.event.TmfEventTypeManager;
 
 /**
+ * The CTF extension of the TMF event type
+ *
+ * @version 1.0
+ * @author Matthew khouzam
  */
 public class CtfTmfEventType extends TmfEventType {
 
     private static final String CONTEXT_ID = "Ctf Event"; //$NON-NLS-1$
+
     /**
      * Constructor for CtfTmfEventType.
-     * @param contextId String
-     * @param eventName String
-     * @param content ITmfEventField
+     *
+     * @param eventName
+     *            String
+     * @param content
+     *            ITmfEventField
      */
-    public CtfTmfEventType( String eventName,
-            ITmfEventField content) {
+    public CtfTmfEventType(String eventName, ITmfEventField content) {
         super(CONTEXT_ID, eventName, content);
     }
 
     /**
      * Method toString.
+     *
      * @return String
      */
     @Override
-    public String toString()
-    {
+    public String toString() {
         return this.getName();
     }
 
+    /**
+     * gets the event type for an event name
+     *
+     * @param eventName
+     *            the event name
+     * @return the event type
+     */
     public static CtfTmfEventType get(String eventName){
         return (CtfTmfEventType) TmfEventTypeManager.getInstance().getType(CONTEXT_ID, eventName);
     }