[line
18]
A doc generator that outputs documentation in one big HTML file.
Output is in one large HTML file and is designed for you to style with your own stylesheet. It contains a table of contents at the top with anchors to each sniff.
generate [line 28]
Generates the documentation for a standard.
- See: processSniff()
- Access: public
Overrides
Generator::generate() (Generates the documentation for a standard.)
printCodeComparisonBlock [line 236]
void printCodeComparisonBlock(
DOMNode
\$node, \DOMNode
$node)
Print a code comparison block found in a standard.
Parameters:
\DOMNode
$node
—
The DOMNode object for the code comparison block.
DOMNode
\$node
—
printFooter [line 165]
Print the footer of the HTML page.
printHeader [line 56]
Print the header of the HTML page.
printTextBlock [line 215]
void printTextBlock(
DOMNode
\$node, \DOMNode
$node)
Print a text block found in a standard.
Parameters:
\DOMNode
$node
—
The DOMNode object for the text block.
DOMNode
\$node
—
printToc [line 142]
Print the table of contents for the standard.
The TOC is just an unordered list of bookmarks to sniffs on the page.
processSniff [line 191]
void processSniff(
DOMNode
\$doc, \DOMNode
$doc)
Process the documentation for a single sniff.
Overrides
Generator::processSniff() (Process the documentation for a single sniff.)
Parameters:
\DOMNode
$doc
—
The DOMNode object for the sniff. It represents the "documentation" tag in the XML standard file.
DOMNode
\$doc
—