[qdox-scm] [603] trunk/qdox/src/java/com/thoughtworks/qdox/model/ClassLibrary.java: ClassLibrary extra comments about usage

[rfscholte]

Title: [603] trunk/qdox/src/java/com/thoughtworks/qdox/model/ClassLibrary.java: ClassLibrary extra comments about usage

Revision

603

Author

rfscholte

Date

2009-05-23 06:40:36 -0500 (Sat, 23 May 2009)

Log Message

ClassLibrary extra comments about usage

Modified Paths

• trunk/qdox/src/java/com/thoughtworks/qdox/model/ClassLibrary.java

Diff

Modified: trunk/qdox/src/java/com/thoughtworks/qdox/model/ClassLibrary.java (602 => 603)

--- trunk/qdox/src/java/com/thoughtworks/qdox/model/ClassLibrary.java	2009-05-23 10:19:47 UTC (rev 602)
+++ trunk/qdox/src/java/com/thoughtworks/qdox/model/ClassLibrary.java	2009-05-23 11:40:36 UTC (rev 603)
@@ -14,8 +14,26 @@
 import java.util.HashMap;
 
 /**
+ * <strong>Important!! Be sure to add a classloader with the bootstrap classes.</strong>
+ * 
+ * <p>
+ * Normally you can generate your classLibrary like this:<br/>
+ * <code>
+ * 	ClassLibrary classLibrary = new ClassLibrary();
+ *  classLibrary.addDefaultLoader();
+ * </code>
+ * </p>
+ * 
+ * <p>
+ * If you want full control over the classLoaders you might want to create your library like:<br/> 
+ * <code>
+ * ClassLibrary classLibrary = new ClassLibrary( ClassLoader.getSystemClassLoader() )
+ * </code>  
+ * </p>
+ * 
  * @author <a href="" Walnes</a>
  * @author Aslak Helles&oslash;y
+ * @author Robert Scholte
  */
 public class ClassLibrary implements Serializable {
 
@@ -24,8 +42,14 @@
     private boolean defaultClassLoadersAdded = false;
     private transient List classLoaders = new ArrayList();
     
+    /**
+     * Remember to add bootstrap classes
+     */
     public ClassLibrary() {}
 
+    /**
+     * Remember to add bootstrap classes
+     */
     public ClassLibrary(ClassLoader loader) {
     	classLoaders.add(loader);
     }

---

To unsubscribe from this list please visit:

http://xircles.codehaus.org/manage_email