Module concuerror

Description
Data Types
Function Index
Function Details

Concuerror's main module.

Description

Concuerror's main module

Contains the entry points for invoking Concuerror, either directly from the command-line or from an Erlang program.

For general documentation go to the Overview page.

Data Types

analysis_result()

analysis_result() = ok | error | fail

Meaning of Concuerror's analysis results, as returned from concuerror:run/1 (the corresponding exit status returned by concuerror:main/1 is given in parenthesis):

ok (exit status: 0): the analysis terminated and found no errors
error (exit status: 1): the analysis terminated and found errors (see the output option)
fail (exit status: 2): the analysis failed and it might have found errors or not

Function Index

main/1	Command-line entry point.
run/1	Erlang entry point.
version/0	Returns a string representation of Concuerror's version.

Function Details

main/1

main(Args::[string()]) -> no_return()

Command-line entry point.

This function can be used to invoke Concuerror from the command-line.

It accepts a list of strings as argument. This list is processed by concuerror_options:parse_cl/1 and the result is passed to concuerror:run/1.

When concuerror:run/1 returns, the Erlang VM will terminate, with an exit value corresponding to the analysis_result().

run/1

run(Options::concuerror_options:options()) -> analysis_result()

Erlang entry point.

This function can be used to invoke Concuerror from an Erlang program. This is the recommended way to invoke Concuerror when you use it as part of a test suite.

This function accepts a proplists list as argument. The supported properties are specified at concuerror_options.

The meaning of the return values is explained at analysis_result().

version/0

version() -> string()

Returns a string representation of Concuerror's version.

Generated by EDoc