Vigilance
A simple tool for enforcing code quality metrics on a codebase
 All Classes Namespaces Files Functions Variables Groups
Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 1234]
oC_satisfaction
|\CSatisfactionThe result of a constraint validation
oCClickException
|\CVigilanceExceptionBase Exception to be raised within vigilance
| oCConfigurationParsingErrorRaised when the vigilance configuration file contains errors
| oCQualityViolationsDetectedRaised when vigilance detects quality violations
| oCReportParsingErrorRaised when a quality report cannot be parsed
| \CUnknownSuiteRaised when the user attempts to use a quality suite that has not yet been loaded
\Cobject
 oCConfigurationParserParsers vigilance configuration files based upon an arbitrary set of configuration stanzas
 oCConfigurationStanzaRepresents a single stanza within a vigilance configuration file
 |oCDocumentationStanzaThe documentation configuration stanza
 |oCBaseStanzaThe global configuration stanza
 ||oCFileStanzaThe file filter configuration stanza
 ||\CPackageStanzaThe package filter configuration stanza
 |\CIgnoreStanzaThe ignore filter configuration stanza
 oCConstraintRepresents a coverage constraint that must be enforced
 |oCFileConstraintA Constraint decorator that applies a Constraint to specific files only
 |oCIgnoreFilesA Constraint that causes specified files to be ignored from vigilance entirely
 |oCPackageConstraintA Constraint decorator that applies a Constraint to a specific package only
 |oCBranchCoverageA Constraint that enforces a branch coverage minimum
 |oCComplexityA Constraint that enforces a maximum complexity
 |oCLineCoverageA Constraint that enforces a line coverage minimum
 |\CDocumentationA Constraint that enforces documentation
 oCConstraintSetDetermines which constraints apply to each item under test
 oCConstraintSuiteRelates multiple constraints together into a constraint suite
 oCTestMetricsHolds data about a previous code quality run (test run, linting, etc)
 oCParserAbstract interface for parsing test coverage output
 |oCCoberturaParserA Parser implementation for Cobertura-compatible coverage reports
 |\CDoxygenParserA Parser implementation for Doxygen error reports
 oCAbstractPluginThe external entrypoint for Vigilance plugins
 |oCDefaultThe AbstractPlugin implementation for coverage
 |\CDefaultThe AbstractPlugin implementation for doxygen
 oCQualityItemRepresents a single item from a code quality report
 |oCFileUnderTestRepresents a single file from a test coverage report
 |oCPackageUnderTestRepresents a single package from a test coverage report
 |\CDocumentationErrorRepresents a single documentation error from a Doxygen run
 oCQualityReportRepresents a parsed code quality report
 \CQualitySuiteRepresents a full set of quality metrics that should be enforced upon a codebase