PageRenderTime 17ms CodeModel.GetById 2ms app.highlight 8ms RepoModel.GetById 1ms app.codeStats 0ms

/tags/jsdoc_toolkit-1.3.3/templates/sweet/file.tmpl

http://jsdoc-toolkit.googlecode.com/
Go Template | 247 lines | 226 code | 21 blank | 0 comment | 0 complexity | ae0dd0861d6b8f079ba74ccf5486aff7 MD5 | raw file
  1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
  2"http://www.w3.org/TR/html4/loose.dtd">
  3<html>
  4<head>
  5	<meta http-equiv="content-type" content="text/html; charset=utf-8">
  6	<meta name="generator" content="JsDoc Toolkit 1.0">
  7	<title>JsDoc: {+data.overview.name+}</title>
  8	<link rel=stylesheet href="default.css" type="text/css" media=screen>
  9</head>
 10
 11<body>
 12	<div class="content">
 13		<div class="docs">
 14		
 15			<div class="sectionHead">Library: {+(data.overview.name||data.filename)+}</div>
 16			<div class="section overview">
 17				<div class="itemTitle">
 18					Overview
 19				</div>
 20				<div>	
 21					<div class="desc">{+data.overview.desc+}</div>
 22					<div class="itemTags">
 23					<ul>
 24						<if test="data.source"><li>source: <a href="{+data.source+}">{+data.filename+}</a></li></if>
 25					<for each="tag" in="data.overview.doc.tags">
 26						<li>{+tag.title+}: {+tag.desc+}</li>
 27					</for>
 28					</ul>
 29					</div>
 30				</div>
 31			</div>
 32			
 33			<div class="sectionHead">Constructors</div>
 34			<for each="symbol" in="data.symbols">
 35			<if test="symbol.is('CONSTRUCTOR')">
 36			<div class="section constructor">
 37				<div class="itemTitle">
 38					<a name="{+symbol.alias+}"></a>
 39					<if test="symbol.memberof">
 40						<i><a href="#{+symbol.memberof+}" class="type">{+symbol.memberof+}.</a></i>{+symbol.name+}({+symbol.signature()+})
 41					</if>
 42					<if test="!symbol.memberof">
 43					{+symbol.alias+}(<span class="signature">{+symbol.signature()+}</span>)
 44					</if>
 45				</div>
 46				
 47				<if test="symbol.desc != 'undocumented'">
 48					<div class="desc">{+symbol.desc+}</div>
 49				</if>
 50				
 51				<for each="example" in="symbol.doc.getTag('example')">
 52					<pre class="code">{+example.desc+}</pre>
 53				</for>
 54				
 55				<if test="symbol.params.length">
 56				<div class="detailHead">parameters</div>
 57				<table class="params">
 58				<for each="param" in="symbol.params">
 59					<tr>
 60						<td class="type">
 61							{+param.type+}
 62						</td>
 63						<td>
 64							{+param.name+}<if test="param.isOptional"><a title="optional parameter" class="type">?</a></if>
 65						</td>
 66						<td>
 67							{+param.desc+}
 68						</td> 
 69					</tr>
 70				</for>
 71				</table>
 72				</if>
 73				
 74				<if test="symbol.methods.length">
 75				<div class="detailHead">methods</div>
 76				<for each="method" in="symbol.methods">
 77					<ul class="details">
 78						<li><a href="#{+method.alias+}">{+method.name+}</a>({+method.signature()+})</li>
 79					</ul>
 80				</for>
 81				</if>
 82				
 83				<if test="symbol.properties.length">
 84				<div class="detailHead">properties</div>
 85				<for each="property" in="symbol.properties">
 86					<ul class="details">
 87						<li><if test="property.type"><span class="type">{+property.type+}</span> </if><a href="#{+property.alias+}">{+property.name+}</a></li>
 88					</ul>
 89				</for>
 90				</if>
 91				
 92				<if test="symbol.inherits.length || symbol.augments.length">
 93					<div class="detailHead">inherits</div>
 94					<for each="method" in="symbol.getInheritedMethods()">
 95						<div>{+method.name+}(<span class="signature">{+method.signature()+}</span>) from {+method.memberof+}</div>
 96					</for>
 97				</if>
 98				
 99				<if test="symbol.exceptions.length">
100				<div class="detailHead">exceptions</div>
101				<table class="params">
102				<for each="ex" in="symbol.exceptions">
103					<tr>
104						<td class="type">
105							{+ex.type+}
106						</td>
107						<td>
108							{+ex.desc+}
109						</td> 
110					</tr>
111				</for>
112				</table>
113				</if>
114			</div>
115			</if>
116			</for>
117			
118			<div class="sectionHead">Functions</div>
119			<for each="symbol" in="data.symbols">
120			<if test="symbol.is('FUNCTION')">
121			<div class="section function">
122				<div class="itemTitle">
123					<a name="{+symbol.alias+}"></a>
124					<if test="symbol.memberof">
125						<i><a href="#{+symbol.memberof+}" class="type">{+symbol.memberof+}.</a></i>{+symbol.name+}(<span class="signature">{+symbol.signature()+}</span>)
126					</if>
127					<if test="!symbol.memberof">
128					{+symbol.alias+}(<span class="signature">{+symbol.signature()+}</span>)
129					</if>
130				</div>
131				
132				<if test="symbol.desc != 'undocumented'">
133					<div class="desc">{+symbol.desc+}</div>
134				</if>
135				
136				<for each="example" in="symbol.doc.getTag('example')">
137					<pre class="code">{+example.desc+}</pre>
138				</for>
139				
140				<if test="symbol.params.length">
141				<div class="detailHead">parameters</div>
142				<table class="params">
143				<for each="param" in="symbol.params">
144					<tr>
145						<td class="type">
146							{+param.type+}
147						</td>
148						<td>
149							{+param.name+}<if test="param.isOptional"><a title="optional parameter" class="type">?</a></if>
150						</td>
151						<td>
152							{+param.desc+}
153						</td> 
154					</tr>
155				</for>
156				</table>
157				</if>
158				
159				<if test="symbol.returns.length">
160				<div class="detailHead">returns</div>
161				<table class="params">
162				<for each="ret" in="symbol.returns">
163					<tr>
164						<td class="type">
165							{+ret.type+}
166						</td>
167						<td>
168							{+ret.desc+}
169						</td> 
170					</tr>
171				</for>
172				</table>
173				</if>
174				
175				<if test="symbol.exceptions.length">
176				<div class="detailHead">exceptions</div>
177				<table class="params">
178				<for each="ex" in="symbol.exceptions">
179					<tr>
180						<td class="type">
181							{+ex.type+}
182						</td>
183						<td>
184							{+ex.desc+}
185						</td> 
186					</tr>
187				</for>
188				</table>
189				</if>
190			</div>
191			</if>
192			</for>
193			
194			<div class="sectionHead">Objects</div>
195			<for each="symbol" in="data.symbols">
196			<if test="symbol.is('OBJECT')">
197			<div class="section object">
198				<div class="itemTitle">
199					<a name="{+symbol.alias+}"></a>
200					<if test="symbol.type">
201					<span class="type">{+symbol.type+}</span>
202					</if>
203					<if test="symbol.memberof">
204						<i><a href="#{+symbol.memberof+}" class="type">{+symbol.memberof+}.</a></i>{+symbol.name+}
205					</if>
206					<if test="!symbol.memberof">
207						{+symbol.alias+}
208					</if>
209				</div>
210				
211				<if test="symbol.desc != 'undocumented'">
212					<div class="desc">{+symbol.desc+}</div>
213				</if>
214				
215				<for each="example" in="symbol.doc.getTag('example')">
216					<pre class="code">{+example.desc+}</pre>
217				</for>
218				
219				<if test="symbol.properties.length">
220				<div class="detailHead">properties</div>
221				<table class="params">
222				<for each="property" in="symbol.properties">
223					<tr>
224						<td class="type">
225							{+property.type+}
226						</td>
227						<td>
228							{+property.name+}
229						</td>
230						<td>
231							{+property.desc+}
232						</td> 
233					</tr>
234				</for>
235				</table>
236				</if>
237			</div>
238			</if>
239			
240			</for>
241		</div>
242	</div>
243	<div class="finePrint">
244	Generated by <a href="http://jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> {+JsDoc.VERSION+} on {+new Date().toUTCString()+}.
245	</div>
246</body>
247</html>