TypEr shows type information for Erlang modules to the user. Additionally, it can annotate the code of files with such type information.
TypEr is used from the command-line. This section provides a brief description of the options. The same information can be obtained by writing the following in a shell:
typer --help
Usage:
typer [--help] [--version] [--plt PLT] [--edoc]
[--show | --show-exported | --annotate | --annotate-inc-files]
[-Ddefine]* [-I include_dir]* [-pa dir]* [-pz dir]*
[-T application]* [-r] file*
* denotes that multiple occurrences of the option are possible.
Options:
Search directories recursively for .erl files below them.
Print type specifications for all functions on stdout. (This is the default behaviour; this option is not really needed.)
Same as
Annotate the specified files with type specifications.
Same as
Print type information as Edoc
Use the specified dialyzer PLT file rather than the default one.
The specified file(s) already contain type specifications and these are to be trusted in order to print specs for the rest of the files. (Multiple files or dirs, separated by spaces, can be specified.)
Pass the defined name(s) to TypEr. (**)
Pass the include_dir to TypEr. (**)
Include
Include
Print the TypEr version and some more information and exit.
** options