PHP_CodeSniffer
[ class tree: PHP_CodeSniffer ] [ index: PHP_CodeSniffer ] [ all elements ]

Class: PHP_CodeSniffer_DocGenerators_Text

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

Class Overview

PHP_CodeSniffer_DocGenerators_Generator
   |
   --PHP_CodeSniffer_DocGenerators_Text

A doc generator that outputs text-based documentation.


Author(s):

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 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 ]


Method Detail

printCodeComparisonBlock   [line 137]

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 ]

printTextBlock   [line 91]

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 ]

printTitle   [line 70]

void printTitle( DOMNode $doc)

Prints the title area for a single sniff.
  • Access: protected

Parameters:

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

[ Top ]

processSniff   [line 46]

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 ]


Documentation generated on Mon, 11 Mar 2019 15:06:36 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.