Class yii\apidoc\helpers\IndexFileAnalyzer

Inheritanceyii\apidoc\helpers\IndexFileAnalyzer » cebe\markdown\Markdown
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/helpers/IndexFileAnalyzer.php

IndexFileAnalyzer analyzes index file with TOC. Typically README.md.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
analyze() Parses text and returns list of chapters got from it yii\apidoc\helpers\IndexFileAnalyzer

Property Details

$introduction public property
public $introduction null
$title public property
public $title null

Method Details

analyze() public method

Parses text and returns list of chapters got from it

public array analyze ( $text )
$text string
renderHeadline() protected method

protected void renderHeadline ( $block )
$block
renderList() protected method

protected void renderList ( $block )
$block
renderParagraph() protected method

protected void renderParagraph ( $block )
$block