-spec format_error(ErrorDescriptor) -> io_lib:chars() when ErrorDescriptor :: error_description().

Takes an ErrorDescriptor and returns a string that describes the error or warning. This function is usually called implicitly when processing an ErrorInfo structure (see section Error Information).

-spec is_guard_test(Expr) -> boolean() when Expr :: erl_parse:abstract_expr().

Tests if Expr is a legal guard test. Expr is an Erlang term representing the abstract form for the expression. erl_parse:parse_exprs(Tokens) can be used to generate a list of Expr.

-spec module(AbsForms) -> {ok, Warnings} | {error, Errors, Warnings}
          when
              AbsForms :: [erl_parse:abstract_form() | erl_parse:form_info()],
              Warnings :: [{SourceFile, [ErrorInfo]}],
              Errors :: [{SourceFile, [ErrorInfo]}],
              SourceFile :: file:filename(),
              ErrorInfo :: error_info().

Equivalent to module/3.

-spec module(AbsForms, FileName) -> {ok, Warnings} | {error, Errors, Warnings}
          when
              AbsForms :: [erl_parse:abstract_form() | erl_parse:form_info()],
              FileName :: atom() | string(),
              Warnings :: [{SourceFile, [ErrorInfo]}],
              Errors :: [{SourceFile, [ErrorInfo]}],
              SourceFile :: file:filename(),
              ErrorInfo :: error_info().

Equivalent to module/3.

-spec module(AbsForms, FileName, CompileOptions) -> {ok, Warnings} | {error, Errors, Warnings}
          when
              AbsForms :: [erl_parse:abstract_form() | erl_parse:form_info()],
              FileName :: atom() | string(),
              CompileOptions :: [compile:option()],
              Warnings :: [{SourceFile, [ErrorInfo]}],
              Errors :: [{SourceFile, [ErrorInfo]}],
              SourceFile :: file:filename(),
              ErrorInfo :: error_info().

Checks all the forms in a module for errors. It returns:

• {ok,Warnings} - There are no errors in the module.

• {error,Errors,Warnings} - There are errors in the module.

As this module is of interest only to the maintainers of the compiler, and to avoid the same description in two places, the elements of Options that control the warnings are only described in the compile module.

AbsForms of a module, which comes from a file that is read through epp, the Erlang preprocessor, can come from many files. This means that any references to errors must include the filename, see the epp module or parser (see the erl_parse module). The returned errors and warnings have the following format:

[{SourceFile,[ErrorInfo]}]

The errors and warnings are listed in the order in which they are encountered in the forms. The errors from one file can therefore be split into different entries in the list of errors.