.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" 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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . 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 .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "TAP::Parser::Result::Comment 3perl" .TH TAP::Parser::Result::Comment 3perl 2024-05-30 "perl v5.38.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 TAP::Parser::Result::Comment \- Comment result token. .SH VERSION .IX Header "VERSION" Version 3.44 .SH DESCRIPTION .IX Header "DESCRIPTION" This is a subclass of TAP::Parser::Result. A token of this class will be returned if a comment line is encountered. .PP .Vb 3 \& 1..1 \& ok 1 \- woo hooo! \& # this is a comment .Ve .SH "OVERRIDDEN METHODS" .IX Header "OVERRIDDEN METHODS" Mainly listed here to shut up the pitiful screams of the pod coverage tests. They keep me awake at night. .IP \(bu 4 \&\f(CW\*(C`as_string\*(C'\fR .Sp Note that this method merely returns the comment preceded by a '# '. .SS "Instance Methods" .IX Subsection "Instance Methods" \fR\f(CI\*(C`comment\*(C'\fR\fI\fR .IX Subsection "comment" .PP .Vb 4 \& if ( $result\->is_comment ) { \& my $comment = $result\->comment; \& print "I have something to say: $comment"; \& } .Ve