Abstract Class yii\apidoc\renderers\ApiRenderer

Inheritanceyii\apidoc\renderers\ApiRenderer » yii\apidoc\renderers\BaseRenderer » yii\base\Component
Subclassesyii\apidoc\templates\bootstrap\ApiRenderer, yii\apidoc\templates\html\ApiRenderer, yii\apidoc\templates\json\ApiRenderer, yii\apidoc\templates\online\ApiRenderer
Available since version2.0
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/renderers/ApiRenderer.php

Base class for all API documentation renderers

Public Methods

Hide inherited methods

MethodDescriptionDefined By
createSubjectLink() Creates a link to a subject yii\apidoc\renderers\BaseRenderer
createTypeLink() Creates a link to a type (class, interface or trait) yii\apidoc\renderers\BaseRenderer
generateApiUrl() Generate an url to a type in apidocs yii\apidoc\renderers\BaseRenderer
generateGuideUrl() Generate an url to a guide page yii\apidoc\renderers\BaseRenderer
init() yii\apidoc\renderers\BaseRenderer
render() Renders a given yii\apidoc\models\Context. yii\apidoc\renderers\ApiRenderer

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
generateLink() Generate link markup yii\apidoc\renderers\BaseRenderer

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

Method Details

render() public abstract method

Renders a given yii\apidoc\models\Context.

public abstract void render ( $context, $targetDir )
$context yii\apidoc\models\Context

The api documentation context to render.

$targetDir