[Jboss-svn-commits] JBL Code SVN: r4084 - labs/jbossrules/trunk/drools-compiler/src/main/java/org/drools/compiler

[<jbo...@li...>]

Author: mic...@jb...
Date: 2006-05-04 06:05:45 -0400 (Thu, 04 May 2006)
New Revision: 4084

Modified:
   labs/jbossrules/trunk/drools-compiler/src/main/java/org/drools/compiler/PackageBuilder.java
Log:
documentation improvements

Modified: labs/jbossrules/trunk/drools-compiler/src/main/java/org/drools/compiler/PackageBuilder.java
===================================================================
--- labs/jbossrules/trunk/drools-compiler/src/main/java/org/drools/compiler/PackageBuilder.java	2006-05-04 09:41:00 UTC (rev 4083)
+++ labs/jbossrules/trunk/drools-compiler/src/main/java/org/drools/compiler/PackageBuilder.java	2006-05-04 10:05:45 UTC (rev 4084)
@@ -44,6 +44,11 @@
 import org.drools.xml.XmlPackageReader;
 import org.xml.sax.SAXException;
 
+/**
+ * This is the main compiler class for parsing and compiling rules and assembling or merging them into a
+ * binary Package instance.
+ * This can be done by merging into existing binary packages, or totally from source.
+ */
 public class PackageBuilder {
     private JavaCompiler                compiler;
 
@@ -57,16 +62,27 @@
 
     private PackageBuilderConfiguration configuration;
 
+    /**
+     * Use this when package is starting from scratch. 
+     */
     public PackageBuilder() {
         this( null,
               null );
     }
 
+    /**
+     * This will allow you to merge rules into this pre existing package.
+     */
     public PackageBuilder(Package pkg) {
         this( pkg,
               null );
     }
 
+    /**
+     * This allows you to pass in a pre existing package, and a configuration (for instance to set the classloader).
+     * @param pkg A pre existing package (can be null if none exists)
+     * @param configuration Optional configuration for this builder.
+     */
     public PackageBuilder(Package pkg,
                           PackageBuilderConfiguration configuration) {
         if ( configuration == null ) {