| 1 |
lars |
1 |
<h2 class="tab">Method Detail</h2>
|
|
|
2 |
<!-- ============ METHOD DETAIL =========== -->
|
|
|
3 |
<strong>Summary:</strong><br />
|
|
|
4 |
<div class="method-summary">
|
|
|
5 |
{section name=methods loop=$methods}
|
|
|
6 |
{if $methods[methods].static}
|
|
|
7 |
<div class="method-definition">
|
|
|
8 |
static {if $methods[methods].function_return}
|
|
|
9 |
<span class="method-result">{$methods[methods].function_return}</span>
|
|
|
10 |
{/if}
|
|
|
11 |
<a href="#{$methods[methods].method_dest}" title="details" class="method-name">{if $methods[methods].ifunction_call.returnsref}&{/if}{$methods[methods].function_name}</a>
|
|
|
12 |
{if count($methods[methods].ifunction_call.params)}
|
|
|
13 |
({section name=params loop=$methods[methods].ifunction_call.params}{if $smarty.section.params.iteration != 1}, {/if}{if $methods[methods].ifunction_call.params[params].hasdefault}[{/if}<span class="var-type">{$methods[methods].ifunction_call.params[params].type}</span> <span class="var-name">{$methods[methods].ifunction_call.params[params].name}</span>{if $methods[methods].ifunction_call.params[params].hasdefault} = <span class="var-default">{$methods[methods].ifunction_call.params[params].default}</span>]{/if}{/section})
|
|
|
14 |
{else}
|
|
|
15 |
()
|
|
|
16 |
{/if}
|
|
|
17 |
</div>
|
|
|
18 |
{/if}
|
|
|
19 |
{/section}
|
|
|
20 |
{section name=methods loop=$methods}
|
|
|
21 |
{if !$methods[methods].static}
|
|
|
22 |
<div class="method-definition">
|
|
|
23 |
{if $methods[methods].function_return}
|
|
|
24 |
<span class="method-result">{$methods[methods].function_return}</span>
|
|
|
25 |
{/if}
|
|
|
26 |
<a href="#{$methods[methods].method_dest}" title="details" class="method-name">{if $methods[methods].ifunction_call.returnsref}&{/if}{$methods[methods].function_name}</a>
|
|
|
27 |
{if count($methods[methods].ifunction_call.params)}
|
|
|
28 |
({section name=params loop=$methods[methods].ifunction_call.params}{if $smarty.section.params.iteration != 1}, {/if}{if $methods[methods].ifunction_call.params[params].hasdefault}[{/if}<span class="var-type">{$methods[methods].ifunction_call.params[params].type}</span> <span class="var-name">{$methods[methods].ifunction_call.params[params].name}</span>{if $methods[methods].ifunction_call.params[params].hasdefault} = <span class="var-default">{$methods[methods].ifunction_call.params[params].default}</span>]{/if}{/section})
|
|
|
29 |
{else}
|
|
|
30 |
()
|
|
|
31 |
{/if}
|
|
|
32 |
</div>
|
|
|
33 |
{/if}
|
|
|
34 |
{/section}
|
|
|
35 |
</div>
|
|
|
36 |
<hr />
|
|
|
37 |
<A NAME='method_detail'></A>
|
|
|
38 |
|
|
|
39 |
|
|
|
40 |
{section name=methods loop=$methods}
|
|
|
41 |
{if $methods[methods].static}
|
|
|
42 |
<a name="{$methods[methods].method_dest}" id="{$methods[methods].method_dest}"><!-- --></a>
|
|
|
43 |
<div style="background='{cycle values="#ffffff,#eeeeee"}'"><h4>
|
|
|
44 |
<img src="{$subdir}media/images/PublicMethod.gif" border="0" /> <strong class="method">Static Method {$methods[methods].function_name}</strong> (line <span class="linenumber">{if $methods[methods].slink}{$methods[methods].slink}{else}{$methods[methods].line_number}{/if}</span>)
|
|
|
45 |
</h4>
|
|
|
46 |
<h4><i>{$methods[methods].function_return}</i> <strong>{if $methods[methods].ifunction_call.returnsref}&{/if}{$methods[methods].function_name}(
|
|
|
47 |
{if count($methods[methods].ifunction_call.params)}
|
|
|
48 |
{section name=params loop=$methods[methods].ifunction_call.params}
|
|
|
49 |
{if $smarty.section.params.iteration != 1}, {/if}
|
|
|
50 |
{if $methods[methods].ifunction_call.params[params].hasdefault}[{/if}{$methods[methods].ifunction_call.params[params].type}
|
|
|
51 |
{$methods[methods].ifunction_call.params[params].name}{if $methods[methods].ifunction_call.params[params].hasdefault} = {$methods[methods].ifunction_call.params[params].default}]{/if}
|
|
|
52 |
{/section}
|
|
|
53 |
{/if})</strong></h4>
|
|
|
54 |
{if $methods[methods].descmethod}
|
|
|
55 |
<p>Overridden in child classes as:<br />
|
|
|
56 |
{section name=dm loop=$methods[methods].descmethod}
|
|
|
57 |
<dl>
|
|
|
58 |
<dt>{$methods[methods].descmethod[dm].link}</dt>
|
|
|
59 |
<dd>{$methods[methods].descmethod[dm].sdesc}</dd>
|
|
|
60 |
</dl>
|
|
|
61 |
{/section}</p>
|
|
|
62 |
{/if}
|
|
|
63 |
|
|
|
64 |
{if $methods[methods].method_overrides}
|
|
|
65 |
<p><strong>Overrides :</strong> {$methods[methods].method_overrides.link} {$methods[methods].method_overrides.sdesc|default:"parent method not documented"}</p>
|
|
|
66 |
{/if}
|
|
|
67 |
{if $methods[methods].method_implements}
|
|
|
68 |
<hr class="separator" />
|
|
|
69 |
<div class="notes">Implementation of:</div>
|
|
|
70 |
{section name=imp loop=$methods[methods].method_implements}
|
|
|
71 |
<dl>
|
|
|
72 |
<dt>{$methods[methods].method_implements[imp].link}</dt>
|
|
|
73 |
{if $methods[methods].method_implements[imp].sdesc}
|
|
|
74 |
<dd>{$methods[methods].method_implements[imp].sdesc}</dd>
|
|
|
75 |
{/if}
|
|
|
76 |
</dl>
|
|
|
77 |
{/section}
|
|
|
78 |
{/if}
|
|
|
79 |
{include file="docblock.tpl" sdesc=$methods[methods].sdesc desc=$methods[methods].desc tags=$methods[methods].tags params=$methods[methods].params function=true}
|
|
|
80 |
</div>
|
|
|
81 |
{/if}
|
|
|
82 |
{/section}
|
|
|
83 |
{section name=methods loop=$methods}
|
|
|
84 |
{if !$methods[methods].static}
|
|
|
85 |
<a name="{$methods[methods].method_dest}" id="{$methods[methods].method_dest}"><!-- --></a>
|
|
|
86 |
<div style="background='{cycle values="#ffffff,#eeeeee"}'"><h4>
|
|
|
87 |
<img src="{$subdir}media/images/{if $methods[methods].ifunction_call.constructor}Constructor{elseif $methods[methods].ifunction_call.destructor}Destructor{else}PublicMethod{/if}.gif" border="0" /> <strong class="method">{if $methods[methods].ifunction_call.constructor}Constructor {elseif $methods[methods].ifunction_call.destructor}Destructor {else}Method {/if}{$methods[methods].function_name}</strong> (line <span class="linenumber">{if $methods[methods].slink}{$methods[methods].slink}{else}{$methods[methods].line_number}{/if}</span>)
|
|
|
88 |
</h4>
|
|
|
89 |
<h4><i>{$methods[methods].function_return}</i> <strong>{if $methods[methods].ifunction_call.returnsref}&{/if}{$methods[methods].function_name}(
|
|
|
90 |
{if count($methods[methods].ifunction_call.params)}
|
|
|
91 |
{section name=params loop=$methods[methods].ifunction_call.params}
|
|
|
92 |
{if $smarty.section.params.iteration != 1}, {/if}
|
|
|
93 |
{if $methods[methods].ifunction_call.params[params].hasdefault}[{/if}{$methods[methods].ifunction_call.params[params].type}
|
|
|
94 |
{$methods[methods].ifunction_call.params[params].name}{if $methods[methods].ifunction_call.params[params].hasdefault} = {$methods[methods].ifunction_call.params[params].default}]{/if}
|
|
|
95 |
{/section}
|
|
|
96 |
{/if})</strong></h4>
|
|
|
97 |
{if $methods[methods].descmethod}
|
|
|
98 |
<p>Overridden in child classes as:<br />
|
|
|
99 |
{section name=dm loop=$methods[methods].descmethod}
|
|
|
100 |
<dl>
|
|
|
101 |
<dt>{$methods[methods].descmethod[dm].link}</dt>
|
|
|
102 |
<dd>{$methods[methods].descmethod[dm].sdesc}</dd>
|
|
|
103 |
</dl>
|
|
|
104 |
{/section}</p>
|
|
|
105 |
{/if}
|
|
|
106 |
|
|
|
107 |
{if $methods[methods].method_overrides}
|
|
|
108 |
<p><strong>Overrides :</strong> {$methods[methods].method_overrides.link} {$methods[methods].method_overrides.sdesc|default:"parent method not documented"}</p>
|
|
|
109 |
{/if}
|
|
|
110 |
{if $methods[methods].method_implements}
|
|
|
111 |
<hr class="separator" />
|
|
|
112 |
<div class="notes">Implementation of:</div>
|
|
|
113 |
{section name=imp loop=$methods[methods].method_implements}
|
|
|
114 |
<dl>
|
|
|
115 |
<dt>{$methods[methods].method_implements[imp].link}</dt>
|
|
|
116 |
{if $methods[methods].method_implements[imp].sdesc}
|
|
|
117 |
<dd>{$methods[methods].method_implements[imp].sdesc}</dd>
|
|
|
118 |
{/if}
|
|
|
119 |
</dl>
|
|
|
120 |
{/section}
|
|
|
121 |
{/if}
|
|
|
122 |
{include file="docblock.tpl" sdesc=$methods[methods].sdesc desc=$methods[methods].desc tags=$methods[methods].tags params=$methods[methods].params function=true}
|
|
|
123 |
</div>
|
|
|
124 |
{/if}
|
|
|
125 |
{/section}
|
|
|
126 |
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage2" ) );</script>
|