ViolationFormat
extends
ViolationReporter
in
A format to report the problems found in the documentation source in, in addition to the log.
Register an implementation with the tag "phpdoc.guides.violation_format" and the name of the format as "format" attribute. When that name is the "violation-format" setting, it receives every violation during the run.
Table of Contents
Methods
- finish() : void
- Called once at the end of the run, to write the collected violations wherever this format needs them, like the output of the command, a file or the API of a code review tool.
- report() : void
Methods
finish()
Called once at the end of the run, to write the collected violations wherever this format needs them, like the output of the command, a file or the API of a code review tool.
public
finish(OutputInterface $output) : void
Parameters
- $output : OutputInterface
report()
public
report(Violation $violation) : void
Parameters
- $violation : Violation