tmf: Update javadoc for TmfTestHelper#executeAnalysis

Change-Id: I015e918b56a8c4607ba0606ba3c768fecc7f433f
Signed-off-by: Geneviève Bastien <gbastien+lttng@versatic.net>
Reviewed-on: https://git.eclipse.org/r/69092
Reviewed-by: Hudson CI
Reviewed-by: Marc-Andre Laperle <marc-andre.laperle@ericsson.com>
Tested-by: Marc-Andre Laperle <marc-andre.laperle@ericsson.com>

diff --git a/tmf/org.eclipse.tracecompass.tmf.core.tests/shared/org/eclipse/tracecompass/tmf/core/tests/shared/TmfTestHelper.java b/tmf/org.eclipse.tracecompass.tmf.core.tests/shared/org/eclipse/tracecompass/tmf/core/tests/shared/TmfTestHelper.java
index c9ede44f74b4b4913d8f5c8e808177d360bf7e98..f3a520d9825d79de96b899d142fef0c0401d555a 100644 (file)
--- a/tmf/org.eclipse.tracecompass.tmf.core.tests/shared/org/eclipse/tracecompass/tmf/core/tests/shared/TmfTestHelper.java
+++ b/tmf/org.eclipse.tracecompass.tmf.core.tests/shared/org/eclipse/tracecompass/tmf/core/tests/shared/TmfTestHelper.java
@@ -40,6 +40,10 @@ public class TmfTestHelper {
      * completed and it returns the result of the method. It allows to execute
      * the analysis without requiring an Eclipse job and waiting for completion.
      *
+     * Note that executing an analysis using this method will not automatically
+     * execute the dependent analyses module. The execution of those modules is
+     * left to the caller.
+     *
      * @param module
      *            The analysis module to execute
      * @return The return value of the