Covfefe v0.0.1 ExDoc.Retriever View Source

Functions to extract documentation information from modules.

Link to this section Summary

Functions

Extract documentation from all modules in the specified directory or directories

Extract documentation from all modules in the specified list of files

Extract documentation from all modules in the list modules

Link to this section Functions

Link to this function docs_from_dir(dir, config) View Source
docs_from_dir(Path.t | [Path.t], ExDoc.Config.t) :: [ExDoc.ModuleNode.t]

Extract documentation from all modules in the specified directory or directories.

Link to this function docs_from_files(files, config) View Source
docs_from_files([Path.t], ExDoc.Config.t) :: [ExDoc.ModuleNode.t]

Extract documentation from all modules in the specified list of files

Link to this function docs_from_modules(modules, config) View Source
docs_from_modules([atom], ExDoc.Config.t) :: [ExDoc.ModuleNode.t]

Extract documentation from all modules in the list modules