Markdown
extends Generator
in package
Table of Contents
Properties
- $docFiles : array<string|int, string>
- XML documentation files used to produce the final output.
- $ruleset : Ruleset
- The ruleset used for the run.
Methods
- __construct() : mixed
- Constructs a doc generator.
- generate() : void
- Generates the documentation for a standard.
- getFormattedCodeComparisonBlock() : string
- Format a code comparison block found in a standard.
- getFormattedFooter() : string
- Format the markdown footer.
- getFormattedHeader() : string
- Format the markdown header.
- getFormattedTextBlock() : string
- Format a text block found in a standard.
- getTitle() : string
- Retrieves the title of the sniff from the DOMNode supplied.
- printCodeComparisonBlock() : void
- Print a code comparison block found in a standard.
- printFooter() : void
- Print the markdown footer.
- printHeader() : void
- Print the markdown header.
- printTextBlock() : void
- Print a text block found in a standard.
- processSniff() : void
- Process the documentation for a single sniff.
- formatCodeSample() : string
- Retrieve a code block contents and prepare it for output as HTML.
- formatCodeTitle() : string
- Retrieve a code block title and prepare it for output as HTML.
Properties
$docFiles
XML documentation files used to produce the final output.
public
array<string|int, string>
$docFiles
= []
$ruleset
The ruleset used for the run.
public
Ruleset
$ruleset
= null
Methods
__construct()
Constructs a doc generator.
public
__construct(Ruleset $ruleset) : mixed
Parameters
- $ruleset : Ruleset
-
The ruleset used for the run.
Tags
generate()
Generates the documentation for a standard.
public
generate() : void
Tags
getFormattedCodeComparisonBlock()
Format a code comparison block found in a standard.
protected
getFormattedCodeComparisonBlock(DOMNode $node) : string
Parameters
- $node : DOMNode
-
The DOMNode object for the code comparison block.
Tags
Return values
stringgetFormattedFooter()
Format the markdown footer.
protected
getFormattedFooter() : string
Tags
Return values
stringgetFormattedHeader()
Format the markdown header.
protected
getFormattedHeader() : string
Tags
Return values
stringgetFormattedTextBlock()
Format a text block found in a standard.
protected
getFormattedTextBlock(DOMNode $node) : string
Parameters
- $node : DOMNode
-
The DOMNode object for the text block.
Tags
Return values
stringgetTitle()
Retrieves the title of the sniff from the DOMNode supplied.
protected
getTitle(DOMNode $doc) : string
Parameters
- $doc : DOMNode
-
The DOMNode object for the sniff. It represents the "documentation" tag in the XML standard file.
Return values
stringprintCodeComparisonBlock()
Print a code comparison block found in a standard.
protected
printCodeComparisonBlock(DOMNode $node) : void
Use Markdown::getFormattedCodeComparisonBlock() instead.
Parameters
- $node : DOMNode
-
The DOMNode object for the code comparison block.
Tags
printFooter()
Print the markdown footer.
protected
printFooter() : void
Use Markdown::getFormattedFooter() instead.
Tags
printHeader()
Print the markdown header.
protected
printHeader() : void
Use Markdown::getFormattedHeader() instead.
Tags
printTextBlock()
Print a text block found in a standard.
protected
printTextBlock(DOMNode $node) : void
Use Markdown::getFormattedTextBlock() instead.
Parameters
- $node : DOMNode
-
The DOMNode object for the text block.
Tags
processSniff()
Process the documentation for a single sniff.
protected
processSniff(DOMNode $doc) : void
Parameters
- $doc : DOMNode
-
The DOMNode object for the sniff. It represents the "documentation" tag in the XML standard file.
formatCodeSample()
Retrieve a code block contents and prepare it for output as HTML.
private
formatCodeSample(DOMElement $codeElm) : string
Parameters
- $codeElm : DOMElement
-
The DOMElement object for a code block.
Tags
Return values
stringformatCodeTitle()
Retrieve a code block title and prepare it for output as HTML.
private
formatCodeTitle(DOMElement $codeElm) : string
Parameters
- $codeElm : DOMElement
-
The DOMElement object for a code block.