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 Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$introduction yii\apidoc\helpers\IndexFileAnalyzer
$title yii\apidoc\helpers\IndexFileAnalyzer

Public Methods

Hide inherited methods

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

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
renderHeadline() yii\apidoc\helpers\IndexFileAnalyzer
renderList() yii\apidoc\helpers\IndexFileAnalyzer
renderParagraph() yii\apidoc\helpers\IndexFileAnalyzer

Property Details

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

Method Details

analyze() public method

Parses text and returns list of chapters got from it

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

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

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

void renderParagraph( $block )
$block