## ## 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. ## ## ## This is a Velocity template for generating an HTML ## document describing an Ant Task/Type ## ## Objects expected in context: ## ## $taskDoc - Describes an Ant Task/Type (of type AntDoc) ## ## $taskDoc.getAntName()

#if ($taskDoc.getAnyCategory().length() > 0) $!taskDoc.getAntCategory() : #end $taskDoc.getAntName()

Description

Java type: $taskDoc.getFullClassName()

$taskDoc.getComment()

Parameters #foreach ($attr in $taskDoc.attributes ) #if ($velocityCount > 1)
#end

$attr : $taskDoc.getAttributeType($attr) #if ($taskDoc.getAttributeRequired($attr)) (required) #end

$taskDoc.getAttributeComment($attr)
#if ($taskDoc.getAttributeRequired($attr)) $taskDoc.getAttributeRequired($attr) #elseif ($taskDoc.getAttributeNotRequired($attr)) $taskDoc.getAttributeNotRequired($attr) #end

#end
Nested elements #if ($taskDoc.isTaskContainer())

This Task is a Container (it accepts nested Tasks).

#end #if ($taskDoc.supportsCharacters())

This Task accepts text in its element body.

#end #set ($hasExternalRefs = false) #foreach ($element in $taskDoc.getNestedElements()) #set ($elementDoc = $taskDoc.getElementDoc($element)) #if ($elementDoc.getAntName() == 'FileSet') #set ($hasExternalRefs = true)

⇒ Ant's fileset type

#elseif ($elementDoc.getAntName() == 'BasicDataSource') #set ($hasExternalRefs = true)

⇒ $element (an object of type org.apache.commons.dbcp.BasicDataSource)

#end #end #if ($hasExternalRefs)
#end #foreach ($element in $taskDoc.getNestedElements()) #set ($elementDoc = $taskDoc.getElementDoc($element)) #if ($elementDoc.sourceIncluded() && $elementDoc.isTagged())

⇒ $element

#end #end

©2005-2007 Apache Software Foundation