[jboss-svn-commits] JBL Code SVN: r9551 - labs/jbossrules/trunk/drools-repository/src/main/java/org/drools/repository.

[jboss-svn-commits at lists.jboss.org]

Author: michael.neale at jboss.com
Date: 2007-02-16 02:36:40 -0500 (Fri, 16 Feb 2007)
New Revision: 9551

Modified:
   labs/jbossrules/trunk/drools-repository/src/main/java/org/drools/repository/PackageItem.java
   labs/jbossrules/trunk/drools-repository/src/main/java/org/drools/repository/RulesRepository.java
Log:
documentation improvements

Modified: labs/jbossrules/trunk/drools-repository/src/main/java/org/drools/repository/PackageItem.java
===================================================================
--- labs/jbossrules/trunk/drools-repository/src/main/java/org/drools/repository/PackageItem.java	2007-02-16 07:34:02 UTC (rev 9550)
+++ labs/jbossrules/trunk/drools-repository/src/main/java/org/drools/repository/PackageItem.java	2007-02-16 07:36:40 UTC (rev 9551)
@@ -101,7 +101,9 @@
 
     /**
      * This adds a rule to the current physical package (you can move it later).
-     * With the given category
+     * With the given category.
+     * 
+     * This will NOT check the asset in, just create the basic record. 
      * @param assetName The name of the asset (the file name minus the extension)
      * @param description A description of the asset.
      * @param initialCategory The initial category the asset is placed in (can belong to multiple ones later).

Modified: labs/jbossrules/trunk/drools-repository/src/main/java/org/drools/repository/RulesRepository.java
===================================================================
--- labs/jbossrules/trunk/drools-repository/src/main/java/org/drools/repository/RulesRepository.java	2007-02-16 07:34:02 UTC (rev 9550)
+++ labs/jbossrules/trunk/drools-repository/src/main/java/org/drools/repository/RulesRepository.java	2007-02-16 07:36:40 UTC (rev 9551)
@@ -404,6 +404,9 @@
         }
     }    
     
+    /**
+     * This returns true if the repository contains the specified package name. 
+     */
     public boolean containsPackage(String name) {
         Node folderNode = this.getAreaNode( RULE_PACKAGE_AREA );
         try {
@@ -535,13 +538,11 @@
     
 
     /**
-     * Adds a rule package node in the repository. This node has a property called 
-     * drools:rule_reference that is a multi-value reference property.  It will hold an array of 
-     * references to rule nodes that are subsequently added.
+     * Adds a package to the repository.
      *   
      * @param name what to name the node added
      * @param description what description to use for the node
-     * @return a RulePackageItem, encapsulating the created node
+     * @return a PackageItem, encapsulating the created node
      * @throws RulesRepositoryException
      */
     public PackageItem createPackage(String name, String description) throws RulesRepositoryException {