mix lazy_doc.check (LazyDoc v0.4.1)

## 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.

## Description

It initializes the LazyDoc application, identifies undocumented functions and modules across specified files, and exits with an appropriate status code based on the presence of undocumented elements. Warnings are logged for any undocumented functions and modules encountered during the check.

Summary

Functions

Parameters

  • entry_functions - a list of tuples representing modules and their functions.
  • file - the file where the undocumented functions are being printed.

Description

Iterates through a list of entry functions and prints warnings for modules that contain undocumented functions.

Parameters

  • modules - a list of modules to check for documentation.
  • file - the name of the file where the modules are located.

Description

Checks if the provided modules are documented and logs warnings for any undocumented modules.

Parameters

  • functions - a list of functions to check for documentation.
  • mod - the module name where the functions are defined.
  • file - the filename where the module is located.

Description

Logs warnings for each function in the list that lacks documentation and provides information about the module and file.

Parameters

  • _command_line_args - arguments passed via the command line interface.

Description

Initializes the LazyDoc application, checks for undocumented functions in the specified files, and gracefully exits based on the findings.

Functions

get_undocumented_functions(entry_functions, file)

Parameters

  • entry_functions - a list of tuples representing modules and their functions.
  • file - the file where the undocumented functions are being printed.

Description

Iterates through a list of entry functions and prints warnings for modules that contain undocumented functions.

Returns

a list of modules that have undocumented functions.

get_undocumented_modules(modules, file)

Parameters

  • modules - a list of modules to check for documentation.
  • file - the name of the file where the modules are located.

Description

Checks if the provided modules are documented and logs warnings for any undocumented modules.

Returns

true if there are undocumented modules, false otherwise.

run(command_line_args)

Parameters

  • _command_line_args - arguments passed via the command line interface.

Description

Initializes the LazyDoc application, checks for undocumented functions in the specified files, and gracefully exits based on the findings.

Returns

Exits the application with a status code indicating the presence of undocumented functions (1 if found, 0 if none).