[qdox-scm] [1161] trunk/qdox/src/main/java/com/thoughtworks/qdox/model: Add some javadoc, remove already inherited methods

Mon, 11 Apr 2011 13:04:31 -0700

Title: [1161] trunk/qdox/src/main/java/com/thoughtworks/qdox/model: Add some javadoc, remove already inherited methods

Diff

Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/AbstractJavaModel.java (1160 => 1161)

--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/AbstractJavaModel.java	2011-04-11 17:42:48 UTC (rev 1160)
+++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/AbstractJavaModel.java	2011-04-11 20:04:23 UTC (rev 1161)
@@ -4,6 +4,14 @@
 import com.thoughtworks.qdox.io.ModelWriter;
 import com.thoughtworks.qdox.io.ModelWriterFactory;
 
+/**
+ * Every element of a class, including the class itself is a javaModel.
+ * While being constructed by a ModelBuilder, they all <strong>must</strong> have a reference to the same source.
+ * If a ModelWriterFactory is set, it <strong>must</strong> be the same for every element of this source, otherwise the defaultModelWriter is used.
+ * 
+ * @author Robert Scholte
+ *
+ */
 public abstract class AbstractJavaModel implements JavaModel {
 
     private ModelWriterFactory modelWriterFactory;

Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaField.java (1160 => 1161)

--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaField.java	2011-04-11 17:42:48 UTC (rev 1160)
+++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaField.java	2011-04-11 20:04:23 UTC (rev 1161)
@@ -24,10 +24,13 @@
 
     public Type getType();
 
+    /**
+     * The in-code representation of this field.
+     * 
+     * @return the complete representation of this field
+     */
     public String getCodeBlock();
 
-    public int compareTo( Object o );
-
     public String getDeclarationSignature( boolean withModifiers );
 
     public String getCallSignature();

Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaMethod.java (1160 => 1161)

--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaMethod.java	2011-04-11 17:42:48 UTC (rev 1160)
+++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaMethod.java	2011-04-11 20:04:23 UTC (rev 1161)
@@ -72,8 +72,6 @@
      */
     public boolean signatureMatches( String name, List<Type> parameterTypes, boolean varArg );
 
-    public boolean isPublic();
-
     /**
      * @return true if this method is a Java Bean accessor
      * @since 1.3

Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaParameter.java (1160 => 1161)

--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaParameter.java	2011-04-11 17:42:48 UTC (rev 1160)
+++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaParameter.java	2011-04-11 20:04:23 UTC (rev 1161)
@@ -42,8 +42,6 @@
      */
     public boolean isVarArgs();
 
-    public String toString();
-
     /**
      * 
      * @return the resolved value if the method has typeParameters, otherwise type's value

To unsubscribe from this list please visit:

http://xircles.codehaus.org/manage_email

Reply via email to