Update some javadocs

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfEndSynchSignal.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfEndSynchSignal.java
index e824e8356ea6c4efca11d715c5c5639943941c5c..327072bf1ccac7ae9ad672647faf4dea83b5f9b9 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfEndSynchSignal.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfEndSynchSignal.java
@@ -13,9 +13,10 @@
 package org.eclipse.linuxtools.tmf.core.signal;
 
 /**
- * <b><u>TmfEndSynchSignal</u></b>
- * <p>
- * TODO: Implement me. Please.
+ * End of signal synchronization
+ * 
+ * @version 1.0
+ * @author Francois Chouinard
  */
 public class TmfEndSynchSignal extends TmfSignal {
 

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfExperimentDisposedSignal.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfExperimentDisposedSignal.java
index 7d0496f1c9dc0b6311b6d82a0b38094952bb320a..4e4360d62e5229146e67feb33fe670b52da88ca5 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfExperimentDisposedSignal.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfExperimentDisposedSignal.java
@@ -16,9 +16,10 @@ import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;
 import org.eclipse.linuxtools.tmf.core.trace.TmfExperiment;
 
 /**
- * <b><u>TmfExperimentDisposedSignal</u></b>
- * <p>
- * TODO: Implement me. Please.
+ * Experiemnt has been disposed
+ * 
+ * @version 1.0
+ * @author Francois Chouinard
  */
 public class TmfExperimentDisposedSignal<T extends ITmfEvent> extends TmfSignal {
 

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfExperimentRangeUpdatedSignal.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfExperimentRangeUpdatedSignal.java
index 90ecf6243aa791ac608fab2746e2acca056a3669..03959b2deba2f6416bdd39c6cab859580fdb935e 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfExperimentRangeUpdatedSignal.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfExperimentRangeUpdatedSignal.java
@@ -17,8 +17,10 @@ import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange;
 import org.eclipse.linuxtools.tmf.core.trace.TmfExperiment;
 
 /**
- * <b><u>TmfExperimentRangeUpdatedSignal</u></b>
- * <p>
+ * Experiment time range update
+ * 
+ * @version 1.0
+ * @author Francois Chouinard
  */
 public class TmfExperimentRangeUpdatedSignal extends TmfSignal {
 

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfExperimentSelectedSignal.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfExperimentSelectedSignal.java
index 07ad2f09739d8afd8c7a15f5b64ba5472a2162f2..560804cbdc97df046cea83d63530bd651f64e951 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfExperimentSelectedSignal.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfExperimentSelectedSignal.java
@@ -16,9 +16,10 @@ import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;
 import org.eclipse.linuxtools.tmf.core.trace.TmfExperiment;
 
 /**
- * <b><u>TmfExperimentSelectedSignal</u></b>
- * <p>
- * TODO: Implement me. Please.
+ * New experiment has been selected
+ * 
+ * @version 1.0
+ * @author Francois Chouinard
  */
 public class TmfExperimentSelectedSignal<T extends ITmfEvent> extends TmfSignal {
 

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfExperimentUpdatedSignal.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfExperimentUpdatedSignal.java
index 671ee7fad454160a9a0a6901d0f3a802b4bb5419..a048b40c513e962f561118a28fd4427080688b07 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfExperimentUpdatedSignal.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfExperimentUpdatedSignal.java
@@ -16,29 +16,24 @@ import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;
 import org.eclipse.linuxtools.tmf.core.trace.TmfExperiment;
 
 /**
- * <b><u>TmfExperimentUpdatedSignal</u></b>
- * <p>
- * TODO: Implement me. Please.
+ * Current experiment has been updated.
+ * 
+ * @version 1.0
+ * @author Francois Chouinard
  */
 public class TmfExperimentUpdatedSignal extends TmfSignal {
 
        private final TmfExperiment<? extends ITmfEvent> fExperiment;
-//     private final ITmfTrace fTrace;
        
-       public TmfExperimentUpdatedSignal(Object source, TmfExperiment<? extends ITmfEvent> experiment) { // , ITmfTrace trace) {
+       public TmfExperimentUpdatedSignal(Object source, TmfExperiment<? extends ITmfEvent> experiment) {
                super(source);
                fExperiment = experiment;
-//             fTrace = trace;
        }
 
        public TmfExperiment<? extends ITmfEvent> getExperiment() {
                return fExperiment;
        }
 
-//     public ITmfTrace getTrace() {
-//             return fTrace;
-//     }
-
        /* (non-Javadoc)
         * @see java.lang.Object#toString()
         */

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfRangeSynchSignal.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfRangeSynchSignal.java
index a6dc79e77d28c5aa2b56f70f271dd2d34756393f..a0cdcdc500f92e4bc2123f5554e271b477956a07 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfRangeSynchSignal.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfRangeSynchSignal.java
@@ -16,8 +16,10 @@ import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp;
 import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange;
 
 /**
- * <b><u>TmfRangeSynchSignal</u></b>
- * <p>
+ * A new active time range has been selected
+ * 
+ * @version 1.0
+ * @author Francois Chouinard
  */
 public class TmfRangeSynchSignal extends TmfSignal {
 

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfSignal.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfSignal.java
index ebf321096a7cc5cd52135df669eebe31eef02967..85eb2af26df14210154f98e28ea330e7189470a6 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfSignal.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfSignal.java
@@ -13,9 +13,10 @@
 package org.eclipse.linuxtools.tmf.core.signal;
 
 /**
- * <b><u>TmfSignal</u></b>
- * <p>
- * TODO: Implement me. Please.
+ * Base class for TMF signals
+ * 
+ * @version 1.0
+ * @author Francois Chouinard
  */
 public abstract class TmfSignal {
 

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfSignalHandler.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfSignalHandler.java
index c0486cae913dba707be162886b666a9fbfb11644..fe5bbd4d8e4f108838849fd83109b2ebbd89ec17 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfSignalHandler.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfSignalHandler.java
@@ -18,9 +18,10 @@ import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 /**
- * <b><u>TmfSignalHandler</u></b>
- * <p>
  * Marker for TMF signal handlers.
+ * 
+ * @version 1.0
+ * @author Francois Chouinard
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.METHOD)

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfSignalManager.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfSignalManager.java
index e67afc7ed3d7a4240894afd49fda4529eddc427d..fec8dcb511c2b25f0758bdd1306578925c3c712c 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfSignalManager.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfSignalManager.java
@@ -22,13 +22,13 @@ import java.util.Map;
 import org.eclipse.linuxtools.internal.tmf.core.Tracer;
 
 /**
- * <b><u>TmfSignalHandler</u></b>
- * <p>
  * This class manages the set of signal listeners and the signals they are
  * interested in. When a signal is broadcasted, the appropriate listeners
  * signal handlers are invoked.
- * <p>
- */
+ * 
+ * @version 1.0
+ * @author Francois Chouinard
++ */
 public class TmfSignalManager {
 
        // The set of event listeners and their corresponding handler methods.

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfSignalTracer.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfSignalTracer.java
index 2c58b513f4f5451bcdbdd361bd235480567f04ca..10b8b309de44d514c2827a8111aa70146c6b3d0c 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfSignalTracer.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfSignalTracer.java
@@ -13,9 +13,10 @@
 package org.eclipse.linuxtools.tmf.core.signal;
 
 /**
- * <b><u>TmfSignalTracer</u></b>
- * <p>
  * This object (singleton) traces all TmfSignals in the application.
+ * 
+ * @version 1.0
+ * @author Francois Chouinard
  */
 public class TmfSignalTracer {
 

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfStartSynchSignal.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfStartSynchSignal.java
index 6415e1c5bdf8f26b1cbbf24df4f3037345cf8b32..b1a76a6ab34c336dd903a8fff790d122c4dc332f 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfStartSynchSignal.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfStartSynchSignal.java
@@ -13,9 +13,10 @@
 package org.eclipse.linuxtools.tmf.core.signal;
 
 /**
- * <b><u>TmfStartSynchSignal</u></b>
- * <p>
- * TODO: Implement me. Please.
+ * Start of signal synchronization
+ * 
+ * @version 1.0
+ * @author Francois Chouinard
  */
 public class TmfStartSynchSignal extends TmfSignal {
 

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfTimeSynchSignal.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfTimeSynchSignal.java
index 5855afa8faf27ae8e0d9eacd495c84698ca11c84..d8db64ea05efd901b85a5b29eb09ebf256ceb730 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfTimeSynchSignal.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfTimeSynchSignal.java
@@ -15,10 +15,11 @@ package org.eclipse.linuxtools.tmf.core.signal;
 import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp;
 
 /**
- * <b><u>TmfTimeSynchSignal</u></b>
- * <p>
- * TODO: Implement me. Please.
- */
+ * A new current time is selected (for component synchronization)
+  * 
+ * @version 1.0
+ * @author Francois Chouinard
+*/
 public class TmfTimeSynchSignal extends TmfSignal {
 
        private final ITmfTimestamp fCurrentTime;

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfTraceSelectedSignal.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfTraceSelectedSignal.java
index 7c69caa553ef11d04becedaeaef1b5f33b7a016a..30c7b68b21124f8f9eeb89082aeb7e8b306dfeb4 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfTraceSelectedSignal.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfTraceSelectedSignal.java
@@ -15,7 +15,10 @@ package org.eclipse.linuxtools.tmf.core.signal;
 import org.eclipse.linuxtools.tmf.core.trace.ITmfTrace;\r
 \r
 /**\r
- * <b><u>TmfTraceSelectedSignal</u></b>\r
+ * A trace was selected\r
+ * \r
+ * @version 1.0\r
+ * @author Patrick Tasse\r
  */\r
 public class TmfTraceSelectedSignal extends TmfSignal {\r
 \r

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfTraceUpdatedSignal.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfTraceUpdatedSignal.java
index 75394332aa3dad4a8c2b63cfb3afa90ce79ed28a..960a35021eac60dc8de158c97bd77a8e36d856d9 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfTraceUpdatedSignal.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfTraceUpdatedSignal.java
@@ -16,9 +16,10 @@ import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange;
 import org.eclipse.linuxtools.tmf.core.trace.ITmfTrace;
 
 /**
- * <b><u>TmfTraceUpdatedSignal</u></b>
- * <p>
- * TODO: Implement me. Please.
+ * A trace was updated (typically its time range)
+ * 
+ * @version 1.0
+ * @author Francois Chouinard
  */
 public class TmfTraceUpdatedSignal extends TmfSignal {
 

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfExperiment.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfExperiment.java
index 2e9e453c555f832becc455e7aa8403108d2776f4..ce196c98ad21a443296230f0b49a39a6a9b2d841 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfExperiment.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfExperiment.java
@@ -37,6 +37,9 @@ import org.eclipse.linuxtools.tmf.core.signal.TmfTraceUpdatedSignal;
 /**
  * TmfExperiment presents a time-ordered, unified view of a set of ITmfTrace:s
  * that are part of a tracing experiment.
+ *
+ * @version 1.0
+ * @author Francois Chouinard
  */
 public class TmfExperiment<T extends ITmfEvent> extends TmfTrace<T> implements ITmfEventParser<T> {