ExDoc.DocNode (ExDoc v0.40.1)

Copy Markdown View Source

Represents a function, macro, callback, or type.

Summary

Types

annotation()

@type annotation() :: String.t()

function_default()

@type function_default() :: {name :: atom(), arity :: non_neg_integer()}

spec_ast()

@type spec_ast() :: term()

t()

@type t() :: %ExDoc.DocNode{
  annotations: [annotation()],
  arity: non_neg_integer(),
  defaults: [function_default()],
  deprecated: String.t() | nil,
  doc: ExDoc.DocAST.t() | nil,
  doc_file: String.t(),
  doc_line: non_neg_integer(),
  group: String.t() | nil,
  id: String.t(),
  name: atom(),
  signature: String.t(),
  source_doc: term() | nil,
  source_specs: [spec_ast()],
  source_url: String.t() | nil,
  specs: [String.t()],
  type: atom()
}