Function

Summary

Generates statistics about code coverage.

Package

hcl

Signature

code-coverage-data-generate-statistics &key code-coverage-data sort => result

Arguments

code-coverage-data

A code-coverage-data object.

sort

A generalized boolean.

Values

result

A vector of code-coverage-file-stats objects.

Description

The function code-coverage-data-generate-statistics generates statistics about code coverage.

code-coverage-data, if supplied, must be a code-coverage-data object, otherwise the internal code-coverage-data object is used. For each file in the data, code-coverage-data-generate-statistics generates a code-coverage-file-stats object. It returns a vector of these code-coverage-file-stats objects.

If the argument sort is non-nil (the default), the vector is sorted by the cl:file-namestring of the source file.

Notes

1. The stats objects do not change after code-coverage-data-generate-statistics returns, even if the data that was used is the internal one.
2. The statistics are only coverage, that is they treat the counters as binary zero/non-zero values. That includes negative counters (which may occur if the supplied data is a result of subtraction), which counted as "Covered".
3. The stats objects can be accessed by the code-coverage-file-stats readers.

See also

code-coverage-data
code-coverage-file-stats