diff -r 0f5e3a7fb6af -r 85df38eb4012 buildframework/helium/doc/antdoclet/html/task.vm --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/buildframework/helium/doc/antdoclet/html/task.vm Tue Apr 27 08:33:08 2010 +0300 @@ -0,0 +1,144 @@ + + +## +## 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()> + + + + + +

<$!taskDoc.getAntCategory() : $taskDoc.getAntName()>

+ +

Description

+
+ $taskDoc.getComment() +
+ +

Parameters

+ + + + + + + + + +#foreach ($attr in $taskDoc.attributes ) + + + + + + + + + + +#end +
AttributeDescriptionTypeRequired?
$attr + $taskDoc.getAttributeComment($attr) + + $taskDoc.getAttributeType($attr) + + + #if( $taskDoc.getAttributeRequired($attr) ) + Yes $taskDoc.getAttributeRequired($attr) + #elseif ( $taskDoc.getAttributeNotRequired($attr) ) + No $taskDoc.getAttributeNotRequired($attr) + #else ? + #end +
+ +

Parameters accepted as 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 + +#foreach ($element in $taskDoc.getNestedElements()) + + #set($elementDoc = $taskDoc.getElementDoc($element)) + +

+ #### + #### Put a link for those types that are in this javadoc run + #### and have nested elements (since nested-nested elements + #### is the only info we are not showing for each nested element) + #### + #if( $elementDoc.sourceIncluded() && ($elementDoc.getNestedElements().hasMoreElements() || $elementDoc.isTagged())) + + <$element> ... + + #else + <$element> + + #if ( ! $elementDoc.sourceIncluded() ) + (Of type ${elementDoc.getAntName()} ) + #end + #end +

+ + #if($elementDoc.getComment()) + $elementDoc.getComment() + #end + + + + + + + + + + #foreach ($elementAttr in $elementDoc.getAttributes()) + + + + + + + + + + #end +
AttributeDescriptionTypeRequired
$elementAttr +### #if($elementDoc.getAttributeComment($elementAttr)) + $!elementDoc.getAttributeComment($elementAttr) +### #end + + $elementDoc.getAttributeType($elementAttr) + + + #if($elementDoc.getAttributeRequired($elementAttr)) + Yes $elementDoc.getAttributeRequired($elementAttr) + #elseif ( $elementDoc.getAttributeNotRequired($elementAttr) ) + No $elementDoc.getAttributeNotRequired($elementAttr) + #else ? + #end + +
+#end +
+
+
+ + + + +