Improve javadoc for ctfAdapter in Tmf.Core

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

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 397be25d7ee41bebc03f6d635a695f3c1ce58862..07bd50cd39364184c577a4e14625172162db62cc 100644 (file)
--- 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
@@ -13,6 +13,11 @@ package org.eclipse.linuxtools.ctf.core.event.types;
 
 import org.eclipse.linuxtools.internal.ctf.core.event.io.BitBuffer;
 
+/**
+ * Float definition
+ * @author Matthew Khouzam
+ *
+ */
 public class FloatDefinition extends Definition {
     // ------------------------------------------------------------------------
     // Attributes
@@ -25,6 +30,16 @@ public class FloatDefinition extends Definition {
     // Contructors
     // ------------------------------------------------------------------------
 
+    /**
+     * Constructor
+     *
+     * @param declaration
+     *            the parent declaration
+     * @param definitionScope
+     *            the parent scope
+     * @param fieldName
+     *            the field name
+     */
     public FloatDefinition(FloatDeclaration declaration,
             IDefinitionScope definitionScope, String fieldName) {
         super(definitionScope, fieldName);
@@ -35,14 +50,27 @@ public class FloatDefinition extends Definition {
     // Gettters/Setters/Predicates
     // ------------------------------------------------------------------------
 
+    /**
+     * 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.
+     */
     public double getValue() {
         return value;
     }
 
+    /**
+     * Sets the value of the float
+     *
+     * @param val
+     *            the value of the float
+     */
     public void setValue(double val) {
         value = val;
     }
 
+    @Override
     public FloatDeclaration getDeclaration() {
         return declaration;
     }