From be6df2d87acd929898f722acd76a5d2b79079959 Mon Sep 17 00:00:00 2001 From: Alexandre Montplaisir Date: Mon, 11 Jun 2012 13:51:34 -0400 Subject: [PATCH] ctf: Fix Javadoc for all public methods Signed-off-by: Alexandre Montplaisir --- .../ctf/core/tests/CtfCorePluginTest.java | 5 ++- .../linuxtools/ctf/core/tests/TestParams.java | 1 + .../core/tests/event/CTFEventFieldTest.java | 2 +- .../ctf/core/tests/headless/ReadTrace.java | 1 + .../core/tests/trace/CTFTraceReaderTest.java | 5 +-- .../ctf/core/tests/trace/CTFTraceTest.java | 1 + .../ctf/core/tests/trace/MetadataTest.java | 5 ++- .../trace/StreamInputPacketIndexTest.java | 1 + .../tests/trace/StreamInputReaderTest.java | 14 ++----- .../ctf/core/tests/trace/StreamInputTest.java | 1 + .../ctf/core/tests/trace/StreamTest.java | 1 + .../core/tests/types/ArrayDefinitionTest.java | 5 +-- .../ctf/core/tests/types/DefinitionTest.java | 1 + .../tests/types/EventDeclarationTest.java | 1 + .../tests/types/FloatDeclarationTest.java | 2 +- .../core/tests/types/FloatDefinitionTest.java | 2 +- .../tests/types/IntegerDefinitionTest.java | 5 +-- .../tests/types/SequenceDeclarationTest.java | 1 + .../tests/types/SequenceDefinitionTest.java | 1 + .../tests/types/StringDefinitionTest.java | 5 +-- .../tests/types/StructDefinitionTest.java | 5 +-- .../tests/types/VariantDeclarationTest.java | 8 ++-- .../tests/types/VariantDefinitionTest.java | 1 + .../linuxtools/ctf/core/event/CTFClock.java | 6 +++ .../ctf/core/event/EventDeclaration.java | 16 +++++--- .../ctf/core/event/EventDefinition.java | 8 ++-- .../core/event/types/IDefinitionScope.java | 4 ++ .../core/event/types/SequenceDeclaration.java | 7 ++-- .../core/event/types/SequenceDefinition.java | 2 + .../core/event/types/StructDefinition.java | 2 +- .../core/event/types/VariantDeclaration.java | 4 ++ .../ctf/core/trace/CTFReaderException.java | 3 +- .../linuxtools/ctf/core/trace/CTFTrace.java | 22 +++++++---- .../ctf/core/trace/CTFTraceReader.java | 37 +++++++++---------- .../linuxtools/ctf/core/trace/Metadata.java | 1 + .../core/trace/StreamInputPacketReader.java | 2 +- .../ctf/core/trace/StreamInputReader.java | 1 + .../internal/ctf/core/event/io/BitBuffer.java | 4 +- .../ctf/core/event/metadata/IOStructGen.java | 9 ++++- .../internal/ctf/core/trace/Stream.java | 7 +++- .../internal/ctf/core/trace/StreamInput.java | 34 ++--------------- .../core/trace/StreamInputPacketIndex.java | 1 + .../linuxtools/ctf/parser/CTFLexer.java | 2 +- .../linuxtools/ctf/parser/CTFParser.java | 2 +- 44 files changed, 127 insertions(+), 121 deletions(-) diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/CtfCorePluginTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/CtfCorePluginTest.java index 5a4b8f1c1e..577a46c542 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/CtfCorePluginTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/CtfCorePluginTest.java @@ -1,11 +1,11 @@ /******************************************************************************* * Copyright (c) 2011, 2010 Ericsson - * + * * All rights reserved. This program and the accompanying materials are * made available under the terms of the Eclipse Public License v1.0 which * accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * Francois Chouinard - Initial API and implementation *******************************************************************************/ @@ -21,6 +21,7 @@ import org.eclipse.linuxtools.internal.ctf.core.Activator; *

* Test the CTF core plug-in activator */ +@SuppressWarnings("javadoc") public class CtfCorePluginTest extends TestCase { // ------------------------------------------------------------------------ diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/TestParams.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/TestParams.java index adb454a0ee..bdf39f9241 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/TestParams.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/TestParams.java @@ -11,6 +11,7 @@ import org.eclipse.linuxtools.ctf.core.trace.CTFTrace; * @author alexmont * */ +@SuppressWarnings("javadoc") public abstract class TestParams { /* diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/event/CTFEventFieldTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/event/CTFEventFieldTest.java index b90a512a1f..4b13697214 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/event/CTFEventFieldTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/event/CTFEventFieldTest.java @@ -30,8 +30,8 @@ import org.junit.Test; * * @author ematkho * @version $Revision: 1.0 $ - * @param */ +@SuppressWarnings("javadoc") public class CTFEventFieldTest { private static final String fieldName = "id"; //$NON-NLS-1$ diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/headless/ReadTrace.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/headless/ReadTrace.java index b373fe6c88..4c2353c288 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/headless/ReadTrace.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/headless/ReadTrace.java @@ -24,6 +24,7 @@ import org.eclipse.linuxtools.ctf.core.trace.CTFTrace; import org.eclipse.linuxtools.ctf.core.trace.CTFTraceReader; import org.eclipse.linuxtools.internal.ctf.core.trace.Stream; +@SuppressWarnings("javadoc") public class ReadTrace { /** diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/CTFTraceReaderTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/CTFTraceReaderTest.java index f628eedf82..247768b5a4 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/CTFTraceReaderTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/CTFTraceReaderTest.java @@ -21,6 +21,7 @@ import org.junit.Test; * @author ematkho * @version $Revision: 1.0 $ */ +@SuppressWarnings("javadoc") public class CTFTraceReaderTest { CTFTraceReader fixture; @@ -203,11 +204,9 @@ public class CTFTraceReaderTest { /** * Run the void goToLastEvent() method test. - * - * @throws CTFReaderException */ @Test - public void testGoToLastEvent() throws CTFReaderException { + public void testGoToLastEvent() { fixture.goToLastEvent(); long ts1 = getTimestamp(); long ts2 = fixture.getEndTime(); diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/CTFTraceTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/CTFTraceTest.java index 39537d09a7..87b2e44e7b 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/CTFTraceTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/CTFTraceTest.java @@ -30,6 +30,7 @@ import org.junit.Test; * @author ematkho * @version $Revision: 1.0 $ */ +@SuppressWarnings("javadoc") public class CTFTraceTest { private CTFTrace fixture; diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/MetadataTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/MetadataTest.java index 543c907e68..b939ca04c8 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/MetadataTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/MetadataTest.java @@ -19,6 +19,7 @@ import org.junit.Test; * @author ematkho * @version $Revision: 1.0 $ */ +@SuppressWarnings("javadoc") public class MetadataTest { private Metadata fixture; @@ -35,8 +36,8 @@ public class MetadataTest { /** * Perform pre-test initialization. - * - * @throws CTFReaderException + * + * @throws CTFReaderException */ @Before public void setUp() throws CTFReaderException { diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/StreamInputPacketIndexTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/StreamInputPacketIndexTest.java index 0992c7e2f5..0ed1d36b84 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/StreamInputPacketIndexTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/StreamInputPacketIndexTest.java @@ -20,6 +20,7 @@ import org.junit.Test; * @author ematkho * @version $Revision: 1.0 $ */ +@SuppressWarnings("javadoc") public class StreamInputPacketIndexTest { private StreamInputPacketIndex fixture; diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/StreamInputReaderTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/StreamInputReaderTest.java index a7c284e07f..bc4a31ecd8 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/StreamInputReaderTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/StreamInputReaderTest.java @@ -27,6 +27,7 @@ import org.junit.Test; * @author ematkho * @version $Revision: 1.0 $ */ +@SuppressWarnings("javadoc") public class StreamInputReaderTest { private StreamInputReader fixture; @@ -142,11 +143,9 @@ public class StreamInputReaderTest { /** * Run the void goToLastEvent() method test. - * - * @throws CTFReaderException */ @Test - public void testGoToLastEvent1() throws CTFReaderException { + public void testGoToLastEvent1() { final long endTimestamp = goToEnd(); final long endTime = 4287422460315L; assertEquals(endTime , endTimestamp ); @@ -154,11 +153,9 @@ public class StreamInputReaderTest { /** * Run the void goToLastEvent() method test. - * - * @throws CTFReaderException */ @Test - public void testGoToLastEvent2() throws CTFReaderException { + public void testGoToLastEvent2() { long timestamp = -1; while(fixture.readNextEvent()) { timestamp = fixture.getCurrentEvent().getTimestamp(); @@ -167,10 +164,7 @@ public class StreamInputReaderTest { assertEquals(0 , timestamp- endTimestamp ); } - /** - * @throws CTFReaderException - */ - private long goToEnd() throws CTFReaderException { + private long goToEnd() { fixture.goToLastEvent(); return fixture.getCurrentEvent().getTimestamp(); } diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/StreamInputTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/StreamInputTest.java index 3bacac1f02..935ec03df4 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/StreamInputTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/StreamInputTest.java @@ -27,6 +27,7 @@ import org.junit.Test; * @author ematkho * @version $Revision: 1.0 $ */ +@SuppressWarnings("javadoc") public class StreamInputTest { private StreamInput fixture; diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/StreamTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/StreamTest.java index 8f11bf7a0c..5f76ac5988 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/StreamTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/trace/StreamTest.java @@ -26,6 +26,7 @@ import org.junit.Test; * @author ematkho * @version $Revision: 1.0 $ */ +@SuppressWarnings("javadoc") public class StreamTest { private Stream fixture; diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/ArrayDefinitionTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/ArrayDefinitionTest.java index 6f85b9af88..facff32435 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/ArrayDefinitionTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/ArrayDefinitionTest.java @@ -17,7 +17,6 @@ import org.eclipse.linuxtools.ctf.core.event.types.IntegerDeclaration; import org.eclipse.linuxtools.ctf.core.event.types.IntegerDefinition; import org.eclipse.linuxtools.ctf.core.event.types.StringDeclaration; import org.eclipse.linuxtools.ctf.core.event.types.StringDefinition; -import org.eclipse.linuxtools.ctf.core.trace.CTFReaderException; import org.eclipse.linuxtools.ctf.core.trace.CTFTrace; import org.eclipse.linuxtools.internal.ctf.core.event.io.BitBuffer; import org.junit.After; @@ -53,11 +52,9 @@ public class ArrayDefinitionTest { * * structDef shouldn't be null after parsing the CTFTraceReader object, so * we can ignore the warning. - * - * @throws CTFReaderException */ @Before - public void setUp() throws CTFReaderException { + public void setUp() { charArrayFixture = createCharArray(); stringArrayFixture = createStringArray(); longArrayFixture = createLongArray(); diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/DefinitionTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/DefinitionTest.java index f2789bc664..f225fcf897 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/DefinitionTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/DefinitionTest.java @@ -17,6 +17,7 @@ import org.junit.Test; * @author ematkho * @version $Revision: 1.0 $ */ +@SuppressWarnings("javadoc") public class DefinitionTest { /** diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/EventDeclarationTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/EventDeclarationTest.java index a19f98a204..3dcbb9873d 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/EventDeclarationTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/EventDeclarationTest.java @@ -25,6 +25,7 @@ import org.junit.Test; * @author ematkho * @version $Revision: 1.0 $ */ +@SuppressWarnings("javadoc") public class EventDeclarationTest { private EventDeclaration fixture; diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/FloatDeclarationTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/FloatDeclarationTest.java index 94759fc5a9..50ce56afa1 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/FloatDeclarationTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/FloatDeclarationTest.java @@ -9,7 +9,7 @@ import java.nio.ByteOrder; import org.eclipse.linuxtools.ctf.core.event.types.FloatDeclaration; import org.junit.Test; - +@SuppressWarnings("javadoc") public class FloatDeclarationTest { private FloatDeclaration fixture; diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/FloatDefinitionTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/FloatDefinitionTest.java index e7a9349f73..18d9f041f1 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/FloatDefinitionTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/FloatDefinitionTest.java @@ -24,7 +24,7 @@ import org.junit.Test; * @author ematkho * @version $Revision: 1.0 $ */ - +@SuppressWarnings("javadoc") public class FloatDefinitionTest { private FloatDefinition fixture; private FloatDefinition singleFixture; diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/IntegerDefinitionTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/IntegerDefinitionTest.java index b13c0e6cfb..08419fa393 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/IntegerDefinitionTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/IntegerDefinitionTest.java @@ -9,7 +9,6 @@ import org.eclipse.linuxtools.ctf.core.event.types.Encoding; import org.eclipse.linuxtools.ctf.core.event.types.IDefinitionScope; import org.eclipse.linuxtools.ctf.core.event.types.IntegerDeclaration; import org.eclipse.linuxtools.ctf.core.event.types.IntegerDefinition; -import org.eclipse.linuxtools.ctf.core.trace.CTFReaderException; import org.eclipse.linuxtools.internal.ctf.core.event.io.BitBuffer; import org.junit.After; import org.junit.Before; @@ -40,11 +39,9 @@ public class IntegerDefinitionTest { /** * Perform pre-test initialization. We know the structDef won't be null (or * else the tests will fail), so we can safely suppress the warning. - * - * @throws CTFReaderException */ @Before - public void setUp() throws CTFReaderException { + public void setUp() { // StructDefinition structDef = null; // boolean found = false; diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/SequenceDeclarationTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/SequenceDeclarationTest.java index f6cb96ffa3..58a857b58d 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/SequenceDeclarationTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/SequenceDeclarationTest.java @@ -24,6 +24,7 @@ import org.junit.Test; * @author ematkho * @version $Revision: 1.0 $ */ +@SuppressWarnings("javadoc") public class SequenceDeclarationTest { private SequenceDeclaration fixture; diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/SequenceDefinitionTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/SequenceDefinitionTest.java index 14b8f950dc..24aabb5af9 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/SequenceDefinitionTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/SequenceDefinitionTest.java @@ -26,6 +26,7 @@ import org.junit.Test; * @author ematkho * @version $Revision: 1.0 $ */ +@SuppressWarnings("javadoc") public class SequenceDefinitionTest { private SequenceDefinition fixture; diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/StringDefinitionTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/StringDefinitionTest.java index 3ef00b8c54..3de56f061f 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/StringDefinitionTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/StringDefinitionTest.java @@ -5,7 +5,6 @@ import static org.junit.Assert.assertNotNull; import org.eclipse.linuxtools.ctf.core.event.types.IDefinitionScope; import org.eclipse.linuxtools.ctf.core.event.types.StringDeclaration; import org.eclipse.linuxtools.ctf.core.event.types.StringDefinition; -import org.eclipse.linuxtools.ctf.core.trace.CTFReaderException; import org.eclipse.linuxtools.internal.ctf.core.event.io.BitBuffer; import org.junit.After; import org.junit.Before; @@ -34,11 +33,9 @@ public class StringDefinitionTest { /** * Perform pre-test initialization. - * - * @throws CTFReaderException */ @Before - public void setUp() throws CTFReaderException { + public void setUp() { String name = "testString"; //$NON-NLS-1$ StringDeclaration stringDec = new StringDeclaration(); fixture = stringDec.createDefinition(null, name); diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/StructDefinitionTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/StructDefinitionTest.java index b2a412411c..7bbcf46d78 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/StructDefinitionTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/StructDefinitionTest.java @@ -22,7 +22,6 @@ import org.eclipse.linuxtools.ctf.core.event.types.StructDeclaration; import org.eclipse.linuxtools.ctf.core.event.types.StructDefinition; import org.eclipse.linuxtools.ctf.core.event.types.VariantDeclaration; import org.eclipse.linuxtools.ctf.core.event.types.VariantDefinition; -import org.eclipse.linuxtools.ctf.core.trace.CTFReaderException; import org.eclipse.linuxtools.internal.ctf.core.event.io.BitBuffer; import org.junit.After; import org.junit.Before; @@ -71,11 +70,9 @@ public class StructDefinitionTest { /** * Perform pre-test initialization. - * - * @throws CTFReaderException */ @Before - public void setUp() throws CTFReaderException { + public void setUp() { StructDeclaration sDec = new StructDeclaration(12); IntegerDeclaration id = new IntegerDeclaration(32, false, 32, ByteOrder.BIG_ENDIAN, Encoding.NONE, null, 8); IntegerDeclaration lenDec = new IntegerDeclaration(8, false, 8, ByteOrder.BIG_ENDIAN, Encoding.NONE, null, 8); diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/VariantDeclarationTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/VariantDeclarationTest.java index 6bb8728e40..6ce0d4df3b 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/VariantDeclarationTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/VariantDeclarationTest.java @@ -19,7 +19,7 @@ import org.junit.Test; /** * The class VariantDeclarationTest contains tests for the class * {@link VariantDeclaration}. - * + * * @author ematkho * @version $Revision: 1.0 $ */ @@ -29,7 +29,7 @@ public class VariantDeclarationTest { /** * Launch the test. - * + * * @param args * the command line arguments */ @@ -78,8 +78,8 @@ public class VariantDeclarationTest { /** * Run the VariantDefinition createDefinition(DefinitionScope,String) method * test. - * - * @throws CTFReaderException + * + * @throws CTFReaderException Should not happen */ @Test public void testCreateDefinition() throws CTFReaderException { diff --git a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/VariantDefinitionTest.java b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/VariantDefinitionTest.java index 046303b932..abe4350a55 100644 --- a/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/VariantDefinitionTest.java +++ b/org.eclipse.linuxtools.ctf.core.tests/src/org/eclipse/linuxtools/ctf/core/tests/types/VariantDefinitionTest.java @@ -35,6 +35,7 @@ import org.junit.Test; * @author ematkho * @version $Revision: 1.0 $ */ +@SuppressWarnings("javadoc") public class VariantDefinitionTest { private VariantDefinition fixture; diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/CTFClock.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/CTFClock.java index 0af919f6c2..aa288da35a 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/CTFClock.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/CTFClock.java @@ -15,6 +15,7 @@ package org.eclipse.linuxtools.ctf.core.event; import java.util.HashMap; /** + * Clock description used in CTF traces */ public class CTFClock { @@ -27,6 +28,11 @@ public class CTFClock { */ private String name; + /** + * Default constructor + */ + public CTFClock() {} + /** * Method addAttribute. * @param key String diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/EventDeclaration.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/EventDeclaration.java index 3f45e0c3eb..5272c0aa4f 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/EventDeclaration.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/EventDeclaration.java @@ -17,9 +17,8 @@ import org.eclipse.linuxtools.ctf.core.trace.StreamInputReader; import org.eclipse.linuxtools.internal.ctf.core.trace.Stream; /** - * EventDeclaration - *

- * Represents one type of event. + * Representation of one type of event. A bit like "int" or "long" but for trace + * events. */ public class EventDeclaration { @@ -61,6 +60,12 @@ public class EventDeclaration { // Constructors // ------------------------------------------------------------------------ + /** + * Default constructor. Use the setters afterwards to set the fields + * accordingly. + */ + public EventDeclaration() {} + /** * Creates an instance of EventDefinition corresponding to this declaration. * @@ -156,8 +161,9 @@ public class EventDeclaration { } /** - * Gets the id of am event declaration - * return id the id + * Gets the id of am event declaration return id the id + * + * @return The EventDeclaration ID */ public Long getId() { return id; diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/EventDefinition.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/EventDefinition.java index 9ca6fee758..8671aaa322 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/EventDefinition.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/EventDefinition.java @@ -21,9 +21,7 @@ import org.eclipse.linuxtools.ctf.core.event.types.StructDefinition; import org.eclipse.linuxtools.ctf.core.trace.StreamInputReader; /** - * EventDefinition - *

- * Represents an instance of an event. + * Representation of a particular instance of an event. */ public class EventDefinition implements IDefinitionScope { @@ -64,7 +62,9 @@ public class EventDefinition implements IDefinitionScope { * Constructs an event definition. * * @param declaration - * The corresponding event declaration. + * The corresponding event declaration + * @param streamInputReader + * The SIR from where this EventDef was read */ public EventDefinition(EventDeclaration declaration, StreamInputReader streamInputReader) { 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 1d20b2d48b..1cf50fa2c8 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 @@ -25,6 +25,10 @@ public interface IDefinitionScope { /** * Looks up in this definition scope. + * + * @param lookupPath + * The path to look up + * @return The Definition that was read */ public Definition lookupDefinition(String lookupPath); } 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 3ee5bb4b54..aea78d1881 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 @@ -33,11 +33,12 @@ public class SequenceDeclaration implements IDeclaration { // ------------------------------------------------------------------------ /** - * Constuctor + * Constructor * * @param lengthName - * the name of the field describing the lenght + * the name of the field describing the length * @param elemType + * The element type */ public SequenceDeclaration(String lengthName, IDeclaration elemType) { this.elemType = elemType; @@ -45,7 +46,7 @@ public class SequenceDeclaration implements IDeclaration { } // ------------------------------------------------------------------------ - // Gettters/Setters/Predicates + // Getters/Setters/Predicates // ------------------------------------------------------------------------ /** 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 3ddb77eed2..65f6525145 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 @@ -42,6 +42,8 @@ public class SequenceDefinition extends Definition { * the parent scope * @param fieldName * the field name + * @throws CTFReaderException + * If the sequence field was malformatted */ public SequenceDefinition(SequenceDeclaration declaration, IDefinitionScope definitionScope, String fieldName) 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 2fb915e371..2aa5f81a0f 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 @@ -41,7 +41,7 @@ public class StructDefinition extends Definition implements IDefinitionScope { * the parent declaration * @param definitionScope * the parent scope - * @param fieldName + * @param structFieldName * the field name */ public StructDefinition(StructDeclaration declaration, 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 6d456c8dd5..bd3d6ab23f 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 @@ -96,10 +96,14 @@ public class VariantDeclaration implements IDeclaration { return new VariantDefinition(this, definitionScope, fieldName); } + /** + * Add a field to this CTF Variant * * @param fieldTag + * The tag of the new field * @param declaration + * The Declaration of this new field */ public void addField(String fieldTag, IDeclaration declaration) { fields.put(fieldTag, declaration); 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 1a7d94975c..58c26e7364 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 @@ -33,6 +33,7 @@ public class CTFReaderException extends Exception { * Constructor with an attached message. * * @param message + * The message attached to this exception */ public CTFReaderException(String message) { super(message); @@ -42,7 +43,7 @@ public class CTFReaderException extends Exception { * Re-throw an exception into this type. * * @param e - * The previous Exception we caught. + * The previous Exception we caught */ public CTFReaderException(Exception e) { super(e); 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 4f29e0cfa5..91fcd596ec 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 @@ -161,8 +161,9 @@ public class CTFTrace implements IDefinitionScope { * Trace constructor. * * @param path - * Filesystem path of the trace directory. - * @throws IOException + * Filesystem path of the trace directory + * @throws CTFReaderException + * If no CTF trace was found at the path */ public CTFTrace(String path) throws CTFReaderException { this(new File(path)); @@ -175,6 +176,7 @@ public class CTFTrace implements IDefinitionScope { * @param path * Filesystem path of the trace directory. * @throws CTFReaderException + * If no CTF trace was found at the path */ public CTFTrace(File path) throws CTFReaderException { this.path = path; @@ -260,12 +262,14 @@ public class CTFTrace implements IDefinitionScope { // ------------------------------------------------------------------------ /** - * Gets an event declaration hashmap for a given streamID - * @param streanId - * @return the hashmap with the event declarations + * Gets an event declaration hash map for a given streamID + * + * @param streamId + * The ID of the stream from which to read + * @return The Hash map with the event declarations */ - public HashMap getEvents(Long streanId) { - return eventDecs.get(streanId); + public HashMap getEvents(Long streamId) { + return eventDecs.get(streamId); } /** @@ -295,6 +299,8 @@ public class CTFTrace implements IDefinitionScope { /** * Get an event by it's ID * + * @param streamId + * The ID of the stream from which to read * @param id * the ID of the event * @return the event declaration @@ -609,8 +615,8 @@ public class CTFTrace implements IDefinitionScope { * * @param stream * A stream object. - * * @throws ParseException + * If there was some problem reading the metadata */ public void addStream(Stream stream) throws ParseException { 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 c4e98ceb74..7f127a4df7 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 @@ -76,7 +76,6 @@ public class CTFTraceReader { * * @param trace * The trace to read from. - * @throws CTFReaderException */ public CTFTraceReader(CTFTrace trace) { this.trace = trace; @@ -105,6 +104,8 @@ public class CTFTraceReader { /** * Copy constructor + * + * @return The new CTFTraceReader */ public CTFTraceReader copyFrom() { CTFTraceReader newReader = null; @@ -259,8 +260,6 @@ public class CTFTraceReader { /** * Go to the last event in the trace. - * - * @throws CTFReaderException */ public void goToLastEvent() { seek(this.getEndTime()); @@ -305,22 +304,22 @@ public class CTFTraceReader { return hasMoreEvents(); } - /** - * Go to the first entry of a trace - * - * @return 0, the first index. - */ - private long goToZero() { - long tempIndex; - for (StreamInputReader streamInputReader : this.streamInputReaders) { - /* - * Seek the trace reader. - */ - streamInputReader.seek(0); - } - tempIndex = 0; - return tempIndex; - } +// /** +// * Go to the first entry of a trace +// * +// * @return 0, the first index. +// */ +// private long goToZero() { +// long tempIndex; +// for (StreamInputReader streamInputReader : this.streamInputReaders) { +// /* +// * Seek the trace reader. +// */ +// streamInputReader.seek(0); +// } +// tempIndex = 0; +// return tempIndex; +// } /** * gets the stream with the oldest event 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 0648c1194b..f28373dc61 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 @@ -117,6 +117,7 @@ public class Metadata { * Parse the metadata file. * * @throws CTFReaderException + * If there was a problem parsing the metadata */ public void parse() throws CTFReaderException { CTFReaderException tempException = null; 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 abefa7ada3..271e499522 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 @@ -339,6 +339,7 @@ public class StreamInputPacketReader implements IDefinitionScope { * @return The event definition containing the event data that was just * read. * @throws CTFReaderException + * If there was a problem reading the trace */ public EventDefinition readNextEvent() throws CTFReaderException { /* WARNING: This is very LTTng-specific. */ @@ -491,7 +492,6 @@ public class StreamInputPacketReader implements IDefinitionScope { return lastTimestamp; } - @SuppressWarnings("unused") @Override public Definition lookupDefinition(String lookupPath) { // TODO Auto-generated method stub 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 d04a8089cd..40b8915ca1 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 @@ -236,6 +236,7 @@ public class StreamInputReader { * * @param timestamp * The timestamp to seek to. + * @return The offset compared to the current position */ public long seek(long timestamp) { long offset = 0; diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/internal/ctf/core/event/io/BitBuffer.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/internal/ctf/core/event/io/BitBuffer.java index 2559fe5df3..341c93ccb9 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/internal/ctf/core/event/io/BitBuffer.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/internal/ctf/core/event/io/BitBuffer.java @@ -521,8 +521,8 @@ public class BitBuffer { /** * Sets the position in the buffer. * - * @param order - * The position of the buffer. + * @param newPosition + * The new position of the buffer. */ public void position(int newPosition) { this.pos = newPosition; diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/internal/ctf/core/event/metadata/IOStructGen.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/internal/ctf/core/event/metadata/IOStructGen.java index b9533b2299..008780cfb5 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/internal/ctf/core/event/metadata/IOStructGen.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/internal/ctf/core/event/metadata/IOStructGen.java @@ -81,8 +81,11 @@ public class IOStructGen { /** * Constuctor - * @param tree the tree (antlr generated) with the parsed TSDL data. - * @param trace the trace containing the places to put all the read metadata + * + * @param tree + * the tree (ANTLR generated) with the parsed TSDL data. + * @param trace + * the trace containing the places to put all the read metadata */ public IOStructGen(CommonTree tree, CTFTrace trace) { this.trace = trace; @@ -91,7 +94,9 @@ public class IOStructGen { /** * Parse the tree and populate the trace defined in the constructor. + * * @throws ParseException + * If there was a problem parsing the metadata */ public void generate() throws ParseException { parseRoot(tree); diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/internal/ctf/core/trace/Stream.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/internal/ctf/core/trace/Stream.java index 83f252e27d..b3c64dfd88 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/internal/ctf/core/trace/Stream.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/internal/ctf/core/trace/Stream.java @@ -97,7 +97,8 @@ public class Stream { /** * Is the id of a stream set - * @param Is id the id of a stream set + * + * @return If the ID is set or not */ public boolean isIdSet() { return id != null; @@ -213,8 +214,10 @@ public class Stream { * is present in the map. * * @param event - * The event to add. + * The event to add * @throws ParseException + * If there was a problem reading the event or adding it to the + * stream */ public void addEvent(EventDeclaration event) throws ParseException { /* diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/internal/ctf/core/trace/StreamInput.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/internal/ctf/core/trace/StreamInput.java index 685c61efcb..365031a33e 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/internal/ctf/core/trace/StreamInput.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/internal/ctf/core/trace/StreamInput.java @@ -191,10 +191,11 @@ public class StreamInput implements IDefinitionScope { /** * Adds the next packet header index entry to the index of a stream input. - * @warning slow - * @warning can corrupt data if not used properly + * + * @warning slow, can corrupt data if not used properly * @return true if there are more packets to add * @throws CTFReaderException + * If there was a problem reading the packed header */ public boolean addPacketHeaderIndex() throws CTFReaderException { long currentPos = 0L; @@ -216,24 +217,10 @@ public class StreamInput implements IDefinitionScope { return false; } - /** - * @param fileSizeBytes - * @return - */ private long getStreamSize() { return file.length(); } - /** - * @param fileSizeBytes - * @param packetOffsetBytes - * @param packetIndex - * @param tracePacketHeaderDef - * @param streamPacketContextDef - * @param bitBuffer - * @return - * @throws CTFReaderException - */ private long createPacketIndexEntry(long fileSizeBytes, long packetOffsetBytes, StreamInputPacketIndexEntry packetIndex, StructDefinition tracePacketHeaderDef, @@ -332,11 +319,6 @@ public class StreamInput implements IDefinitionScope { return bb; } - /** - * @param tracePacketHeaderDef - * @param bitBuffer - * @throws CTFReaderException - */ private void parseTracePacketHeader(StructDefinition tracePacketHeaderDef, BitBuffer bitBuffer) throws CTFReaderException { tracePacketHeaderDef.read(bitBuffer); @@ -391,10 +373,6 @@ public class StreamInput implements IDefinitionScope { } } - /** - * @param fileSizeBytes - * @param packetIndex - */ private static void setPacketContextNull(long fileSizeBytes, StreamInputPacketIndexEntry packetIndex) { /* @@ -405,12 +383,6 @@ public class StreamInput implements IDefinitionScope { packetIndex.setPacketSizeBits((int) (fileSizeBytes * 8)); } - /** - * @param fileSizeBytes - * @param streamPacketContextDef - * @param bitBuffer - * @param packetIndex - */ private void parsePacketContext(long fileSizeBytes, StructDefinition streamPacketContextDef, BitBuffer bitBuffer, StreamInputPacketIndexEntry packetIndex) { diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/internal/ctf/core/trace/StreamInputPacketIndex.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/internal/ctf/core/trace/StreamInputPacketIndex.java index b04165f460..14366d4547 100644 --- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/internal/ctf/core/trace/StreamInputPacketIndex.java +++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/internal/ctf/core/trace/StreamInputPacketIndex.java @@ -73,6 +73,7 @@ public class StreamInputPacketIndex { * @param entry * The entry to add * @throws CTFReaderException + * If there was a problem reading the entry */ public void addEntry(StreamInputPacketIndexEntry entry) throws CTFReaderException { diff --git a/org.eclipse.linuxtools.ctf.parser/src/org/eclipse/linuxtools/ctf/parser/CTFLexer.java b/org.eclipse.linuxtools.ctf.parser/src/org/eclipse/linuxtools/ctf/parser/CTFLexer.java index d189dc7a8a..2dbbf83a09 100644 --- a/org.eclipse.linuxtools.ctf.parser/src/org/eclipse/linuxtools/ctf/parser/CTFLexer.java +++ b/org.eclipse.linuxtools.ctf.parser/src/org/eclipse/linuxtools/ctf/parser/CTFLexer.java @@ -13,7 +13,7 @@ import org.antlr.runtime.NoViableAltException; import org.antlr.runtime.RecognitionException; import org.antlr.runtime.RecognizerSharedState; -@SuppressWarnings({"nls"}) +@SuppressWarnings({"nls", "javadoc"}) public class CTFLexer extends Lexer { public static final int SIGN = 49; public static final int TERM = 47; diff --git a/org.eclipse.linuxtools.ctf.parser/src/org/eclipse/linuxtools/ctf/parser/CTFParser.java b/org.eclipse.linuxtools.ctf.parser/src/org/eclipse/linuxtools/ctf/parser/CTFParser.java index 1a171aa343..94ac35daec 100644 --- a/org.eclipse.linuxtools.ctf.parser/src/org/eclipse/linuxtools/ctf/parser/CTFParser.java +++ b/org.eclipse.linuxtools.ctf.parser/src/org/eclipse/linuxtools/ctf/parser/CTFParser.java @@ -28,7 +28,7 @@ import org.antlr.runtime.tree.RewriteRuleSubtreeStream; import org.antlr.runtime.tree.RewriteRuleTokenStream; import org.antlr.runtime.tree.TreeAdaptor; -@SuppressWarnings({ "nls", "unused", "unchecked", "rawtypes" }) +@SuppressWarnings({ "nls", "unused", "unchecked", "rawtypes", "javadoc"}) public class CTFParser extends Parser { public static final String[] tokenNames = new String[] { "", "", "", "", "ALIGNTOK", "CONSTTOK", "CHARTOK", -- 2.34.1