ctf: java 8 compliance of javadoc
authorMatthew Khouzam <matthew.khouzam@ericsson.com>
Fri, 25 Apr 2014 17:30:35 +0000 (13:30 -0400)
committerMatthew Khouzam <matthew.khouzam@ericsson.com>
Sat, 26 Apr 2014 01:02:26 +0000 (21:02 -0400)
Change-Id: I9ad7d732f606365bcdef1608b7c98c6577558e25
Signed-off-by: Matthew Khouzam <matthew.khouzam@ericsson.com>
Reviewed-on: https://git.eclipse.org/r/25579
Tested-by: Hudson CI
Reviewed-by: Marc-Andre Laperle <marc-andre.laperle@ericsson.com>
Tested-by: Marc-Andre Laperle <marc-andre.laperle@ericsson.com>
org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/ArrayDefinition.java
org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/EnumDeclaration.java
org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/FloatDeclaration.java
org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/IntegerDeclaration.java
org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/SequenceDefinition.java
org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/CTFTrace.java
org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/StreamInput.java
org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/trace/Utils.java

index 97f6f5ae28d79bdcaf3032f345daa06a5f0c4ec6..fab0012600afb73c09a8bacbb2d541d388191d70 100644 (file)
@@ -85,7 +85,7 @@ public class ArrayDefinition extends Definition {
     /**
      * Get the element at i
      * @param i the index (cannot be negative)
-     * @return The element at I, if I > length, null, if I < 0, the method throws an out of bounds exception
+     * @return The element at I, if I &gt; length, null, if I &lt; 0, the method throws an out of bounds exception
      */
     public Definition getElem(int i) {
         if (i > definitions.length) {
index 2b6a728ecadb1f20d062672ef12367c835263265..89d28d8d0eef7ae1d6434784420a22ba7e6abe60 100644 (file)
@@ -83,7 +83,7 @@ public class EnumDeclaration implements IDeclaration {
     }
 
     /**
-     * Add a value. Do not overlap, this is <i><u><b>not</i></u></b> an interval
+     * Add a value. Do not overlap, this is <em><strong>not</strong></em> an interval
      * tree.
      *
      * @param low
index 36c50a740e87374c358cf462b72b22041698eb3f..f9ca2ceed58fe9421d3569032f37560d940e3bff 100644 (file)
@@ -46,7 +46,7 @@ public class FloatDeclaration implements IDeclaration {
      * @param byteOrder
      *            The byte order
      * @param alignment
-     *            The alignment. Should be >= 1
+     *            The alignment. Should be &ge; 1
      */
     public FloatDeclaration(int exponent, int mantissa, ByteOrder byteOrder,
             long alignment) {
index 5e2ba99ed39f6b52ac7375411bc7084f63117a14..5469a7b3cd0cd146bb554430cee18ce19090801f 100644 (file)
@@ -60,7 +60,7 @@ public class IntegerDeclaration implements IDeclaration {
      * @param clock
      *            The clock path, can be null
      * @param alignment
-     *            The minimum alignment. Should be >= 1
+     *            The minimum alignment. Should be &ge; 1
      */
     public IntegerDeclaration(int len, boolean signed, int base,
             ByteOrder byteOrder, Encoding encoding, String clock, long alignment) {
index cfd68a2d8283f2a5ade005d27b79293cbb78f63e..c6b004377d0a356eb150f37edc13816edac09aa1 100644 (file)
@@ -104,7 +104,7 @@ public class SequenceDefinition extends Definition {
      *
      * @param i
      *            the index (cannot be negative)
-     * @return The element at I, if I > length, null, if I < 0, the method
+     * @return The element at I, if I &gt; length, null, if I &lt; 0, the method
      *         throws an out of bounds exception
      */
     public Definition getElem(int i) {
index 00eac61eb2c2f98cde3668a2b27a8179f5d28de3..7bb19730fe8c4cce8279e57f40084e4d402a2337 100644 (file)
@@ -467,7 +467,7 @@ public class CTFTrace implements IDefinitionScope, AutoCloseable {
     /**
      * Get all the streams as an iterable.
      *
-     * @return Iterable<Stream> an iterable over streams.
+     * @return Iterable&lt;Stream&gt; an iterable over streams.
      * @since 3.0
      */
     public Iterable<Stream> getStreams() {
index 02d0822ad5e302f60b376ef62bfe236fecdaff16..a6ac0857085ac5781e61ff4a297a04dc67bdc171 100644 (file)
@@ -201,7 +201,7 @@ public class StreamInput implements IDefinitionScope {
     /**
      * Adds the next packet header index entry to the index of a stream input.
      *
-     * @warning slow, can corrupt data if not used properly
+     * <strong>This method is slow and can corrupt data if not used properly</strong>
      * @return true if there are more packets to add
      * @throws CTFReaderException
      *             If there was a problem reading the packed header
index 8d8ba83f736fc8fe8e2c5d1fc39e399150d617df..efed12738e66b9668f91a0debe709498a0f330eb 100644 (file)
@@ -61,15 +61,15 @@ public class Utils {
     /**
      * Performs an unsigned long comparison on two unsigned long numbers.
      *
-     * @note As Java does not support unsigned types and arithmetic, parameters
+     * <strong> As Java does not support unsigned types and arithmetic, parameters
      *       are received encoded as a signed long (two-complement) but the
-     *       operation is an unsigned comparator.
+     *       operation is an unsigned comparator.</strong>
      *
      * @param left
      *            Left operand of the comparator.
      * @param right
      *            Right operand of the comparator.
-     * @return -1 if left < right, 1 if left > right, 0 if left == right.
+     * @return -1 if left &lt; right, 1 if left &gt; right, 0 if left == right.
      */
     public static int unsignedCompare(long left, long right) {
         /*
This page took 0.029859 seconds and 5 git commands to generate.