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 3b7a5701f3a698167d95a0c0281fabd0d16eb35c..0326c816bcb3219062175cf78116111e158edbb6 100644 (file)
--- 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
 
 
 =head1 VERSION
 

-Version 1.02
+Version 1.17

 
 =cut
 
 
 =cut
 

-our $VERSION = '1.02';
+our $VERSION = '1.17';
+
+=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 Scalar::Util ();
 

-use base qw/Test::Valgrind::Carp/;
+use base qw<Test::Valgrind::Carp>;

 
 =head1 METHODS
 
 =head2 C<new>
 
 
 =head1 METHODS
 
 =head2 C<new>
 

+    my $tvc = Test::Valgrind::Component->new;
+

 Basic constructor.
 
 =cut
 Basic constructor.
 
 =cut


@@ -44,7 +52,9 @@ sub new {
  }, $class;
 }
 
  }, $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>).
 
 
 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>
 
 
 =head2 C<start>
 

+    $tvc->start;
+

 Marks the component as started, and throws an exception if it was already.
 Returns its self object.
 
 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>
 
 
 =head2 C<finish>
 

+    $tvc->finish;
+

 Marks the component as stopped, and throws an exception if it wasn't started.
 Returns its self object.
 
 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
 
 
 =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.
 
 
 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.