Improve javadoc for ctfAdapter in Tmf.Core

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

diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/ArrayDeclaration.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/ArrayDeclaration.java
index 84c5f599eccec24f7e223fa0fb205ec1683fe696..c7ee915ff5a809ff3c121545a5a798bb36b8d396 100644 (file)
--- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/ArrayDeclaration.java
+++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/ArrayDeclaration.java
@@ -28,6 +28,11 @@ public class ArrayDeclaration implements IDeclaration {
     // Constructors
     // ------------------------------------------------------------------------
 
+    /**
+     * Constructor
+     * @param length how many elements in the array
+     * @param elemType what type of element is in the array
+     */
     public ArrayDeclaration(int length, IDeclaration elemType) {
         this.length = length;
         this.elemType = elemType;
@@ -37,10 +42,18 @@ public class ArrayDeclaration implements IDeclaration {
     // Getters/Setters/Predicates
     // ------------------------------------------------------------------------
 
+    /**
+     *
+     * @return the type of element in the array
+     */
     public IDeclaration getElementType() {
         return elemType;
     }
 
+    /**
+     *
+     * @return how many elements in the array
+     */
     public int getLength() {
         return length;
     }