Doctor v0.7.0 API Reference
Modules
Doctor is a utility which aims to provide insights into the health of your project's documentation. In addition to be a useful development time tool, Doctor can also be useful during CI/CD and can block merges and releases if the documentation coverage is not up to spec.
Provides the various CLI task entry points and CLI arg parsing.
This module defines a struct which houses all the configuration data for Doctor.
This module defines a struct which houses all the documentation data for module functions.
This module defines a struct which houses all the documentation data for an entire module.
This module exposes a struct which encapsulates all the results for a doctor report. Whether the module has a moduledoc, what the doc coverage is, the number of author defined functions, and so on.
This module provides some utility functions for use in report generators.
Defines the behaviour for a reporter
This reporter generates a full documentation coverage report and lists all the files in the project along with whether they pass or fail.
This module provides convenience functions for use when generating reports
This reporter generates a full documentation coverage report and lists all the files in the project along with whether they pass or fail.
This reporter generates a short summary documentation coverage report and lists overall how many modules passed/failed.
This module defines a struct which houses all the documentation data for function specs.