From: Bernd Hufmann <Bernd.Hufmann@ericsson.com>
Date: Fri, 17 May 2013 19:21:21 +0000 (-0400)
Subject: tmf: fix comments about ITmfTrace.validate() return value
X-Git-Url: http://drtracing.org/?a=commitdiff_plain;h=da1a4b39d333c503762aaca9571caa6ea7451891;p=deliverable%2Ftracecompass.git

tmf: fix comments about ITmfTrace.validate() return value

Change-Id: Ieb686dd9a776372a84115d79b5f7b5a5000b2bb6
Signed-off-by: Bernd Hufmann <Bernd.Hufmann@ericsson.com>
Reviewed-on: https://git.eclipse.org/r/12946
Reviewed-by: Alexandre Montplaisir <alexmonthy@voxpopuli.im>
IP-Clean: Alexandre Montplaisir <alexmonthy@voxpopuli.im>
Tested-by: Hudson CI
---

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/ITmfTrace.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/ITmfTrace.java
index 8ee674df2d..24ccaa1a91 100644
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/ITmfTrace.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/ITmfTrace.java
@@ -149,7 +149,7 @@ public interface ITmfTrace extends ITmfDataProvider {
      * @param project the eclipse project
      * @param path the trace path
      *
-     * @return true if trace is valid
+     * @return an IStatus object with validation result. Use severity OK to indicate success.
      * @since 2.0
      */
     IStatus validate(IProject project, String path);
diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfTrace.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfTrace.java
index c24238a365..5a9fd53599 100644
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfTrace.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfTrace.java
@@ -47,7 +47,7 @@ import org.eclipse.linuxtools.tmf.core.timestamp.TmfTimestamp;
  * <li> public double getLocationRatio(ITmfLocation<?> location)
  * <li> public ITmfContext seekEvent(ITmfLocation<?> location)
  * <li> public ITmfContext seekEvent(double ratio)
- * <li> public boolean validate(IProject project, String path)
+ * <li> public IStatus validate(IProject project, String path)
  * </ul>
  * A concrete trace must provide its corresponding parser. A common way to
  * accomplish this is by making the concrete class extend TmfTrace and