BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
PHP_CodeSniffer\Generators Namespace Reference

Classes

class  Generator
 
class  HTML
 
class  Markdown
 
class  Text
 

Detailed Description

The base class for all PHP_CodeSniffer documentation generators.

Documentation generators are used to print documentation about code sniffs in a standard.

Author
Greg Sherwood gsher.nosp@m.wood.nosp@m.@squi.nosp@m.z.ne.nosp@m.t

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
Greg Sherwood gsher.nosp@m.wood.nosp@m.@squi.nosp@m.z.ne.nosp@m.t

A doc generator that outputs documentation in Markdown format.

Author
Stefano Kowalke blued.nosp@m.uck@.nosp@m.gmx.n.nosp@m.et

A doc generator that outputs text-based documentation.

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

Author
Greg Sherwood gsher.nosp@m.wood.nosp@m.@squi.nosp@m.z.ne.nosp@m.t