Debian Codegraph @

upstream/debian-unstable/man3/Test2::Event::Note.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (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 .\"
57 .IX Title "Test2::Event::Note 3perl"
58 .TH Test2::Event::Note 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Test2::Event::Note \- Note event type
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 Notes, typically rendered to STDOUT.
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 2
71 \& use Test2::API qw/context/;
72 \& use Test2::Event::Note;
73 \&
74 \& my $ctx = context();
75 \& my $event = $ctx\->Note($message);
76 .Ve
77 .SH ACCESSORS
78 .IX Header "ACCESSORS"
79 .ie n .IP $note\->message 4
80 .el .IP \f(CW$note\fR\->message 4
81 .IX Item "$note->message"
82 The message for the note.
83 .SH SOURCE
84 .IX Header "SOURCE"
85 The source code repository for Test2 can be found at
86 <https://github.com/Test\-More/test\-more/>.
87 .SH MAINTAINERS
88 .IX Header "MAINTAINERS"
89 .IP "Chad Granum <[email protected]>" 4
90 .IX Item "Chad Granum <[email protected]>"
91 .SH AUTHORS
92 .IX Header "AUTHORS"
93 .PD 0
94 .IP "Chad Granum <[email protected]>" 4
95 .IX Item "Chad Granum <[email protected]>"
96 .PD
97 .SH COPYRIGHT
98 .IX Header "COPYRIGHT"
99 Copyright 2020 Chad Granum <[email protected]>.
100 .PP
101 This program is free software; you can redistribute it and/or
102 modify it under the same terms as Perl itself.
103 .PP
104 See <https://dev.perl.org/licenses/>