clean stuff up for a 0.09 release

[gitmo/MooseX-Daemonize.git] / lib / MooseX / Daemonize / Pid.pm

diff --git a/lib/MooseX/Daemonize/Pid.pm b/lib/MooseX/Daemonize/Pid.pm
index 60b9086..1f070df 100644 (file)
--- a/lib/MooseX/Daemonize/Pid.pm
+++ b/lib/MooseX/Daemonize/Pid.pm
@@ -2,12 +2,12 @@ package MooseX::Daemonize::Pid;
 use strict;    # because Kwalitee is pedantic
 use Moose;
 use Moose::Util::TypeConstraints;
+our $VERSION = '0.09';
 
 coerce 'MooseX::Daemonize::Pid' 
     => from 'Int' 
         => via { MooseX::Daemonize::Pid->new( pid => $_ ) };
 
-our $VERSION = '0.01';
 
 has 'pid' => (
     is        => 'rw',
@@ -29,24 +29,37 @@ __END__
 =head1 NAME
 
 MooseX::Daemonize::Pid - PID management for MooseX::Daemonize
-
-=head1 SYNOPSIS
      
 =head1 DESCRIPTION
 
+This is a very basic Pid management object, it doesn't do all that 
+much, and mostly just serves as a base class for L<MooseX::Daemonize::Pid::File>.
+
 =head1 ATTRIBUTES
 
-=over
+=over 4
 
-=item pid Int
+=item I<pid Int>
 
 =back
 
 =head1 METHODS 
 
-=over
+=over 4
+
+=item B<clear_pid>
+
+This will clear the value of the I<pid> attribute. It is useful for making sure
+that the parent process does not have a bad value stored in it.
 
-=item is_running
+=item B<has_pid>
+
+This is a predicate method to tell you if your I<pid> attribute has 
+been initialized yet.
+
+=item B<is_running>
+
+This checks to see if the I<pid> is running.
 
 =item meta()
 
@@ -72,17 +85,16 @@ L<http://rt.cpan.org>.
 
 =head1 AUTHOR
 
-Stevan Little  C<< <stevan@cpan.org> >>
+Stevan Little  C<< <stevan.little@iinteractive.com> >>
 
 =head1 LICENCE AND COPYRIGHT
 
-Copyright (c) 2007, Chris Prather C<< <perigrin@cpan.org> >>. All rights 
+Copyright (c) 2007-2008, Chris Prather C<< <perigrin@cpan.org> >>. All rights 
 reserved.
 
 This module is free software; you can redistribute it and/or
 modify it under the same terms as Perl itself. See L<perlartistic>.
 
-
 =head1 DISCLAIMER OF WARRANTY
 
 BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY