Doctor.Config (Doctor v0.19.0) View Source

This module defines a struct which houses all the configuration data for Doctor.

Link to this section Summary

Functions

Get the configuration defaults as a Config struct

Get the configuration defaults as a string

Get the configuration file name

Link to this section Types

Specs

t() :: %Doctor.Config{
  exception_moduledoc_required: boolean(),
  failed: false,
  ignore_modules: [Regex.t() | String.t()],
  ignore_paths: [Regex.t() | module()],
  min_module_doc_coverage: integer() | float(),
  min_module_spec_coverage: integer() | float(),
  min_overall_doc_coverage: integer() | float(),
  min_overall_spec_coverage: integer() | float(),
  moduledoc_required: boolean(),
  raise: boolean(),
  reporter: module(),
  struct_type_spec_required: boolean(),
  umbrella: boolean()
}

Link to this section Functions

Get the configuration defaults as a Config struct

Link to this function

config_defaults_as_string()

View Source

Get the configuration defaults as a string

Get the configuration file name