Author: jhoblitt
Date: Sun Jan 8 16:07:57 2006
New Revision: 11005
Modified:
trunk/lib/Parrot/Configure/Step/Base.pm
Log:
complete Pod overhaul
Modified: trunk/lib/Parrot/Configure/Step/Base.pm
==============================================================================
--- trunk/lib/Parrot/Configure/Step/Base.pm (original)
+++ trunk/lib/Parrot/Configure/Step/Base.pm Sun Jan 8 16:07:57 2006
@@ -1,21 +1,47 @@
# Copyright: 2001-2005 The Perl Foundation. All Rights Reserved.
# $Id$
+=pod
+
=head1 NAME
Parrot::Configure::Step::Base - Configuration Step Base Class
+=head1 SYNOPSIS
+
+ use base qw(Parrot::Configure::Step::Base);
+
=head1 DESCRIPTION
The C<Parrot::Configure::Step::Base> module contains utility methods that
should be inherited by all configuration steps.
+=head1 USAGE
+
+=head2 Import Parameters
+
+This module accepts no arguments to it's C<import> method and exports no
+I<symbols>.
+
=cut
package Parrot::Configure::Step::Base;
use strict;
+=head2 Methods
+
+=head3 Class Methods
+
+=over 4
+
+=item * C<description()>
+
+Accepts no arguments and returns the value of C<$description> from the
+inheriting classes namespace.
+
+=cut
+
sub description
{
my $class = shift;
@@ -25,6 +51,13 @@ sub description
}
}
+=item * C<result()>
+
+Accepts no arguments and returns the value of C<$result> from the inheriting
+classes namespace.
+
+=cut
+
sub result
{
my $class = shift;
@@ -34,6 +67,13 @@ sub result
}
}
+=item * C<args()>
+
+Accepts no arguments and returns the value of C<@args> from the inheriting
+classes namespace.
+
+=cut
+
sub args
{
my $class = shift;
@@ -43,4 +83,17 @@ sub args
}
}
+=back
+
+=head1 AUTHOR
+
+Joshua Hoblitt C<[EMAIL PROTECTED]>
+
+=head1 SEE ALSO
+
+F<docs/configuration.pod>, L<Parrot::Configure>, L<Parrot::Configure::Data>,
+L<Parrot::Configure::Step>
+
+=cut
+
1;
