1package TAP::Parser::Result::Comment;
2
3use strict;
4use warnings;
5
6use base 'TAP::Parser::Result';
7
8=head1 NAME
9
10TAP::Parser::Result::Comment - Comment result token.
11
12=head1 VERSION
13
14Version 3.44
15
16=cut
17
18our $VERSION = '3.44';
19
20=head1 DESCRIPTION
21
22This is a subclass of L<TAP::Parser::Result>.  A token of this class will be
23returned if a comment line is encountered.
24
25 1..1
26 ok 1 - woo hooo!
27 # this is a comment
28
29=head1 OVERRIDDEN METHODS
30
31Mainly listed here to shut up the pitiful screams of the pod coverage tests.
32They keep me awake at night.
33
34=over 4
35
36=item * C<as_string>
37
38Note that this method merely returns the comment preceded by a '# '.
39
40=back
41
42=cut
43
44##############################################################################
45
46=head2 Instance Methods
47
48=head3 C<comment>
49
50  if ( $result->is_comment ) {
51      my $comment = $result->comment;
52      print "I have something to say:  $comment";
53  }
54
55=cut
56
57sub comment   { shift->{comment} }
58sub as_string { shift->{raw} }
59
601;
61