.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Test2::Event::Info 3perl"
.TH Test2::Event::Info 3perl "2018-08-12" "perl v5.26.2" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Test2::Event::Info \- Info event base class
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Successor for note and diag events. This event base class supports multiple
formats. This event makes it possible to send additional information such as
color and highlighting to the harness.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Test2::API::Context qw/context/;
\&
\&    $ctx\->info($obj, diagnostics => $bool);
.Ve
.SH "FORMATS"
.IX Header "FORMATS"
Format will be passed in to \f(CW\*(C`render()\*(C'\fR and \f(CW\*(C`summary()\*(C'\fR as a string. Any
string is considered valid, if your event does not recognize the format it
should fallback to 'text'.
.IP "'text'" 4
.IX Item "'text'"
Plain and ordinary text.
.IP "'ansi'" 4
.IX Item "'ansi'"
Text that may include ansi sequences such as colors.
.IP "'html'" 4
.IX Item "'html'"
\&\s-1HTML\s0 formatted text.
.SH "ACCESSORS"
.IX Header "ACCESSORS"
.ie n .IP "$bool = $info\->\fIdiagnostics()\fR" 4
.el .IP "\f(CW$bool\fR = \f(CW$info\fR\->\fIdiagnostics()\fR" 4
.IX Item "$bool = $info->diagnostics()"
.PD 0
.ie n .IP "$info\->set_diagnostics($bool)" 4
.el .IP "\f(CW$info\fR\->set_diagnostics($bool)" 4
.IX Item "$info->set_diagnostics($bool)"
.PD
True if this info is essential for diagnostics. The implication is that
diagnostics will got to \s-1STDERR\s0 while everything else goes to \s-1STDOUT,\s0 but that
is formatter/harness specific.
.SH "SOURCE"
.IX Header "SOURCE"
The source code repository for Test2 can be found at
\&\fIhttp://github.com/Test\-More/test\-more/\fR.
.SH "MAINTAINERS"
.IX Header "MAINTAINERS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.SH "AUTHORS"
.IX Header "AUTHORS"
.PD 0
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.PD
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2016 Chad Granum <exodist@cpan.org>.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See \fIhttp://dev.perl.org/licenses/\fR