|
587
|
1 |
<?xml version="1.0" encoding="utf-8"?>
|
|
|
2 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
3 |
##
|
|
|
4 |
## This is a Velocity template for generating an HTML
|
|
|
5 |
## document describing an Ant Task/Type
|
|
|
6 |
##
|
|
|
7 |
## Objects expected in context:
|
|
|
8 |
##
|
|
|
9 |
## $taskDoc - Describes an Ant Task/Type (of type AntDoc)
|
|
|
10 |
##
|
|
|
11 |
##
|
|
|
12 |
<html>
|
|
|
13 |
<head>
|
|
|
14 |
<title><$taskDoc.getAntName()></title>
|
|
|
15 |
<link rel="stylesheet" type="text/css" href="style.css" />
|
|
|
16 |
</head>
|
|
|
17 |
|
|
|
18 |
<body>
|
|
|
19 |
|
|
|
20 |
<h2><strong><$!taskDoc.getAntCategory() : $taskDoc.getAntName()></strong></h2>
|
|
|
21 |
|
|
|
22 |
<h3><strong>Description</strong></h3>
|
|
|
23 |
<div class="description">
|
|
|
24 |
$taskDoc.getComment()
|
|
|
25 |
</div>
|
|
|
26 |
|
|
|
27 |
<h3><a name="attributes"><strong>Parameters</strong></a></h3>
|
|
|
28 |
|
|
|
29 |
<table>
|
|
|
30 |
<tr>
|
|
|
31 |
<td valign="top" align="left"><b>Attribute</b></td>
|
|
|
32 |
<td valign="top" align="left"><b>Description</b></td>
|
|
|
33 |
<td valign="top" align="left"><b>Type</b></td>
|
|
|
34 |
<td valign="top" align="left"><b>Required?</b></td>
|
|
|
35 |
</tr>
|
|
|
36 |
|
|
|
37 |
#foreach ($attr in $taskDoc.attributes )
|
|
|
38 |
|
|
|
39 |
<tr>
|
|
|
40 |
<td valign="top" align="left">$attr</td>
|
|
|
41 |
|
|
|
42 |
<td valign="top" align="left">
|
|
|
43 |
$taskDoc.getAttributeComment($attr)
|
|
|
44 |
</td>
|
|
|
45 |
|
|
|
46 |
<td valign="top" align="left">
|
|
|
47 |
$taskDoc.getAttributeType($attr)
|
|
|
48 |
</td>
|
|
|
49 |
|
|
|
50 |
<td valign="top" align="left">
|
|
|
51 |
|
|
|
52 |
#if( $taskDoc.getAttributeRequired($attr) )
|
|
|
53 |
<b>Yes</b> $taskDoc.getAttributeRequired($attr)
|
|
|
54 |
#elseif ( $taskDoc.getAttributeNotRequired($attr) )
|
|
|
55 |
<b>No</b> $taskDoc.getAttributeNotRequired($attr)
|
|
|
56 |
#else ?
|
|
|
57 |
#end
|
|
|
58 |
</td>
|
|
|
59 |
</tr>
|
|
|
60 |
#end
|
|
|
61 |
</table>
|
|
|
62 |
|
|
|
63 |
<h3>Parameters accepted as nested elements</h3>
|
|
|
64 |
|
|
|
65 |
<div class="description">
|
|
|
66 |
#if ($taskDoc.isTaskContainer())
|
|
|
67 |
<p>This Task is a Container (it accepts nested Tasks).</p>
|
|
|
68 |
#end
|
|
|
69 |
|
|
|
70 |
#if ($taskDoc.supportsCharacters())
|
|
|
71 |
<p>This Task accepts text in its element body.</p>
|
|
|
72 |
#end
|
|
|
73 |
|
|
|
74 |
#foreach ($element in $taskDoc.getNestedElements())
|
|
|
75 |
|
|
|
76 |
#set($elementDoc = $taskDoc.getElementDoc($element))
|
|
|
77 |
|
|
|
78 |
<h4>
|
|
|
79 |
####
|
|
|
80 |
#### Put a link for those types that are in this javadoc run
|
|
|
81 |
#### and have nested elements (since nested-nested elements
|
|
|
82 |
#### is the only info we are not showing for each nested element)
|
|
|
83 |
####
|
|
|
84 |
#if( $elementDoc.sourceIncluded() && ($elementDoc.getNestedElements().hasMoreElements() || $elementDoc.isTagged()))
|
|
|
85 |
<a href="${elementDoc.getFullClassName()}.html">
|
|
|
86 |
<strong><$element> ...</strong>
|
|
|
87 |
</a>
|
|
|
88 |
#else
|
|
|
89 |
<strong><$element></strong>
|
|
|
90 |
|
|
|
91 |
#if ( ! $elementDoc.sourceIncluded() )
|
|
|
92 |
(Of type ${elementDoc.getAntName()} )
|
|
|
93 |
#end
|
|
|
94 |
#end
|
|
|
95 |
</h4>
|
|
|
96 |
|
|
|
97 |
#if($elementDoc.getComment())
|
|
|
98 |
$elementDoc.getComment()
|
|
|
99 |
#end
|
|
|
100 |
|
|
|
101 |
<table border="0" cellspacing="2" cellpadding="2" width="100%">
|
|
|
102 |
<tr>
|
|
|
103 |
<td valign="top" align="left"><b>Attribute</b></td>
|
|
|
104 |
<td valign="top" align="left"><b>Description</b></td>
|
|
|
105 |
<td valign="top" align="left"><b>Type</b></td>
|
|
|
106 |
<td valign="top" align="left"><b>Required</b></td>
|
|
|
107 |
</tr>
|
|
|
108 |
|
|
|
109 |
#foreach ($elementAttr in $elementDoc.getAttributes())
|
|
|
110 |
|
|
|
111 |
<tr>
|
|
|
112 |
<td>$elementAttr</td>
|
|
|
113 |
<td>
|
|
|
114 |
### #if($elementDoc.getAttributeComment($elementAttr))
|
|
|
115 |
<span>$!elementDoc.getAttributeComment($elementAttr)</span>
|
|
|
116 |
### #end
|
|
|
117 |
</td>
|
|
|
118 |
|
|
|
119 |
<td>
|
|
|
120 |
$elementDoc.getAttributeType($elementAttr)
|
|
|
121 |
</td>
|
|
|
122 |
|
|
|
123 |
<td>
|
|
|
124 |
|
|
|
125 |
#if($elementDoc.getAttributeRequired($elementAttr))
|
|
|
126 |
<b>Yes</b> $elementDoc.getAttributeRequired($elementAttr)
|
|
|
127 |
#elseif ( $elementDoc.getAttributeNotRequired($elementAttr) )
|
|
|
128 |
<b>No</b> $elementDoc.getAttributeNotRequired($elementAttr)
|
|
|
129 |
#else ?
|
|
|
130 |
#end
|
|
|
131 |
|
|
|
132 |
</td>
|
|
|
133 |
</tr>
|
|
|
134 |
#end
|
|
|
135 |
</table>
|
|
|
136 |
#end
|
|
|
137 |
</div>
|
|
|
138 |
<br />
|
|
|
139 |
<hr />
|
|
|
140 |
|
|
|
141 |
<div class="copyright"><em>Generated with <a href="http://antdoclet.neuroning.com">AntDoclet</a></em></div>
|
|
|
142 |
|
|
|
143 |
</body>
|
|
|
144 |
</html>
|