tmf: Update Javadoc throughout tmf.ui

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / editors / ITmfTraceEditor.java

diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/editors/ITmfTraceEditor.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/editors/ITmfTraceEditor.java
index 18091d7d2940ad12a9e20f795411ef80db8f70f0..7ab06752741140a1d637cc5ce9c113bfa038821c 100644 (file)
--- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/editors/ITmfTraceEditor.java
+++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/editors/ITmfTraceEditor.java
@@ -1,11 +1,11 @@
 /*******************************************************************************\r
  * Copyright (c) 2010 Ericsson\r
- * \r
+ *\r
  * All rights reserved. This program and the accompanying materials are\r
  * made available under the terms of the Eclipse Public License v1.0 which\r
  * accompanies this distribution, and is available at\r
  * http://www.eclipse.org/legal/epl-v10.html\r
- * \r
+ *\r
  * Contributors:\r
  *   Patrick Tasse - Initial API and implementation\r
  *******************************************************************************/\r
@@ -15,8 +15,25 @@ package org.eclipse.linuxtools.tmf.ui.editors;
 import org.eclipse.core.resources.IFile;\r
 import org.eclipse.linuxtools.tmf.core.trace.ITmfTrace;\r
 \r
+/**\r
+ * The trace editor interface\r
+ *\r
+ * @version 1.0\r
+ * @author Patrick Tasse\r
+ */\r
 public interface ITmfTraceEditor {\r
 \r
+    /**\r
+     * Get the trace to which this editor is assigned\r
+     *\r
+     * @return The trace\r
+     */\r
     public ITmfTrace<?> getTrace();\r
+\r
+    /**\r
+     * Get the bookmark file associated to this trace\r
+     *\r
+     * @return The IFile object pointing to the bookmark file\r
+     */\r
     public IFile getBookmarksFile();\r
 }\r