aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEtienneb Bergeron2013-11-22 00:30:05 (EST)
committerAlexandre Montplaisir2013-11-22 15:43:44 (EST)
commitfe87ef519aad9b85b58fffd6d8e32bb2f08ae9f8 (patch)
treefd0ce91a9793b6beb556b91e4e59664b4273d858
parent88b27f9c12b26359d257b1c828d9fbb93328fe22 (diff)
downloadorg.eclipse.linuxtools-fe87ef519aad9b85b58fffd6d8e32bb2f08ae9f8.zip
org.eclipse.linuxtools-fe87ef519aad9b85b58fffd6d8e32bb2f08ae9f8.tar.gz
org.eclipse.linuxtools-fe87ef519aad9b85b58fffd6d8e32bb2f08ae9f8.tar.bz2
[ctf] Fixes multiple coding style issues while reading ctf Types.refs/changes/06/18706/4
Change-Id: I73a2e42b76090ed344a32da330cd0ab240b68099 Signed-off-by: Etienne Bergeron <etienne.bergeron@gmail.com> Reviewed-on: https://git.eclipse.org/r/18706 Tested-by: Hudson CI Reviewed-by: Matthew Khouzam <matthew.khouzam@ericsson.com> IP-Clean: Matthew Khouzam <matthew.khouzam@ericsson.com> Tested-by: Matthew Khouzam <matthew.khouzam@ericsson.com> Reviewed-by: Alexandre Montplaisir <alexmonthy@voxpopuli.im>
-rw-r--r--lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/ArrayDefinition.java2
-rw-r--r--lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/Definition.java2
-rw-r--r--lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/EnumDeclaration.java4
-rw-r--r--lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/FloatDeclaration.java2
-rw-r--r--lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/FloatDefinition.java6
-rw-r--r--lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IntegerDeclaration.java14
-rw-r--r--lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IntegerDefinition.java4
-rw-r--r--lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/SimpleDatatypeDefinition.java4
-rw-r--r--lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDeclaration.java4
-rw-r--r--lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StructDefinition.java14
-rw-r--r--lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/VariantDeclaration.java5
11 files changed, 30 insertions, 31 deletions
diff --git a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/ArrayDefinition.java b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/ArrayDefinition.java
index 1e4b8c2..96d16d8 100644
--- a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/ArrayDefinition.java
+++ b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/ArrayDefinition.java
@@ -17,7 +17,7 @@ import java.util.Arrays;
import org.eclipse.linuxtools.ctf.core.event.io.BitBuffer;
/**
- * A CTF array definiton
+ * A CTF array definition
*
* Arrays are fixed-length. Their length is declared in the type
* declaration within the meta-data. They contain an array of "inner type"
diff --git a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/Definition.java b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/Definition.java
index 5233ada..99c031b 100644
--- a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/Definition.java
+++ b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/Definition.java
@@ -15,7 +15,7 @@ package org.eclipse.linuxtools.ctf.core.event.types;
import org.eclipse.linuxtools.ctf.core.event.io.BitBuffer;
/**
- * A CTF definiton
+ * A CTF definition
*
* A definition is like an object of a declaration class. It fills the declaration
* with values. <br>
diff --git a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/EnumDeclaration.java b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/EnumDeclaration.java
index 44a5206..d820c3d 100644
--- a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/EnumDeclaration.java
+++ b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/EnumDeclaration.java
@@ -90,7 +90,7 @@ public class EnumDeclaration implements IDeclaration {
}
/**
- * check if the label for a value (enum a{day=0,night=1} would return "day" for query(0)
+ * Check if the label for a value (enum a{day=0,night=1} would return "day" for query(0)
* @param value the value to lookup
* @return the label of that value, can be null
*/
@@ -124,7 +124,7 @@ public class EnumDeclaration implements IDeclaration {
}
/**
- * return the first label that matches a value
+ * Return the first label that matches a value
* @param value the value to query
* @return the label corresponding to that value
*/
diff --git a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/FloatDeclaration.java b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/FloatDeclaration.java
index 71ec320..3b5bbea 100644
--- a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/FloatDeclaration.java
+++ b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/FloatDeclaration.java
@@ -58,7 +58,7 @@ public class FloatDeclaration implements IDeclaration {
}
// ------------------------------------------------------------------------
- // Gettters/Setters/Predicates
+ // Getters/Setters/Predicates
// ------------------------------------------------------------------------
/**
diff --git a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/FloatDefinition.java b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/FloatDefinition.java
index d70645e..044a82d 100644
--- a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/FloatDefinition.java
+++ b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/FloatDefinition.java
@@ -32,7 +32,7 @@ public class FloatDefinition extends Definition {
private double value;
// ------------------------------------------------------------------------
- // Contructors
+ // Constructors
// ------------------------------------------------------------------------
/**
@@ -52,11 +52,11 @@ public class FloatDefinition extends Definition {
}
// ------------------------------------------------------------------------
- // Gettters/Setters/Predicates
+ // Getters/Setters/Predicates
// ------------------------------------------------------------------------
/**
- * THe value of a float stored, fit into a double. This should be extended
+ * The value of a float stored, fit into a double. This should be extended
* for exotic floats if this is necessary.
*
* @return the value of the float field fit into a double.
diff --git a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IntegerDeclaration.java b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IntegerDeclaration.java
index 0f7673d..58c03fc 100644
--- a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IntegerDeclaration.java
+++ b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IntegerDeclaration.java
@@ -45,7 +45,7 @@ public class IntegerDeclaration implements IDeclaration {
// ------------------------------------------------------------------------
/**
- * Contructor
+ * Constructor
*
* @param len
* The length in bits
@@ -54,7 +54,7 @@ public class IntegerDeclaration implements IDeclaration {
* @param base
* The base (10-16 are most common)
* @param byteOrder
- * Big endian little endian or other
+ * Big-endian little-endian or other
* @param encoding
* ascii, utf8 or none.
* @param clock
@@ -77,7 +77,7 @@ public class IntegerDeclaration implements IDeclaration {
}
// ------------------------------------------------------------------------
- // Gettters/Setters/Predicates
+ // Getters/Setters/Predicates
// ------------------------------------------------------------------------
/**
@@ -89,7 +89,7 @@ public class IntegerDeclaration implements IDeclaration {
}
/**
- * get the integer base commonly decimal or hex
+ * Get the integer base commonly decimal or hex
* @return the integer base
*/
public int getBase() {
@@ -97,7 +97,7 @@ public class IntegerDeclaration implements IDeclaration {
}
/**
- * gets the byte order
+ * Gets the byte order
* @return the byte order
*/
public ByteOrder getByteOrder() {
@@ -105,7 +105,7 @@ public class IntegerDeclaration implements IDeclaration {
}
/**
- * get encoding, chars are 8 bit ints
+ * Get encoding, chars are 8 bit ints
* @return the encoding
*/
public Encoding getEncoding() {
@@ -113,7 +113,7 @@ public class IntegerDeclaration implements IDeclaration {
}
/**
- * is the integer a character (8 bits and encoded?)
+ * Is the integer a character (8 bits and encoded?)
* @return is the integer a char
*/
public boolean isCharacter() {
diff --git a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IntegerDefinition.java b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IntegerDefinition.java
index 8c4f8f1..0b63230 100644
--- a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IntegerDefinition.java
+++ b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IntegerDefinition.java
@@ -37,7 +37,7 @@ public class IntegerDefinition extends SimpleDatatypeDefinition {
private long value;
// ------------------------------------------------------------------------
- // Contructors
+ // Constructors
// ------------------------------------------------------------------------
/**
@@ -57,7 +57,7 @@ public class IntegerDefinition extends SimpleDatatypeDefinition {
}
// ------------------------------------------------------------------------
- // Gettters/Setters/Predicates
+ // Getters/Setters/Predicates
// ------------------------------------------------------------------------
/**
diff --git a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/SimpleDatatypeDefinition.java b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/SimpleDatatypeDefinition.java
index 569af25..04fc012 100644
--- a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/SimpleDatatypeDefinition.java
+++ b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/SimpleDatatypeDefinition.java
@@ -35,7 +35,7 @@ public abstract class SimpleDatatypeDefinition extends Definition {
}
/**
- * gets the value in integer form
+ * Gets the value in integer form
*
* @return the integer in a Long, can be null
*/
@@ -44,7 +44,7 @@ public abstract class SimpleDatatypeDefinition extends Definition {
}
/**
- * gets the value in string form
+ * Gets the value in string form
*
* @return the integer in a String, can be null
*/
diff --git a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDeclaration.java b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDeclaration.java
index c79e506..6f63b4d 100644
--- a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDeclaration.java
+++ b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDeclaration.java
@@ -14,7 +14,7 @@ package org.eclipse.linuxtools.ctf.core.event.types;
/**
* 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.
@@ -42,7 +42,7 @@ public class StringDeclaration implements IDeclaration {
}
/**
- * generate an encoded string declaration
+ * Generate an encoded string declaration
* @param encoding the encoding, utf8 or ascii
*/
public StringDeclaration(Encoding encoding) {
diff --git a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StructDefinition.java b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StructDefinition.java
index 667b4e3..378b2e0 100644
--- a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StructDefinition.java
+++ b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StructDefinition.java
@@ -115,7 +115,7 @@ public class StructDefinition extends Definition implements IDefinitionScope {
}
/**
- * Lookup an array in a struct. if the name returns a non-array (like an
+ * Lookup an array in a struct. If the name returns a non-array (like an
* int) than the method returns null
*
* @param name
@@ -128,7 +128,7 @@ public class StructDefinition extends Definition implements IDefinitionScope {
}
/**
- * Lookup an enum in a struct. if the name returns a non-enum (like an int)
+ * Lookup an enum in a struct. If the name returns a non-enum (like an int)
* than the method returns null
*
* @param name
@@ -141,7 +141,7 @@ public class StructDefinition extends Definition implements IDefinitionScope {
}
/**
- * Lookup an integer in a struct. if the name returns a non-integer (like an
+ * Lookup an integer in a struct. If the name returns a non-integer (like an
* float) than the method returns null
*
* @param name
@@ -155,7 +155,7 @@ public class StructDefinition extends Definition implements IDefinitionScope {
}
/**
- * Lookup a sequence in a struct. if the name returns a non-sequence (like
+ * Lookup a sequence in a struct. If the name returns a non-sequence (like
* an int) than the method returns null
*
* @param name
@@ -169,7 +169,7 @@ public class StructDefinition extends Definition implements IDefinitionScope {
}
/**
- * Lookup a string in a struct. if the name returns a non-string (like
+ * Lookup a string in a struct. If the name returns a non-string (like
* an int) than the method returns null
*
* @param name
@@ -183,7 +183,7 @@ public class StructDefinition extends Definition implements IDefinitionScope {
}
/**
- * Lookup a struct in a struct. if the name returns a non-struct (like
+ * Lookup a struct in a struct. If the name returns a non-struct (like
* an int) than the method returns null
*
* @param name
@@ -197,7 +197,7 @@ public class StructDefinition extends Definition implements IDefinitionScope {
}
/**
- * Lookup a variant in a struct. if the name returns a non-variant (like
+ * Lookup a variant in a struct. If the name returns a non-variant (like
* an int) than the method returns null
*
* @param name
diff --git a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/VariantDeclaration.java b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/VariantDeclaration.java
index 42a9f43..0e526ae 100644
--- a/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/VariantDeclaration.java
+++ b/lttng/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/VariantDeclaration.java
@@ -41,10 +41,9 @@ public class VariantDeclaration implements IDeclaration {
// ------------------------------------------------------------------------
/**
- * constructor
+ * Constructor
*/
public VariantDeclaration() {
-
}
// ------------------------------------------------------------------------
@@ -76,7 +75,7 @@ public class VariantDeclaration implements IDeclaration {
}
/**
- * gets current variant tag
+ * Gets current variant tag
* @return the variant tag.
*/
public String getTag() {