summaryrefslogtreecommitdiff
path: root/buildscripts/apigen/pradosoft/function.latte
diff options
context:
space:
mode:
Diffstat (limited to 'buildscripts/apigen/pradosoft/function.latte')
-rw-r--r--buildscripts/apigen/pradosoft/function.latte45
1 files changed, 18 insertions, 27 deletions
diff --git a/buildscripts/apigen/pradosoft/function.latte b/buildscripts/apigen/pradosoft/function.latte
index 6c4c3238..5797cf17 100644
--- a/buildscripts/apigen/pradosoft/function.latte
+++ b/buildscripts/apigen/pradosoft/function.latte
@@ -1,52 +1,43 @@
-{*
-ApiGen 2.8.0 - API documentation generator for PHP 5.3+
-
-Copyright (c) 2010-2011 David Grudl (http://davidgrudl.com)
-Copyright (c) 2011-2012 Jaroslav Hanslík (https://github.com/kukulich)
-Copyright (c) 2011-2012 Ondřej Nešpor (https://github.com/Andrewsville)
-
-For the full copyright and license information, please view
-the file LICENSE.md that was distributed with this source code.
-*}
{layout '@layout.latte'}
{var $active = 'function'}
-{block #title}{if $function->deprecated}Deprecated {/if}Function {$function->name}{/block}
+{block title}{if $function->deprecated}Deprecated {/if}Function {$function->name}{/block}
-{block #content}
+{block content}
<div id="content" class="function">
<h1 n:class="$function->deprecated ? deprecated">Function {$function->shortName}</h1>
{if $function->valid}
<div class="description" n:if="$template->longDescription($function)">
- {!$function|longDescription}
+ {$function|longDescription|noescape}
</div>
<div class="info">
- {if $function->inNamespace()}<b>Namespace:</b> {!$function->namespaceName|namespaceLinks}<br>{/if}
- {if $function->inPackage()}<b>Package:</b> {!$function->packageName|packageLinks}<br>{/if}
+ {if $function->inNamespace()}<b>Namespace:</b> {$function->namespaceName|namespaceLinks|noescape}<br>{/if}
+ {if $function->inPackage()}<b>Package:</b> {$function->packageName|packageLinks|noescape}<br>{/if}
{foreach $template->annotationSort($template->annotationFilter($function->annotations, array('param', 'return', 'throws'))) as $annotation => $values}
{foreach $values as $value}
<b>{$annotation|annotationBeautify}{if $value}:{/if}</b>
- {!$value|annotation:$annotation:$function}<br>
+ {$value|annotation:$annotation:$function|noescape}<br>
{/foreach}
{/foreach}
- <b>Located at</b> <a n:tag-if="$config->sourceCode" href="{$function|sourceUrl}" title="Go to source code">{$function->fileName|relativePath}</a><br>
+ <b>Located at</b>
+ <a n:tag-if="$config->sourceCode" href="{$function|sourceUrl}" title="Go to source code">
+ {$function->fileName|relativePath}
+ </a><br>
</div>
{var $annotations = $function->annotations}
- <table class="summary" id="parameters" n:if="$function->numberOfParameters">
+ <table class="summary" id="parameters" n:if="count($function->parameters)">
<caption>Parameters summary</caption>
<tr n:foreach="$function->parameters as $parameter" id="${$parameter->name}">
- <td class="name"><code>{!$parameter->typeHint|typeLinks:$function}</code></td>
+ <td class="name"><code>{$parameter->typeHint|typeLinks:$function|noescape}</code></td>
<td class="value"><code>{block|strip}
- <var>{if $parameter->passedByReference}&amp; {/if}${$parameter->name}</var>{if $parameter->defaultValueAvailable} = {!$parameter->defaultValueDefinition|highlightPHP:$function}{elseif $parameter->unlimited},…{/if}
+ <var>{if $parameter->passedByReference}&amp; {/if}${$parameter->name}</var>{if $parameter->defaultValueAvailable} = {$parameter->defaultValueDefinition|highlightPHP:$function|noescape}{elseif $parameter->unlimited},…{/if}
{/block}</code></td>
- <td>
- {ifset $annotations['param'][$parameter->position]}{!$annotations['param'][$parameter->position]|description:$parameter}{/ifset}
- </td>
+ <td>{$parameter->description|description:$function}</td>
</tr>
</table>
@@ -54,10 +45,10 @@ the file LICENSE.md that was distributed with this source code.
<caption>Return value summary</caption>
<tr>
<td class="name"><code>
- {!$annotations['return'][0]|typeLinks:$function}
+ {$annotations['return'][0]|typeLinks:$function|noescape}
</code></td>
<td>
- {!$annotations['return'][0]|description:$function}
+ {$annotations['return'][0]|description:$function|noescape}
</td>
</tr>
</table>
@@ -66,10 +57,10 @@ the file LICENSE.md that was distributed with this source code.
<caption>Thrown exceptions summary</caption>
<tr n:foreach="$annotations['throws'] as $throws">
<td class="name"><code>
- {!$throws|typeLinks:$function}
+ {$throws|typeLinks:$function|noescape}
</code></td>
<td>
- {!$throws|description:$function}
+ {$throws|description:$function|noescape}
</td>
</tr>
</table>