From d37aaa7f25cdec9b601846ed3ab5c5502e44c8cb Mon Sep 17 00:00:00 2001 From: Francois Chouinard Date: Tue, 12 Jun 2012 08:34:01 -0400 Subject: [PATCH] More javadoc updates --- .../ctf/core/event/types/ArrayDeclaration.java | 12 +++++++++++- .../ctf/core/event/types/ArrayDefinition.java | 12 +++++++++++- .../linuxtools/ctf/core/event/types/Definition.java | 9 +++++++-- .../linuxtools/ctf/core/event/types/Encoding.java | 8 +++++--- .../ctf/core/event/types/EnumDeclaration.java | 9 ++++++++- .../ctf/core/event/types/EnumDefinition.java | 9 ++++++++- .../ctf/core/event/types/FloatDeclaration.java | 6 ++++-- .../ctf/core/event/types/FloatDefinition.java | 9 +++++++-- .../ctf/core/event/types/IDeclaration.java | 12 +++++++++++- .../ctf/core/event/types/IDefinitionScope.java | 6 +++++- .../ctf/core/event/types/IntegerDeclaration.java | 8 +++++++- .../ctf/core/event/types/IntegerDefinition.java | 11 +++++++++-- .../ctf/core/event/types/SequenceDeclaration.java | 7 ++++++- .../ctf/core/event/types/SequenceDefinition.java | 9 ++++++++- .../ctf/core/event/types/StringDeclaration.java | 10 +++++++++- .../ctf/core/event/types/StringDefinition.java | 10 +++++++++- .../ctf/core/event/types/StructDeclaration.java | 10 +++++++++- .../ctf/core/event/types/StructDefinition.java | 10 +++++++++- .../ctf/core/event/types/VariantDeclaration.java | 10 +++++++++- .../ctf/core/event/types/VariantDefinition.java | 10 +++++++++- .../ctf/core/trace/CTFReaderException.java | 6 +++--- .../eclipse/linuxtools/ctf/core/trace/CTFTrace.java | 4 ++-- .../linuxtools/ctf/core/trace/CTFTraceReader.java | 7 +++++-- .../eclipse/linuxtools/ctf/core/trace/Metadata.java | 8 +++++--- .../ctf/core/trace/StreamInputPacketReader.java | 8 +++++--- .../linuxtools/ctf/core/trace/StreamInputReader.java | 8 +++++--- .../org/eclipse/linuxtools/ctf/core/trace/Utils.java | 6 ++++-- .../org/eclipse/linuxtools/lttng/jni/JniEvent.java | 6 +++--- .../org/eclipse/linuxtools/lttng/jni/JniMarker.java | 4 ++-- .../eclipse/linuxtools/lttng/jni/JniMarkerField.java | 3 ++- .../org/eclipse/linuxtools/lttng/jni/JniParser.java | 4 ++-- .../org/eclipse/linuxtools/lttng/jni/JniTrace.java | 6 +++--- .../eclipse/linuxtools/lttng/jni/JniTracefile.java | 4 ++-- .../eclipse/linuxtools/lttng/jni/Jni_C_Common.java | 4 ++-- .../lttng/jni/factory/JniTraceFactory.java | 4 ++-- .../lttng/jni/factory/JniTraceVersion.java | 4 ++-- .../tmf/core/filter/model/TmfFilterAndNode.java | 6 ++++++ .../tmf/core/filter/model/TmfFilterCompareNode.java | 9 +++++++++ .../tmf/core/filter/model/TmfFilterContainsNode.java | 7 ++++++- .../tmf/core/filter/model/TmfFilterEqualsNode.java | 6 ++++++ .../core/filter/model/TmfFilterEventTypeNode.java | 7 ++++++- .../tmf/core/filter/model/TmfFilterMatchesNode.java | 7 ++++++- .../tmf/core/filter/model/TmfFilterNode.java | 7 ++++++- .../tmf/core/filter/model/TmfFilterOrNode.java | 7 ++++++- .../tmf/core/filter/model/TmfFilterRootNode.java | 7 ++++++- .../tmf/core/filter/model/TmfFilterTreeNode.java | 9 +++++---- .../tmf/core/filter/xml/TmfFilterContentHandler.java | 9 +++++---- .../tmf/core/filter/xml/TmfFilterXMLParser.java | 9 +++++---- .../tmf/core/filter/xml/TmfFilterXMLWriter.java | 9 +++++---- 49 files changed, 287 insertions(+), 85 deletions(-) diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/ArrayDeclaration.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/ArrayDeclaration.java index c7ee915ff5..fd3c79c744 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/ArrayDeclaration.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/ArrayDeclaration.java @@ -13,7 +13,17 @@ package org.eclipse.linuxtools.ctf.core.event.types; /** - * ArrayDeclaration + * A CTF array declaration + * + * Arrays are fixed-length. Their length is declared in the type + * declaration within the meta-data. They contain an array of "inner type" + * elements, which can refer to any type not containing the type of the + * array being declared (no circular dependency). The length is the number + * of elements in an array. + * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public class ArrayDeclaration implements IDeclaration { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/ArrayDefinition.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/ArrayDefinition.java index 7f1f6e353b..33e655aed8 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/ArrayDefinition.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/ArrayDefinition.java @@ -15,7 +15,17 @@ package org.eclipse.linuxtools.ctf.core.event.types; import org.eclipse.linuxtools.internal.ctf.core.event.io.BitBuffer; /** - * ArrayDefinition + * A CTF array definiton + * + * Arrays are fixed-length. Their length is declared in the type + * declaration within the meta-data. They contain an array of "inner type" + * elements, which can refer to any type not containing the type of the + * array being declared (no circular dependency). The length is the number + * of elements in an array. + * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public class ArrayDefinition extends Definition { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/Definition.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/Definition.java index 45351aa113..2edc2a9e71 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/Definition.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/Definition.java @@ -15,14 +15,19 @@ package org.eclipse.linuxtools.ctf.core.event.types; import org.eclipse.linuxtools.internal.ctf.core.event.io.BitBuffer; /** - * Definition
- * A definition is like an object of a declaration class. It fills the declaration with values.
+ * A CTF definiton + * + * A definition is like an object of a declaration class. It fills the declaration + * with values.
* An example:
* int i = 0;
* int is the declaration.
* i is the definition.
* 0 is the value assigned to the definition, not the declaration.
* + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public abstract class Definition { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/Encoding.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/Encoding.java index a3de0160ba..e77b890d97 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/Encoding.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/Encoding.java @@ -13,9 +13,11 @@ package org.eclipse.linuxtools.ctf.core.event.types; /** - * Encoding - *

- * Encoding types + * CTF encoding types + * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public enum Encoding { /** UTF-8 encoding */ diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/EnumDeclaration.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/EnumDeclaration.java index 6cd0bdbe5f..4c145b4c01 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/EnumDeclaration.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/EnumDeclaration.java @@ -16,7 +16,14 @@ import java.util.LinkedList; import java.util.List; /** - * EnumDeclaration + * A CTF enum declaration. + * + * The definition of a enum point basic data type. It will take the data + * from a trace and store it (and make it fit) as an integer and a string. + * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public class EnumDeclaration implements IDeclaration { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/EnumDefinition.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/EnumDefinition.java index e1565f92ad..d341d0a681 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/EnumDefinition.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/EnumDefinition.java @@ -15,7 +15,14 @@ package org.eclipse.linuxtools.ctf.core.event.types; import org.eclipse.linuxtools.internal.ctf.core.event.io.BitBuffer; /** - * EnumDefinition + * A CTF enum definition. + * + * The definition of a enum point basic data type. It will take the data + * from a trace and store it (and make it fit) as an integer and a string. + * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public class EnumDefinition extends Definition { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/FloatDeclaration.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/FloatDeclaration.java index 3d97dd4601..51f5903e9a 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/FloatDeclaration.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/FloatDeclaration.java @@ -14,10 +14,12 @@ package org.eclipse.linuxtools.ctf.core.event.types; import java.nio.ByteOrder; /** - * Float declaration + * A CTF float declaration. + * + * The declaration of a floating point basic data type. * + * @version 1.0 * @author Matthew Khouzam - * */ public class FloatDeclaration implements IDeclaration { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/FloatDefinition.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/FloatDefinition.java index 07bd50cd39..c94027eb20 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/FloatDefinition.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/FloatDefinition.java @@ -14,9 +14,14 @@ package org.eclipse.linuxtools.ctf.core.event.types; import org.eclipse.linuxtools.internal.ctf.core.event.io.BitBuffer; /** - * Float definition - * @author Matthew Khouzam + * A CTF float definition. + * + * The definition of a floating point basic data type. It will take the data + * from a trace and store it (and make it fit) as a double. * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public class FloatDefinition extends Definition { // ------------------------------------------------------------------------ diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IDeclaration.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IDeclaration.java index 1aba10e3c9..428a4f127e 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IDeclaration.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IDeclaration.java @@ -13,7 +13,17 @@ package org.eclipse.linuxtools.ctf.core.event.types; /** - * IDeclaration + * A CTF data type declaration. + * + * An example:
+ * int i = 0;
+ * int is the declaration.
+ * i is the definition.
+ * 0 is the value assigned to the definition, not the declaration.
+ * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public interface IDeclaration { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IDefinitionScope.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IDefinitionScope.java index 1cf50fa2c8..46bc5d7477 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IDefinitionScope.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IDefinitionScope.java @@ -13,7 +13,11 @@ package org.eclipse.linuxtools.ctf.core.event.types; /** - * IDefinitionScope + * The scope of a CTF definition. Used for compound types. + * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public interface IDefinitionScope { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IntegerDeclaration.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IntegerDeclaration.java index b8803786bf..26a8976d51 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IntegerDeclaration.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IntegerDeclaration.java @@ -15,7 +15,13 @@ package org.eclipse.linuxtools.ctf.core.event.types; import java.nio.ByteOrder; /** - * IntegerDeclaration + * A CTF integer declaration. + * + * The declaration of a integer basic data type. + * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public class IntegerDeclaration implements IDeclaration { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IntegerDefinition.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IntegerDefinition.java index 312489775e..1157abde24 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IntegerDefinition.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IntegerDefinition.java @@ -15,10 +15,17 @@ package org.eclipse.linuxtools.ctf.core.event.types; import org.eclipse.linuxtools.internal.ctf.core.event.io.BitBuffer; /** - * IntegerDefinition - *

+ * A CTF integer definition. + * + * The definition of a integer basic data type. It will take the data + * from a trace and store it (and make it fit) as a long. + * * TODO: Reading integers with an endianness different from the trace endianness * is not supported + * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public class IntegerDefinition extends Definition { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/SequenceDeclaration.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/SequenceDeclaration.java index aea78d1881..082c70488a 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/SequenceDeclaration.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/SequenceDeclaration.java @@ -15,9 +15,14 @@ package org.eclipse.linuxtools.ctf.core.event.types; import org.eclipse.linuxtools.ctf.core.trace.CTFReaderException; /** - * SequenceDeclaration
+ * A CTF sequence declaration. + * * An array where the size is fixed but declared in the trace, unlike array * where it is declared with a literal + * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public class SequenceDeclaration implements IDeclaration { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/SequenceDefinition.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/SequenceDefinition.java index 65f6525145..6c95948ce7 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/SequenceDefinition.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/SequenceDefinition.java @@ -16,7 +16,14 @@ import org.eclipse.linuxtools.ctf.core.trace.CTFReaderException; import org.eclipse.linuxtools.internal.ctf.core.event.io.BitBuffer; /** - * SequenceDefinition + * A CTF sequence definition (a fixed-size array). + * + * An array where the size is fixed but declared in the trace, unlike array + * where it is declared with a literal + * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public class SequenceDefinition extends Definition { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDeclaration.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDeclaration.java index d57229fca0..c79e506af1 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDeclaration.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDeclaration.java @@ -13,7 +13,15 @@ package org.eclipse.linuxtools.ctf.core.event.types; /** - * StringDeclaration + * A CTF string declaration. + * + * Strings are an array of bytes of variable size and are terminated by a '\0' + * "NULL" character. Their encoding is described in the TSDL meta-data. In + * absence of encoding attribute information, the default encoding is UTF-8. + * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public class StringDeclaration implements IDeclaration { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDefinition.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDefinition.java index 2661f31253..33a26aa90c 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDefinition.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDefinition.java @@ -15,7 +15,15 @@ package org.eclipse.linuxtools.ctf.core.event.types; import org.eclipse.linuxtools.internal.ctf.core.event.io.BitBuffer; /** - * StringDefinition + * A CTF string definition (similar to a C null-terminated byte array). + * + * Strings are an array of bytes of variable size and are terminated by a '\0' + * "NULL" character. Their encoding is described in the TSDL meta-data. In + * absence of encoding attribute information, the default encoding is UTF-8. + * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public class StringDefinition extends Definition { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StructDeclaration.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StructDeclaration.java index 9bc93a3f6a..d4a01717fb 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StructDeclaration.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StructDeclaration.java @@ -17,7 +17,15 @@ import java.util.LinkedList; import java.util.List; /** - * StructDeclaration + * A CTF structure declaration. + * + * A structure is similar to a C structure, it is a compound data type that + * contains other datatypes in fields. they are stored in an hashmap and indexed + * by names which are strings. + * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public class StructDeclaration implements IDeclaration { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StructDefinition.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StructDefinition.java index 2aa5f81a0f..41fcb66c80 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StructDefinition.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StructDefinition.java @@ -19,7 +19,15 @@ import java.util.ListIterator; import org.eclipse.linuxtools.internal.ctf.core.event.io.BitBuffer; /** - * StructDefinition + * A CTF structure definition (similar to a C structure). + * + * A structure is similar to a C structure, it is a compound data type that + * contains other datatypes in fields. they are stored in an hashmap and indexed + * by names which are strings. + * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public class StructDefinition extends Definition implements IDefinitionScope { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/VariantDeclaration.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/VariantDeclaration.java index bd3d6ab23f..fcedc1bed2 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/VariantDeclaration.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/VariantDeclaration.java @@ -15,7 +15,15 @@ package org.eclipse.linuxtools.ctf.core.event.types; import java.util.HashMap; /** - * VariantDeclaration + * A CTFC variant declaration. + * + * A variant is similar to a C union, only taking the minimum size of the types, + * it is a compound data type that contains other datatypes in fields. they are + * stored in an hashmap and indexed by names which are strings. + * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public class VariantDeclaration implements IDeclaration { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/VariantDefinition.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/VariantDefinition.java index 4c249440b3..a1dfd95e50 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/VariantDefinition.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/VariantDefinition.java @@ -18,7 +18,15 @@ import java.util.Map; import org.eclipse.linuxtools.internal.ctf.core.event.io.BitBuffer; /** - * VariantDefinition + * A CTF variant definition (similar to a C union). + * + * A variant is similar to a C union, only taking the minimum size of the types, + * it is a compound data type that contains other datatypes in fields. they are + * stored in an hashmap and indexed by names which are strings. + * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public class VariantDefinition extends Definition implements IDefinitionScope { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFReaderException.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFReaderException.java index 58c26e7364..c3499eaf68 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFReaderException.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFReaderException.java @@ -14,9 +14,9 @@ package org.eclipse.linuxtools.ctf.core.trace; /** * General exception that is thrown when there is a problem somewhere with the * CTF trace reader. - * - * @author alexmont - * + * + * @version 1.0 + * @author Alexandre Montplaisir */ public class CTFReaderException extends Exception { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFTrace.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFTrace.java index 91fcd596ec..5ef907552e 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFTrace.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFTrace.java @@ -49,8 +49,8 @@ import org.eclipse.linuxtools.internal.ctf.core.trace.StreamInput; import org.eclipse.linuxtools.internal.ctf.core.trace.StreamInputPacketIndex; /** - * CTFTrace - *

+ * A CTF trace on the file system. + * * Represents a trace on the filesystem. It is responsible of parsing the * metadata, creating declarations data structures, indexing the event packets * (in other words, all the work that can be shared between readers), but the diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFTraceReader.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFTraceReader.java index 7f127a4df7..8ac8c297ea 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFTraceReader.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFTraceReader.java @@ -24,9 +24,12 @@ import org.eclipse.linuxtools.internal.ctf.core.trace.StreamInput; import org.eclipse.linuxtools.internal.ctf.core.trace.StreamInputReaderTimestampComparator; /** - * Reads the events of a trace. + * A CTF trace reader. Reads the events of a trace. + * + * @version 1.0 + * @author Matthew Khouzam + * @author Alexandre Montplaisir */ - public class CTFTraceReader { // ------------------------------------------------------------------------ diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/Metadata.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/Metadata.java index f28373dc61..d7d720efc0 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/Metadata.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/Metadata.java @@ -36,9 +36,11 @@ import org.eclipse.linuxtools.internal.ctf.core.event.metadata.IOStructGen; import org.eclipse.linuxtools.internal.ctf.core.event.metadata.exceptions.ParseException; /** - * Metadata - *

- * Represents a metadata file + * The CTF trace metadata file + * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public class Metadata { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/StreamInputPacketReader.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/StreamInputPacketReader.java index 271e499522..4c3c3447dd 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/StreamInputPacketReader.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/StreamInputPacketReader.java @@ -31,9 +31,11 @@ import org.eclipse.linuxtools.internal.ctf.core.trace.Stream; import org.eclipse.linuxtools.internal.ctf.core.trace.StreamInputPacketIndexEntry; /** - * StreamInputPacketReader - *

- * Reads the events of a packet of a trace file. + * CTF trace packet reader. Reads the events of a packet of a trace file. + * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public class StreamInputPacketReader implements IDefinitionScope { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/StreamInputReader.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/StreamInputReader.java index 40b8915ca1..3c4b9b6b7e 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/StreamInputReader.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/StreamInputReader.java @@ -20,9 +20,11 @@ import org.eclipse.linuxtools.internal.ctf.core.trace.StreamInput; import org.eclipse.linuxtools.internal.ctf.core.trace.StreamInputPacketIndexEntry; /** - * StreamInputReader - *

- * Reads the events of a trace file. + * A CTF trace event reader. Reads the events of a trace file. + * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public class StreamInputReader { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/Utils.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/Utils.java index 552dc5b2f1..90f8958606 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/Utils.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/Utils.java @@ -15,9 +15,11 @@ package org.eclipse.linuxtools.ctf.core.trace; import java.util.UUID; /** - * Utils - *

* Various utilities. + * + * @version 1.0 + * @author Matthew Khouzam + * @author Simon Marchi */ public class Utils { diff --git a/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniEvent.java b/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniEvent.java index af2cde7b9c..ab5365ea27 100644 --- a/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniEvent.java +++ b/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniEvent.java @@ -21,9 +21,7 @@ import org.eclipse.linuxtools.internal.lttng.jni.exception.JniException; import org.eclipse.linuxtools.internal.lttng.jni.exception.JniNoSuchEventException; /** - * JniEvent

- * - * A JniEvent has the actual content that got traced by Lttng.
+ * The LTTng event in its native (C) format.
* Provides access to the LttEvent C structure in java.

* * Most important fields in the JniEvent are : @@ -36,6 +34,8 @@ import org.eclipse.linuxtools.internal.lttng.jni.exception.JniNoSuchEventExcepti * NOTE

* This class is ABSTRACT, you need to extends it to support your specific LTTng version.

* + * @version 0.1 + * @author William Bourque */ public abstract class JniEvent extends Jni_C_Common implements Comparable { diff --git a/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniMarker.java b/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniMarker.java index 30f3da1871..206efaa98a 100644 --- a/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniMarker.java +++ b/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniMarker.java @@ -19,8 +19,6 @@ import org.eclipse.linuxtools.internal.lttng.jni.exception.JniException; import org.eclipse.linuxtools.internal.lttng.jni.exception.JniMarkerException; /** - * JniMarker

- * * A JniMarker contain information how to interpret the unparsed content (payload) of an event.
* Each JniMarker contains several MarkerFields for each fields in the event's payload. * @@ -37,6 +35,8 @@ import org.eclipse.linuxtools.internal.lttng.jni.exception.JniMarkerException; * This class is ABSTRACT, you need to extends it to support your specific LTTng version.
* Please look at the abstract functions to override at the bottom of this file.

* + * @version 0.1 + * @author William Bourque */ public abstract class JniMarker extends Jni_C_Common { diff --git a/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniMarkerField.java b/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniMarkerField.java index 0bf906496d..984b970dfa 100644 --- a/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniMarkerField.java +++ b/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniMarkerField.java @@ -6,7 +6,6 @@ import org.eclipse.linuxtools.internal.lttng.jni.exception.JniMarkerFieldExcepti /** - * JniMarkerField

* A JniMarkerField is one of the field of the unparsed content (payload) of an event.

* * Provides access to the marker_field C structure (from LTT) in java.

@@ -20,6 +19,8 @@ import org.eclipse.linuxtools.internal.lttng.jni.exception.JniMarkerFieldExcepti * NOTE

* This class is ABSTRACT, you need to extends it to support your specific LTTng version.

* + * @version 0.1 + * @author William Bourque */ public abstract class JniMarkerField extends Jni_C_Common { diff --git a/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniParser.java b/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniParser.java index 6ad7e07a1c..7693e2fefe 100644 --- a/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniParser.java +++ b/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniParser.java @@ -18,8 +18,6 @@ import java.util.Iterator; import org.eclipse.linuxtools.internal.lttng.jni.common.Jni_C_Pointer; /** - * JniParser

- * * JniParser is used to parse an event payload into something usable.

* * All methods are static, the parser shouldn't be instantiated. @@ -27,6 +25,8 @@ import org.eclipse.linuxtools.internal.lttng.jni.common.Jni_C_Pointer; * NOTE

* This class is ABSTRACT, you need to extends it to support your specific LTTng version.

* + * @version 0.1 + * @author William Bourque */ public abstract class JniParser extends Jni_C_Common { diff --git a/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniTrace.java b/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniTrace.java index ca8cb07cfe..b8c8f877d0 100644 --- a/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniTrace.java +++ b/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniTrace.java @@ -28,8 +28,6 @@ import org.eclipse.linuxtools.internal.lttng.jni.exception.JniTraceException; import org.eclipse.linuxtools.internal.lttng.jni.exception.JniTracefileWithoutEventException; /** - * JniTrace - *

* This is the top level class in the JNI. It provides access to the LttTrace C * structure in java. *

@@ -44,7 +42,9 @@ import org.eclipse.linuxtools.internal.lttng.jni.exception.JniTracefileWithoutEv * This class is ABSTRACT, you need to extends it to support your specific LTTng * version.
* Please look at the abstract functions to override at the bottom of this file. - *

+ * + * @version 0.1 + * @author William Bourque */ public abstract class JniTrace extends Jni_C_Common { diff --git a/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniTracefile.java b/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniTracefile.java index 6b0fd24f03..01d89cffcd 100644 --- a/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniTracefile.java +++ b/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/JniTracefile.java @@ -23,8 +23,6 @@ import org.eclipse.linuxtools.internal.lttng.jni.exception.JniTracefileException import org.eclipse.linuxtools.internal.lttng.jni.exception.JniTracefileWithoutEventException; /** - * JniTracefile - *

* A tracefile own an event of a certain type.
* Provides access to the LttTracefile C structure in java. *

@@ -39,6 +37,8 @@ import org.eclipse.linuxtools.internal.lttng.jni.exception.JniTracefileWithoutEv * This class is ABSTRACT, you need to extends it to support your specific LTTng version.
* Please look at the abstract functions to override at the bottom of this file.

* + * @version 0.1 + * @author William Bourque */ public abstract class JniTracefile extends Jni_C_Common { diff --git a/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/Jni_C_Common.java b/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/Jni_C_Common.java index 7eeb170828..4e0d2f43a1 100644 --- a/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/Jni_C_Common.java +++ b/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/Jni_C_Common.java @@ -16,13 +16,13 @@ import org.eclipse.linuxtools.internal.lttng.jni.common.Jni_C_Constant; /** - * Jni_C_Common - *

* Common constants and methods that should be shared between JNI objects. * * NOTE

* This class is ABSTRACT, and will be extended by each LTTng structure (Trac, Tracefile, Event, ...) * + * @version 0.1 + * @author William Bourque */ public abstract class Jni_C_Common extends Jni_C_Constant { diff --git a/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/factory/JniTraceFactory.java b/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/factory/JniTraceFactory.java index 8e17c8c4dc..38c71bc465 100644 --- a/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/factory/JniTraceFactory.java +++ b/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/factory/JniTraceFactory.java @@ -20,13 +20,13 @@ import org.eclipse.linuxtools.internal.lttng.jni_v2_6.JniTrace_v2_6; import org.eclipse.linuxtools.lttng.jni.JniTrace; /** - * JniTraceFactory - *

* This class factory is responsible of returning the correct JniTrace implementation from a (valid) trace path.

* * The different version supported are listed below and the same version string are expected to be returned by JniTraceVersion.
* Each version need a different Lttv library so each need its liblttvtraceread-X.Y.so installed and available on the system. * + * @version 0.1 + * @author William Bourque */ public class JniTraceFactory { diff --git a/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/factory/JniTraceVersion.java b/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/factory/JniTraceVersion.java index acbe25cfe1..fe5001eb7b 100644 --- a/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/factory/JniTraceVersion.java +++ b/org.eclipse.linuxtools.lttng.jni/src/org/eclipse/linuxtools/lttng/jni/factory/JniTraceVersion.java @@ -17,14 +17,14 @@ import java.io.File; import org.eclipse.linuxtools.internal.lttng.jni.exception.JniTraceVersionException; /** - * JniTraceVersion - *

* This class is responsible of returning the correct version number of a trace at a certain given path.

* * The class will call the C library to get the correct version number from the trace.

* * Lttv library loader (liblttvtraceread_loader.so) and the default Lttv library (liblttvtraceread.so) must be installed on system and available to java. * + * @version 0.1 + * @author William Bourque */ public class JniTraceVersion { diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterAndNode.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterAndNode.java index 2d16bcebb1..bfb89f1f28 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterAndNode.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterAndNode.java @@ -15,6 +15,12 @@ package org.eclipse.linuxtools.tmf.core.filter.model; import org.eclipse.linuxtools.tmf.core.event.ITmfEvent; +/** + * Filter node for the 'and' operation + * + * @version 1.0 + * @author Patrick Tasse + */ public class TmfFilterAndNode extends TmfFilterTreeNode { public static final String NODE_NAME = "AND"; //$NON-NLS-1$ diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterCompareNode.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterCompareNode.java index a89bb077ba..c8a68c47cd 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterCompareNode.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterCompareNode.java @@ -21,6 +21,12 @@ import org.eclipse.linuxtools.tmf.core.event.ITmfEvent; import org.eclipse.linuxtools.tmf.core.event.TmfTimestamp; +/** + * Filter node for the comparison operation + * + * @version 1.0 + * @author Patrick Tasse + */ public class TmfFilterCompareNode extends TmfFilterTreeNode { public static final String NODE_NAME = "COMPARE"; //$NON-NLS-1$ @@ -30,6 +36,9 @@ public class TmfFilterCompareNode extends TmfFilterTreeNode { public static final String TYPE_ATTR = "type"; //$NON-NLS-1$ public static final String VALUE_ATTR = "value"; //$NON-NLS-1$ + /** + * Supported comparison types + */ public static enum Type { NUM, ALPHA, diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterContainsNode.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterContainsNode.java index dce1cf09d7..e57c93ce1a 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterContainsNode.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterContainsNode.java @@ -17,7 +17,12 @@ import java.util.List; import org.eclipse.linuxtools.tmf.core.event.ITmfEvent; - +/** + * Filter node for the 'contains' operation + * + * @version 1.0 + * @author Patrick Tasse + */ public class TmfFilterContainsNode extends TmfFilterTreeNode { public static final String NODE_NAME = "CONTAINS"; //$NON-NLS-1$ diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterEqualsNode.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterEqualsNode.java index 52231427e4..37e5826f48 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterEqualsNode.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterEqualsNode.java @@ -18,6 +18,12 @@ import java.util.List; import org.eclipse.linuxtools.tmf.core.event.ITmfEvent; +/** + * Filter node for the '==' operation + * + * @version 1.0 + * @author Patrick Tasse + */ public class TmfFilterEqualsNode extends TmfFilterTreeNode { public static final String NODE_NAME = "EQUALS"; //$NON-NLS-1$ diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterEventTypeNode.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterEventTypeNode.java index 4de9d5ef73..9694665a21 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterEventTypeNode.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterEventTypeNode.java @@ -17,7 +17,12 @@ import java.util.List; import org.eclipse.linuxtools.tmf.core.event.ITmfEvent; - +/** + * Filter node for an event + * + * @version 1.0 + * @author Patrick Tasse + */ public class TmfFilterEventTypeNode extends TmfFilterTreeNode { public static final String NODE_NAME = "EVENTTYPE"; //$NON-NLS-1$ diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterMatchesNode.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterMatchesNode.java index 0d5c2e2069..4a289274ac 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterMatchesNode.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterMatchesNode.java @@ -19,7 +19,12 @@ import java.util.regex.PatternSyntaxException; import org.eclipse.linuxtools.tmf.core.event.ITmfEvent; - +/** + * Filter node for the regex match + * + * @version 1.0 + * @author Patrick Tasse + */ public class TmfFilterMatchesNode extends TmfFilterTreeNode { public static final String NODE_NAME = "MATCHES"; //$NON-NLS-1$ diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterNode.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterNode.java index 3aac38af92..af7d2428fe 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterNode.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterNode.java @@ -17,7 +17,12 @@ import java.util.List; import org.eclipse.linuxtools.tmf.core.event.ITmfEvent; - +/** + * Filter node for the event match operation + * + * @version 1.0 + * @author Patrick Tasse + */ public class TmfFilterNode extends TmfFilterTreeNode { public static final String NODE_NAME = "FILTER"; //$NON-NLS-1$ diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterOrNode.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterOrNode.java index 6fdf6e5f84..0dfa91c4cd 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterOrNode.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterOrNode.java @@ -14,7 +14,12 @@ package org.eclipse.linuxtools.tmf.core.filter.model; import org.eclipse.linuxtools.tmf.core.event.ITmfEvent; - +/** + * Filter node for the 'or' operation + * + * @version 1.0 + * @author Patrick Tasse + */ public class TmfFilterOrNode extends TmfFilterTreeNode { public static final String NODE_NAME = "OR"; //$NON-NLS-1$ diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterRootNode.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterRootNode.java index 4577bb3d77..b1216e72b4 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterRootNode.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterRootNode.java @@ -17,7 +17,12 @@ import java.util.List; import org.eclipse.linuxtools.tmf.core.event.ITmfEvent; - +/** + * The Filter tree root node + * + * @version 1.0 + * @author Patrick Tasse + */ public class TmfFilterRootNode extends TmfFilterTreeNode { public static final String NODE_NAME = "ROOT"; //$NON-NLS-1$ diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterTreeNode.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterTreeNode.java index 7ae85a1b3c..2c3b5a294c 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterTreeNode.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/model/TmfFilterTreeNode.java @@ -21,10 +21,11 @@ import org.eclipse.linuxtools.tmf.core.event.ITmfEvent; import org.eclipse.linuxtools.tmf.core.event.ITmfEventField; /** - * TmfFilterTreeNode - *

- * The Filter Tree node - *

+ * The base class for the Filter tree nodes + * + * @version 1.0 + * @author Yuriy Vashchuk + * @author Patrick Tasse */ public abstract class TmfFilterTreeNode implements ITmfFilterTreeNode, Cloneable { diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/xml/TmfFilterContentHandler.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/xml/TmfFilterContentHandler.java index f3ecc79d4a..befbae1c3a 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/xml/TmfFilterContentHandler.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/xml/TmfFilterContentHandler.java @@ -33,10 +33,11 @@ import org.xml.sax.SAXException; import org.xml.sax.helpers.DefaultHandler; /** - * FilterContentHandler - *

- * The Filter SAX Content Handler - *

+ * The SAX Content Handler + * + * @version 1.0 + * @author Yuriy Vashchuk + * @author Patrick Tasse */ public class TmfFilterContentHandler extends DefaultHandler { diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/xml/TmfFilterXMLParser.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/xml/TmfFilterXMLParser.java index b56a5d235e..9b69276d33 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/xml/TmfFilterXMLParser.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/xml/TmfFilterXMLParser.java @@ -23,10 +23,11 @@ import org.xml.sax.SAXException; import org.xml.sax.XMLReader; /** - * FilterXMLParser - *

- * This is SAX based XML parser - *

+ * The SAX based XML parser + * + * @version 1.0 + * @author Yuriy Vashchuk + * @author Patrick Tasse */ public class TmfFilterXMLParser { diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/xml/TmfFilterXMLWriter.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/xml/TmfFilterXMLWriter.java index 337f003b09..3b7412b870 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/xml/TmfFilterXMLWriter.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/filter/xml/TmfFilterXMLWriter.java @@ -38,10 +38,11 @@ import org.w3c.dom.Document; import org.w3c.dom.Element; /** - * FilterXMLParser - *

- * This is SAX based XML parser - *

+ * The SAX based XML writer + * + * @version 1.0 + * @author Yuriy Vashchuk + * @author Patrick Tasse */ public class TmfFilterXMLWriter { -- 2.34.1