You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by rw...@apache.org on 2003/03/05 18:15:52 UTC
cvs commit: jakarta-commons-sandbox/functor project.xml project.properties
rwaldhoff 2003/03/05 09:15:51
Modified: functor/xdocs index.xml
functor/xdocs/stylesheets project.xml
functor project.xml project.properties
Added: functor/xdocs examples.xml building.xml
Log:
add docs
Revision Changes Path
1.4 +2 -13 jakarta-commons-sandbox/functor/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/functor/xdocs/index.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- index.xml 18 Feb 2003 23:10:38 -0000 1.3
+++ index.xml 5 Mar 2003 17:15:50 -0000 1.4
@@ -31,10 +31,6 @@
by a single, generic member function, and that is the approach taken
here.
</p>
- <p>
- Functors support a number of interesting and powerful design strategies
- [...]
- </p>
</section>
<section name="Overview">
<p>
@@ -56,16 +52,9 @@
two <code>Object</code> arguments.
</p>
<p>
- The
- <code><a href="apidocs/org/apache/commons/functor/adapter/package-summary.html">functor.adapter</a></code>
- package defines classes for adapting one functor interface to another,
- both by signature and return type.
- </p>
- <p>
The
- <code><a href="apidocs/org/apache/commons/functor/core/package-summary.html">functor.core</a></code>
- package (and its <a href="apidocs/overview-summary.html">subpackages</a>)
- defines common functor implementations.
+ <a href="apidocs/index.html">remaining packages</a>
+ provide common functor implementations, adapters and utilities.
</p>
</section>
</body>
1.1 jakarta-commons-sandbox/functor/xdocs/examples.xml
Index: examples.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Examples</title>
<author email="commons-dev@jakarta.apache.org">Jakarta Commons Development Team</author>
<author email="rwaldhoff@apache.org">Rodney Waldhoff</author>
</properties>
<body>
<section name="Examples">
<p>
We've begun to develop some example code that demonstrates the use and
utility of the Functor component.
</p>
<subsection name="Code Reuse Through Composition">
<p>
See the <a href="xref-test/org/apache/commons/functor/example/FlexiMapExample.html#88">FlexiMap</a> example.
</p>
</subsection>
<subsection name="A Functional Quicksort Implementation">
<p>
See the <a href="xref-test/org/apache/commons/functor/example/Quicksort.html#79">Quicksort</a> example.
</p>
</subsection>
</section>
</body>
</document>
1.1 jakarta-commons-sandbox/functor/xdocs/building.xml
Index: building.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Building</title>
<author email="commons-dev@jakarta.apache.org">Jakarta Commons Development Team</author>
<author email="rwaldhoff@apache.org">Rodney Waldhoff</author>
</properties>
<body>
<section name="Building Functor">
<p>
To build Commons Functor from scratch, you must first obtain the source, either
from
<a href="http://jakarta.apache.org/site/cvsindex.html">the CVS server</a>
or from
<a href="http://cvs.apache.org/builds/jakarta-commons/nightly/commons-functor/">a source snapshot</a>.
</p>
<p>
Commons Functor can be built using <a href="http://jakarta.apache.org/turbine/maven/">Maven</a>
or <a href="http://ant.apache.org/">Ant</a>. The <a href="http://jakarta.apache.org/gump">Gump</a>
continuous integration process attempts to build Functor several times a day (against the built-from-scratch
versions of all of it's dependencies), and notifies the development team if it does not succeed.
You can
<a href="http://cvs.apache.org/builds/gump/latest/commons-functor.html">view the status of the latest gump build here</a>.
</p>
<subsection name="Building with Maven">
<ol>
<li>
Install a recent Maven release. Maven is available from
<a href="http://jakarta.apache.org/turbine/maven/">http://jakarta.apache.org/turbine/maven/</a>.
</li>
<li>
With Maven installed, you should be able to run an arbitrary maven goal from the root Commons Functor
directory. Use <code>maven -g</code> for a list of avaiable goals. Commonly used goals include
<code>clean</code>, <code>test</code>, <code>dist</code>, <code>site</code> and <code>clover</code>.
</li>
</ol>
</subsection>
<subsection name="Building with Ant">
<ol>
<li>
Install a recent Ant release. Ant is available from
<a href="http://ant.apache.org/">http://ant.apache.org/</a>.
</li>
<li>
Obtain JUnit 3.8.1 or later. JUnit is available from
<a href="http://junit.org/">http://junit.org/</a>.
Note that JUnit is a needed to compile and run the unit tests,
but is not needed at runtime by clients of Commons Functor.
</li>
<li>
Copy the <code>build.properties.sample</code> file found in the
root Commons Functor directory to a file named <code>build.properties</code>.
Modify this file to provide the location of the <code>junit.jar</code> file.
(Note that Commons Functor supports a "shared" <code>build.properties</code>
file placed either at <code>../build.properties</code> or
<code>../../jakarta-commons/build.properties</code>, or both, relative to the
root Commons Functor directory.)
</li>
<li>
You may run <code>ant -projecthelp</code> to obtain a list of the available Ant targets.
Commonly used targets include <code>clean</code>, <code>test</code>, <code>compile</code>,
<code>dist</code>, and <code>javadoc</code>.
</li>
</ol>
</subsection>
</section>
</body>
</document>
1.4 +9 -1 jakarta-commons-sandbox/functor/xdocs/stylesheets/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/functor/xdocs/stylesheets/project.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- project.xml 28 Jan 2003 20:33:36 -0000 1.3
+++ project.xml 5 Mar 2003 17:15:51 -0000 1.4
@@ -9,10 +9,18 @@
<item name="Jakarta Commons" href="http://jakarta.apache.org/commons/index.html" />
<item name="Commons Functor" href="/index.html" />
</menu>
- <menu name="Project Files">
+ <menu name="Using Functor">
+ <item name="Examples" href="/examples.html"/>
<item name="Downloads" href="/download.html"/>
+ <item name="Snapshots" href="http://cvs.apache.org/builds/jakarta-commons/nightly/commons-functor/"/>
+ </menu>
+ <menu name="Developing Functor">
+ <item name="Building" href="/building.html"/>
+ <item name="Test Coverage" href="/clover/index.html"/>
<item name="Source (Browse)" href="http://cvs.apache.org/viewcvs/jakarta-commons-sandbox/functor/"/>
<item name="Source (CVS)" href="http://jakarta.apache.org/site/cvsindex.html"/>
+ </menu>
+ <menu name="Administrivia">
<item name="License" href="http://cvs.apache.org/viewcvs.cgi/*checkout*/jakarta-commons-sandbox/functor/LICENSE.txt"/>
<item name="Original Proposal" href="http://cvs.apache.org/viewcvs.cgi/*checkout*/jakarta-commons-sandbox/functor/PROPOSAL.html"/>
</menu>
1.3 +2 -2 jakarta-commons-sandbox/functor/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/functor/project.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- project.xml 5 Mar 2003 00:16:39 -0000 1.2
+++ project.xml 5 Mar 2003 17:15:51 -0000 1.3
@@ -7,10 +7,10 @@
<organization>
<name>Apache Software Foundation</name>
- <url>http://jakarta.apache.org</url>
+ <url>http://jakarta.apache.org/commons</url>
<logo>http://jakarta.apache.org/images/jakarta-logo-blue.gif</logo>
</organization>
- <!-- <logo>/images/logo.jpg</logo> -->
+ <!-- <logo>http://jakarta.apache.org/commons/images/logo.jpg</logo> -->
<inceptionYear>2003</inceptionYear>
<package>org.apache.commons.functor</package>
1.3 +1 -0 jakarta-commons-sandbox/functor/project.properties
Index: project.properties
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/functor/project.properties,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- project.properties 18 Feb 2003 23:10:36 -0000 1.2
+++ project.properties 5 Mar 2003 17:15:51 -0000 1.3
@@ -15,3 +15,4 @@
maven.junit.fork=true
clover.excludes=**/Test*.java,**/Base*Test.java,org/apache/commons/functor/example/**
+
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org