updated javadoc comments.

git-svn-id: http://anonsvn.jboss.org/repos/javassist/trunk@218 30ef5769-5b8d-40dd-aea6-55b5d6557bb3

3 files changed, 40 insertions, 0 deletions

diff --git a/src/main/javassist/CtBehavior.java b/src/main/javassist/CtBehavior.java
index c556910b..749caf33 100644
--- a/src/main/javassist/CtBehavior.java
+++ b/src/main/javassist/CtBehavior.java
@@ -301,6 +301,10 @@ public abstract class CtBehavior extends CtMember {
      * If that attribute is not found in the class file, this
      * method returns null.
      *
+     * <p>Note that an attribute is a data block specified by
+     * the class file format.
+     * See {@link javassist.bytecode.AttributeInfo}.
+     *
      * @param name              attribute name
      */
     public byte[] getAttribute(String name) {
@@ -314,6 +318,10 @@ public abstract class CtBehavior extends CtMember {
     /**
      * Adds an attribute. The attribute is saved in the class file.
      *
+     * <p>Note that an attribute is a data block specified by
+     * the class file format.
+     * See {@link javassist.bytecode.AttributeInfo}.
+     *
      * @param name      attribute name
      * @param data      attribute value
      */
diff --git a/src/main/javassist/CtField.java b/src/main/javassist/CtField.java
index 6de62119..8b3580a2 100644
--- a/src/main/javassist/CtField.java
+++ b/src/main/javassist/CtField.java
@@ -251,6 +251,15 @@ public class CtField extends CtMember {
     }
 
     /**
+     * Returns the character string representing the type of the field.
+     * If two fields have the same type,
+     * <code>getSignature()</code> returns the same string.
+     */
+    public String getSignature() {
+        return fieldInfo.getDescriptor();
+    }
+
+    /**
      * Returns the type of the field.
      */
     public CtClass getType() throws NotFoundException {
@@ -316,6 +325,10 @@ public class CtField extends CtMember {
      * If that attribute is not found in the class file, this
      * method returns null.
      *
+     * <p>Note that an attribute is a data block specified by
+     * the class file format.
+     * See {@link javassist.bytecode.AttributeInfo}.
+     *
      * @param name              attribute name
      */
     public byte[] getAttribute(String name) {
@@ -329,6 +342,10 @@ public class CtField extends CtMember {
     /**
      * Adds an attribute. The attribute is saved in the class file.
      *
+     * <p>Note that an attribute is a data block specified by
+     * the class file format.
+     * See {@link javassist.bytecode.AttributeInfo}.
+     *
      * @param name      attribute name
      * @param data      attribute value
      */
diff --git a/src/main/javassist/CtMember.java b/src/main/javassist/CtMember.java
index b04e107a..4e0154f0 100644
--- a/src/main/javassist/CtMember.java
+++ b/src/main/javassist/CtMember.java
@@ -142,10 +142,21 @@ public abstract class CtMember {
     public abstract String getName();
 
     /**
+     * Returns the character string representing the signature of the member.
+     * If two members have the same signature (parameter types etc.),
+     * <code>getSignature()</code> returns the same string.
+     */
+    public abstract String getSignature();
+
+    /**
      * Obtains a user-defined attribute with the given name.
      * If that attribute is not found in the class file, this
      * method returns null.
      *
+     * <p>Note that an attribute is a data block specified by
+     * the class file format.
+     * See {@link javassist.bytecode.AttributeInfo}.
+     *
      * @param name              attribute name
      */
     public abstract byte[] getAttribute(String name);
@@ -153,6 +164,10 @@ public abstract class CtMember {
     /**
      * Adds a user-defined attribute. The attribute is saved in the class file.
      *
+     * <p>Note that an attribute is a data block specified by
+     * the class file format.
+     * See {@link javassist.bytecode.AttributeInfo}.
+     *
      * @param name      attribute name
      * @param data      attribute value
      */