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

Class: Text

Source Location: /PHP_CodeSniffer-3.1.1/src/Generators/Text.php

Class Overview

Generator
   |
   --Text

A doc generator that outputs text-based documentation.


Author(s):

Copyright:

  • 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)

Methods


Inherited Variables

Inherited Methods

Class: Generator

Generator::__construct()
Constructs a doc generator.
current ( )
Generator::generate()
Generates the documentation for a standard.
Generator::getTitle()
Retrieves the title of the sniff from the DOMNode supplied.
key ( )
next ( )
Generator::processSniff()
Process the documentation for a single sniff.
rewind ( )
send ( $value )
throw ( $exception )
valid ( )
__wakeup ( )

Class Details

[line 14]
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 118]

void printCodeComparisonBlock( DOMNode \$node, \DOMNode $node)

Print a code comparison block found in a standard.
  • Access: protected

Parameters:

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

[ Top ]

printTextBlock   [line 72]

void printTextBlock( DOMNode \$node, \DOMNode $node)

Print a text block found in a standard.
  • Access: protected

Parameters:

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

[ Top ]

printTitle   [line 51]

void printTitle( DOMNode \$doc, \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.
DOMNode   \$doc   — 

[ Top ]

processSniff   [line 27]

void processSniff( DOMNode \$doc, \DOMNode $doc)

Process the documentation for a single sniff.
  • Access: public

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   — 

[ Top ]


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