lttng: Fix Javadoc in lttng2.core

[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng2.core / src / org / eclipse / linuxtools / internal / lttng2 / core / control / model / TraceEventType.java

diff --git a/org.eclipse.linuxtools.lttng2.core/src/org/eclipse/linuxtools/internal/lttng2/core/control/model/TraceEventType.java b/org.eclipse.linuxtools.lttng2.core/src/org/eclipse/linuxtools/internal/lttng2/core/control/model/TraceEventType.java
index 0650831a9652dcfc3dbeee7ee36862b65d10ffa9..67b84b10b78b7a3b570e637b9036c6b9325a37ee 100644 (file)
--- a/org.eclipse.linuxtools.lttng2.core/src/org/eclipse/linuxtools/internal/lttng2/core/control/model/TraceEventType.java
+++ b/org.eclipse.linuxtools.lttng2.core/src/org/eclipse/linuxtools/internal/lttng2/core/control/model/TraceEventType.java
@@ -1,12 +1,12 @@
 /**********************************************************************
  * Copyright (c) 2012 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: 
+ *
+ * Contributors:
  *   Bernd Hufmann - Initial API and implementation
  **********************************************************************/
 package org.eclipse.linuxtools.internal.lttng2.core.control.model;
@@ -15,13 +15,17 @@ package org.eclipse.linuxtools.internal.lttng2.core.control.model;
  * <p>
  * Trace event type enumeration.
  * </p>
- * 
+ *
  * @author Bernd Hufmann
  */
-public enum TraceEventType { 
+public enum TraceEventType {
+    /** Event type: tracepoint */
     TRACEPOINT("tracepoint"), //$NON-NLS-1$
+    /** Event type: syscall */
     SYSCALL("syscall"), //$NON-NLS-1$
+    /** Event type: probe */
     PROBE("probe"),  //$NON-NLS-1$
+    /** Event type unknown */
     UNKNOWN("unknown"); //$NON-NLS-1$
 
     private final String fInName;
@@ -30,8 +34,13 @@ public enum TraceEventType {
         fInName = name;
     }
 
+    /**
+     * Get the type's name
+     *
+     * @return The type's name
+     */
     public String getInName() {
         return fInName;
     }
-};
+}