From 5cd46e5a0da3841719d0676a06c963c70c5a524c Mon Sep 17 00:00:00 2001 From: Fabio Bas Date: Mon, 9 Nov 2015 01:15:12 +0100 Subject: Created theme for apigen4, wsat doc fixes --- buildscripts/apigen/pradosoft/class.latte | 149 +++++++++++++++--------------- 1 file changed, 76 insertions(+), 73 deletions(-) (limited to 'buildscripts/apigen/pradosoft/class.latte') diff --git a/buildscripts/apigen/pradosoft/class.latte b/buildscripts/apigen/pradosoft/class.latte index 36b3804c..4555d79d 100644 --- a/buildscripts/apigen/pradosoft/class.latte +++ b/buildscripts/apigen/pradosoft/class.latte @@ -1,26 +1,16 @@ -{* -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 = 'class'} -{block #title}{if $class->deprecated}Deprecated {/if}{if $class->interface}Interface{elseif $class->trait}Trait{else}Class{/if} {$class->name}{/block} +{block title}{if $class->deprecated}Deprecated {/if}{if $class->interface}Interface{elseif $class->trait}Trait{else}Class{/if} {$class->name}{/block} -{block #content} +{block content}

{if $class->interface}Interface{elseif $class->trait}Trait{else}Class{/if} {$class->shortName}

{if $class->valid}
- {!$class|longDescription} + {$class|longDescription|noescape}
@@ -35,12 +25,17 @@ the file LICENSE.md that was distributed with this source code. {/foreach}{/if} {var $itemOwnTraits = $item->ownTraits} {if $itemOwnTraits} uses {foreach $itemOwnTraits as $trait} - {$trait->name}{sep}, {/sep} + {if is_string($trait)} + {$trait} (not available) + + {else} + {$trait->name}{sep}, {/sep} + {/} {/foreach}{/if}
- {define #children} + {define children} {foreach $children as $child} {$child->name}{sep}, {/sep} {/foreach} @@ -48,59 +43,65 @@ the file LICENSE.md that was distributed with this source code.

Direct known subclasses

- {include #children, children => $directSubClasses} + {include children, children => $directSubClasses}

Indirect known subclasses

- {include #children, children => $indirectSubClasses} + {include children, children => $indirectSubClasses}

Direct known implementers

- {include #children, children => $directImplementers} + {include children, children => $directImplementers}

Indirect known implementers

- {include #children, children => $indirectImplementers} + {include children, children => $indirectImplementers}

Direct Known Users

- {include #children, children => $directUsers} + {include children, children => $directUsers}

Indirect Known Users

- {include #children, children => $indirectUsers} + {include children, children => $indirectUsers}
{if !$class->interface && !$class->trait && ($class->abstract || $class->final)}{if $class->abstract}Abstract{else}Final{/if}
{/if} {if $class->internal}PHP Extension: {$class->extension->name|firstUpper}
{/if} - {if $class->inNamespace()}Namespace: {!$class->namespaceName|namespaceLinks}
{/if} - {if $class->inPackage()}Package: {!$class->packageName|packageLinks}
{/if} + {if $class->inNamespace()}Namespace: {$class->namespaceName|namespaceLinks|noescape}
{/if} + {if $class->inPackage()}Package: {$class->packageName|packageLinks|noescape}
{/if} {foreach $template->annotationSort($template->annotationFilter($class->annotations)) as $annotation => $values} {foreach $values as $value} {$annotation|annotationBeautify}{if $value}:{/if} - {!$value|annotation:$annotation:$class}
+ {$value|annotation:$annotation:$class|noescape}
{/foreach} {/foreach} - {if $class->internal}Documented at php.net{else}Located at {$class->fileName|relativePath}{/if}
+ {if $class->internal} + Documented at php.net + {else} + Located at {$class->fileName|relativePath} + {/if} +
{var $ownMethods = $class->ownMethods} {var $ownMagicMethods = $class->ownMagicMethods} - {define #method} - + {define method} + {var $annotations = $method->annotations} {if !$class->interface && $method->abstract}abstract{elseif $method->final}final{/if} {if $method->protected}protected{elseif $method->private}private{else}public{/if} {if $method->static}static{/if} - {ifset $annotations['return']}{!$annotations['return'][0]|typeLinks:$method}{/ifset} + + {ifset $annotations['return']}{$annotations['return'][0]|typeLinks:$method|noescape}{/ifset} {if $method->returnsReference()}&{/if} @@ -114,19 +115,19 @@ the file LICENSE.md that was distributed with this source code. {$method->name}( {/if} {foreach $method->parameters as $parameter} - {!$parameter->typeHint|typeLinks:$method} - {if $parameter->passedByReference}& {/if}${$parameter->name}{if $parameter->defaultValueAvailable} = {!$parameter->defaultValueDefinition|highlightPHP:$class}{elseif $parameter->unlimited},…{/if}{sep}, {/sep} + {$parameter->typeHint|typeLinks:$method|noescape} + {if $parameter->passedByReference}& {/if}${$parameter->name}{if $parameter->defaultValueAvailable} = {$parameter->defaultValueDefinition|highlightPHP:$class|noescape}{elseif $parameter->unlimited},…{/if}{sep}, {/sep} {/foreach} ){/block} {if $config->template['options']['elementDetailsCollapsed']}
- {!$method|shortDescription:true} + {$method|shortDescription:true|noescape}
{/if}
- {!$method|longDescription} + {$method|longDescription|noescape} {if !$class->deprecated && $method->deprecated}

Deprecated

@@ -134,7 +135,7 @@ the file LICENSE.md that was distributed with this source code.
{foreach $annotations['deprecated'] as $description} {if $description} - {!$description|annotation:'deprecated':$method}
+ {$description|annotation:'deprecated':$method|noescape}
{/if} {/foreach}
@@ -146,7 +147,7 @@ the file LICENSE.md that was distributed with this source code.
{foreach $method->parameters as $parameter}
${$parameter->name}{if $parameter->unlimited},…{/if}
-
{ifset $annotations['param'][$parameter->position]}{!$annotations['param'][$parameter->position]|annotation:'param':$method}{/ifset}
+
{$parameter->description|description:$method|noescape}
{/foreach}
{/if} @@ -155,7 +156,7 @@ the file LICENSE.md that was distributed with this source code.

Returns

{foreach $annotations['return'] as $description} - {!$description|annotation:'return':$method}
+ {$description|annotation:'return':$method|noescape}{sep}
{/} {/foreach}
{/if} @@ -164,7 +165,7 @@ the file LICENSE.md that was distributed with this source code.

Throws

{foreach $annotations['throws'] as $description} - {!$description|annotation:'throws':$method}
+ {$description|annotation:'throws':$method|noescape}{sep}
{/} {/foreach}
{/ifset} @@ -174,7 +175,7 @@ the file LICENSE.md that was distributed with this source code.
{foreach $descriptions as $description} {if $description} - {!$description|annotation:$annotation:$method}
+ {$description|annotation:$annotation:$method|noescape}
{/if} {/foreach}
@@ -196,10 +197,10 @@ the file LICENSE.md that was distributed with this source code. {/define} - +
{foreach $ownMethods as $method} - {include #method, method => $method} + {include method, method => $method} {/foreach}
Methods summary
@@ -219,16 +220,16 @@ the file LICENSE.md that was distributed with this source code. {foreach $methods as $data} - {$data['method']->originalName}(){if $data['aliases']}(as {foreach $data['aliases'] as $alias}{$alias->name}(){sep}, {/sep}{/foreach}){/if}{sep}, {/sep} + {$data['method']->name}(){if $data['aliases']}(as {foreach $data['aliases'] as $alias}{$alias->name}(){sep}, {/sep}{/foreach}){/if}{sep}, {/sep} {/foreach} - +
{foreach $ownMagicMethods as $method} - {include #method, method => $method} + {include method, method => $method} {/foreach}
Magic methods summary
@@ -257,44 +258,46 @@ the file LICENSE.md that was distributed with this source code. {var $ownConstants = $class->ownConstants} - +
{var $annotations = $constant->annotations} - - + - - + +
Constants summary
{!$constant->typeHint|typeLinks:$constant} + {$constant->typeHint|typeLinks:$constant|noescape} + {if $class->internal} {$constant->name} {else} {$constant->name} {/if} - {!$constant->valueDefinition|highlightValue:$class}
- # + - {if $config->template['options']['elementDetailsCollapsed']} -
- {!$constant|shortDescription:true} +
+ {$constant|shortDescription:true|noescape}
- {/if}
- {!$constant|longDescription} + {$constant|longDescription|noescape} {foreach $template->annotationSort($template->annotationFilter($annotations, array('var'))) as $annotation => $descriptions}

{$annotation|annotationBeautify}

{foreach $descriptions as $description} {if $description} - {!$description|annotation:$annotation:$constant}
+ {$description|annotation:$annotation:$constant|noescape}
{/if} {/foreach}
{/foreach}
-
+
+ # + {$constant->valueDefinition|highlightValue:$class|noescape} +
+
@@ -309,11 +312,11 @@ the file LICENSE.md that was distributed with this source code. - {define #property} + {define property} {if $property->protected}protected{elseif $property->private}private{else}public{/if} {if $property->static}static{/if} {if $property->readOnly}read-only{elseif $property->writeOnly}write-only{/if} - {!$property->typeHint|typeLinks:$property} + {$property->typeHint|typeLinks:$property|noescape} @@ -322,42 +325,42 @@ the file LICENSE.md that was distributed with this source code. {else} ${$property->name} {/if} - - {!$property->defaultValueDefinition|highlightValue:$class} -
- # - {if $config->template['options']['elementDetailsCollapsed']} -
- {!$property|shortDescription:true} +
+ {$property|shortDescription:true|noescape}
- {/if}
- {!$property|longDescription} + {$property|longDescription|noescape} {foreach $template->annotationSort($template->annotationFilter($property->annotations, array('var'))) as $annotation => $descriptions}

{$annotation|annotationBeautify}

{foreach $descriptions as $description} {if $description} - {!$description|annotation:$annotation:$property}
+ {$description|annotation:$annotation:$property|noescape}
{/if} {/foreach}
{/foreach}
-
+ + +
+ # + {$property->defaultValueDefinition|highlightValue:$class|noescape} +
+ {/define} {var $ownProperties = $class->ownProperties} {var $ownMagicProperties = $class->ownMagicProperties} - +
{foreach $ownProperties as $property} - {include #property, property => $property} + {include property, property => $property} {/foreach}
Properties summary
@@ -383,10 +386,10 @@ the file LICENSE.md that was distributed with this source code. - +
{foreach $ownMagicProperties as $property} - {include #property, property => $property} + {include property, property => $property} {/foreach}
Magic properties summary
-- cgit v1.2.3