Class yii\apidoc\helpers\ApiMarkdownLaTeX
| Inheritance | yii\apidoc\helpers\ApiMarkdownLaTeX » cebe\markdown\latex\GithubMarkdown |
|---|---|
| Uses Traits | yii\apidoc\helpers\ApiMarkdownTrait |
| Available since version | 2.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
| Property | Type | Description | Defined By |
|---|---|---|---|
| $renderer | yii\apidoc\renderers\BaseRenderer | yii\apidoc\helpers\ApiMarkdownLaTeX |
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $renderingContext | yii\apidoc\helpers\ApiMarkdownLaTeX |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| process() | Converts markdown into HTML | yii\apidoc\helpers\ApiMarkdownLaTeX |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| consumeQuote() | Consume lines for a blockquote element | yii\apidoc\helpers\ApiMarkdownTrait |
| parseApiLinkForContext() | Attempts to parse an API link for the given context. | yii\apidoc\helpers\ApiMarkdownTrait |
| parseApiLinks() | yii\apidoc\helpers\ApiMarkdownTrait | |
| renderApiLink() | yii\apidoc\helpers\ApiMarkdownLaTeX | |
| renderBrokenApiLink() | yii\apidoc\helpers\ApiMarkdownLaTeX | |
| renderQuote() | Renders a blockquote | yii\apidoc\helpers\ApiMarkdownLaTeX |
| translateBlockType() | yii\apidoc\helpers\ApiMarkdownLaTeX |
Property Details
Method Details
Converts markdown into HTML
| public static string process ( $content, $context = null, $paragraph = false ) | ||
| $content | string | |
| $context | yii\apidoc\models\TypeDoc | |
| $paragraph | boolean | |
| protected void renderApiLink ( $block ) | ||
| $block | ||
| protected void renderBrokenApiLink ( $block ) | ||
| $block | ||
Renders a blockquote
| protected void renderQuote ( $block ) | ||
| $block | ||
| protected void translateBlockType ( $type ) | ||
| $type | ||