Class: PHP_CodeSniffer_DocGenerators_Text

Source Location: /PHP_CodeSniffer-0.7.0/CodeSniffer/DocGenerators/Text.php

PHP_CodeSniffer_DocGenerators_Generator
   |
   --PHP_CodeSniffer_DocGenerators_Text

A doc generator that outputs text-based documentation.

PHP_CodeSniffer_DocGenerators_Generator::__construct(): Constructs a PHP_CodeSniffer_DocGenerators_Generator object.
PHP_CodeSniffer_DocGenerators_Generator::generate(): Generates the documentation for a standard.
PHP_CodeSniffer_DocGenerators_Generator::getStandard(): Retrieves the name of the standard we are generating docs for.
PHP_CodeSniffer_DocGenerators_Generator::getStandardFiles(): Returns a list of paths to XML standard files for all sniffs in a standard.
PHP_CodeSniffer_DocGenerators_Generator::getTitle(): Retrieves the title of the sniff from the DOMNode supplied.
PHP_CodeSniffer_DocGenerators_Generator::processSniff(): Process the documentation for a single sniff.

[line 33]
A doc generator that outputs text-based documentation.

Output is designed to be displayed in a terminal and is wrapped to 100 characters.

[ Top ]

void printCodeComparisonBlock(
DOMNode
$node)

Print a code comparison block found in a standard.

DOMNode $node — The DOMNode object for the code comparison block.

[ Top ]

void printTextBlock(
DOMNode
$node)

Print a text block found in a standard.

DOMNode $node — The DOMNode object for the text block.

[ Top ]

void printTitle(
DOMNode
$doc)

Prints the title area for a single sniff.

DOMNode $doc — The DOMNode object for the sniff. It represents the "documentation" tag in the XML standard file.

[ Top ]

void processSniff(
DOMNode
$doc)

Process the documentation for a single sniff.

Overrides PHP_CodeSniffer_DocGenerators_Generator::processSniff() (Process the documentation for a single sniff.)

DOMNode $doc — The DOMNode object for the sniff. It represents the "documentation" tag in the XML standard file.

[ Top ]