check() = undefined_function_calls | undefined_functions | locals_not_used | exports_not_used | deprecated_function_calls | deprecated_functions
config() = #{extra_paths => [file:name_all()], xref_defaults => [xref_default()], dirs => [file:name_all()]}
warning() = #{filename => file:name_all(), line => non_neg_integer(), source => mfa(), target => mfa(), check => check()}
xref_default() = {builtins | recurse | verbose | warnings, boolean()}
check/0 | Runs a list of checks. |
check/1 | |
check/2 | Runs a check on the dirs and with the options provided on Config. |
find_dirs/1 | Returns all dirs under the specified wildcard. |
check() -> [warning()]
Runs a list of checks. To decide which checks to run and what options to use, it reads the xref.config file in the current folder expecting it to be something like a regular config file (i.e. [{app_name, [...]}].). The runner will then read the configuration for the xref application. It must contain two (optional) keys: - checks: the list of checks to perform - config: the configuration to use for all of them
check(Path::file:name_all()) -> [warning()]
Runs a check on the dirs and with the options provided on Config.
find_dirs(Dirs::[file:name()]) -> [file:filename()]
Returns all dirs under the specified wildcard
Generated by EDoc