API Reference LazyDoc v0.5.1

View Source

Modules

Main functionality

The module LazyDoc provides a way to extract and organize documentation from Elixir source files by reading them, parsing their abstract syntax tree (AST), and collecting relevant information about modules, functions, and comments.

Main functionality

The module LazyDoc.Application is responsible for initiating the application process in the LazyDoc system.

Documentation for LazyDoc.

Main functionality

The module LazyDoc.Provider provides a standard interface for making requests to an external service and processing the responses.

Main functionality

The module LazyDoc.Providers.GithubAi provides a way of interacting with the Github AI API for prompt-based communication and response generation.

Mix Tasks

Main functionality

The module Mix.Tasks.LazyDoc provides a Mix task for processing source files to extract and format documentation for Elixir modules and functions.

Main functionality

The module Mix.Tasks.LazyDoc.Check is designed to facilitate the checking of documentation for functions and modules within a codebase using the LazyDoc application.

Main functionality

The module Mix.Tasks.LazyDoc.Clean provides a task for cleaning up documentation in the codebase.