.TH ct_cover 3erl "common_test 1.13" "Ericsson AB" "Erlang Module Definition"
.SH NAME
ct_cover \- Common Test framework code coverage support module.
  
.SH DESCRIPTION
.LP
\fICommon Test\fR\& framework code coverage support module\&.
.LP
This module exports help functions for performing code coverage analysis\&.
.SH EXPORTS
.LP
.B
add_nodes(Nodes) -> {ok, StartedNodes} | {error, Reason}
.br
.RS
.LP
Types:

.RS 3
Nodes = [atom()]
.br
StartedNodes = [atom()]
.br
Reason = cover_not_running | not_main_node
.br
.RE
.RE
.RS
.LP
Adds nodes to current cover test\&. Notice that this only works if cover support is active\&.
.LP
To have effect, this function is to be called from \fIinit_per_suite/1\fR\& (see \fB\fIcommon_test\fR\&\fR\&) before any tests are performed\&.
.RE

.LP
.B
cross_cover_analyse(Level, Tests) -> ok
.br
.RS
.LP
Types:

.RS 3
Level = overview | details
.br
Tests = [{Tag, Dir}]
.br
Tag = atom()
.br
Dir = string()
.br
.RE
.RE
.RS
.LP
Accumulates cover results over multiple tests\&. See section \fBCross Cover Analysis\fR\& in the Users\&'s Guide\&.
.RE

.LP
.B
remove_nodes(Nodes) -> ok | {error, Reason}
.br
.RS
.LP
Types:

.RS 3
Nodes = [atom()]
.br
Reason = cover_not_running | not_main_node
.br
.RE
.RE
.RS
.LP
Removes nodes from the current cover test\&.
.LP
Call this function to stop cover test on nodes previously added with \fB\fIct_cover:add_nodes/1\fR\&\fR\&\&. Results on the remote node are transferred to the \fICommon Test\fR\& node\&.
.RE