edoc_parser

DATA TYPES

yecc_ret() = {error, term()} | {ok, term()}

Functions

parse_spec(S, L) -> term()

EDoc type specification parsing. Parses the content of @spec declarations.

parse_typedef(S, L) -> term()

EDoc type definition parsing. Parses the content of @type declarations.

parse_ref(S, L) -> term()

Parses a reference to a module, package, function, type, or application

parse_see(S, L) -> term()

Parses the content of @see references.

parse_param(S, L) -> term()

Parses the content of @param tags.

parse_throws(S, L) -> term()

EDoc exception specification parsing. Parses the content of @throws declarations.

parse(Tokens::list()) -> yecc_ret()

parse_and_scan(X1::{function() | {atom(), atom()}, [term()]} | {atom(), atom(), [term()]}) -> yecc_ret()

format_error(Message::any()) -> [char() | list()]

View Functions