Update Test-Harness to CPAN version 3.39
[perl.git] / cpan / Test-Harness / lib / TAP / Parser / Result / Comment.pm
1 package TAP::Parser::Result::Comment;
2
3 use strict;
4 use warnings;
5
6 use base 'TAP::Parser::Result';
7
8 =head1 NAME
9
10 TAP::Parser::Result::Comment - Comment result token.
11
12 =head1 VERSION
13
14 Version 3.39
15
16 =cut
17
18 our $VERSION = '3.39';
19
20 =head1 DESCRIPTION
21
22 This is a subclass of L<TAP::Parser::Result>.  A token of this class will be
23 returned 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
31 Mainly listed here to shut up the pitiful screams of the pod coverage tests.
32 They keep me awake at night.
33
34 =over 4
35
36 =item * C<as_string>
37
38 Note 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
57 sub comment   { shift->{comment} }
58 sub as_string { shift->{raw} }
59
60 1;