View Source Doctor.ReportUtils (Doctor v0.21.0)
This module provides some utility functions for use in report generators.
Link to this section Summary
Functions
Calculate the overall doc coverage in the codebase
Calculate the ratio of modules which have a moduledoc.
Calculate the overall spec coverage in the codebase
Given a list of module reports, count the total number of documented functions
Given a list of module reports, count the total number of failed modules
Given a list of module reports, count the total number of functions
Given a list of module reports, count the total number of passed modules
Given a list of module reports, count the total number of speced functions
Check whether Doctor overall has passed or failed validation
Check whether Doctor overall has passed or failed validation
Checks whether the provided module passed validation
Link to this section Functions
Calculate the overall doc coverage in the codebase
Calculate the ratio of modules which have a moduledoc.
Calculate the overall spec coverage in the codebase
Given a list of module reports, count the total number of documented functions
Given a list of module reports, count the total number of failed modules
Given a list of module reports, count the total number of functions
Given a list of module reports, count the total number of passed modules
Given a list of module reports, count the total number of speced functions
@spec doctor_report_errors([Doctor.ModuleReport.t()], Doctor.Config.t()) :: [ String.t() ]
Check whether Doctor overall has passed or failed validation
Check whether Doctor overall has passed or failed validation
Checks whether the provided module passed validation