Covfefe v0.0.1 ExDoc.Formatter.HTML.Autolink View Source

Conveniences for autolinking locals, types and more.

Link to this section Summary

Functions

Receives a list of module nodes and autolink all docs and typespecs

Create links to elixir functions defined in the project and Elixir itself

Create links to elixir modules defined in the project and in Elixir itself

Create links to Erlang functions in code blocks

Create links to locally defined functions, specified in locals as a list of fun/arity strings

Creates links to modules and functions defined in the project

Converts the given ast to string while linking the locals given by typespecs as HTML

Link to this section Functions

Link to this function all(modules, extension, extra_lib_dirs) View Source

Receives a list of module nodes and autolink all docs and typespecs.

Link to this function elixir_functions(bin, project_funs, extension \\ ".html", lib_dirs \\ elixir_lib_dirs()) View Source

Create links to elixir functions defined in the project and Elixir itself.

Project functions are specified in project_funs as a list of Module.fun/arity tuples.

Ignores functions which are already wrapped in markdown url syntax, e.g. [Module.test/1](url). If the function doesn’t touch the leading or trailing ], e.g. [my link Module.link/1 is here](url), the Module.fun/arity will get translated to the new href of the function.

Link to this function elixir_modules(bin, modules, module_id \\ nil, extension \\ ".html", lib_dirs \\ elixir_lib_dirs()) View Source

Create links to elixir modules defined in the project and in Elixir itself.

Ignores modules which are already wrapped in markdown url syntax, e.g. [Module](url). If the module name doesn’t touch the leading or trailing ], e.g. [my link Module is here](url), the Module will get translated to the new href of the module.

Create links to Erlang functions in code blocks.

Only links modules that are in the Erlang distribution lib_dir and only link functions in those modules that export a function of the same name and arity.

Ignores functions which are already wrapped in markdown url syntax, e.g. [:module.test/1](url). If the function doesn’t touch the leading or trailing ], e.g. [my link :module.link/1 is here](url), the :module.fun/arity will get translated to the new href of the function.

Create links to locally defined functions, specified in locals as a list of fun/arity strings.

Ignores functions which are already wrapped in markdown url syntax, e.g. [test/1](url). If the function doesn’t touch the leading or trailing ], e.g. [my link link/1 is here](url), the fun/arity will get translated to the new href of the function.

Link to this function project_doc(bin, modules, module_id \\ nil, extension \\ ".html", lib_dirs \\ elixir_lib_dirs()) View Source

Creates links to modules and functions defined in the project.

Link to this function typespec(ast, typespecs, aliases, lib_dirs \\ elixir_lib_dirs()) View Source

Converts the given ast to string while linking the locals given by typespecs as HTML.