tmf: Add missing Javadoc to tmf.ui

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / internal / tmf / ui / parsers / custom / CustomTxtTraceContext.java

diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/internal/tmf/ui/parsers/custom/CustomTxtTraceContext.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/internal/tmf/ui/parsers/custom/CustomTxtTraceContext.java
index 0a237a60e07fda966a1a7b0f20f57a7d2bf13ec8..a5e115cfffa51bc4147a3015e71d43520fc9015e 100644 (file)
--- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/internal/tmf/ui/parsers/custom/CustomTxtTraceContext.java
+++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/internal/tmf/ui/parsers/custom/CustomTxtTraceContext.java
@@ -18,12 +18,33 @@ import org.eclipse.linuxtools.internal.tmf.ui.parsers.custom.CustomTxtTraceDefin
 import org.eclipse.linuxtools.tmf.core.trace.ITmfLocation;
 import org.eclipse.linuxtools.tmf.core.trace.TmfContext;
 
+/**
+ * Trace context for custom text traces.
+ *
+ * @author Patrick Tassé
+ */
 public class CustomTxtTraceContext extends TmfContext {
+
+    /** Regex matcher for the first line of the trace */
     public Matcher firstLineMatcher;
+
+    /** First line of the text file */
     public String firstLine;
+
+    /** Position in the file where the 'current' next line is */
     public long nextLineLocation;
+
+    /** InputLine object for the currently read line */
     public InputLine inputLine;
 
+    /**
+     * Constructor.
+     *
+     * @param location
+     *            Location in the trace
+     * @param rank
+     *            Rank of the event at this location
+     */
     public CustomTxtTraceContext(ITmfLocation location, long rank) {
         super(location, rank);
     }