Validation
Table of Contents
Interfaces
- ViolationFormat
- A format to report the problems found in the documentation source in, in addition to the log.
Classes
- AnnotationDetails
- Where a violation is found and what it says, as code review tools show it on the lines of a change.
- GithubActionsViolationFormat
- Prints the violations as GitHub Actions workflow commands, which GitHub shows as annotations on a pull request.
- GitlabViolationFormat
- Writes the violations to a code quality report, which GitLab shows in a merge request and on the lines of its diff.
- ViolationFormats
- Passes each violation on to the format chosen with the "violation-format" setting, out of all formats registered
with the tag "phpdoc.guides.violation_format".