tmf: Add missing Javadoc to tmf.ui

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / internal / tmf / ui / parsers / custom / CustomEventType.java

diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/internal/tmf/ui/parsers/custom/CustomEventType.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/internal/tmf/ui/parsers/custom/CustomEventType.java
index 4a5026b3808dcb4e95e8b0d5803179d416f61ed0..5ed13144d753ffe21e0cc37765ed546b505faa13 100644 (file)
--- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/internal/tmf/ui/parsers/custom/CustomEventType.java
+++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/internal/tmf/ui/parsers/custom/CustomEventType.java
@@ -1,24 +1,47 @@
-package org.eclipse.linuxtools.internal.tmf.ui.parsers.custom;\r
-\r
-import org.eclipse.linuxtools.tmf.core.event.ITmfEventField;\r
-import org.eclipse.linuxtools.tmf.core.event.TmfEventField;\r
-import org.eclipse.linuxtools.tmf.core.event.TmfEventType;\r
-\r
-public abstract class CustomEventType extends TmfEventType {\r
-    \r
-    private static String CONTEXT_ID = "CustomEventType"; //$NON-NLS-1$\r
-    \r
-    public CustomEventType(CustomTraceDefinition definition) {\r
-        super(CONTEXT_ID, definition.definitionName, getRootField(definition));\r
-    }\r
-\r
-    private static ITmfEventField getRootField(CustomTraceDefinition definition) {\r
-        ITmfEventField[] fields = new ITmfEventField[definition.outputs.size()];\r
-        for (int i = 0; i < fields.length; i++) {\r
-            fields[i] = new TmfEventField(definition.outputs.get(i).name, null);\r
-        }\r
-        ITmfEventField rootField = new TmfEventField(ITmfEventField.ROOT_FIELD_ID, fields);\r
-        return rootField;\r
-    }\r
-\r
-}\r
+/*******************************************************************************
+ * Copyright (c) 2010 Ericsson
+ *
+ * All rights reserved. This program and the accompanying materials are
+ * made available under the terms of the Eclipse Public License v1.0 which
+ * accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *   Patrick Tassé - Initial API and implementation
+ *******************************************************************************/
+
+package org.eclipse.linuxtools.internal.tmf.ui.parsers.custom;
+
+import org.eclipse.linuxtools.tmf.core.event.ITmfEventField;
+import org.eclipse.linuxtools.tmf.core.event.TmfEventField;
+import org.eclipse.linuxtools.tmf.core.event.TmfEventType;
+
+/**
+ * Event type for custom text parsers.
+ *
+ * @author Patrick Tassé
+ */
+public abstract class CustomEventType extends TmfEventType {
+
+    private static String CONTEXT_ID = "CustomEventType"; //$NON-NLS-1$
+
+    /**
+     * Constructor
+     *
+     * @param definition
+     *            Trace definition
+     */
+    public CustomEventType(CustomTraceDefinition definition) {
+        super(CONTEXT_ID, definition.definitionName, getRootField(definition));
+    }
+
+    private static ITmfEventField getRootField(CustomTraceDefinition definition) {
+        ITmfEventField[] fields = new ITmfEventField[definition.outputs.size()];
+        for (int i = 0; i < fields.length; i++) {
+            fields[i] = new TmfEventField(definition.outputs.get(i).name, null);
+        }
+        ITmfEventField rootField = new TmfEventField(ITmfEventField.ROOT_FIELD_ID, fields);
+        return rootField;
+    }
+
+}