Pipeline-friendly helpers for installed BEAM docs and source slices.
Summary
Functions
Returns documented entries for a module or docs result as a plain list.
Finds one function or macro entry by name and arity.
Keeps function and macro entries from a docs result or module.
Finds one documented entry by name and arity.
Loads docs for currently loaded modules, optionally filtered by prefix.
Loads docs for a module.
Loads docs for many modules.
Searches docs entries by module/name/signature/summary/doc text.
Returns source for a module, docs entry, or single-entry result.
Functions
@spec entries(Pi.Docs.Result.t() | module()) :: [Pi.Docs.Entry.t()]
Returns documented entries for a module or docs result as a plain list.
@spec function(Pi.Docs.Result.t() | module(), atom(), non_neg_integer()) :: Pi.Docs.Entry.t() | nil
Finds one function or macro entry by name and arity.
@spec functions(Pi.Docs.Result.t() | module()) :: Pi.Docs.Result.t()
Keeps function and macro entries from a docs result or module.
@spec get(Pi.Docs.Result.t() | module(), atom(), non_neg_integer()) :: Pi.Docs.Entry.t() | nil
Finds one documented entry by name and arity.
@spec loaded(keyword()) :: Pi.Docs.Result.t()
Loads docs for currently loaded modules, optionally filtered by prefix.
@spec module(module()) :: Pi.Docs.Result.t()
Loads docs for a module.
@spec modules([module()]) :: Pi.Docs.Result.t()
Loads docs for many modules.
@spec search(Pi.Docs.Result.t() | module(), String.t()) :: Pi.Docs.Result.t()
Searches docs entries by module/name/signature/summary/doc text.
@spec source( module() | Pi.Docs.Entry.t() | Pi.Docs.Result.t(), keyword() ) :: Pi.Docs.Source.t() | nil
Returns source for a module, docs entry, or single-entry result.