Improve javadoc for ctfAdapter in Tmf.Core

[deliverable/tracecompass.git] / org.eclipse.linuxtools.ctf.core / src / org / eclipse / linuxtools / ctf / core / event / types / FloatDeclaration.java

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 293528f2769e27a48ecaac028304fb2843ff35af..3d97dd46015b16d52a6298222e8a17dec90ef5a5 100644 (file)
--- 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
@@ -13,7 +13,12 @@ package org.eclipse.linuxtools.ctf.core.event.types;
 
 import java.nio.ByteOrder;
 
-
+/**
+ * Float declaration
+ *
+ * @author Matthew Khouzam
+ *
+ */
 public class FloatDeclaration implements IDeclaration {
 
     // ------------------------------------------------------------------------
@@ -29,6 +34,13 @@ public class FloatDeclaration implements IDeclaration {
     // Constructors
     // ------------------------------------------------------------------------
 
+    /**
+     * Constructor
+     * @param exponent the exponent size in bits
+     * @param mantissa the mantissa size in bits (+1 for sign) (see ctf spec)
+     * @param byteOrder the byte order
+     * @param alignment the alignment
+     */
     public FloatDeclaration(int exponent, int mantissa, ByteOrder byteOrder,
             long alignment) {
         mant = mantissa;