Class yii\apidoc\templates\bootstrap\GuideRenderer

Inheritanceyii\apidoc\templates\bootstrap\GuideRenderer » yii\apidoc\templates\html\GuideRenderer » yii\apidoc\renderers\GuideRenderer » yii\apidoc\renderers\BaseRenderer » yii\base\Component
Uses Traitsyii\apidoc\templates\bootstrap\RendererTrait
Available since version2.0
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/templates/bootstrap/GuideRenderer.php

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
afterMarkdownProcess() Callback that is called after markdown is processed. yii\apidoc\templates\html\GuideRenderer
filterTypes() Returns types of a given class yii\apidoc\templates\bootstrap\RendererTrait
fixMarkdownLinks() Adds guide name to link URLs in markdown yii\apidoc\templates\html\GuideRenderer
generateGuideFileName() Given markdown file name generates resulting html file name yii\apidoc\templates\html\GuideRenderer
generateLink() Generate link markup yii\apidoc\templates\html\GuideRenderer
getTypeCategory() Returns category of TypeDoc yii\apidoc\templates\bootstrap\RendererTrait
loadGuideStructure() Loads guide structure from a set of files yii\apidoc\renderers\GuideRenderer

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
GUIDE_PREFIX 'guide-' Deprecated since 2.0.1 use $guidePrefix instead which allows configuring this options yii\apidoc\renderers\BaseRenderer

Property Details

$layout public property
public $layout '@yii/apidoc/templates/bootstrap/layouts/guide.php'

Method Details

render() public method

Renders a set of files given into target directory.

public void render ( $files, $targetDir )
$files array
$targetDir string