Packages

doctor

0.10.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
doctor lib docs.ex
Raw

lib/docs.ex 

defmodule Doctor.Docs do
  @moduledoc """
  This module defines a struct which houses all the
  documentation data for module functions.
  """
  alias __MODULE__
  defstruct ~w(kind name arity doc)a
  @doc """
  Build the Docs struct from the results of Code.fetch_docs/0
  """
  def build({{kind, name, arity}, _annotation, _signature, doc, _metadata}) do
    %Docs{
      kind: kind,
      name: name,
      arity: arity,
      doc: doc
    }
  end
end