Doctor v0.21.0

View Source Doctor.ModuleReport (Doctor v0.21.0)

This module exposes a struct which encapsulates all the results for a doctor report. Whether the module has a moduledoc, what the doc coverage is, the number of author defined functions, and so on.

Link to this section Summary

Types

t()

Functions

build(module_info)

Given a ModuleInformation struct with the necessary fields completed, build the report.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Doctor.ModuleReport{
  doc_coverage: Decimal.t(),
  file: String.t(),
  functions: integer(),
  has_module_doc: boolean(),
  has_struct_type_spec: atom() | boolean(),
  is_protocol_implementation: boolean(),
  missed_docs: integer(),
  missed_specs: integer(),
  module: String.t(),
  properties: Keyword.t(),
  spec_coverage: Decimal.t()
}

Link to this section Functions

Link to this function

build(module_info)

View Source

Given a ModuleInformation struct with the necessary fields completed, build the report.