Author: ekoneil
Date: Thu Apr 14 10:30:39 2005
New Revision: 161323
URL: http://svn.apache.org/viewcvs?view=rev&rev=161323
Log:
Fix for JIRA 201. Add a useful message to the "usage" target.
Also added descriptions for all of the attributes to the macros.
BB: self
DRT: Beehive pass
Modified:
incubator/beehive/trunk/ant/beehive-tools.xml
Modified: incubator/beehive/trunk/ant/beehive-tools.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/ant/beehive-tools.xml?view=diff&r1=161322&r2=161323
==============================================================================
--- incubator/beehive/trunk/ant/beehive-tools.xml (original)
+++ incubator/beehive/trunk/ant/beehive-tools.xml Thu Apr 14 10:30:39 2005
@@ -29,8 +29,8 @@
</path>
<macrodef name="build-schemas">
- <attribute name="sourceDir"/>
- <attribute name="destDir"/>
+ <attribute name="sourceDir" description="The direcotry containing XML
Schemas or XMLBeans xsdconfig files to build"/>
+ <attribute name="destDir" description="The directory to use for files
generated during an XSD build"/>
<sequential>
<taskdef name="xmlbeanbuild"
classname="org.apache.xmlbeans.impl.tool.XMLBean"
@@ -44,10 +44,10 @@
</macrodef>
<macrodef name="build-controls">
- <attribute name="sourceDir"/>
- <attribute name="destDir"/>
- <attribute name="tmpDir"/>
- <attribute name="classpathRef"/>
+ <attribute name="sourceDir" description="The directory containing
controls to build"/>
+ <attribute name="destDir" description="The directory to use for
generated class files"/>
+ <attribute name="tmpDir" description="The temporary directory used
when building controls"/>
+ <attribute name="classpathRef" description="The classpath to use when
compiling controls. This should be the id of an Ant <path>"/>
<sequential>
<taskdef name="apt"
classname="org.apache.beehive.controls.runtime.generator.AptTask"
@@ -79,10 +79,10 @@
once the compilation of the controls is complete, the page flows
within the web app can be compiled
using the macrodef below. -->
<macrodef name="build-pageflows">
- <attribute name="sourceDir"/>
- <attribute name="destDir"/>
- <attribute name="tmpDir"/>
- <attribute name="classpathRef"/>
+ <attribute name="sourceDir" description="The directory contining Page
Flows to build"/>
+ <attribute name="destDir" description="The directory to use for
generated class files"/>
+ <attribute name="tmpDir" description="The temporary directory used
when building Page Flows"/>
+ <attribute name="classpathRef" description="The classpath to use when
compiling Page Flows. This should be the id of an Ant <path>"/>
<sequential>
<taskdef name="apt"
classname="org.apache.beehive.controls.runtime.generator.AptTask"
@@ -107,5 +107,17 @@
debug="true"/>
</sequential>
</macrodef>
+
+ <target name="usage" description="Print the usage for this Ant build
file.">
+ <echo>
+The beehive-tools.xml file contains Ant macros which can be used
+to build Beehive related source artifacts such as Controls, Page Flows,
+and XML Schemas. For examples of how to use these macros, see the
+Beehive samples.
+
+Note, this build file does not contain targets that can be called
+directly on the command line.
+ </echo>
+ </target>
</project>
