hex logo Hex
Packages Pricing Docs
Log In
Packages Pricing Docs Log In
Packages

doctor

0.6.0
0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

Simple utility to create documentation coverage reports

HexDocs

Current section

Files

Jump to
Readme
23 Versions
1 Dependency
2 Dependants
Files
Activity
Readme 23 Versions 1 Dependency 2 Dependants Files Activity
doctor lib specs.ex
Raw

19 files

  • lib
    • cli
      • cli.ex
    • mix
      • tasks
        • doctor.ex
        • doctor.gen.config.ex
    • reporters
      • full.ex
      • output_utils.ex
      • short.ex
      • summary.ex
    • config.ex
    • docs.ex
    • doctor.ex
    • module_information.ex
    • module_report.ex
    • report_utils.ex
    • reporter.ex
    • specs.ex
  • CHANGELOG.md
  • LICENSE
  • README.md
  • mix.exs

lib/specs.ex

defmodule Doctor.Specs do
@moduledoc """
This module defines a struct which houses all the
documentation data for function specs.
"""
alias __MODULE__
defstruct ~w(name arity)a
@doc """
Build a spec definition for each result from Code.Typespec.fetch_specs/1
"""
def build({{name, arity}, _spec}) do
%Specs{
name: name,
arity: arity
}
end
end

Package files

  • CHANGELOG.md
  • LICENSE
  • README.md
  • lib/cli/cli.ex
  • lib/config.ex
  • lib/docs.ex
  • lib/doctor.ex
  • lib/mix/tasks/doctor.ex
  • lib/mix/tasks/doctor.gen.config.ex
  • lib/module_information.ex
  • lib/module_report.ex
  • lib/report_utils.ex
  • lib/reporter.ex
  • lib/reporters/full.ex
  • lib/reporters/output_utils.ex
  • lib/reporters/short.ex
  • lib/reporters/summary.ex
  • lib/specs.ex
  • mix.exs
hex logo Hex
About Blog Sponsors Status Advisories
Documentation FAQ Specifications Report Client Issue Report General Issue Report Security Issue Contact Support
Code of Conduct Terms of Service Privacy Policy Copyright Policy Dispute Policy

Copyright 2015. Six Colors AB.

Powered by the Erlang VM and the Elixir Programming Language

Search filters

Type any of these into the search box. They can be combined with free text which searches package names and descriptions.

Operator Description Example
name: Match package name. Supports * wildcards and repo/package form name:phx* or name:hexpm/phoenix
description: Full-text search of package descriptions description:auth
depends: Packages depending on a given package. Supports repo:package form depends:ecto or depends:hexpm:ecto
build_tool: Filter by build tool build_tool:mix
updated_after: Packages updated after an ISO8601 datetime updated_after:2025-01-01T00:00:00Z
extra: Match custom metadata (key,value). Nested keys are separated by commas extra:license,MIT

Wrap values in double quotes to include spaces, e.g. name:"my package".