cpan/Test-Simple/lib/Test2/Event/Note.pm

   1 package Test2::Event::Note;
   2 use strict;
   3 use warnings;
   4
   5 our $VERSION = '1.302040';
   6
   7
   8 BEGIN { require Test2::Event; our @ISA = qw(Test2::Event) }
   9 use Test2::Util::HashBase qw/message/;
  10
  11 sub init {
  12     $_[0]->{+MESSAGE} = 'undef' unless defined $_[0]->{+MESSAGE};
  13 }
  14
  15 sub summary { $_[0]->{+MESSAGE} }
  16
  17 1;
  18
  19 __END__
  20
  21 =pod
  22
  23 =encoding UTF-8
  24
  25 =head1 NAME
  26
  27 Test2::Event::Note - Note event type
  28
  29 =head1 DESCRIPTION
  30
  31 Notes, typically rendered to STDOUT.
  32
  33 =head1 SYNOPSIS
  34
  35     use Test2::API qw/context/;
  36     use Test2::Event::Note;
  37
  38     my $ctx = context();
  39     my $event = $ctx->Note($message);
  40
  41 =head1 ACCESSORS
  42
  43 =over 4
  44
  45 =item $note->message
  46
  47 The message for the note.
  48
  49 =back
  50
  51 =head1 SOURCE
  52
  53 The source code repository for Test2 can be found at
  54 F<http://github.com/Test-More/test-more/>.
  55
  56 =head1 MAINTAINERS
  57
  58 =over 4
  59
  60 =item Chad Granum E<lt>exodist@cpan.orgE<gt>
  61
  62 =back
  63
  64 =head1 AUTHORS
  65
  66 =over 4
  67
  68 =item Chad Granum E<lt>exodist@cpan.orgE<gt>
  69
  70 =back
  71
  72 =head1 COPYRIGHT
  73
  74 Copyright 2016 Chad Granum E<lt>exodist@cpan.orgE<gt>.
  75
  76 This program is free software; you can redistribute it and/or
  77 modify it under the same terms as Perl itself.
  78
  79 See F<http://dev.perl.org/licenses/>
  80
  81 =cut