EDoc interface to Erlang specifications and types.

EDoc interface to Erlang specifications and types.


add_data(Entries, Opts, File, Module) -> term()

Create tags a la EDoc for Erlang specifications and types. Exported types and types used (indirectly) by Erlang specs are added to the entries.

docs(Forms, CommentFun) -> term()

Find comments after -type/-opaque declarations. Postcomments "inside" the type are skipped.

dummy_spec(Form) -> term()

Create a #tag{} record where data is a string with the name of the given Erlang spec and an empty list of arguments.

is_tag(X1) -> term()

Return true if Tag is one of the specification and type attribute tags recognized by the Erlang compiler.

spec(Form, Clause) -> term()

Convert an Erlang spec to EDoc representation.

tag(X1) -> term()

Return the kind of the attribute tag.

type(Form, TypeDocs) -> term()

Convert an Erlang type to EDoc representation. TypeDocs is a dict of {Name, Doc}. Note: #t_typedef.name is set to {record, R} for record types.

View Functions