Trait yii\apidoc\helpers\ApiMarkdownTrait

All Classes | Methods
Implemented byyii\apidoc\helpers\ApiMarkdown, yii\apidoc\helpers\ApiMarkdownLaTeX
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/helpers/ApiMarkdownTrait.php

Class ApiMarkdownTrait

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
consumeQuote() Consume lines for a blockquote element yii\apidoc\helpers\ApiMarkdownTrait
parseApiLinks() yii\apidoc\helpers\ApiMarkdownTrait
renderApiLink() Renders API link yii\apidoc\helpers\ApiMarkdownTrait
renderBrokenApiLink() Renders API link that is broken i.e. points nowhere yii\apidoc\helpers\ApiMarkdownTrait
renderQuote() Renders a blockquote yii\apidoc\helpers\ApiMarkdownTrait
translateBlockType() yii\apidoc\helpers\ApiMarkdownTrait

Method Details

consumeQuote() protected method

Consume lines for a blockquote element

protected void consumeQuote ( $lines, $current )
$lines
$current
parseApiLinks() protected method

protected void parseApiLinks ( $text )
$text
renderApiLink() protected method

Renders API link

protected string renderApiLink ( $block )
$block array
renderBrokenApiLink() protected method

Renders API link that is broken i.e. points nowhere

protected string renderBrokenApiLink ( $block )
$block array
renderQuote() protected method

Renders a blockquote

protected void renderQuote ( $block )
$block
translateBlockType() protected abstract method (available since version 2.0.5)

protected abstract void translateBlockType ( $type )
$type