leosutic 2004/03/03 13:20:04
Modified: attributes maven.xml
attributes/xdocs index.xml
Log:
Improved documentation.
Revision Changes Path
1.9 +2 -2 jakarta-commons-sandbox/attributes/maven.xml
Index: maven.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/attributes/maven.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- maven.xml 19 Feb 2004 14:49:12 -0000 1.8
+++ maven.xml 3 Mar 2004 21:20:04 -0000 1.9
@@ -15,7 +15,7 @@
= limitations under the License.
=
-->
-<project default="do-install" xmlns:maven="jelly:maven" xmlns:j="jelly:core"
xmlns:util="jelly:util">
+<project default="attributes:install" xmlns:maven="jelly:maven"
xmlns:j="jelly:core" xmlns:util="jelly:util">
<property file="${basedir}/../build.properties"/>
<property file="${basedir}/../project.properties"/>
@@ -25,7 +25,7 @@
<property name="pom.organization.identifier" value="ASF"/>
<property name="pom.specificationVersion" value="1.0"/>
- <goal name="do-install"
+ <goal name="attributes:install"
description="Build the Jakarta Commons Attributes distribution." >
<maven:reactor
basedir="${basedir}"
1.6 +72 -43 jakarta-commons-sandbox/attributes/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/attributes/xdocs/index.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- index.xml 28 Feb 2004 17:21:11 -0000 1.5
+++ index.xml 3 Mar 2004 21:20:04 -0000 1.6
@@ -17,73 +17,102 @@
=
-->
<document>
-
+
<properties>
<author email="[EMAIL PROTECTED]">Leo Sutic</author>
<title>Jakarta Commons Attributes</title>
</properties>
-
+
<body>
-
+
<section name="Commons Attributes">
<p>
Commons Attributes enables Java programmers to use C#/.Net-style
attributes in their code.
-
- Please see the Javadoc overview for a thorough explanation of the
features
+
+ Please see the <a href="api/index.html">Javadoc overview</a> for a
thorough explanation of the features
and how the project integrates into the development process.
</p>
-<subsection name="Status">
-<p>
- <ul>
- <li>This code is in the commons <i>sandbox</i></li>
- <li>The code is unreleased</li>
- <li>Methods and classes can and will appear and disappear without warning</li>
- <li>If you like the code and want to push it towards a release, join the mailing
list!</li>
- </ul>
-</p>
-</subsection>
+ <subsection name="Status">
+ <p>
+ <ul>
+ <li>This code is in the commons <i>sandbox</i></li>
+ <li>The code is unreleased</li>
+ <li>Methods and classes can and will appear and disappear
without warning</li>
+ <li>If you like the code and want to push it towards a
release, join the mailing list!</li>
+ </ul>
+ </p>
+ </subsection>
</section>
<section name="Download and Install">
- <p>
- You can grab the snapshot jars here:
- </p>
-
- <ul>
- <li>
- <p>Client API: <a
href="http://cvs.apache.org/~leosutic/commons-attributes-api-SNAPSHOT.jar";>commons-attributes-api-SNAPSHOT.jar</a></p>
- </li>
- <li>
- <p>Ant task: <a
href="http://cvs.apache.org/~leosutic/commons-attributes-compiler-SNAPSHOT.jar";>commons-attributes-compiler-SNAPSHOT.jar</a></p>
- </li>
- <li>
- <p>Maven plugin: <a
href="http://cvs.apache.org/~leosutic/commons-attributes-plugin-2.0alpha.jar";>commons-attributes-plugin-2.0alpha.jar</a></p>
- </li>
- </ul>
-
- <p>Drop the client API and the ant task jars into your ${maven
repository}/commons-attributes/jars/ directory, and the
- maven plugin in your ${maven home}/plugins/ directory. You can now
use attributes in your Java code, provided that
- you declare a dependency on the client API:</p>
-
- <source><![CDATA[<dependency>
+
+ <subsection name="Maven Users">
+ <p>
+ Download the following jars:
+ </p>
+
+ <ul>
+ <li>
+ <p>Client API: <a
href="http://cvs.apache.org/~leosutic/commons-attributes-api-SNAPSHOT.jar";>commons-attributes-api-SNAPSHOT.jar</a></p>
+ </li>
+ <li>
+ <p>Ant task: <a
href="http://cvs.apache.org/~leosutic/commons-attributes-compiler-SNAPSHOT.jar";>commons-attributes-compiler-SNAPSHOT.jar</a></p>
+ </li>
+ <li>
+ <p>Maven plugin: <a
href="http://cvs.apache.org/~leosutic/commons-attributes-plugin-2.0alpha.jar";>commons-attributes-plugin-2.0alpha.jar</a></p>
+ </li>
+ </ul>
+
+ <p>Drop the client API and the ant task jars into your ${maven
repository}/commons-attributes/jars/ directory, and the
+ maven plugin in your ${maven home}/plugins/ directory. You
can now use attributes in your Java code, provided that
+ you declare a dependency on the client API:</p>
+
+ <source><![CDATA[<dependency>
<groupId>commons-attributes</groupId>
<artifactId>commons-attributes-api</artifactId>
<version>SNAPSHOT</version>
</dependency>]]></source>
-
+
+ <p>The attribute compiler will act as a precompiler to the
java:compile goal, so you do not need to do
+ anything else.</p>
+ </subsection>
+
+ <subsection name="Ant Users">
+ <p>
+ Download the following files and place them in your
<source>$ANT_HOME/lib</source> directory:
+ </p>
+
+ <ul>
+ <li>
+ <p>Client API: <a
href="http://cvs.apache.org/~leosutic/commons-attributes-api-SNAPSHOT.jar";>commons-attributes-api-SNAPSHOT.jar</a></p>
+ </li>
+ <li>
+ <p>Ant task: <a
href="http://cvs.apache.org/~leosutic/commons-attributes-compiler-SNAPSHOT.jar";>commons-attributes-compiler-SNAPSHOT.jar</a></p>
+ </li>
+ <li>
+ <p>Xjavadoc-1.0: <a
href="http://www.ibiblio.org/maven/xjavadoc/jars/xdoclet-xjavadoc-1.0.jar";>xdoclet-xjavadoc-1.0.jar</a></p>
+ </li>
+ <li>
+ <p>Commons-collections-2.1: <a
href="http://www.ibiblio.org/maven/commons-collections/jars/commons-collections-2.1.jar";>commons-collections-2.1.jar</a></p>
+ </li>
+ </ul>
+
+ <p>
+ See the <a href="api/index.html">Javadoc overview</a> for
examples of how to use Commons-Attributes
+ in your Ant projects.
+ </p>
+ </subsection>
- <p>The attribute compiler will act as a precompiler to the java:compile
goal, so you do not need to do
- anything else.</p>
</section>
<section name="A Quick Sample">
<p>
Commons Attributes enables you to add attributes to your code:
- </p>
+ </p>
- <source><![CDATA[
+ <source><![CDATA[
/**
* Make this attribute inheritable...
*
@@ -201,11 +230,11 @@
<td>Excellent</td>
</tr>
</table>
-
+
</section>
</body>
-
+
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
