Class: PHP_CodeSniffer_DocGenerators_HTML

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

Class Overview

PHP_CodeSniffer_DocGenerators_Generator
   |
   --PHP_CodeSniffer_DocGenerators_HTML

A doc generator that outputs documentation in one big HTML file.

Author(s):

Marc McIntyre <mmcintyre at squiz.net>
Greg Sherwood <gsherwood at squiz.net>

Version:

Release: 0.7.0

Copyright:

2006 Squiz Pty Ltd (ABN 77 084 670 600)

Methods

Inherited Variables

Inherited Methods

Class: PHP_CodeSniffer_DocGenerators_Generator

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.

Class Details

[line 35]
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.

Author: Marc McIntyre <mmcintyre@squiz.net>
Author: Greg Sherwood <gsherwood@squiz.net>
Version: Release: 0.7.0
Copyright: 2006 Squiz Pty Ltd (ABN 77 084 670 600)
Link: http://pear.php.net/package/PHP_CodeSniffer
License: BSD Licence

[ Top ]

Method Detail

generate [line 45]

void generate(
)

Generates the documentation for a standard.

See: PHP_CodeSniffer_DocGenerators_HTML::processSniff()
Access: public

Overrides PHP_CodeSniffer_DocGenerators_Generator::generate() (Generates the documentation for a standard.)

[ Top ]

printCodeComparisonBlock [line 255]

void printCodeComparisonBlock(
DOMNode
$node)

Print a code comparison block found in a standard.

Access: protected

Parameters:

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

[ Top ]

printFooter [line 184]

void printFooter(
)

Print the footer of the HTML page.

Access: protected

[ Top ]

printHeader [line 75]

void printHeader(
)

Print the header of the HTML page.

Access: protected

[ Top ]

printTextBlock [line 234]

void printTextBlock(
DOMNode
$node)

Print a text block found in a standard.

Access: protected

Parameters:

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

[ Top ]

printToc [line 161]

void printToc(

$standardFiles)

Print the table of contents for the standard.

The TOC is just an unordered list of bookmarks to sniffs on the page.

Access: protected

Parameters:

$standardFiles —

[ Top ]

processSniff [line 210]

void processSniff(
DOMNode
$doc)

Process the documentation for a single sniff.

Access: public

Overrides PHP_CodeSniffer_DocGenerators_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.

[ Top ]