Class schmunk42\apidoc\templates\phundament\ApiRenderer

All Classes | Properties | Methods
Inheritanceschmunk42\apidoc\templates\phundament\ApiRenderer » yii\apidoc\templates\html\ApiRenderer
Uses Traitsschmunk42\apidoc\templates\phundament\RendererTrait
Available since version2.0

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$extensions array Official Yii extensions schmunk42\apidoc\templates\phundament\RendererTrait
$indexView schmunk42\apidoc\templates\phundament\ApiRenderer
$layout schmunk42\apidoc\templates\phundament\ApiRenderer

Public Methods

Hide inherited methods

MethodDescriptionDefined By
getNavTypes() Returns nav TypeDocs schmunk42\apidoc\templates\phundament\RendererTrait
getSourceUrl() schmunk42\apidoc\templates\phundament\ApiRenderer
render() schmunk42\apidoc\templates\phundament\ApiRenderer

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
filterTypes() Returns types of a given class schmunk42\apidoc\templates\phundament\RendererTrait
getTypeCategory() Returns category of TypeDoc schmunk42\apidoc\templates\phundament\RendererTrait

Property Details

$indexView public property
public $indexView = '@schmunk42/apidoc/templates/phundament/views/index.php'
$layout public property
public $layout = '@schmunk42/apidoc/templates/phundament/layouts/api.php'

Method Details

getSourceUrl() public method

public void getSourceUrl ( $type, $line = null )
$type
$line
render() public method

public void render ( $context, $targetDir )
$context
$targetDir