svn commit: r1516280 - in /commons/sandbox/weaver/trunk/ant/lib/src/site: ./ markdown/ markdown/index.md

[mb...@apache.org]

Author: mbenson
Date: Wed Aug 21 19:58:34 2013
New Revision: 1516280

URL: http://svn.apache.org/r1516280
Log:
document antlib

Added:
    commons/sandbox/weaver/trunk/ant/lib/src/site/
    commons/sandbox/weaver/trunk/ant/lib/src/site/markdown/
    commons/sandbox/weaver/trunk/ant/lib/src/site/markdown/index.md

Added: commons/sandbox/weaver/trunk/ant/lib/src/site/markdown/index.md
URL: http://svn.apache.org/viewvc/commons/sandbox/weaver/trunk/ant/lib/src/site/markdown/index.md?rev=1516280&view=auto
==============================================================================
--- commons/sandbox/weaver/trunk/ant/lib/src/site/markdown/index.md (added)
+++ commons/sandbox/weaver/trunk/ant/lib/src/site/markdown/index.md Wed Aug 21 19:58:34 2013
@@ -0,0 +1,50 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+## Apache Commons Weaver Antlib
+
+Provides an Antlib in the `antlib:org.apache.commons.weaver` namespace,
+consisting of the following tasks:
+
+### clean
+
+Invokes available [Cleaner][cleaner] implementations.
+
+### weave
+
+Invokes available [Weaver][weaver] implementations.
+
+
+Both the **weave** and **clean** tasks are parameterized either by
+nesting or by reference (via the `settingsref` attribute) with a
+custom type:
+
+### settings
+
+ * `target` attribute - specifies the location of the classfiles to weave
+ * `classpath` attribute - path string (incompatible with `classpathref`)
+ * `classpathref` attribute - refid of an Ant **path**
+ (incompatible with `classpath`)
+ * nested `propertyset` - Ant **PropertySet**
+ * nested `properties` - specifies properties using the names and text values
+ of nested elements (looks like Maven POM properties)
+
+
+[cleaner]: ../../apidocs/org/apache/commons/weaver/spi/Cleaner.html
+[weaver]: ../../apidocs/org/apache/commons/weaver/spi/Weaver.html