MarkdownDouble
extends Markdown
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.
- getRealFooter() : string
- Retrieve the _real_ footer of the markdown page.
- printFooter() : void
- [VISIBILITY WIDENING ONLY] Print the footer of the HTML page.
- printHeader() : void
- [VISIBILITY WIDENING ONLY] Print the header of the HTML page.
- printToc() : void
- [VISIBILITY WIDENING ONLY] Print the table of contents for the standard.
- getFormattedCodeComparisonBlock() : string
- Format a code comparison block found in a standard.
- getFormattedFooter() : string
- Format the markdown footer without the date or version nr to make the expectation fixtures stable.
- 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.
- printTextBlock() : void
- Print a text block found in a standard.
- processSniff() : void
- Process the documentation for a single sniff.
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
getRealFooter()
Retrieve the _real_ footer of the markdown page.
public
getRealFooter() : string
Return values
stringprintFooter()
[VISIBILITY WIDENING ONLY] Print the footer of the HTML page.
public
printFooter() : void
printHeader()
[VISIBILITY WIDENING ONLY] Print the header of the HTML page.
public
printHeader() : void
printToc()
[VISIBILITY WIDENING ONLY] Print the table of contents for the standard.
public
printToc() : void
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 without the date or version nr to make the expectation fixtures stable.
protected
getFormattedFooter() : string
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
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.