View Source Swagdox.Parser (swagdox v0.1.1)
Parses endpoint docstrings to extract Open API specification data.
Summary
Functions
Extracts the description from a docstring.
Extracts the module docstring from a module.
Extracts the type of configuration and its value from a line in the Open API specification.
Functions
Extracts the description from a docstring.
Examples:
iex> extract_description("Creates a User.")
"Creates a User."
Extracts the module docstring from a module.
Extracts the type of configuration and its value from a line in the Open API specification.
Examples:
iex> parse_definition("@param user(query), map, "User attributes"")
{:param, [{"user", "query"}, "map", "User attributes"]}