Debian Codegraph @

upstream/debian-unstable/man3/Test2::EventFacet::About.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::EventFacet::About 3perl"
58 .TH Test2::EventFacet::About 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::EventFacet::About \- Facet with event details.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 This facet has information about the event, such as event package.
68 .SH FIELDS
69 .IX Header "FIELDS"
70 .ie n .IP "$string = $about\->{details}" 4
71 .el .IP "\f(CW$string\fR = \f(CW$about\fR\->{details}" 4
72 .IX Item "$string = $about->{details}"
73 .PD 0
74 .ie n .IP "$string = $about\->\fBdetails()\fR" 4
75 .el .IP "\f(CW$string\fR = \f(CW$about\fR\->\fBdetails()\fR" 4
76 .IX Item "$string = $about->details()"
77 .PD
78 Summary about the event.
79 .ie n .IP "$package = $about\->{package}" 4
80 .el .IP "\f(CW$package\fR = \f(CW$about\fR\->{package}" 4
81 .IX Item "$package = $about->{package}"
82 .PD 0
83 .ie n .IP "$package = $about\->\fBpackage()\fR" 4
84 .el .IP "\f(CW$package\fR = \f(CW$about\fR\->\fBpackage()\fR" 4
85 .IX Item "$package = $about->package()"
86 .PD
87 Event package name.
88 .ie n .IP "$bool = $about\->{no_display}" 4
89 .el .IP "\f(CW$bool\fR = \f(CW$about\fR\->{no_display}" 4
90 .IX Item "$bool = $about->{no_display}"
91 .PD 0
92 .ie n .IP "$bool = $about\->\fBno_display()\fR" 4
93 .el .IP "\f(CW$bool\fR = \f(CW$about\fR\->\fBno_display()\fR" 4
94 .IX Item "$bool = $about->no_display()"
95 .PD
96 True if the event should be skipped by formatters.
97 .ie n .IP "$uuid = $about\->{uuid}" 4
98 .el .IP "\f(CW$uuid\fR = \f(CW$about\fR\->{uuid}" 4
99 .IX Item "$uuid = $about->{uuid}"
100 .PD 0
101 .ie n .IP "$uuid = $about\->\fBuuid()\fR" 4
102 .el .IP "\f(CW$uuid\fR = \f(CW$about\fR\->\fBuuid()\fR" 4
103 .IX Item "$uuid = $about->uuid()"
104 .PD
105 Will be set to a uuid if uuid tagging was enabled.
106 .ie n .IP "$uuid = $about\->{eid}" 4
107 .el .IP "\f(CW$uuid\fR = \f(CW$about\fR\->{eid}" 4
108 .IX Item "$uuid = $about->{eid}"
109 .PD 0
110 .ie n .IP "$uuid = $about\->\fBeid()\fR" 4
111 .el .IP "\f(CW$uuid\fR = \f(CW$about\fR\->\fBeid()\fR" 4
112 .IX Item "$uuid = $about->eid()"
113 .PD
114 A unique (for the test job) identifier for the event.
115 .SH SOURCE
116 .IX Header "SOURCE"
117 The source code repository for Test2 can be found at
118 <https://github.com/Test\-More/test\-more/>.
119 .SH MAINTAINERS
120 .IX Header "MAINTAINERS"
121 .IP "Chad Granum <[email protected]>" 4
122 .IX Item "Chad Granum <[email protected]>"
123 .SH AUTHORS
124 .IX Header "AUTHORS"
125 .PD 0
126 .IP "Chad Granum <[email protected]>" 4
127 .IX Item "Chad Granum <[email protected]>"
128 .PD
129 .SH COPYRIGHT
130 .IX Header "COPYRIGHT"
131 Copyright 2020 Chad Granum <[email protected]>.
132 .PP
133 This program is free software; you can redistribute it and/or
134 modify it under the same terms as Perl itself.
135 .PP
136 See <https://dev.perl.org/licenses/>