Class yii\apidoc\helpers\ApiMarkdownLaTeX

Inheritanceyii\apidoc\helpers\ApiMarkdownLaTeX » cebe\markdown\latex\GithubMarkdown
Uses Traitsyii\apidoc\helpers\ApiMarkdownTrait
Available since version2.0
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/helpers/ApiMarkdownLaTeX.php

A Markdown helper with support for class reference links.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$renderer yii\apidoc\renderers\BaseRenderer yii\apidoc\helpers\ApiMarkdownLaTeX

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$renderingContext yii\apidoc\helpers\ApiMarkdownLaTeX

Public Methods

Hide inherited methods

MethodDescriptionDefined By
process() Converts markdown into HTML yii\apidoc\helpers\ApiMarkdownLaTeX

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
parseApiLinks() yii\apidoc\helpers\ApiMarkdownTrait
renderApiLink() yii\apidoc\helpers\ApiMarkdownLaTeX
renderBrokenApiLink() yii\apidoc\helpers\ApiMarkdownLaTeX

Property Details

$renderer public property
yii\apidoc\renderers\BaseRenderer $renderer = null
$renderingContext protected property
$renderingContext = null

Method Details

process() public method

Converts markdown into HTML

string process( $content, $context = null, $paragraph = false )
$content string
$context yii\apidoc\models\TypeDoc
$paragraph boolean
renderApiLink() protected method

void renderApiLink( $block )
$block
renderBrokenApiLink() protected method

void renderBrokenApiLink( $block )
$block