This is 1.17

[perl/modules/Test-Valgrind.git] / lib / Test / Valgrind / Component.pm

diff --git a/lib/Test/Valgrind/Component.pm b/lib/Test/Valgrind/Component.pm
index bcba4476fce01fc2ba2300e407e78659cf8b26e1..0326c816bcb3219062175cf78116111e158edbb6 100644 (file)
--- a/lib/Test/Valgrind/Component.pm
+++ b/lib/Test/Valgrind/Component.pm
@@ -9,11 +9,11 @@ Test::Valgrind::Component - Base class for Test::Valgrind components.
 
 =head1 VERSION
 
-Version 1.11
+Version 1.17
 
 =cut
 
-our $VERSION = '1.11';
+our $VERSION = '1.17';
 
 =head1 DESCRIPTION
 
@@ -23,12 +23,14 @@ This class is the base for all others that act as components that can be started
 
 use Scalar::Util ();
 
-use base qw/Test::Valgrind::Carp/;
+use base qw<Test::Valgrind::Carp>;
 
 =head1 METHODS
 
 =head2 C<new>
 
+    my $tvc = Test::Valgrind::Component->new;
+
 Basic constructor.
 
 =cut
@@ -50,7 +52,9 @@ sub new {
  }, $class;
 }
 
-=head2 C<started [ $bool ]>
+=head2 C<started>
+
+    $tvc->started($bool);
 
 Specifies whether the component is running (C<1>), stopped (C<0>) or was never started (C<undef>).
 
@@ -60,6 +64,8 @@ sub started { @_ <= 1 ? $_[0]->{started} : ($_[0]->{started} = $_[1] ? 1 : 0) }
 
 =head2 C<start>
 
+    $tvc->start;
+
 Marks the component as started, and throws an exception if it was already.
 Returns its self object.
 
@@ -76,6 +82,8 @@ sub start {
 
 =head2 C<finish>
 
+    $tvc->finish;
+
 Marks the component as stopped, and throws an exception if it wasn't started.
 Returns its self object.
 
@@ -113,7 +121,7 @@ You can find documentation for this module with the perldoc command.
 
 =head1 COPYRIGHT & LICENSE
 
-Copyright 2009 Vincent Pit, all rights reserved.
+Copyright 2009,2010,2011,2013,2015 Vincent Pit, all rights reserved.
 
 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.