Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Test2::Event::Note.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Test2::Event::Note 3pm"
61 .TH Test2::Event::Note 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Test2::Event::Note \- Note event type
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 Notes, typically rendered to STDOUT.
71 .SH SYNOPSIS
72 .IX Header "SYNOPSIS"
73 .Vb 2
74 \& use Test2::API qw/context/;
75 \& use Test2::Event::Note;
76 \&
77 \& my $ctx = context();
78 \& my $event = $ctx\->Note($message);
79 .Ve
80 .SH ACCESSORS
81 .IX Header "ACCESSORS"
82 .ie n .IP $note\->message 4
83 .el .IP \f(CW$note\fR\->message 4
84 .IX Item "$note->message"
85 The message for the note.
86 .SH SOURCE
87 .IX Header "SOURCE"
88 The source code repository for Test2 can be found at
89 <https://github.com/Test\-More/test\-more/>.
90 .SH MAINTAINERS
91 .IX Header "MAINTAINERS"
92 .IP "Chad Granum <[email protected]>" 4
93 .IX Item "Chad Granum <[email protected]>"
94 .SH AUTHORS
95 .IX Header "AUTHORS"
96 .IP "Chad Granum <[email protected]>" 4
97 .IX Item "Chad Granum <[email protected]>"
98 .SH COPYRIGHT
99 .IX Header "COPYRIGHT"
100 Copyright Chad Granum <[email protected]>.
101 .PP
102 This program is free software; you can redistribute it and/or
103 modify it under the same terms as Perl itself.
104 .PP
105 See <https://dev.perl.org/licenses/>