Class: PHP_CodeSniffer_DocGenerators_Markdown

Source Location: /PHP_CodeSniffer-2.7.1/CodeSniffer/DocGenerators/Markdown.php

Class Overview

PHP_CodeSniffer_DocGenerators_Generator
   |
   --PHP_CodeSniffer_DocGenerators_Markdown

A doc generator that outputs documentation in Markdown format.

Author(s):

Stefano Kowalke <blueduck at gmx.net>

Version:

Release: 2.7.1

Copyright:

2014 Arroba IT

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 30]
A doc generator that outputs documentation in Markdown format.

Author: Stefano Kowalke <blueduck@gmx.net>
Version: Release: 2.7.1
Copyright: 2014 Arroba IT
Link: http://pear.php.net/package/PHP_CodeSniffer
License: BSD Licence

[ Top ]

Method Detail

generate [line 40]

void generate(
)

Generates the documentation for a standard.

See: PHP_CodeSniffer_DocGenerators_Markdown::processSniff()
Access: public

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

[ Top ]

printCodeComparisonBlock [line 145]

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

void printFooter(
)

Print the markdown footer.

Access: protected

[ Top ]

printHeader [line 68]

void printHeader(
)

Print the markdown header.

Access: protected

[ Top ]

printTextBlock [line 125]

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 ]

processSniff [line 102]

void processSniff(
DOMNode
$doc)

Process the documentation for a single sniff.

Access: protected

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 ]