API Documentation

SemanticDocumentationArticle

in package

• Application

Class to make Hyde documentation pages smarter by dynamically enriching them with semantic HTML.

Table of Contents

Properties

$body  : string

$footer  : string

$header  : string

$html  : string

$page  : DocumentationPage

Methods

hasTorchlight()  : bool

Does the current document use Torchlight?

make()  : static

Create a new SemanticDocumentationArticle instance, process, and return it.

renderBody()  : HtmlString

renderFooter()  : HtmlString

renderHeader()  : HtmlString

__construct()  : mixed

addDynamicFooterContent()  : static

addDynamicHeaderContent()  : static

canRenderSourceLink()  : bool

Do we satisfy the requirements to render an edit source button in the supplied position?

getTokenizedDataArray()  : array<string|int, mixed>

normalizeBody()  : void

process()  : static

renderSourceLink()  : string

tokenize()  : static