X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;f=lib%2FTest%2FValgrind%2FComponent.pm;h=9b10a18bb2d9a03e8ddd36d21e5e53f2d68047fd;hb=d93ddba6bc7708cbd0df564b47eb63edf70d601c;hp=ed212b9700729a0e41099a1f3edaf940ae8a7ef2;hpb=08860dad1f820cce06758ec4add9353a4dbc8175;p=perl%2Fmodules%2FTest-Valgrind.git

diff --git a/lib/Test/Valgrind/Component.pm b/lib/Test/Valgrind/Component.pm
index ed212b9..9b10a18 100644
--- a/lib/Test/Valgrind/Component.pm
+++ b/lib/Test/Valgrind/Component.pm
@@ -9,20 +9,28 @@ Test::Valgrind::Component - Base class for Test::Valgrind components.
 
 =head1 VERSION
 
-Version 1.10
+Version 1.14
 
 =cut
 
-our $VERSION = '1.10';
+our $VERSION = '1.14';
+
+=head1 DESCRIPTION
+
+This class is the base for all others that act as components that can be started and stopped.
+
+=cut
 
 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
@@ -44,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>).
 
@@ -54,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.
 
@@ -70,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.
 
@@ -107,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.