btf: Move plugins to the Trace Compass namespace

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

diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StructDeclaration.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StructDeclaration.java
index 92e024029ebb93ef2d605daa35a4634265d6a0a4..a356e8650ad8f395c9e7afcae9f5502d71a77d4c 100644 (file)
--- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StructDeclaration.java
+++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StructDeclaration.java
@@ -172,17 +172,19 @@ public class StructDeclaration extends Declaration {
     }
 
     /**
-     * Accelerated create definition
+     * Create a definition from this declaration. This is a faster constructor
+     * as it has a lexical scope and this does not need to look it up.
      *
      * @param definitionScope
-     *            the definition scope
+     *            the definition scope, the parent where the definition will be
+     *            placed
      * @param fieldScope
-     *            the lexical scope of this element
+     *            the scope of the definition
      * @param input
-     *            the {@Link BitBuffer} to read
-     * @return the Struct definition
+     *            a bitbuffer to read from
+     * @return a reference to the definition
      * @throws CTFReaderException
-     *             read error and such
+     *             error in reading
      * @since 3.1
      */
     public StructDefinition createDefinition(IDefinitionScope definitionScope,