Vibe.DocsHelper (vibe v0.1.0)
View SourceProvides documentation lookup and formatting for modules and functions.
Summary
Functions
Get documentation for a specific function.
Get documentation for a module.
List all modules in the current project.
Functions
Get documentation for a specific function.
Parameters
- module_name: String or atom representing the module name
- function_name: String or atom representing the function name
- arity: Optional integer for arity, if nil returns all arities
Returns
{:ok, docs}- Documentation found{:error, message}- Error finding documentation
Get documentation for a module.
Parameters
- module_name: String or atom representing the module name
Returns
{:ok, docs}- Documentation found{:error, message}- Error finding documentation
List all modules in the current project.
Returns a list of module names as strings.