Validation
Table of Contents
Interfaces
- ViolationReporter
- Reports the violations found in the documentation source, each implementation in its own way.
Classes
- CompositeViolationReporter
- Passes each violation on to all the given reporters, for example to log it and to annotate a pull request.
- LoggingViolationReporter
- Passes each violation on to a logger right away, with the same message and context as before violations existed.
- NullViolationReporter
- Ignores all violations, for when nobody is interested in them.
- Violation
- A problem in the documentation source, like markup that is ignored or a directive used incorrectly.
Traits
- ReportsViolations
- For classes that took a logger before violations existed, and now accept a ViolationReporter in its place.
Enums
- Severity
- How serious a violation is, independent of how it is reported.