summaryrefslogtreecommitdiff
path: root/src/site/xdoc/antdocs/ConditionalPath.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/site/xdoc/antdocs/ConditionalPath.xml')
-rw-r--r--src/site/xdoc/antdocs/ConditionalPath.xml122
1 files changed, 122 insertions, 0 deletions
diff --git a/src/site/xdoc/antdocs/ConditionalPath.xml b/src/site/xdoc/antdocs/ConditionalPath.xml
new file mode 100644
index 0000000..0ba7346
--- /dev/null
+++ b/src/site/xdoc/antdocs/ConditionalPath.xml
@@ -0,0 +1,122 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+Licensed to the Ant-Contrib Project under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The Ant-Contrib Project 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.
+
+ -->
+<document xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:taskdocs="http://ant-contrib.sf.net/taskdocs">
+<properties>
+<title>conditionalpath</title>
+</properties>
+<body>
+<section name="conditionalpath">
+<subsection name="Description">An Ant Path object augmented with if and unless conditionals</subsection>
+<subsection name="parameters">
+<table>
+<tr>
+<td>
+<b>Attribute</b>
+</td>
+<td>
+<b>Description</b>
+</td>
+<td>
+<b>Type</b>
+</td>
+</tr>
+<tr>
+<td>description</td>
+<td></td>
+<td>String</td>
+</tr>
+<tr>
+<td>if</td>
+<td>Sets the property name for the 'if' condition.
+
+ The path will be ignored unless the property is defined.
+
+ The value of the property is insignificant, but values that would imply
+ misinterpretation ("false", "no") will throw an exception when
+ evaluated.</td>
+<td>String</td>
+</tr>
+<tr>
+<td>location</td>
+<td></td>
+<td>File</td>
+</tr>
+<tr>
+<td>path</td>
+<td></td>
+<td>String</td>
+</tr>
+<tr>
+<td>refid</td>
+<td></td>
+<td>Reference</td>
+</tr>
+<tr>
+<td>unless</td>
+<td>Set the property name for the 'unless' condition.
+
+ If named property is set, the path will be ignored.
+
+ The value of the property is insignificant, but values that would imply
+ misinterpretation ("false", "no") of the behavior will throw an
+ exception when evaluated.</td>
+<td>String</td>
+</tr>
+</table>
+</subsection>
+<subsection name="parameters as nested elements">
+<dl>
+<dt>
+<a href="http://ant.apache.org/manual/using.html#path"></a>
+</dt>
+<dd/>
+<dt>
+<a href="about:blank">dirset</a>
+</dt>
+<dd/>
+<dt>
+<a href="http://ant.apache.org/manual/using.html#path">existing</a>
+</dt>
+<dd/>
+<dt>
+<a href="http://ant.apache.org/manual/using.html#path">extdirs</a>
+</dt>
+<dd/>
+<dt>
+<a href="about:blank">filelist</a>
+</dt>
+<dd/>
+<dt>
+<a href="about:blank">fileset</a>
+</dt>
+<dd/>
+<dt>
+<a href="http://ant.apache.org/manual/using.html#path">path</a>
+</dt>
+<dd/>
+<dt>
+<a href="http://ant.apache.org/manual/using.html#path">pathelement</a>
+</dt>
+<dd/>
+</dl>
+</subsection>
+</section>
+</body>
+</document>