elixir_sense v1.0.0 ElixirSense.Core.Introspection

A collection of functions to introspect/format docs, specs, types and callbacks.

Based on: https://github.com/elixir-lang/elixir/blob/c983b3db6936ce869f2668b9465a50007ffb9896/lib/iex/lib/iex/introspection.ex https://github.com/elixir-lang/ex_doc/blob/82463a56053b29a406fd271e9e2e2f05e87d6248/lib/ex_doc/retriever.ex

Summary

Types

docs()
docs() :: mod_docs | fun_docs
fun_docs()
fun_docs() :: %{docs: markdown, types: markdown}
markdown()
markdown() :: String.t
mod_docs()
mod_docs() :: %{docs: markdown, types: markdown, callbacks: markdown}
mod_fun()
mod_fun() :: {mod :: module | nil, fun :: atom | nil}

Functions

actual_mod_fun(mod_fun, imports, aliases, current_module)
all_modules()
define_callback?(mod, fun, arity)
extract_fun_args_and_desc(arg1)
extract_summary_from_docs(doc)
format_spec_ast(spec_ast)
format_spec_ast_single_line(spec_ast)
get_all_docs(arg)
get_all_docs(mod_fun) :: docs
get_callback_ast(module, callback, arity)
get_callbacks_md(mod)
get_callbacks_with_docs(mod)
get_docs_md(mod)
get_func_docs_md(mod, fun)
get_module_docs_summary(module)
get_module_specs(module)
get_module_subtype(module)
get_returns_from_callback(module, func, arity)
get_signatures(mod, fun, code_docs \\ nil)
get_spec(module, function, arity)
get_spec_text(mod, fun, arity)
get_types_md(mod)
get_types_with_docs(module)
module_functions_info(module)
module_to_string(module)
param_to_var(arg)
split_mod_fun_call(call)
split_mod_quoted_fun_call(quoted)