mix libdev.check.docs (libdev v0.3.3)

Copy Markdown View Source

Checks that the project's modules and public functions are documented.

The task compiles the project, inspects the documentation metadata of every module of the current application and reports the modules that have at least one documentation problem. Each problem is reported with the source file and line of the definition that misses its documentation.

Modules with @moduledoc false are ignored entirely: their public functions do not count towards the coverage thresholds and are never checked. Functions implementing a behaviour callback are also skipped.

Options

  • --min-module-coverage - the minimum percentage of modules that must have a @moduledoc. Defaults to 100.0.
  • --min-function-coverage - the minimum percentage of public functions that must have a @doc. Defaults to 100.0.