[Jboss-svn-commits] JBL Code SVN: r4688 - in labs/jbossrules/trunk: . documentation/training/developers-course/lab-4-rule-formats drools-compiler/src/main/resources/org/drools drools-compiler/src/main/resources/org/drools/compiler drools-compiler/src/main/resources/org/drools/lang drools-compiler/src/main/resources/org/drools/xml drools-core/src/main/resources drools-core/src/main/resources/org drools-core/src/main/resources/org/drools drools-core/src/main/resources/org/drools/audit drools-core/src/main/resources/org/drools/event drools-core/src/main/resources/org/drools/rule drools-core/src/main/resources/org/drools/visualize drools-decisiontables/src/main/resources drools-decisiontables/src/main/resources/org drools-decisiontables/src/main/resources/org/drools drools-decisiontables/src/main/resources/org/drools/decisiontable

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

Author: mic...@jb...
Date: 2006-06-08 22:17:28 -0400 (Thu, 08 Jun 2006)
New Revision: 4688

Added:
   labs/jbossrules/trunk/drools-compiler/src/main/resources/org/drools/compiler/
   labs/jbossrules/trunk/drools-compiler/src/main/resources/org/drools/compiler/package.html
   labs/jbossrules/trunk/drools-compiler/src/main/resources/org/drools/lang/package.html
   labs/jbossrules/trunk/drools-compiler/src/main/resources/org/drools/xml/
   labs/jbossrules/trunk/drools-compiler/src/main/resources/org/drools/xml/package.html
   labs/jbossrules/trunk/drools-core/src/main/resources/org/
   labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/
   labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/audit/
   labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/audit/package.html
   labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/event/
   labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/event/package.html
   labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/package.html
   labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/rule/
   labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/rule/package.html
   labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/visualize/
   labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/visualize/package.html
   labs/jbossrules/trunk/drools-core/src/main/resources/overview.html
   labs/jbossrules/trunk/drools-decisiontables/src/main/resources/org/
   labs/jbossrules/trunk/drools-decisiontables/src/main/resources/org/drools/
   labs/jbossrules/trunk/drools-decisiontables/src/main/resources/org/drools/decisiontable/
   labs/jbossrules/trunk/drools-decisiontables/src/main/resources/org/drools/decisiontable/package.html
Modified:
   labs/jbossrules/trunk/build.xml
   labs/jbossrules/trunk/documentation/training/developers-course/lab-4-rule-formats/Instructions.txt
Log:
improved javadocs

Modified: labs/jbossrules/trunk/build.xml
===================================================================
--- labs/jbossrules/trunk/build.xml	2006-06-08 22:05:22 UTC (rev 4687)
+++ labs/jbossrules/trunk/build.xml	2006-06-09 02:17:28 UTC (rev 4688)
@@ -483,7 +483,8 @@
          packagenames="org.drools.*"
          excludepackagenames="org.drools.asm.*"
          destdir="target/docs/apidocs"
-         author="false"		 
+         author="false"	
+		 Overview="drools-core/target/classes/overview.html"
          version="false">
 
          <sourcepath>
@@ -499,7 +500,7 @@
          </classpath>       
 
 			<group title="Runtime Core API"
-				packages="org.drools"/>
+				packages="org.drools:org.drools.rule"/>
 			<group title="Compiler Core API" 
 				packages="org.drools.compiler"/>
 
@@ -508,11 +509,12 @@
 				packages="org.drools.lang:org.drools.xml"/>	
 				
 			<group title="Runtime Utilities" 
-				packages="org.drools.audit*:org.drools.event:org.drools.visualize"/>
+				packages="org.drools.audit:org.drools.event:org.drools.visualize"/>
 			<group title="Decision Tables" 
 				packages="org.drools.decisiontable"/>
 				
-
+			<group title="Internal"
+				packages="org.drools*" />
        </javadoc>    
     </target>
     
@@ -523,6 +525,7 @@
          destdir="target/docs/apidocs"
          author="false"
          version="false"
+		 Overview="drools-core/target/classes/overview.html"
          source="1.4">
 
          <sourcepath>
@@ -558,8 +561,9 @@
           <param name="-breakiterator"/>
         </doclet>         
 
+
 			<group title="Runtime Core API"
-				packages="org.drools"/>
+				packages="org.drools:org.drools.rule"/>
 			<group title="Compiler Core API" 
 				packages="org.drools.compiler"/>
 
@@ -568,9 +572,12 @@
 				packages="org.drools.lang:org.drools.xml"/>	
 				
 			<group title="Runtime Utilities" 
-				packages="org.drools.audit*:org.drools.event:org.drools.visualize"/>
+				packages="org.drools.audit:org.drools.event:org.drools.visualize"/>
 			<group title="Decision Tables" 
 				packages="org.drools.decisiontable"/>
+				
+			<group title="Internal"
+				packages="org.drools*" />
 
 
        </javadoc>    

Modified: labs/jbossrules/trunk/documentation/training/developers-course/lab-4-rule-formats/Instructions.txt
===================================================================
--- labs/jbossrules/trunk/documentation/training/developers-course/lab-4-rule-formats/Instructions.txt	2006-06-08 22:05:22 UTC (rev 4687)
+++ labs/jbossrules/trunk/documentation/training/developers-course/lab-4-rule-formats/Instructions.txt	2006-06-09 02:17:28 UTC (rev 4688)
@@ -1,5 +1,5 @@
 ---------------------------------------------
-JBoss Rules Essentual Lab Excercise 4
+JBoss Rules Essentials Lab Excercise 4
 	- Alternative rule formats -
 ---------------------------------------------
 

Added: labs/jbossrules/trunk/drools-compiler/src/main/resources/org/drools/compiler/package.html
===================================================================
--- labs/jbossrules/trunk/drools-compiler/src/main/resources/org/drools/compiler/package.html	2006-06-08 22:05:22 UTC (rev 4687)
+++ labs/jbossrules/trunk/drools-compiler/src/main/resources/org/drools/compiler/package.html	2006-06-09 02:17:28 UTC (rev 4688)
@@ -0,0 +1,3 @@
+<body>
+	This is the main package to load rules. Use PackageBuilder and RuleBaseLoader classes.
+</body>
\ No newline at end of file


Property changes on: labs/jbossrules/trunk/drools-compiler/src/main/resources/org/drools/compiler/package.html
___________________________________________________________________
Name: svn:eol-style
   + native

Added: labs/jbossrules/trunk/drools-compiler/src/main/resources/org/drools/lang/package.html
===================================================================
--- labs/jbossrules/trunk/drools-compiler/src/main/resources/org/drools/lang/package.html	2006-06-08 22:05:22 UTC (rev 4687)
+++ labs/jbossrules/trunk/drools-compiler/src/main/resources/org/drools/lang/package.html	2006-06-09 02:17:28 UTC (rev 4688)
@@ -0,0 +1,3 @@
+<body>
+	This contains the parser and utilities for the native DRL format, for handling DRL source.
+</body>
\ No newline at end of file


Property changes on: labs/jbossrules/trunk/drools-compiler/src/main/resources/org/drools/lang/package.html
___________________________________________________________________
Name: svn:eol-style
   + native

Added: labs/jbossrules/trunk/drools-compiler/src/main/resources/org/drools/xml/package.html
===================================================================
--- labs/jbossrules/trunk/drools-compiler/src/main/resources/org/drools/xml/package.html	2006-06-08 22:05:22 UTC (rev 4687)
+++ labs/jbossrules/trunk/drools-compiler/src/main/resources/org/drools/xml/package.html	2006-06-09 02:17:28 UTC (rev 4688)
@@ -0,0 +1,3 @@
+<body>
+	This contains the parser and utilities for handling rules in XML format. 
+</body>
\ No newline at end of file


Property changes on: labs/jbossrules/trunk/drools-compiler/src/main/resources/org/drools/xml/package.html
___________________________________________________________________
Name: svn:eol-style
   + native

Added: labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/audit/package.html
===================================================================
--- labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/audit/package.html	2006-06-08 22:05:22 UTC (rev 4687)
+++ labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/audit/package.html	2006-06-09 02:17:28 UTC (rev 4688)
@@ -0,0 +1,3 @@
+<body>
+	This is a utility for providing audit trails/explanations of rule actions.
+</body>
\ No newline at end of file


Property changes on: labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/audit/package.html
___________________________________________________________________
Name: svn:eol-style
   + native

Added: labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/event/package.html
===================================================================
--- labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/event/package.html	2006-06-08 22:05:22 UTC (rev 4687)
+++ labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/event/package.html	2006-06-09 02:17:28 UTC (rev 4688)
@@ -0,0 +1,3 @@
+<body>
+	Events provide all sorts of call backs to monitor the engine as it is running.
+</body>
\ No newline at end of file


Property changes on: labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/event/package.html
___________________________________________________________________
Name: svn:eol-style
   + native

Added: labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/package.html
===================================================================
--- labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/package.html	2006-06-08 22:05:22 UTC (rev 4687)
+++ labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/package.html	2006-06-09 02:17:28 UTC (rev 4688)
@@ -0,0 +1,3 @@
+<body>
+	This is the engine that works off binary RuleBases, you will mostly use WorkingMemory, RuleBase and RuleBaseFactory
+</body>
\ No newline at end of file


Property changes on: labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/package.html
___________________________________________________________________
Name: svn:eol-style
   + native

Added: labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/rule/package.html
===================================================================
--- labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/rule/package.html	2006-06-08 22:05:22 UTC (rev 4687)
+++ labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/rule/package.html	2006-06-09 02:17:28 UTC (rev 4688)
@@ -0,0 +1,3 @@
+<body>
+	Contains the binary representations of rule constructs, like Package (which the compiler produces), Rule, and Conditional Elements.
+</body>
\ No newline at end of file


Property changes on: labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/rule/package.html
___________________________________________________________________
Name: svn:eol-style
   + native

Added: labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/visualize/package.html
===================================================================
--- labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/visualize/package.html	2006-06-08 22:05:22 UTC (rev 4687)
+++ labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/visualize/package.html	2006-06-09 02:17:28 UTC (rev 4688)
@@ -0,0 +1,3 @@
+<body>
+	Some visual utilities for viewing RETE networks (can also use the plug in for this)
+</body>
\ No newline at end of file


Property changes on: labs/jbossrules/trunk/drools-core/src/main/resources/org/drools/visualize/package.html
___________________________________________________________________
Name: svn:eol-style
   + native

Added: labs/jbossrules/trunk/drools-core/src/main/resources/overview.html
===================================================================
--- labs/jbossrules/trunk/drools-core/src/main/resources/overview.html	2006-06-08 22:05:22 UTC (rev 4687)
+++ labs/jbossrules/trunk/drools-core/src/main/resources/overview.html	2006-06-09 02:17:28 UTC (rev 4688)
@@ -0,0 +1,22 @@
+<body>
+
+<h2>Drools API</h2>
+<P/>
+The documentation concentrates upon the following key interfaces:
+<li><tt>org.drools.WorkingMemory</tt></li>
+<li><tt>org.drools.RuleBase</tt></li>
+<li><tt>org.drools.RuleBaseFactory</tt></li>
+<li><tt>org.drools.compiler.PackageBuilder</tt></li>
+<li><tt>org.drools.compiler.RuleBaseLoader</tt></li>
+<li><tt>org.drools.rule.Package</tt></li>
+
+These interfaces are fully intended to be exposed to application code.
+Gernally speaking, PackageBuilder would be used to assemble binary rule Packages, which are what is used by the 
+core engine (RuleBase, WorkingMemory).<br>
+
+<br>
+The other utility classes are optional, and you may or may not need to use them based on your specific needs.
+<br>
+The Internal APIs are not intended for "normal" application code use, but from time to time, advanced uses may need to refer to or use this API directly.
+
+</body>
\ No newline at end of file


Property changes on: labs/jbossrules/trunk/drools-core/src/main/resources/overview.html
___________________________________________________________________
Name: svn:eol-style
   + native

Added: labs/jbossrules/trunk/drools-decisiontables/src/main/resources/org/drools/decisiontable/package.html
===================================================================
--- labs/jbossrules/trunk/drools-decisiontables/src/main/resources/org/drools/decisiontable/package.html	2006-06-08 22:05:22 UTC (rev 4687)
+++ labs/jbossrules/trunk/drools-decisiontables/src/main/resources/org/drools/decisiontable/package.html	2006-06-09 02:17:28 UTC (rev 4688)
@@ -0,0 +1,3 @@
+<body>
+	This it a utility for using spreadsheets to manage rules. Use SpreasheetCompiler.
+</body>
\ No newline at end of file


Property changes on: labs/jbossrules/trunk/drools-decisiontables/src/main/resources/org/drools/decisiontable/package.html
___________________________________________________________________
Name: svn:eol-style
   + native