summaryrefslogtreecommitdiff
path: root/buildscripts/PhpDocumentor/phpDocumentor/Converters/HTML/frames/templates/default/templates/method.tpl
blob: 3138a9256003232b12822a42fd3698b6cdce391c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<A NAME='method_detail'></A>
{section name=methods loop=$methods}
<a name="method{$methods[methods].function_name}" id="{$methods[methods].function_name}"><!-- --></a>
<div class="{cycle values="evenrow,oddrow"}">
	
	<div class="method-header">
		<span class="method-title">{if $methods[methods].ifunction_call.constructor}Constructor {elseif $methods[methods].ifunction_call.destructor}Destructor {/if}{$methods[methods].function_name}</span> (line <span class="line-number">{if $methods[methods].slink}{$methods[methods].slink}{else}{$methods[methods].line_number}{/if}</span>)
	</div> 
	
	{include file="docblock.tpl" sdesc=$methods[methods].sdesc desc=$methods[methods].desc tags=$methods[methods].tags params=$methods[methods].params function=false}
	
	<div class="method-signature">
		<span class="method-result">{$methods[methods].function_return}</span>
		<span class="method-name">
			{if $methods[methods].ifunction_call.returnsref}&amp;{/if}{$methods[methods].function_name}
		</span>
		{if count($methods[methods].ifunction_call.params)}
			({section name=params loop=$methods[methods].ifunction_call.params}{if $smarty.section.params.iteration != 1}, {/if}{if $methods[methods].ifunction_call.params[params].default}[{/if}<span class="var-type">{$methods[methods].ifunction_call.params[params].type}</span>&nbsp;<span class="var-name">{$methods[methods].ifunction_call.params[params].name}</span>{if $methods[methods].ifunction_call.params[params].default} = <span class="var-default">{$methods[methods].ifunction_call.params[params].default}</span>]{/if}{/section})
		{else}
		()
		{/if}
	</div>
	
	{if $methods[methods].params}
		<ul class="parameters">
		{section name=params loop=$methods[methods].params}
			<li>
				<span class="var-type">{$methods[methods].params[params].datatype}</span>
				<span class="var-name">{$methods[methods].params[params].var}</span>{if $methods[methods].params[params].data}<span class="var-description">: {$methods[methods].params[params].data}</span>{/if}
			</li>
		{/section}
		</ul>
	{/if}
	
	{if $methods[methods].method_overrides}
		<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt>{$methods[methods].method_overrides.link}</dt>
			{if $methods[methods].method_overrides.sdesc}
			<dd>{$methods[methods].method_overrides.sdesc}</dd>
			{/if}
		</dl>
	{/if}
	
	{if $methods[methods].descmethod}
		<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
		{section name=dm loop=$methods[methods].descmethod}
			<li>
				{$methods[methods].descmethod[dm].link}
				{if $methods[methods].descmethod[dm].sdesc}
				: {$methods[methods].descmethod[dm].sdesc}
				{/if}
			</li>
		{/section}
		</ul>
	{/if}
</div>
{/section}