Improve javadoc for ctfAdapter in Tmf.Core

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

diff --git a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDeclaration.java b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDeclaration.java
index 0f62d91732433e022e00d7866fa071e2dffa2e66..d57229fca04c15e75b39243c173cfd0bd0af41be 100644 (file)
--- a/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDeclaration.java
+++ b/org.eclipse.linuxtools.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/StringDeclaration.java
@@ -27,17 +27,16 @@ public class StringDeclaration implements IDeclaration {
     // Constructors
     // ------------------------------------------------------------------------
 
-    public Encoding getEncoding() {
-        return encoding;
-    }
-
-    // ------------------------------------------------------------------------
-    // Constructors
-    // ------------------------------------------------------------------------
-
+    /**
+     * Generate a UTF8 string declaration
+     */
     public StringDeclaration() {
     }
 
+    /**
+     * generate an encoded string declaration
+     * @param encoding the encoding, utf8 or ascii
+     */
     public StringDeclaration(Encoding encoding) {
         this.encoding = encoding;
     }
@@ -46,6 +45,18 @@ public class StringDeclaration implements IDeclaration {
     // Getters/Setters/Predicates
     // ------------------------------------------------------------------------
 
+    /**
+     *
+     * @return the character encoding.
+     */
+    public Encoding getEncoding() {
+        return encoding;
+    }
+
+    /**
+     *
+     * @param encoding the character encoding to set
+     */
     public void setEncoding(Encoding encoding) {
         this.encoding = encoding;
     }