coverage.h Header

#include <coverage.h>

Types

struct CoverageKind Doc-comment coverage of one kind of public declaration (plan 07 slice E)

Functions

std::vector<CoverageKind> compute_coverage(const std::vector<ClassInfo> & classes, const std::vector<const HeaderInfo *> & headers)
std::string coverage_summary(const CoverageKind & kind)

Function Documentation

std::vector<CoverageKind> compute_coverage(const std::vector<ClassInfo> & classes, const std::vector<const HeaderInfo *> & headers)

Coverage of everything a build documents: every parsed type (nested ones included) with its public functions (destructors excluded; they rarely carry their own docs), public fields, nested enums and aliases; plus the namespace-scope functions, aliases and enums of the given headers. A declaration counts as documented when its comment cleans to non-empty Markdown. Kinds come back in a fixed order, including empty ones.

std::string coverage_summary(const CoverageKind & kind)

One kind's log line body, e.g. "structs: 12 of 13 documented (1 undocumented)"

Appearance
Theme
—