Debian Codegraph @

upstream/debian-unstable/man3/TAP::Parser::Result::Comment.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 "TAP::Parser::Result::Comment 3perl"
58 .TH TAP::Parser::Result::Comment 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 TAP::Parser::Result::Comment \- Comment result token.
65 .SH VERSION
66 .IX Header "VERSION"
67 Version 3.48
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This is a subclass of TAP::Parser::Result. A token of this class will be
71 returned if a comment line is encountered.
72 .PP
73 .Vb 3
74 \& 1..1
75 \& ok 1 \- woo hooo!
76 \& # this is a comment
77 .Ve
78 .SH "OVERRIDDEN METHODS"
79 .IX Header "OVERRIDDEN METHODS"
80 Mainly listed here to shut up the pitiful screams of the pod coverage tests.
81 They keep me awake at night.
82 .IP \(bu 4
83 \&\f(CW\*(C`as_string\*(C'\fR
84 .Sp
85 Note that this method merely returns the comment preceded by a '# '.
86 .SS "Instance Methods"
87 .IX Subsection "Instance Methods"
88 \fR\f(CI\*(C`comment\*(C'\fR\fI\fR
89 .IX Subsection "comment"
90 .PP
91 .Vb 4
92 \& if ( $result\->is_comment ) {
93 \& my $comment = $result\->comment;
94 \& print "I have something to say: $comment";
95 \& }
96 .Ve