PHP Class yii\apidoc\helpers\ApiMarkdownLaTeX

Since: 2.0

Author: Carsten Brandt ([email protected])

Inheritance: extends cebe\markdown\latex\GithubMarkdown, use trait yii\apidoc\helpers\ApiMarkdownTrait

Mostrar archivo Open project: yiisoft/yii2-apidoc Class Usage Examples

Public Properties

Property	Type	Description
$renderer	yii\apidoc\renderers\BaseRenderer

Protected Properties

Property	Type	Description
$renderingContext

Public Methods

Method	Description
process ( string $content, yii\apidoc\models\TypeDoc $context = null, boolean $paragraph = false ) : string	Converts markdown into HTML

Protected Methods

Method	Description
renderApiLink ( $block )
renderBrokenApiLink ( $block )
renderQuote ( $block )	Renders a blockquote
translateBlockType ( $type )

Method Details

process() public static method

Converts markdown into HTML

public static process ( string $content, yii\apidoc\models\TypeDoc $context = null, boolean $paragraph = false ) : string
$content	string
$context	yii\apidoc\models\TypeDoc
$paragraph	boolean
return	string

renderApiLink() protected method

protected renderApiLink ( $block )

renderBrokenApiLink() protected method

protected renderBrokenApiLink ( $block )

renderQuote() protected method

Renders a blockquote

protected renderQuote ( $block )

translateBlockType() protected method

Since: 2.0.5

protected translateBlockType ( $type )

Property Details

$renderer public_oe static_oe property

public static BaseRenderer,yii\apidoc\renderers $renderer
return	yii\apidoc\renderers\BaseRenderer

$renderingContext protected_oe property

protected $renderingContext